AWSChimeSDKMessagingSendChannelMessageRequest

Objective-C

@interface AWSChimeSDKMessagingSendChannelMessageRequest

Swift

class AWSChimeSDKMessagingSendChannelMessageRequest

  • The ARN of the channel.

    Declaration

    Objective-C

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

    Swift

    var channelArn: String? { get set }

  • The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    Declaration

    Objective-C

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

    Swift

    var chimeBearer: String? { get set }

  • The Idempotency token for each client request.

    Declaration

    Objective-C

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

    Swift

    var clientRequestToken: String? { get set }

  • The content of the channel message.

    Declaration

    Objective-C

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

    Swift

    var content: String? { get set }

  • The content type of the channel message.

    Declaration

    Objective-C

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

    Swift

    var contentType: String? { get set }

  • The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, AWSChimeSDKMessagingMessageAttributeValue *> *_Nullable messageAttributes;

    Swift

    var messageAttributes: [String : AWSChimeSDKMessagingMessageAttributeValue]? { get set }

  • The optional metadata for each message.

    Declaration

    Objective-C

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

    Swift

    var metadata: String? { get set }

  • Boolean that controls whether the message is persisted on the back end. Required.

    Declaration

    Objective-C

    @property (nonatomic) AWSChimeSDKMessagingChannelMessagePersistenceType persistence;

    Swift

    var persistence: AWSChimeSDKMessagingChannelMessagePersistenceType { get set }

  • The push notification configuration of the message.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSChimeSDKMessagingPushNotificationConfiguration *_Nullable pushNotification;

    Swift

    var pushNotification: AWSChimeSDKMessagingPushNotificationConfiguration? { get set }

  • The ID of the SubChannel in the request.

    Declaration

    Objective-C

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

    Swift

    var subChannelId: String? { get set }

  • The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSChimeSDKMessagingTarget *> *_Nullable target;

    Swift

    var target: [AWSChimeSDKMessagingTarget]? { get set }

  • The type of message, STANDARD or CONTROL.

    STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.

    CONTROL messages are limited to 30 bytes and do not contain metadata.

    Declaration

    Objective-C

    @property (nonatomic) AWSChimeSDKMessagingChannelMessageType types;

    Swift

    var types: AWSChimeSDKMessagingChannelMessageType { get set }