AWSChimeSDKMessagingCreateChannelRequest

Objective-C

@interface AWSChimeSDKMessagingCreateChannelRequest

Swift

class AWSChimeSDKMessagingCreateChannelRequest

  • The ARN of the channel request.

    Declaration

    Objective-C

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

    Swift

    var appInstanceArn: String? { get set }

  • The ID of the channel in the request.

    Declaration

    Objective-C

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

    Swift

    var channelId: 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 client token for the request. An Idempotency token.

    Declaration

    Objective-C

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

    Swift

    var clientRequestToken: String? { get set }

  • The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSChimeSDKMessagingElasticChannelConfiguration *_Nullable elasticChannelConfiguration;

    Swift

    var elasticChannelConfiguration: AWSChimeSDKMessagingElasticChannelConfiguration? { get set }

  • Settings that control the interval after which the channel is automatically deleted.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSChimeSDKMessagingExpirationSettings *_Nullable expirationSettings;

    Swift

    var expirationSettings: AWSChimeSDKMessagingExpirationSettings? { get set }

  • The ARNs of the channel members in the request.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable memberArns;

    Swift

    var memberArns: [String]? { get set }

  • The metadata of the creation request. Limited to 1KB and UTF-8.

    Declaration

    Objective-C

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

    Swift

    var metadata: String? { get set }

  • The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.

    Declaration

    Objective-C

    @property (nonatomic) AWSChimeSDKMessagingChannelMode mode;

    Swift

    var mode: AWSChimeSDKMessagingChannelMode { get set }

  • The ARNs of the channel moderators in the request.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable moderatorArns;

    Swift

    var moderatorArns: [String]? { get set }

  • The name of the channel.

    Declaration

    Objective-C

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

    Swift

    var name: String? { get set }

  • The channel’s privacy level: PUBLIC or PRIVATE. Private channels aren’t discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.

    Declaration

    Objective-C

    @property (nonatomic) AWSChimeSDKMessagingChannelPrivacy privacy;

    Swift

    var privacy: AWSChimeSDKMessagingChannelPrivacy { get set }

  • The tags for the creation request.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSChimeSDKMessagingTag *> *_Nullable tags;

    Swift

    var tags: [AWSChimeSDKMessagingTag]? { get set }