AWSIoTDataPublishRequest

Objective-C

@interface AWSIoTDataPublishRequest

Swift

class AWSIoTDataPublishRequest

The input for the Publish operation.

Required parameters: [topic]

  • A UTF-8 encoded string that describes the content of the publishing message.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable contentType;

    Swift

    var contentType: String? { get set }

  • The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it’s received. correlationData is an HTTP header value in the API.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable correlationData;

    Swift

    var correlationData: String? { get set }

  • A user-defined integer value that represents the message expiry interval in seconds. If absent, the message doesn’t expire. For more information about the limits of messageExpiry, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable messageExpiry;

    Swift

    var messageExpiry: NSNumber? { get set }

  • The message body. MQTT accepts text, binary, and empty (null) message payloads.

    Publishing an empty (null) payload with retain = true deletes the retained message identified by topic from Amazon Web Services IoT Core.

    Declaration

    Objective-C

    @property (nonatomic, strong) id _Nullable payload;

    Swift

    var payload: Any? { get set }

  • An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.

    Declaration

    Objective-C

    @property (nonatomic) AWSIoTDataPayloadFormatIndicator payloadFormatIndicator;

    Swift

    var payloadFormatIndicator: AWSIoTDataPayloadFormatIndicator { get set }
  • qos

    The Quality of Service (QoS) level. The default QoS level is 0.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable qos;

    Swift

    var qos: NSNumber? { get set }

  • A UTF-8 encoded string that’s used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable responseTopic;

    Swift

    var responseTopic: String? { get set }

  • A Boolean value that determines whether to set the RETAIN flag when the message is published.

    Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.

    Valid values: true | false

    Default value: false

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable retainValue;

    Swift

    var retainValue: NSNumber? { get set }

  • The name of the MQTT topic.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable topic;

    Swift

    var topic: String? { get set }

  • A JSON string that contains an array of JSON objects. If you don’t use Amazon Web Services SDK or CLI, you must encode the JSON string to base64 format before adding it to the HTTP header. userProperties is an HTTP header value in the API.

    The following example userProperties parameter is a JSON string which represents two User Properties. Note that it needs to be base64-encoded:

    [{"deviceName": "alpha"}, {"deviceCnt": "45"}]

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable userProperties;

    Swift

    var userProperties: String? { get set }