AWSChimeSDKMessaging

Objective-C

@interface AWSChimeSDKMessaging

Swift

class AWSChimeSDKMessaging

The Amazon Chime SDK messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK identity APIs. For more information about the messaging APIs, see Amazon Chime SDK messaging.

  • The service configuration used to instantiate this service client.

    Warning

    Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration

  • Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with defaultServiceConfiguration from [AWSServiceManager defaultServiceManager]. The reference to this object is maintained by the SDK, and you do not need to retain it manually.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
   let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
   let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider)
   AWSServiceManager.default().defaultServiceConfiguration = configuration

   return true

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                     identityPoolId:@"YourIdentityPoolId"];
     AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1
                                                                          credentialsProvider:credentialsProvider];
     [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration;

     return YES;
 }

    Then call the following to get the default service client:

    Swift

    let ChimeSDKMessaging = AWSChimeSDKMessaging.default()

    Objective-C

    AWSChimeSDKMessaging *ChimeSDKMessaging = [AWSChimeSDKMessaging defaultChimeSDKMessaging];

    Declaration

    Objective-C

    + (nonnull instancetype)defaultChimeSDKMessaging;

    Swift

    class func `default`() -> Self

    Return Value

    The default service client.

  • Creates a service client with the given service configuration and registers it for the key.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
   let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
   let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
   AWSChimeSDKMessaging.register(with: configuration!, forKey: "USWest2ChimeSDKMessaging")

   return true

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                    identityPoolId:@"YourIdentityPoolId"];
    AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                         credentialsProvider:credentialsProvider];

    [AWSChimeSDKMessaging registerChimeSDKMessagingWithConfiguration:configuration forKey:@"USWest2ChimeSDKMessaging"];

    return YES;
}

    Then call the following to get the service client:

    Swift

    let ChimeSDKMessaging = AWSChimeSDKMessaging(forKey: "USWest2ChimeSDKMessaging")

    Objective-C

    AWSChimeSDKMessaging *ChimeSDKMessaging = [AWSChimeSDKMessaging ChimeSDKMessagingForKey:@"USWest2ChimeSDKMessaging"];

    Warning

    After calling this method, do not modify the configuration object. It may cause unspecified behaviors.

    Declaration

    Objective-C

    + (void)registerChimeSDKMessagingWithConfiguration:(id)configuration
                                            forKey:(nonnull NSString *)key;

    Swift

    class func register(withConfiguration configuration: Any!, forKey key: String)

    Parameters

    configuration

    A service configuration object.
    key

    A string to identify the service client.

  • Retrieves the service client associated with the key. You need to call + registerChimeSDKMessagingWithConfiguration:forKey: before invoking this method.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
   let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
   let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
   AWSChimeSDKMessaging.register(with: configuration!, forKey: "USWest2ChimeSDKMessaging")

   return true

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                    identityPoolId:@"YourIdentityPoolId"];
    AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                         credentialsProvider:credentialsProvider];

    [AWSChimeSDKMessaging registerChimeSDKMessagingWithConfiguration:configuration forKey:@"USWest2ChimeSDKMessaging"];

    return YES;
}

    Then call the following to get the service client:

    Swift

    let ChimeSDKMessaging = AWSChimeSDKMessaging(forKey: "USWest2ChimeSDKMessaging")

    Objective-C

    AWSChimeSDKMessaging *ChimeSDKMessaging = [AWSChimeSDKMessaging ChimeSDKMessagingForKey:@"USWest2ChimeSDKMessaging"];

    Declaration

    Objective-C

    + (nonnull instancetype)ChimeSDKMessagingForKey:(nonnull NSString *)key;

    Swift

    convenience init(forKey key: String)

    Parameters

    key

    A string to identify the service client.

    Return Value

    An instance of the service client.

  • Removes the service client associated with the key and release it.

    Warning

    Before calling this method, make sure no method is running on this client.

    Declaration

    Objective-C

    + (void)removeChimeSDKMessagingForKey:(nonnull NSString *)key;

    Swift

    class func remove(forKey key: String)

    Parameters

    key

    A string to identify the service client.

  • Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the DisassociateChannelFlow API.

    Only administrators or channel moderators can associate a channel flow. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingAssociateChannelFlowRequest

    Declaration

    Objective-C

    - (id)associateChannelFlow:
    (nonnull AWSChimeSDKMessagingAssociateChannelFlowRequest *)request;

    Swift

    func associateChannelFlow(_ request: AWSChimeSDKMessagingAssociateChannelFlowRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the AssociateChannelFlow service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorNotFound, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the DisassociateChannelFlow API.

    Only administrators or channel moderators can associate a channel flow. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingAssociateChannelFlowRequest

    Declaration

    Objective-C

    - (void)associateChannelFlow:
            (nonnull AWSChimeSDKMessagingAssociateChannelFlowRequest *)request
           completionHandler:
               (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func associateChannelFlow(_ request: AWSChimeSDKMessagingAssociateChannelFlowRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the AssociateChannelFlow service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorNotFound, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Adds a specified number of users and bots to a channel.

    See

    AWSChimeSDKMessagingBatchCreateChannelMembershipRequest

    See

    AWSChimeSDKMessagingBatchCreateChannelMembershipResponse

    Declaration

    Objective-C

    - (id)batchCreateChannelMembership:
    (nonnull AWSChimeSDKMessagingBatchCreateChannelMembershipRequest *)request;

    Swift

    func batchCreateChannelMembership(_ request: AWSChimeSDKMessagingBatchCreateChannelMembershipRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the BatchCreateChannelMembership service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingBatchCreateChannelMembershipResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorServiceFailure, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorNotFound, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorResourceLimitExceeded.

  • Adds a specified number of users and bots to a channel.

    See

    AWSChimeSDKMessagingBatchCreateChannelMembershipRequest

    See

    AWSChimeSDKMessagingBatchCreateChannelMembershipResponse

    Declaration

    Objective-C

    - (void)
    batchCreateChannelMembership:
        (nonnull AWSChimeSDKMessagingBatchCreateChannelMembershipRequest *)
            request
               completionHandler:
                   (void (^_Nullable)(
                       AWSChimeSDKMessagingBatchCreateChannelMembershipResponse
                           *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func batchCreateChannelMembership(_ request: AWSChimeSDKMessagingBatchCreateChannelMembershipRequest) async throws -> AWSChimeSDKMessagingBatchCreateChannelMembershipResponse

    Parameters

    request

    A container for the necessary parameters to execute the BatchCreateChannelMembership service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorServiceFailure, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorNotFound, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorResourceLimitExceeded.

  • Calls back Amazon Chime SDK messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.

    You can return one of the following processing responses:

    • Update message content or metadata

    • Deny a message

    • Make no changes to the message

    See

    AWSChimeSDKMessagingChannelFlowCallbackRequest

    See

    AWSChimeSDKMessagingChannelFlowCallbackResponse

    Declaration

    Objective-C

    - (id)channelFlowCallback:
    (nonnull AWSChimeSDKMessagingChannelFlowCallbackRequest *)request;

    Swift

    func channelFlowCallback(_ request: AWSChimeSDKMessagingChannelFlowCallbackRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ChannelFlowCallback service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingChannelFlowCallbackResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Calls back Amazon Chime SDK messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.

    You can return one of the following processing responses:

    • Update message content or metadata

    • Deny a message

    • Make no changes to the message

    See

    AWSChimeSDKMessagingChannelFlowCallbackRequest

    See

    AWSChimeSDKMessagingChannelFlowCallbackResponse

    Declaration

    Objective-C

    - (void)channelFlowCallback:
            (nonnull AWSChimeSDKMessagingChannelFlowCallbackRequest *)request
          completionHandler:
              (void (^_Nullable)(
                  AWSChimeSDKMessagingChannelFlowCallbackResponse *_Nullable,
                  NSError *_Nullable))completionHandler;

    Swift

    func channelFlowCallback(_ request: AWSChimeSDKMessagingChannelFlowCallbackRequest) async throws -> AWSChimeSDKMessagingChannelFlowCallbackResponse

    Parameters

    request

    A container for the necessary parameters to execute the ChannelFlowCallback service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Creates a channel to which you can add users and send messages.

    Restriction: You can’t change a channel’s privacy.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingCreateChannelRequest

    See

    AWSChimeSDKMessagingCreateChannelResponse

    Declaration

    Objective-C

    - (id)createChannel:(nonnull AWSChimeSDKMessagingCreateChannelRequest *)request;

    Swift

    func createChannel(_ request: AWSChimeSDKMessagingCreateChannelRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateChannel service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingCreateChannelResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorResourceLimitExceeded, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Creates a channel to which you can add users and send messages.

    Restriction: You can’t change a channel’s privacy.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingCreateChannelRequest

    See

    AWSChimeSDKMessagingCreateChannelResponse

    Declaration

    Objective-C

    - (void)createChannel:
            (nonnull AWSChimeSDKMessagingCreateChannelRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSChimeSDKMessagingCreateChannelResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func createChannel(_ request: AWSChimeSDKMessagingCreateChannelRequest) async throws -> AWSChimeSDKMessagingCreateChannelResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateChannel service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorResourceLimitExceeded, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Permanently bans a member from a channel. Moderators can’t add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels.

    If you ban a user who is already part of a channel, that user is automatically kicked from the channel.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingCreateChannelBanRequest

    See

    AWSChimeSDKMessagingCreateChannelBanResponse

    Declaration

    Objective-C

    - (id)createChannelBan:
    (nonnull AWSChimeSDKMessagingCreateChannelBanRequest *)request;

    Swift

    func createChannelBan(_ request: AWSChimeSDKMessagingCreateChannelBanRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateChannelBan service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingCreateChannelBanResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorResourceLimitExceeded, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Permanently bans a member from a channel. Moderators can’t add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels.

    If you ban a user who is already part of a channel, that user is automatically kicked from the channel.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingCreateChannelBanRequest

    See

    AWSChimeSDKMessagingCreateChannelBanResponse

    Declaration

    Objective-C

    - (void)createChannelBan:
            (nonnull AWSChimeSDKMessagingCreateChannelBanRequest *)request
       completionHandler:
           (void (^_Nullable)(
               AWSChimeSDKMessagingCreateChannelBanResponse *_Nullable,
               NSError *_Nullable))completionHandler;

    Swift

    func createChannelBan(_ request: AWSChimeSDKMessagingCreateChannelBanRequest) async throws -> AWSChimeSDKMessagingCreateChannelBanResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateChannelBan service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorResourceLimitExceeded, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API.

    Channel flows process the following items:

    1. New and updated messages

    2. Persistent and non-persistent messages

    3. The Standard message type

    Channel flows don’t process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to Message types in the Amazon Chime developer guide.

    See

    AWSChimeSDKMessagingCreateChannelFlowRequest

    See

    AWSChimeSDKMessagingCreateChannelFlowResponse

    Declaration

    Objective-C

    - (id)createChannelFlow:
    (nonnull AWSChimeSDKMessagingCreateChannelFlowRequest *)request;

    Swift

    func createChannelFlow(_ request: AWSChimeSDKMessagingCreateChannelFlowRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateChannelFlow service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingCreateChannelFlowResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorResourceLimitExceeded, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API.

    Channel flows process the following items:

    1. New and updated messages

    2. Persistent and non-persistent messages

    3. The Standard message type

    Channel flows don’t process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to Message types in the Amazon Chime developer guide.

    See

    AWSChimeSDKMessagingCreateChannelFlowRequest

    See

    AWSChimeSDKMessagingCreateChannelFlowResponse

    Declaration

    Objective-C

    - (void)createChannelFlow:
            (nonnull AWSChimeSDKMessagingCreateChannelFlowRequest *)request
        completionHandler:
            (void (^_Nullable)(
                AWSChimeSDKMessagingCreateChannelFlowResponse *_Nullable,
                NSError *_Nullable))completionHandler;

    Swift

    func createChannelFlow(_ request: AWSChimeSDKMessagingCreateChannelFlowRequest) async throws -> AWSChimeSDKMessagingCreateChannelFlowResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateChannelFlow service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorResourceLimitExceeded, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Adds a member to a channel. The InvitedBy field in ChannelMembership is derived from the request header. A channel member can:

    • List messages

    • Send messages

    • Receive messages

    • Edit their own messages

    • Leave the channel

    Privacy settings impact this action as follows:

    • Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.

    • Private Channels: You must be a member to list or send messages.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingCreateChannelMembershipRequest

    See

    AWSChimeSDKMessagingCreateChannelMembershipResponse

    Declaration

    Objective-C

    - (id)createChannelMembership:
    (nonnull AWSChimeSDKMessagingCreateChannelMembershipRequest *)request;

    Swift

    func createChannelMembership(_ request: AWSChimeSDKMessagingCreateChannelMembershipRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateChannelMembership service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingCreateChannelMembershipResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorNotFound, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorResourceLimitExceeded, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Adds a member to a channel. The InvitedBy field in ChannelMembership is derived from the request header. A channel member can:

    • List messages

    • Send messages

    • Receive messages

    • Edit their own messages

    • Leave the channel

    Privacy settings impact this action as follows:

    • Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.

    • Private Channels: You must be a member to list or send messages.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingCreateChannelMembershipRequest

    See

    AWSChimeSDKMessagingCreateChannelMembershipResponse

    Declaration

    Objective-C

    - (void)createChannelMembership:
            (nonnull AWSChimeSDKMessagingCreateChannelMembershipRequest *)
                request
              completionHandler:
                  (void (^_Nullable)(
                      AWSChimeSDKMessagingCreateChannelMembershipResponse
                          *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func createChannelMembership(_ request: AWSChimeSDKMessagingCreateChannelMembershipRequest) async throws -> AWSChimeSDKMessagingCreateChannelMembershipResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateChannelMembership service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorNotFound, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorResourceLimitExceeded, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Creates a new ChannelModerator. A channel moderator can:

    • Add and remove other members of the channel.

    • Add and remove other moderators of the channel.

    • Add and remove user bans for the channel.

    • Redact messages in the channel.

    • List messages in the channel.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBotof the user that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingCreateChannelModeratorRequest

    See

    AWSChimeSDKMessagingCreateChannelModeratorResponse

    Declaration

    Objective-C

    - (id)createChannelModerator:
    (nonnull AWSChimeSDKMessagingCreateChannelModeratorRequest *)request;

    Swift

    func createChannelModerator(_ request: AWSChimeSDKMessagingCreateChannelModeratorRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateChannelModerator service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingCreateChannelModeratorResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorResourceLimitExceeded, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Creates a new ChannelModerator. A channel moderator can:

    • Add and remove other members of the channel.

    • Add and remove other moderators of the channel.

    • Add and remove user bans for the channel.

    • Redact messages in the channel.

    • List messages in the channel.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBotof the user that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingCreateChannelModeratorRequest

    See

    AWSChimeSDKMessagingCreateChannelModeratorResponse

    Declaration

    Objective-C

    - (void)
    createChannelModerator:
        (nonnull AWSChimeSDKMessagingCreateChannelModeratorRequest *)request
         completionHandler:
             (void (^_Nullable)(
                 AWSChimeSDKMessagingCreateChannelModeratorResponse *_Nullable,
                 NSError *_Nullable))completionHandler;

    Swift

    func createChannelModerator(_ request: AWSChimeSDKMessagingCreateChannelModeratorRequest) async throws -> AWSChimeSDKMessagingCreateChannelModeratorResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateChannelModerator service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorResourceLimitExceeded, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDeleteChannelRequest

    Declaration

    Objective-C

    - (id)deleteChannel:(nonnull AWSChimeSDKMessagingDeleteChannelRequest *)request;

    Swift

    func deleteChannel(_ request: AWSChimeSDKMessagingDeleteChannelRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteChannel service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDeleteChannelRequest

    Declaration

    Objective-C

    - (void)deleteChannel:
            (nonnull AWSChimeSDKMessagingDeleteChannelRequest *)request
    completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteChannel(_ request: AWSChimeSDKMessagingDeleteChannelRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteChannel service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Removes a member from a channel’s ban list.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDeleteChannelBanRequest

    Declaration

    Objective-C

    - (id)deleteChannelBan:
    (nonnull AWSChimeSDKMessagingDeleteChannelBanRequest *)request;

    Swift

    func deleteChannelBan(_ request: AWSChimeSDKMessagingDeleteChannelBanRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteChannelBan service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Removes a member from a channel’s ban list.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDeleteChannelBanRequest

    Declaration

    Objective-C

    - (void)deleteChannelBan:
            (nonnull AWSChimeSDKMessagingDeleteChannelBanRequest *)request
       completionHandler:
           (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteChannelBan(_ request: AWSChimeSDKMessagingDeleteChannelBanRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteChannelBan service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Deletes a channel flow, an irreversible process. This is a developer API.

    This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the ListChannelsAssociatedWithChannelFlow API. Use the DisassociateChannelFlow API to disassociate a channel flow from all channels.

    See

    AWSChimeSDKMessagingDeleteChannelFlowRequest

    Declaration

    Objective-C

    - (id)deleteChannelFlow:
    (nonnull AWSChimeSDKMessagingDeleteChannelFlowRequest *)request;

    Swift

    func deleteChannelFlow(_ request: AWSChimeSDKMessagingDeleteChannelFlowRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteChannelFlow service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Deletes a channel flow, an irreversible process. This is a developer API.

    This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the ListChannelsAssociatedWithChannelFlow API. Use the DisassociateChannelFlow API to disassociate a channel flow from all channels.

    See

    AWSChimeSDKMessagingDeleteChannelFlowRequest

    Declaration

    Objective-C

    - (void)deleteChannelFlow:
            (nonnull AWSChimeSDKMessagingDeleteChannelFlowRequest *)request
        completionHandler:
            (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteChannelFlow(_ request: AWSChimeSDKMessagingDeleteChannelFlowRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteChannelFlow service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Removes a member from a channel.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDeleteChannelMembershipRequest

    Declaration

    Objective-C

    - (id)deleteChannelMembership:
    (nonnull AWSChimeSDKMessagingDeleteChannelMembershipRequest *)request;

    Swift

    func deleteChannelMembership(_ request: AWSChimeSDKMessagingDeleteChannelMembershipRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteChannelMembership service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Removes a member from a channel.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDeleteChannelMembershipRequest

    Declaration

    Objective-C

    - (void)deleteChannelMembership:
            (nonnull AWSChimeSDKMessagingDeleteChannelMembershipRequest *)
                request
              completionHandler:
                  (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteChannelMembership(_ request: AWSChimeSDKMessagingDeleteChannelMembershipRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteChannelMembership service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDeleteChannelMessageRequest

    Declaration

    Objective-C

    - (id)deleteChannelMessage:
    (nonnull AWSChimeSDKMessagingDeleteChannelMessageRequest *)request;

    Swift

    func deleteChannelMessage(_ request: AWSChimeSDKMessagingDeleteChannelMessageRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteChannelMessage service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDeleteChannelMessageRequest

    Declaration

    Objective-C

    - (void)deleteChannelMessage:
            (nonnull AWSChimeSDKMessagingDeleteChannelMessageRequest *)request
           completionHandler:
               (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteChannelMessage(_ request: AWSChimeSDKMessagingDeleteChannelMessageRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteChannelMessage service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Deletes a channel moderator.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDeleteChannelModeratorRequest

    Declaration

    Objective-C

    - (id)deleteChannelModerator:
    (nonnull AWSChimeSDKMessagingDeleteChannelModeratorRequest *)request;

    Swift

    func deleteChannelModerator(_ request: AWSChimeSDKMessagingDeleteChannelModeratorRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteChannelModerator service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Deletes a channel moderator.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDeleteChannelModeratorRequest

    Declaration

    Objective-C

    - (void)deleteChannelModerator:
            (nonnull AWSChimeSDKMessagingDeleteChannelModeratorRequest *)request
             completionHandler:
                 (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteChannelModerator(_ request: AWSChimeSDKMessagingDeleteChannelModeratorRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteChannelModerator service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Deletes the streaming configurations for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

    See

    AWSChimeSDKMessagingDeleteMessagingStreamingConfigurationsRequest

    Declaration

    Objective-C

    - (id)deleteMessagingStreamingConfigurations:
    (nonnull AWSChimeSDKMessagingDeleteMessagingStreamingConfigurationsRequest
         *)request;

    Swift

    func deleteStreamingConfigurations(_ request: AWSChimeSDKMessagingDeleteMessagingStreamingConfigurationsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteMessagingStreamingConfigurations service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Deletes the streaming configurations for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

    See

    AWSChimeSDKMessagingDeleteMessagingStreamingConfigurationsRequest

    Declaration

    Objective-C

    - (void)
    deleteMessagingStreamingConfigurations:
        (nonnull
             AWSChimeSDKMessagingDeleteMessagingStreamingConfigurationsRequest
                 *)request
                         completionHandler:
                             (void (^_Nullable)(NSError *_Nullable))
                                 completionHandler;

    Swift

    func deleteStreamingConfigurations(_ request: AWSChimeSDKMessagingDeleteMessagingStreamingConfigurationsRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteMessagingStreamingConfigurations service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Returns the full details of a channel in an Amazon Chime AppInstance.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDescribeChannelRequest

    See

    AWSChimeSDKMessagingDescribeChannelResponse

    Declaration

    Objective-C

    - (id)describeChannel:
    (nonnull AWSChimeSDKMessagingDescribeChannelRequest *)request;

    Swift

    func describeChannel(_ request: AWSChimeSDKMessagingDescribeChannelRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeChannel service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingDescribeChannelResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Returns the full details of a channel in an Amazon Chime AppInstance.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDescribeChannelRequest

    See

    AWSChimeSDKMessagingDescribeChannelResponse

    Declaration

    Objective-C

    - (void)describeChannel:
            (nonnull AWSChimeSDKMessagingDescribeChannelRequest *)request
      completionHandler:
          (void (^_Nullable)(
              AWSChimeSDKMessagingDescribeChannelResponse *_Nullable,
              NSError *_Nullable))completionHandler;

    Swift

    func describeChannel(_ request: AWSChimeSDKMessagingDescribeChannelRequest) async throws -> AWSChimeSDKMessagingDescribeChannelResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeChannel service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Returns the full details of a channel ban.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDescribeChannelBanRequest

    See

    AWSChimeSDKMessagingDescribeChannelBanResponse

    Declaration

    Objective-C

    - (id)describeChannelBan:
    (nonnull AWSChimeSDKMessagingDescribeChannelBanRequest *)request;

    Swift

    func describeChannelBan(_ request: AWSChimeSDKMessagingDescribeChannelBanRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeChannelBan service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingDescribeChannelBanResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorNotFound, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Returns the full details of a channel ban.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDescribeChannelBanRequest

    See

    AWSChimeSDKMessagingDescribeChannelBanResponse

    Declaration

    Objective-C

    - (void)describeChannelBan:
            (nonnull AWSChimeSDKMessagingDescribeChannelBanRequest *)request
         completionHandler:
             (void (^_Nullable)(
                 AWSChimeSDKMessagingDescribeChannelBanResponse *_Nullable,
                 NSError *_Nullable))completionHandler;

    Swift

    func describeChannelBan(_ request: AWSChimeSDKMessagingDescribeChannelBanRequest) async throws -> AWSChimeSDKMessagingDescribeChannelBanResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeChannelBan service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorNotFound, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.

    See

    AWSChimeSDKMessagingDescribeChannelFlowRequest

    See

    AWSChimeSDKMessagingDescribeChannelFlowResponse

    Declaration

    Objective-C

    - (id)describeChannelFlow:
    (nonnull AWSChimeSDKMessagingDescribeChannelFlowRequest *)request;

    Swift

    func describeChannelFlow(_ request: AWSChimeSDKMessagingDescribeChannelFlowRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeChannelFlow service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingDescribeChannelFlowResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.

    See

    AWSChimeSDKMessagingDescribeChannelFlowRequest

    See

    AWSChimeSDKMessagingDescribeChannelFlowResponse

    Declaration

    Objective-C

    - (void)describeChannelFlow:
            (nonnull AWSChimeSDKMessagingDescribeChannelFlowRequest *)request
          completionHandler:
              (void (^_Nullable)(
                  AWSChimeSDKMessagingDescribeChannelFlowResponse *_Nullable,
                  NSError *_Nullable))completionHandler;

    Swift

    func describeChannelFlow(_ request: AWSChimeSDKMessagingDescribeChannelFlowRequest) async throws -> AWSChimeSDKMessagingDescribeChannelFlowResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeChannelFlow service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Returns the full details of a user’s channel membership.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDescribeChannelMembershipRequest

    See

    AWSChimeSDKMessagingDescribeChannelMembershipResponse

    Declaration

    Objective-C

    - (id)describeChannelMembership:
    (nonnull AWSChimeSDKMessagingDescribeChannelMembershipRequest *)request;

    Swift

    func describeChannelMembership(_ request: AWSChimeSDKMessagingDescribeChannelMembershipRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeChannelMembership service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingDescribeChannelMembershipResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorNotFound, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Returns the full details of a user’s channel membership.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDescribeChannelMembershipRequest

    See

    AWSChimeSDKMessagingDescribeChannelMembershipResponse

    Declaration

    Objective-C

    - (void)describeChannelMembership:
            (nonnull AWSChimeSDKMessagingDescribeChannelMembershipRequest *)
                request
                completionHandler:
                    (void (^_Nullable)(
                        AWSChimeSDKMessagingDescribeChannelMembershipResponse
                            *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func describeChannelMembership(_ request: AWSChimeSDKMessagingDescribeChannelMembershipRequest) async throws -> AWSChimeSDKMessagingDescribeChannelMembershipResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeChannelMembership service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorNotFound, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Returns the details of a channel based on the membership of the specified AppInstanceUser or AppInstanceBot.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDescribeChannelMembershipForAppInstanceUserRequest

    See

    AWSChimeSDKMessagingDescribeChannelMembershipForAppInstanceUserResponse

    Declaration

    Objective-C

    - (id)describeChannelMembershipForAppInstanceUser:
    (nonnull
         AWSChimeSDKMessagingDescribeChannelMembershipForAppInstanceUserRequest
             *)request;

    Swift

    func describeChannelMembership(forAppInstanceUser request: AWSChimeSDKMessagingDescribeChannelMembershipForAppInstanceUserRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeChannelMembershipForAppInstanceUser service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingDescribeChannelMembershipForAppInstanceUserResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Returns the details of a channel based on the membership of the specified AppInstanceUser or AppInstanceBot.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDescribeChannelMembershipForAppInstanceUserRequest

    See

    AWSChimeSDKMessagingDescribeChannelMembershipForAppInstanceUserResponse

    Declaration

    Objective-C

    - (void)
    describeChannelMembershipForAppInstanceUser:
        (nonnull
             AWSChimeSDKMessagingDescribeChannelMembershipForAppInstanceUserRequest
                 *)request
                              completionHandler:
                                  (void (^_Nullable)(
                                      AWSChimeSDKMessagingDescribeChannelMembershipForAppInstanceUserResponse
                                          *_Nullable,
                                      NSError *_Nullable))completionHandler;

    Swift

    func describeChannelMembership(forAppInstanceUser request: AWSChimeSDKMessagingDescribeChannelMembershipForAppInstanceUserRequest) async throws -> AWSChimeSDKMessagingDescribeChannelMembershipForAppInstanceUserResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeChannelMembershipForAppInstanceUser service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Returns the full details of a channel moderated by the specified AppInstanceUser or AppInstanceBot.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDescribeChannelModeratedByAppInstanceUserRequest

    See

    AWSChimeSDKMessagingDescribeChannelModeratedByAppInstanceUserResponse

    Declaration

    Objective-C

    - (id)describeChannelModeratedByAppInstanceUser:
    (nonnull
         AWSChimeSDKMessagingDescribeChannelModeratedByAppInstanceUserRequest *)
        request;

    Swift

    func describeChannelModerated(byAppInstanceUser request: AWSChimeSDKMessagingDescribeChannelModeratedByAppInstanceUserRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeChannelModeratedByAppInstanceUser service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingDescribeChannelModeratedByAppInstanceUserResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Returns the full details of a channel moderated by the specified AppInstanceUser or AppInstanceBot.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDescribeChannelModeratedByAppInstanceUserRequest

    See

    AWSChimeSDKMessagingDescribeChannelModeratedByAppInstanceUserResponse

    Declaration

    Objective-C

    - (void)
    describeChannelModeratedByAppInstanceUser:
        (nonnull
             AWSChimeSDKMessagingDescribeChannelModeratedByAppInstanceUserRequest
                 *)request
                            completionHandler:
                                (void (^_Nullable)(
                                    AWSChimeSDKMessagingDescribeChannelModeratedByAppInstanceUserResponse
                                        *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func describeChannelModerated(byAppInstanceUser request: AWSChimeSDKMessagingDescribeChannelModeratedByAppInstanceUserRequest) async throws -> AWSChimeSDKMessagingDescribeChannelModeratedByAppInstanceUserResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeChannelModeratedByAppInstanceUser service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Returns the full details of a single ChannelModerator.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDescribeChannelModeratorRequest

    See

    AWSChimeSDKMessagingDescribeChannelModeratorResponse

    Declaration

    Objective-C

    - (id)describeChannelModerator:
    (nonnull AWSChimeSDKMessagingDescribeChannelModeratorRequest *)request;

    Swift

    func describeChannelModerator(_ request: AWSChimeSDKMessagingDescribeChannelModeratorRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeChannelModerator service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingDescribeChannelModeratorResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorNotFound, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Returns the full details of a single ChannelModerator.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDescribeChannelModeratorRequest

    See

    AWSChimeSDKMessagingDescribeChannelModeratorResponse

    Declaration

    Objective-C

    - (void)describeChannelModerator:
            (nonnull AWSChimeSDKMessagingDescribeChannelModeratorRequest *)
                request
               completionHandler:
                   (void (^_Nullable)(
                       AWSChimeSDKMessagingDescribeChannelModeratorResponse
                           *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func describeChannelModerator(_ request: AWSChimeSDKMessagingDescribeChannelModeratorRequest) async throws -> AWSChimeSDKMessagingDescribeChannelModeratorResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeChannelModerator service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorNotFound, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor.

    Only administrators or channel moderators can disassociate a channel flow.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDisassociateChannelFlowRequest

    Declaration

    Objective-C

    - (id)disassociateChannelFlow:
    (nonnull AWSChimeSDKMessagingDisassociateChannelFlowRequest *)request;

    Swift

    func disassociateChannelFlow(_ request: AWSChimeSDKMessagingDisassociateChannelFlowRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DisassociateChannelFlow service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorNotFound, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor.

    Only administrators or channel moderators can disassociate a channel flow.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingDisassociateChannelFlowRequest

    Declaration

    Objective-C

    - (void)disassociateChannelFlow:
            (nonnull AWSChimeSDKMessagingDisassociateChannelFlowRequest *)
                request
              completionHandler:
                  (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func disassociateChannelFlow(_ request: AWSChimeSDKMessagingDisassociateChannelFlowRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DisassociateChannelFlow service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorNotFound, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Gets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. A user or a bot must be a member of the channel and own the membership in order to retrieve membership preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can’t retrieve preferences for other users or bots. Banned users or bots can’t retrieve membership preferences for the channel from which they are banned.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingGetChannelMembershipPreferencesRequest

    See

    AWSChimeSDKMessagingGetChannelMembershipPreferencesResponse

    Declaration

    Objective-C

    - (id)getChannelMembershipPreferences:
    (nonnull AWSChimeSDKMessagingGetChannelMembershipPreferencesRequest *)
        request;

    Swift

    func getChannelMembershipPreferences(_ request: AWSChimeSDKMessagingGetChannelMembershipPreferencesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetChannelMembershipPreferences service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingGetChannelMembershipPreferencesResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Gets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. A user or a bot must be a member of the channel and own the membership in order to retrieve membership preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can’t retrieve preferences for other users or bots. Banned users or bots can’t retrieve membership preferences for the channel from which they are banned.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingGetChannelMembershipPreferencesRequest

    See

    AWSChimeSDKMessagingGetChannelMembershipPreferencesResponse

    Declaration

    Objective-C

    - (void)
    getChannelMembershipPreferences:
        (nonnull AWSChimeSDKMessagingGetChannelMembershipPreferencesRequest *)
            request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSChimeSDKMessagingGetChannelMembershipPreferencesResponse
                              *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func channelMembershipPreferences(_ request: AWSChimeSDKMessagingGetChannelMembershipPreferencesRequest) async throws -> AWSChimeSDKMessagingGetChannelMembershipPreferencesResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetChannelMembershipPreferences service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Gets the full details of a channel message.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingGetChannelMessageRequest

    See

    AWSChimeSDKMessagingGetChannelMessageResponse

    Declaration

    Objective-C

    - (id)getChannelMessage:
    (nonnull AWSChimeSDKMessagingGetChannelMessageRequest *)request;

    Swift

    func getChannelMessage(_ request: AWSChimeSDKMessagingGetChannelMessageRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetChannelMessage service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingGetChannelMessageResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorNotFound, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Gets the full details of a channel message.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingGetChannelMessageRequest

    See

    AWSChimeSDKMessagingGetChannelMessageResponse

    Declaration

    Objective-C

    - (void)getChannelMessage:
            (nonnull AWSChimeSDKMessagingGetChannelMessageRequest *)request
        completionHandler:
            (void (^_Nullable)(
                AWSChimeSDKMessagingGetChannelMessageResponse *_Nullable,
                NSError *_Nullable))completionHandler;

    Swift

    func channelMessage(_ request: AWSChimeSDKMessagingGetChannelMessageRequest) async throws -> AWSChimeSDKMessagingGetChannelMessageResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetChannelMessage service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorNotFound, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn’t connected to a websocket.

    Messages can have any one of these statuses.

    SENT

    Message processed successfully

    PENDING

    Ongoing processing

    FAILED

    Processing failed

    DENIED

    Message denied by the processor

    • This API does not return statuses for denied messages, because we don’t store them once the processor denies them.

    • Only the message sender can invoke this API.

    • The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingGetChannelMessageStatusRequest

    See

    AWSChimeSDKMessagingGetChannelMessageStatusResponse

    Declaration

    Objective-C

    - (id)getChannelMessageStatus:
    (nonnull AWSChimeSDKMessagingGetChannelMessageStatusRequest *)request;

    Swift

    func getChannelMessageStatus(_ request: AWSChimeSDKMessagingGetChannelMessageStatusRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetChannelMessageStatus service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingGetChannelMessageStatusResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn’t connected to a websocket.

    Messages can have any one of these statuses.

    SENT

    Message processed successfully

    PENDING

    Ongoing processing

    FAILED

    Processing failed

    DENIED

    Message denied by the processor

    • This API does not return statuses for denied messages, because we don’t store them once the processor denies them.

    • Only the message sender can invoke this API.

    • The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingGetChannelMessageStatusRequest

    See

    AWSChimeSDKMessagingGetChannelMessageStatusResponse

    Declaration

    Objective-C

    - (void)getChannelMessageStatus:
            (nonnull AWSChimeSDKMessagingGetChannelMessageStatusRequest *)
                request
              completionHandler:
                  (void (^_Nullable)(
                      AWSChimeSDKMessagingGetChannelMessageStatusResponse
                          *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func channelMessageStatus(_ request: AWSChimeSDKMessagingGetChannelMessageStatusRequest) async throws -> AWSChimeSDKMessagingGetChannelMessageStatusResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetChannelMessageStatus service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • The details of the endpoint for the messaging session.

    See

    AWSChimeSDKMessagingGetMessagingSessionEndpointRequest

    See

    AWSChimeSDKMessagingGetMessagingSessionEndpointResponse

    Declaration

    Objective-C

    - (id)getMessagingSessionEndpoint:
    (nonnull AWSChimeSDKMessagingGetMessagingSessionEndpointRequest *)request;

    Swift

    func getSessionEndpoint(_ request: AWSChimeSDKMessagingGetMessagingSessionEndpointRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetMessagingSessionEndpoint service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingGetMessagingSessionEndpointResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • The details of the endpoint for the messaging session.

    See

    AWSChimeSDKMessagingGetMessagingSessionEndpointRequest

    See

    AWSChimeSDKMessagingGetMessagingSessionEndpointResponse

    Declaration

    Objective-C

    - (void)
    getMessagingSessionEndpoint:
        (nonnull AWSChimeSDKMessagingGetMessagingSessionEndpointRequest *)
            request
              completionHandler:
                  (void (^_Nullable)(
                      AWSChimeSDKMessagingGetMessagingSessionEndpointResponse
                          *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func sessionEndpoint(_ request: AWSChimeSDKMessagingGetMessagingSessionEndpointRequest) async throws -> AWSChimeSDKMessagingGetMessagingSessionEndpointResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetMessagingSessionEndpoint service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Retrieves the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

    See

    AWSChimeSDKMessagingGetMessagingStreamingConfigurationsRequest

    See

    AWSChimeSDKMessagingGetMessagingStreamingConfigurationsResponse

    Declaration

    Objective-C

    - (id)getMessagingStreamingConfigurations:
    (nonnull AWSChimeSDKMessagingGetMessagingStreamingConfigurationsRequest *)
        request;

    Swift

    func getStreamingConfigurations(_ request: AWSChimeSDKMessagingGetMessagingStreamingConfigurationsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetMessagingStreamingConfigurations service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingGetMessagingStreamingConfigurationsResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorNotFound, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Retrieves the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

    See

    AWSChimeSDKMessagingGetMessagingStreamingConfigurationsRequest

    See

    AWSChimeSDKMessagingGetMessagingStreamingConfigurationsResponse

    Declaration

    Objective-C

    - (void)
    getMessagingStreamingConfigurations:
        (nonnull AWSChimeSDKMessagingGetMessagingStreamingConfigurationsRequest
             *)request
                      completionHandler:
                          (void (^_Nullable)(
                              AWSChimeSDKMessagingGetMessagingStreamingConfigurationsResponse
                                  *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func streamingConfigurations(_ request: AWSChimeSDKMessagingGetMessagingStreamingConfigurationsRequest) async throws -> AWSChimeSDKMessagingGetMessagingStreamingConfigurationsResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetMessagingStreamingConfigurations service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorNotFound, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Lists all the users and bots banned from a particular channel.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingListChannelBansRequest

    See

    AWSChimeSDKMessagingListChannelBansResponse

    Declaration

    Objective-C

    - (id)listChannelBans:
    (nonnull AWSChimeSDKMessagingListChannelBansRequest *)request;

    Swift

    func listChannelBans(_ request: AWSChimeSDKMessagingListChannelBansRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListChannelBans service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingListChannelBansResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Lists all the users and bots banned from a particular channel.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingListChannelBansRequest

    See

    AWSChimeSDKMessagingListChannelBansResponse

    Declaration

    Objective-C

    - (void)listChannelBans:
            (nonnull AWSChimeSDKMessagingListChannelBansRequest *)request
      completionHandler:
          (void (^_Nullable)(
              AWSChimeSDKMessagingListChannelBansResponse *_Nullable,
              NSError *_Nullable))completionHandler;

    Swift

    func listChannelBans(_ request: AWSChimeSDKMessagingListChannelBansRequest) async throws -> AWSChimeSDKMessagingListChannelBansResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListChannelBans service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.

    See

    AWSChimeSDKMessagingListChannelFlowsRequest

    See

    AWSChimeSDKMessagingListChannelFlowsResponse

    Declaration

    Objective-C

    - (id)listChannelFlows:
    (nonnull AWSChimeSDKMessagingListChannelFlowsRequest *)request;

    Swift

    func listChannelFlows(_ request: AWSChimeSDKMessagingListChannelFlowsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListChannelFlows service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingListChannelFlowsResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.

    See

    AWSChimeSDKMessagingListChannelFlowsRequest

    See

    AWSChimeSDKMessagingListChannelFlowsResponse

    Declaration

    Objective-C

    - (void)listChannelFlows:
            (nonnull AWSChimeSDKMessagingListChannelFlowsRequest *)request
       completionHandler:
           (void (^_Nullable)(
               AWSChimeSDKMessagingListChannelFlowsResponse *_Nullable,
               NSError *_Nullable))completionHandler;

    Swift

    func listChannelFlows(_ request: AWSChimeSDKMessagingListChannelFlowsRequest) async throws -> AWSChimeSDKMessagingListChannelFlowsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListChannelFlows service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Lists all channel memberships in a channel.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.

    See

    AWSChimeSDKMessagingListChannelMembershipsRequest

    See

    AWSChimeSDKMessagingListChannelMembershipsResponse

    Declaration

    Objective-C

    - (id)listChannelMemberships:
    (nonnull AWSChimeSDKMessagingListChannelMembershipsRequest *)request;

    Swift

    func listChannelMemberships(_ request: AWSChimeSDKMessagingListChannelMembershipsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListChannelMemberships service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingListChannelMembershipsResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Lists all channel memberships in a channel.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.

    See

    AWSChimeSDKMessagingListChannelMembershipsRequest

    See

    AWSChimeSDKMessagingListChannelMembershipsResponse

    Declaration

    Objective-C

    - (void)
    listChannelMemberships:
        (nonnull AWSChimeSDKMessagingListChannelMembershipsRequest *)request
         completionHandler:
             (void (^_Nullable)(
                 AWSChimeSDKMessagingListChannelMembershipsResponse *_Nullable,
                 NSError *_Nullable))completionHandler;

    Swift

    func listChannelMemberships(_ request: AWSChimeSDKMessagingListChannelMembershipsRequest) async throws -> AWSChimeSDKMessagingListChannelMembershipsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListChannelMemberships service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Lists all channels that an AppInstanceUser or AppInstanceBot is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingListChannelMembershipsForAppInstanceUserRequest

    See

    AWSChimeSDKMessagingListChannelMembershipsForAppInstanceUserResponse

    Declaration

    Objective-C

    - (id)listChannelMembershipsForAppInstanceUser:
    (nonnull AWSChimeSDKMessagingListChannelMembershipsForAppInstanceUserRequest
         *)request;

    Swift

    func listChannelMemberships(forAppInstanceUser request: AWSChimeSDKMessagingListChannelMembershipsForAppInstanceUserRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListChannelMembershipsForAppInstanceUser service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingListChannelMembershipsForAppInstanceUserResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Lists all channels that an AppInstanceUser or AppInstanceBot is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingListChannelMembershipsForAppInstanceUserRequest

    See

    AWSChimeSDKMessagingListChannelMembershipsForAppInstanceUserResponse

    Declaration

    Objective-C

    - (void)
    listChannelMembershipsForAppInstanceUser:
        (nonnull
             AWSChimeSDKMessagingListChannelMembershipsForAppInstanceUserRequest
                 *)request
                           completionHandler:
                               (void (^_Nullable)(
                                   AWSChimeSDKMessagingListChannelMembershipsForAppInstanceUserResponse
                                       *_Nullable,
                                   NSError *_Nullable))completionHandler;

    Swift

    func listChannelMemberships(forAppInstanceUser request: AWSChimeSDKMessagingListChannelMembershipsForAppInstanceUserRequest) async throws -> AWSChimeSDKMessagingListChannelMembershipsForAppInstanceUserResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListChannelMembershipsForAppInstanceUser service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order.

    Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.

    Also, the x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingListChannelMessagesRequest

    See

    AWSChimeSDKMessagingListChannelMessagesResponse

    Declaration

    Objective-C

    - (id)listChannelMessages:
    (nonnull AWSChimeSDKMessagingListChannelMessagesRequest *)request;

    Swift

    func listChannelMessages(_ request: AWSChimeSDKMessagingListChannelMessagesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListChannelMessages service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingListChannelMessagesResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order.

    Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.

    Also, the x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingListChannelMessagesRequest

    See

    AWSChimeSDKMessagingListChannelMessagesResponse

    Declaration

    Objective-C

    - (void)listChannelMessages:
            (nonnull AWSChimeSDKMessagingListChannelMessagesRequest *)request
          completionHandler:
              (void (^_Nullable)(
                  AWSChimeSDKMessagingListChannelMessagesResponse *_Nullable,
                  NSError *_Nullable))completionHandler;

    Swift

    func listChannelMessages(_ request: AWSChimeSDKMessagingListChannelMessagesRequest) async throws -> AWSChimeSDKMessagingListChannelMessagesResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListChannelMessages service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Lists all the moderators for a channel.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingListChannelModeratorsRequest

    See

    AWSChimeSDKMessagingListChannelModeratorsResponse

    Declaration

    Objective-C

    - (id)listChannelModerators:
    (nonnull AWSChimeSDKMessagingListChannelModeratorsRequest *)request;

    Swift

    func listChannelModerators(_ request: AWSChimeSDKMessagingListChannelModeratorsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListChannelModerators service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingListChannelModeratorsResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Lists all the moderators for a channel.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingListChannelModeratorsRequest

    See

    AWSChimeSDKMessagingListChannelModeratorsResponse

    Declaration

    Objective-C

    - (void)
    listChannelModerators:
        (nonnull AWSChimeSDKMessagingListChannelModeratorsRequest *)request
        completionHandler:
            (void (^_Nullable)(
                AWSChimeSDKMessagingListChannelModeratorsResponse *_Nullable,
                NSError *_Nullable))completionHandler;

    Swift

    func listChannelModerators(_ request: AWSChimeSDKMessagingListChannelModeratorsRequest) async throws -> AWSChimeSDKMessagingListChannelModeratorsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListChannelModerators service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.

    Functionality & restrictions

    • Use privacy = PUBLIC to retrieve all public channels in the account.

    • Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingListChannelsRequest

    See

    AWSChimeSDKMessagingListChannelsResponse

    Declaration

    Objective-C

    - (id)listChannels:(nonnull AWSChimeSDKMessagingListChannelsRequest *)request;

    Swift

    func listChannels(_ request: AWSChimeSDKMessagingListChannelsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListChannels service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingListChannelsResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.

    Functionality & restrictions

    • Use privacy = PUBLIC to retrieve all public channels in the account.

    • Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingListChannelsRequest

    See

    AWSChimeSDKMessagingListChannelsResponse

    Declaration

    Objective-C

    - (void)listChannels:(nonnull AWSChimeSDKMessagingListChannelsRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSChimeSDKMessagingListChannelsResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func listChannels(_ request: AWSChimeSDKMessagingListChannelsRequest) async throws -> AWSChimeSDKMessagingListChannelsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListChannels service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.

    See

    AWSChimeSDKMessagingListChannelsAssociatedWithChannelFlowRequest

    See

    AWSChimeSDKMessagingListChannelsAssociatedWithChannelFlowResponse

    Declaration

    Objective-C

    - (id)listChannelsAssociatedWithChannelFlow:
    (nonnull AWSChimeSDKMessagingListChannelsAssociatedWithChannelFlowRequest *)
        request;

    Swift

    func listChannelsAssociated(withChannelFlow request: AWSChimeSDKMessagingListChannelsAssociatedWithChannelFlowRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListChannelsAssociatedWithChannelFlow service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingListChannelsAssociatedWithChannelFlowResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.

    See

    AWSChimeSDKMessagingListChannelsAssociatedWithChannelFlowRequest

    See

    AWSChimeSDKMessagingListChannelsAssociatedWithChannelFlowResponse

    Declaration

    Objective-C

    - (void)
    listChannelsAssociatedWithChannelFlow:
        (nonnull
             AWSChimeSDKMessagingListChannelsAssociatedWithChannelFlowRequest *)
            request
                        completionHandler:
                            (void (^_Nullable)(
                                AWSChimeSDKMessagingListChannelsAssociatedWithChannelFlowResponse
                                    *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func listChannelsAssociated(withChannelFlow request: AWSChimeSDKMessagingListChannelsAssociatedWithChannelFlowRequest) async throws -> AWSChimeSDKMessagingListChannelsAssociatedWithChannelFlowResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListChannelsAssociatedWithChannelFlow service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • A list of the channels moderated by an AppInstanceUser.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingListChannelsModeratedByAppInstanceUserRequest

    See

    AWSChimeSDKMessagingListChannelsModeratedByAppInstanceUserResponse

    Declaration

    Objective-C

    - (id)listChannelsModeratedByAppInstanceUser:
    (nonnull AWSChimeSDKMessagingListChannelsModeratedByAppInstanceUserRequest
         *)request;

    Swift

    func listChannelsModerated(byAppInstanceUser request: AWSChimeSDKMessagingListChannelsModeratedByAppInstanceUserRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListChannelsModeratedByAppInstanceUser service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingListChannelsModeratedByAppInstanceUserResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • A list of the channels moderated by an AppInstanceUser.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingListChannelsModeratedByAppInstanceUserRequest

    See

    AWSChimeSDKMessagingListChannelsModeratedByAppInstanceUserResponse

    Declaration

    Objective-C

    - (void)
    listChannelsModeratedByAppInstanceUser:
        (nonnull
             AWSChimeSDKMessagingListChannelsModeratedByAppInstanceUserRequest
                 *)request
                         completionHandler:
                             (void (^_Nullable)(
                                 AWSChimeSDKMessagingListChannelsModeratedByAppInstanceUserResponse
                                     *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func listChannelsModerated(byAppInstanceUser request: AWSChimeSDKMessagingListChannelsModeratedByAppInstanceUserRequest) async throws -> AWSChimeSDKMessagingListChannelsModeratedByAppInstanceUserResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListChannelsModeratedByAppInstanceUser service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.

    See

    AWSChimeSDKMessagingListSubChannelsRequest

    See

    AWSChimeSDKMessagingListSubChannelsResponse

    Declaration

    Objective-C

    - (id)listSubChannels:
    (nonnull AWSChimeSDKMessagingListSubChannelsRequest *)request;

    Swift

    func listSubChannels(_ request: AWSChimeSDKMessagingListSubChannelsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListSubChannels service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingListSubChannelsResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.

    See

    AWSChimeSDKMessagingListSubChannelsRequest

    See

    AWSChimeSDKMessagingListSubChannelsResponse

    Declaration

    Objective-C

    - (void)listSubChannels:
            (nonnull AWSChimeSDKMessagingListSubChannelsRequest *)request
      completionHandler:
          (void (^_Nullable)(
              AWSChimeSDKMessagingListSubChannelsResponse *_Nullable,
              NSError *_Nullable))completionHandler;

    Swift

    func listSubChannels(_ request: AWSChimeSDKMessagingListSubChannelsRequest) async throws -> AWSChimeSDKMessagingListSubChannelsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListSubChannels service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Lists the tags applied to an Amazon Chime SDK messaging resource.

    See

    AWSChimeSDKMessagingListTagsForResourceRequest

    See

    AWSChimeSDKMessagingListTagsForResourceResponse

    Declaration

    Objective-C

    - (id)listTagsForResource:
    (nonnull AWSChimeSDKMessagingListTagsForResourceRequest *)request;

    Swift

    func listTags(forResource request: AWSChimeSDKMessagingListTagsForResourceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListTagsForResource service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingListTagsForResourceResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Lists the tags applied to an Amazon Chime SDK messaging resource.

    See

    AWSChimeSDKMessagingListTagsForResourceRequest

    See

    AWSChimeSDKMessagingListTagsForResourceResponse

    Declaration

    Objective-C

    - (void)listTagsForResource:
            (nonnull AWSChimeSDKMessagingListTagsForResourceRequest *)request
          completionHandler:
              (void (^_Nullable)(
                  AWSChimeSDKMessagingListTagsForResourceResponse *_Nullable,
                  NSError *_Nullable))completionHandler;

    Swift

    func listTags(forResource request: AWSChimeSDKMessagingListTagsForResourceRequest) async throws -> AWSChimeSDKMessagingListTagsForResourceResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListTagsForResource service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Sets the number of days before the channel is automatically deleted.

    • A background process deletes expired channels within 6 hours of expiration. Actual deletion times may vary.

    • Expired channels that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.

    • The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingPutChannelExpirationSettingsRequest

    See

    AWSChimeSDKMessagingPutChannelExpirationSettingsResponse

    Declaration

    Objective-C

    - (id)putChannelExpirationSettings:
    (nonnull AWSChimeSDKMessagingPutChannelExpirationSettingsRequest *)request;

    Swift

    func putChannelExpirationSettings(_ request: AWSChimeSDKMessagingPutChannelExpirationSettingsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the PutChannelExpirationSettings service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingPutChannelExpirationSettingsResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Sets the number of days before the channel is automatically deleted.

    • A background process deletes expired channels within 6 hours of expiration. Actual deletion times may vary.

    • Expired channels that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.

    • The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingPutChannelExpirationSettingsRequest

    See

    AWSChimeSDKMessagingPutChannelExpirationSettingsResponse

    Declaration

    Objective-C

    - (void)
    putChannelExpirationSettings:
        (nonnull AWSChimeSDKMessagingPutChannelExpirationSettingsRequest *)
            request
               completionHandler:
                   (void (^_Nullable)(
                       AWSChimeSDKMessagingPutChannelExpirationSettingsResponse
                           *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func putChannelExpirationSettings(_ request: AWSChimeSDKMessagingPutChannelExpirationSettingsRequest) async throws -> AWSChimeSDKMessagingPutChannelExpirationSettingsResponse

    Parameters

    request

    A container for the necessary parameters to execute the PutChannelExpirationSettings service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Sets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the membership can set preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can’t set preferences for other users. Banned users or bots can’t set membership preferences for the channel from which they are banned.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of an AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingPutChannelMembershipPreferencesRequest

    See

    AWSChimeSDKMessagingPutChannelMembershipPreferencesResponse

    Declaration

    Objective-C

    - (id)putChannelMembershipPreferences:
    (nonnull AWSChimeSDKMessagingPutChannelMembershipPreferencesRequest *)
        request;

    Swift

    func putChannelMembershipPreferences(_ request: AWSChimeSDKMessagingPutChannelMembershipPreferencesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the PutChannelMembershipPreferences service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingPutChannelMembershipPreferencesResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Sets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the membership can set preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can’t set preferences for other users. Banned users or bots can’t set membership preferences for the channel from which they are banned.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of an AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingPutChannelMembershipPreferencesRequest

    See

    AWSChimeSDKMessagingPutChannelMembershipPreferencesResponse

    Declaration

    Objective-C

    - (void)
    putChannelMembershipPreferences:
        (nonnull AWSChimeSDKMessagingPutChannelMembershipPreferencesRequest *)
            request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSChimeSDKMessagingPutChannelMembershipPreferencesResponse
                              *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func putChannelMembershipPreferences(_ request: AWSChimeSDKMessagingPutChannelMembershipPreferencesRequest) async throws -> AWSChimeSDKMessagingPutChannelMembershipPreferencesResponse

    Parameters

    request

    A container for the necessary parameters to execute the PutChannelMembershipPreferences service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Sets the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

    See

    AWSChimeSDKMessagingPutMessagingStreamingConfigurationsRequest

    See

    AWSChimeSDKMessagingPutMessagingStreamingConfigurationsResponse

    Declaration

    Objective-C

    - (id)putMessagingStreamingConfigurations:
    (nonnull AWSChimeSDKMessagingPutMessagingStreamingConfigurationsRequest *)
        request;

    Swift

    func putStreamingConfigurations(_ request: AWSChimeSDKMessagingPutMessagingStreamingConfigurationsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the PutMessagingStreamingConfigurations service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingPutMessagingStreamingConfigurationsResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorNotFound, AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Sets the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

    See

    AWSChimeSDKMessagingPutMessagingStreamingConfigurationsRequest

    See

    AWSChimeSDKMessagingPutMessagingStreamingConfigurationsResponse

    Declaration

    Objective-C

    - (void)
    putMessagingStreamingConfigurations:
        (nonnull AWSChimeSDKMessagingPutMessagingStreamingConfigurationsRequest
             *)request
                      completionHandler:
                          (void (^_Nullable)(
                              AWSChimeSDKMessagingPutMessagingStreamingConfigurationsResponse
                                  *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func putStreamingConfigurations(_ request: AWSChimeSDKMessagingPutMessagingStreamingConfigurationsRequest) async throws -> AWSChimeSDKMessagingPutMessagingStreamingConfigurationsResponse

    Parameters

    request

    A container for the necessary parameters to execute the PutMessagingStreamingConfigurations service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorNotFound, AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingRedactChannelMessageRequest

    See

    AWSChimeSDKMessagingRedactChannelMessageResponse

    Declaration

    Objective-C

    - (id)redactChannelMessage:
    (nonnull AWSChimeSDKMessagingRedactChannelMessageRequest *)request;

    Swift

    func redactChannelMessage(_ request: AWSChimeSDKMessagingRedactChannelMessageRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the RedactChannelMessage service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingRedactChannelMessageResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingRedactChannelMessageRequest

    See

    AWSChimeSDKMessagingRedactChannelMessageResponse

    Declaration

    Objective-C

    - (void)redactChannelMessage:
            (nonnull AWSChimeSDKMessagingRedactChannelMessageRequest *)request
           completionHandler:
               (void (^_Nullable)(
                   AWSChimeSDKMessagingRedactChannelMessageResponse *_Nullable,
                   NSError *_Nullable))completionHandler;

    Swift

    func redactChannelMessage(_ request: AWSChimeSDKMessagingRedactChannelMessageRequest) async throws -> AWSChimeSDKMessagingRedactChannelMessageResponse

    Parameters

    request

    A container for the necessary parameters to execute the RedactChannelMessage service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Allows the ChimeBearer to search channels by channel members. Users or bots can search across the channels that they belong to. Users in the AppInstanceAdmin role can search across all channels.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingSearchChannelsRequest

    See

    AWSChimeSDKMessagingSearchChannelsResponse

    Declaration

    Objective-C

    - (id)searchChannels:
    (nonnull AWSChimeSDKMessagingSearchChannelsRequest *)request;

    Swift

    func searchChannels(_ request: AWSChimeSDKMessagingSearchChannelsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the SearchChannels service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingSearchChannelsResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Allows the ChimeBearer to search channels by channel members. Users or bots can search across the channels that they belong to. Users in the AppInstanceAdmin role can search across all channels.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingSearchChannelsRequest

    See

    AWSChimeSDKMessagingSearchChannelsResponse

    Declaration

    Objective-C

    - (void)searchChannels:
            (nonnull AWSChimeSDKMessagingSearchChannelsRequest *)request
     completionHandler:
         (void (^_Nullable)(
             AWSChimeSDKMessagingSearchChannelsResponse *_Nullable,
             NSError *_Nullable))completionHandler;

    Swift

    func searchChannels(_ request: AWSChimeSDKMessagingSearchChannelsRequest) async throws -> AWSChimeSDKMessagingSearchChannelsResponse

    Parameters

    request

    A container for the necessary parameters to execute the SearchChannels service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Sends a message to a particular channel that the member is a part of.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    Also, 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.

    See

    AWSChimeSDKMessagingSendChannelMessageRequest

    See

    AWSChimeSDKMessagingSendChannelMessageResponse

    Declaration

    Objective-C

    - (id)sendChannelMessage:
    (nonnull AWSChimeSDKMessagingSendChannelMessageRequest *)request;

    Swift

    func sendChannelMessage(_ request: AWSChimeSDKMessagingSendChannelMessageRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the SendChannelMessage service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingSendChannelMessageResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Sends a message to a particular channel that the member is a part of.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    Also, 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.

    See

    AWSChimeSDKMessagingSendChannelMessageRequest

    See

    AWSChimeSDKMessagingSendChannelMessageResponse

    Declaration

    Objective-C

    - (void)sendChannelMessage:
            (nonnull AWSChimeSDKMessagingSendChannelMessageRequest *)request
         completionHandler:
             (void (^_Nullable)(
                 AWSChimeSDKMessagingSendChannelMessageResponse *_Nullable,
                 NSError *_Nullable))completionHandler;

    Swift

    func sendChannelMessage(_ request: AWSChimeSDKMessagingSendChannelMessageRequest) async throws -> AWSChimeSDKMessagingSendChannelMessageResponse

    Parameters

    request

    A container for the necessary parameters to execute the SendChannelMessage service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Applies the specified tags to the specified Amazon Chime SDK messaging resource.

    See

    AWSChimeSDKMessagingTagResourceRequest

    Declaration

    Objective-C

    - (id)tagResource:(nonnull AWSChimeSDKMessagingTagResourceRequest *)request;

    Swift

    func tagResource(_ request: AWSChimeSDKMessagingTagResourceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the TagResource service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorResourceLimitExceeded, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Applies the specified tags to the specified Amazon Chime SDK messaging resource.

    See

    AWSChimeSDKMessagingTagResourceRequest

    Declaration

    Objective-C

    - (void)tagResource:(nonnull AWSChimeSDKMessagingTagResourceRequest *)request
    completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func tagResource(_ request: AWSChimeSDKMessagingTagResourceRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the TagResource service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorResourceLimitExceeded, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Removes the specified tags from the specified Amazon Chime SDK messaging resource.

    See

    AWSChimeSDKMessagingUntagResourceRequest

    Declaration

    Objective-C

    - (id)untagResource:(nonnull AWSChimeSDKMessagingUntagResourceRequest *)request;

    Swift

    func untagResource(_ request: AWSChimeSDKMessagingUntagResourceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UntagResource service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Removes the specified tags from the specified Amazon Chime SDK messaging resource.

    See

    AWSChimeSDKMessagingUntagResourceRequest

    Declaration

    Objective-C

    - (void)untagResource:
            (nonnull AWSChimeSDKMessagingUntagResourceRequest *)request
    completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func untagResource(_ request: AWSChimeSDKMessagingUntagResourceRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UntagResource service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Update a channel’s attributes.

    Restriction: You can’t change a channel’s privacy.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingUpdateChannelRequest

    See

    AWSChimeSDKMessagingUpdateChannelResponse

    Declaration

    Objective-C

    - (id)updateChannel:(nonnull AWSChimeSDKMessagingUpdateChannelRequest *)request;

    Swift

    func updateChannel(_ request: AWSChimeSDKMessagingUpdateChannelRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateChannel service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingUpdateChannelResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Update a channel’s attributes.

    Restriction: You can’t change a channel’s privacy.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingUpdateChannelRequest

    See

    AWSChimeSDKMessagingUpdateChannelResponse

    Declaration

    Objective-C

    - (void)updateChannel:
            (nonnull AWSChimeSDKMessagingUpdateChannelRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSChimeSDKMessagingUpdateChannelResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func updateChannel(_ request: AWSChimeSDKMessagingUpdateChannelRequest) async throws -> AWSChimeSDKMessagingUpdateChannelResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdateChannel service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Updates channel flow attributes. This is a developer API.

    See

    AWSChimeSDKMessagingUpdateChannelFlowRequest

    See

    AWSChimeSDKMessagingUpdateChannelFlowResponse

    Declaration

    Objective-C

    - (id)updateChannelFlow:
    (nonnull AWSChimeSDKMessagingUpdateChannelFlowRequest *)request;

    Swift

    func updateChannelFlow(_ request: AWSChimeSDKMessagingUpdateChannelFlowRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateChannelFlow service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingUpdateChannelFlowResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Updates channel flow attributes. This is a developer API.

    See

    AWSChimeSDKMessagingUpdateChannelFlowRequest

    See

    AWSChimeSDKMessagingUpdateChannelFlowResponse

    Declaration

    Objective-C

    - (void)updateChannelFlow:
            (nonnull AWSChimeSDKMessagingUpdateChannelFlowRequest *)request
        completionHandler:
            (void (^_Nullable)(
                AWSChimeSDKMessagingUpdateChannelFlowResponse *_Nullable,
                NSError *_Nullable))completionHandler;

    Swift

    func updateChannelFlow(_ request: AWSChimeSDKMessagingUpdateChannelFlowRequest) async throws -> AWSChimeSDKMessagingUpdateChannelFlowResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdateChannelFlow service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Updates the content of a message.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingUpdateChannelMessageRequest

    See

    AWSChimeSDKMessagingUpdateChannelMessageResponse

    Declaration

    Objective-C

    - (id)updateChannelMessage:
    (nonnull AWSChimeSDKMessagingUpdateChannelMessageRequest *)request;

    Swift

    func updateChannelMessage(_ request: AWSChimeSDKMessagingUpdateChannelMessageRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateChannelMessage service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingUpdateChannelMessageResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • Updates the content of a message.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingUpdateChannelMessageRequest

    See

    AWSChimeSDKMessagingUpdateChannelMessageResponse

    Declaration

    Objective-C

    - (void)updateChannelMessage:
            (nonnull AWSChimeSDKMessagingUpdateChannelMessageRequest *)request
           completionHandler:
               (void (^_Nullable)(
                   AWSChimeSDKMessagingUpdateChannelMessageResponse *_Nullable,
                   NSError *_Nullable))completionHandler;

    Swift

    func updateChannelMessage(_ request: AWSChimeSDKMessagingUpdateChannelMessageRequest) async throws -> AWSChimeSDKMessagingUpdateChannelMessageResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdateChannelMessage service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • The details of the time when a user last read messages in a channel.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingUpdateChannelReadMarkerRequest

    See

    AWSChimeSDKMessagingUpdateChannelReadMarkerResponse

    Declaration

    Objective-C

    - (id)updateChannelReadMarker:
    (nonnull AWSChimeSDKMessagingUpdateChannelReadMarkerRequest *)request;

    Swift

    func updateChannelReadMarker(_ request: AWSChimeSDKMessagingUpdateChannelReadMarkerRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateChannelReadMarker service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKMessagingUpdateChannelReadMarkerResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.

  • The details of the time when a user last read messages in a channel.

    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

    See

    AWSChimeSDKMessagingUpdateChannelReadMarkerRequest

    See

    AWSChimeSDKMessagingUpdateChannelReadMarkerResponse

    Declaration

    Objective-C

    - (void)updateChannelReadMarker:
            (nonnull AWSChimeSDKMessagingUpdateChannelReadMarkerRequest *)
                request
              completionHandler:
                  (void (^_Nullable)(
                      AWSChimeSDKMessagingUpdateChannelReadMarkerResponse
                          *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func updateChannelReadMarker(_ request: AWSChimeSDKMessagingUpdateChannelReadMarkerRequest) async throws -> AWSChimeSDKMessagingUpdateChannelReadMarkerResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdateChannelReadMarker service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKMessagingErrorDomain domain and the following error code: AWSChimeSDKMessagingErrorBadRequest, AWSChimeSDKMessagingErrorForbidden, AWSChimeSDKMessagingErrorConflict, AWSChimeSDKMessagingErrorUnauthorizedClient, AWSChimeSDKMessagingErrorThrottledClient, AWSChimeSDKMessagingErrorServiceUnavailable, AWSChimeSDKMessagingErrorServiceFailure.