@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonChimeSDKMessagingAsync extends AmazonChimeSDKMessaging
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonChimeSDKMessagingAsync instead.
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
ENDPOINT_PREFIXassociateChannelFlow, batchCreateChannelMembership, channelFlowCallback, createChannel, createChannelBan, createChannelFlow, createChannelMembership, createChannelModerator, deleteChannel, deleteChannelBan, deleteChannelFlow, deleteChannelMembership, deleteChannelMessage, deleteChannelModerator, describeChannel, describeChannelBan, describeChannelFlow, describeChannelMembership, describeChannelMembershipForAppInstanceUser, describeChannelModeratedByAppInstanceUser, describeChannelModerator, disassociateChannelFlow, getCachedResponseMetadata, getChannelMembershipPreferences, getChannelMessage, getChannelMessageStatus, getMessagingSessionEndpoint, listChannelBans, listChannelFlows, listChannelMemberships, listChannelMembershipsForAppInstanceUser, listChannelMessages, listChannelModerators, listChannels, listChannelsAssociatedWithChannelFlow, listChannelsModeratedByAppInstanceUser, listTagsForResource, putChannelMembershipPreferences, redactChannelMessage, sendChannelMessage, shutdown, tagResource, untagResource, updateChannel, updateChannelFlow, updateChannelMessage, updateChannelReadMarkerFuture<AssociateChannelFlowResult> associateChannelFlowAsync(AssociateChannelFlowRequest associateChannelFlowRequest)
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 AppInstanceUserArn of the user that makes the API call as the
value in the header.
associateChannelFlowRequest - Future<AssociateChannelFlowResult> associateChannelFlowAsync(AssociateChannelFlowRequest associateChannelFlowRequest, AsyncHandler<AssociateChannelFlowRequest,AssociateChannelFlowResult> asyncHandler)
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 AppInstanceUserArn of the user that makes the API call as the
value in the header.
associateChannelFlowRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchCreateChannelMembershipResult> batchCreateChannelMembershipAsync(BatchCreateChannelMembershipRequest batchCreateChannelMembershipRequest)
Adds a specified number of users to a channel.
batchCreateChannelMembershipRequest - Future<BatchCreateChannelMembershipResult> batchCreateChannelMembershipAsync(BatchCreateChannelMembershipRequest batchCreateChannelMembershipRequest, AsyncHandler<BatchCreateChannelMembershipRequest,BatchCreateChannelMembershipResult> asyncHandler)
Adds a specified number of users to a channel.
batchCreateChannelMembershipRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ChannelFlowCallbackResult> channelFlowCallbackAsync(ChannelFlowCallbackRequest channelFlowCallbackRequest)
Calls back 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
channelFlowCallbackRequest - Future<ChannelFlowCallbackResult> channelFlowCallbackAsync(ChannelFlowCallbackRequest channelFlowCallbackRequest, AsyncHandler<ChannelFlowCallbackRequest,ChannelFlowCallbackResult> asyncHandler)
Calls back 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
channelFlowCallbackRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateChannelResult> createChannelAsync(CreateChannelRequest createChannelRequest)
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
createChannelRequest - Future<CreateChannelResult> createChannelAsync(CreateChannelRequest createChannelRequest, AsyncHandler<CreateChannelRequest,CreateChannelResult> asyncHandler)
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
createChannelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateChannelBanResult> createChannelBanAsync(CreateChannelBanRequest createChannelBanRequest)
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
createChannelBanRequest - Future<CreateChannelBanResult> createChannelBanAsync(CreateChannelBanRequest createChannelBanRequest, AsyncHandler<CreateChannelBanRequest,CreateChannelBanResult> asyncHandler)
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
createChannelBanRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateChannelFlowResult> createChannelFlowAsync(CreateChannelFlowRequest createChannelFlowRequest)
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:
New and updated messages
Persistent and non-persistent messages
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.
createChannelFlowRequest - Future<CreateChannelFlowResult> createChannelFlowAsync(CreateChannelFlowRequest createChannelFlowRequest, AsyncHandler<CreateChannelFlowRequest,CreateChannelFlowResult> asyncHandler)
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:
New and updated messages
Persistent and non-persistent messages
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.
createChannelFlowRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateChannelMembershipResult> createChannelMembershipAsync(CreateChannelMembershipRequest createChannelMembershipRequest)
Adds a user 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
createChannelMembershipRequest - Future<CreateChannelMembershipResult> createChannelMembershipAsync(CreateChannelMembershipRequest createChannelMembershipRequest, AsyncHandler<CreateChannelMembershipRequest,CreateChannelMembershipResult> asyncHandler)
Adds a user 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
createChannelMembershipRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateChannelModeratorResult> createChannelModeratorAsync(CreateChannelModeratorRequest createChannelModeratorRequest)
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
createChannelModeratorRequest - Future<CreateChannelModeratorResult> createChannelModeratorAsync(CreateChannelModeratorRequest createChannelModeratorRequest, AsyncHandler<CreateChannelModeratorRequest,CreateChannelModeratorResult> asyncHandler)
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
createChannelModeratorRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteChannelResult> deleteChannelAsync(DeleteChannelRequest deleteChannelRequest)
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
deleteChannelRequest - Future<DeleteChannelResult> deleteChannelAsync(DeleteChannelRequest deleteChannelRequest, AsyncHandler<DeleteChannelRequest,DeleteChannelResult> asyncHandler)
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
deleteChannelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteChannelBanResult> deleteChannelBanAsync(DeleteChannelBanRequest deleteChannelBanRequest)
Removes a user from a channel's ban list.
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.
deleteChannelBanRequest - Future<DeleteChannelBanResult> deleteChannelBanAsync(DeleteChannelBanRequest deleteChannelBanRequest, AsyncHandler<DeleteChannelBanRequest,DeleteChannelBanResult> asyncHandler)
Removes a user from a channel's ban list.
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.
deleteChannelBanRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteChannelFlowResult> deleteChannelFlowAsync(DeleteChannelFlowRequest deleteChannelFlowRequest)
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.
deleteChannelFlowRequest - Future<DeleteChannelFlowResult> deleteChannelFlowAsync(DeleteChannelFlowRequest deleteChannelFlowRequest, AsyncHandler<DeleteChannelFlowRequest,DeleteChannelFlowResult> asyncHandler)
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.
deleteChannelFlowRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteChannelMembershipResult> deleteChannelMembershipAsync(DeleteChannelMembershipRequest deleteChannelMembershipRequest)
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.
deleteChannelMembershipRequest - Future<DeleteChannelMembershipResult> deleteChannelMembershipAsync(DeleteChannelMembershipRequest deleteChannelMembershipRequest, AsyncHandler<DeleteChannelMembershipRequest,DeleteChannelMembershipResult> asyncHandler)
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.
deleteChannelMembershipRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteChannelMessageResult> deleteChannelMessageAsync(DeleteChannelMessageRequest deleteChannelMessageRequest)
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
deleteChannelMessageRequest - Future<DeleteChannelMessageResult> deleteChannelMessageAsync(DeleteChannelMessageRequest deleteChannelMessageRequest, AsyncHandler<DeleteChannelMessageRequest,DeleteChannelMessageResult> asyncHandler)
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
deleteChannelMessageRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteChannelModeratorResult> deleteChannelModeratorAsync(DeleteChannelModeratorRequest deleteChannelModeratorRequest)
Deletes a channel moderator.
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.
deleteChannelModeratorRequest - Future<DeleteChannelModeratorResult> deleteChannelModeratorAsync(DeleteChannelModeratorRequest deleteChannelModeratorRequest, AsyncHandler<DeleteChannelModeratorRequest,DeleteChannelModeratorResult> asyncHandler)
Deletes a channel moderator.
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.
deleteChannelModeratorRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeChannelResult> describeChannelAsync(DescribeChannelRequest describeChannelRequest)
Returns the full details of a channel in an Amazon Chime AppInstance.
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.
describeChannelRequest - Future<DescribeChannelResult> describeChannelAsync(DescribeChannelRequest describeChannelRequest, AsyncHandler<DescribeChannelRequest,DescribeChannelResult> asyncHandler)
Returns the full details of a channel in an Amazon Chime AppInstance.
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.
describeChannelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeChannelBanResult> describeChannelBanAsync(DescribeChannelBanRequest describeChannelBanRequest)
Returns the full details of a channel ban.
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.
describeChannelBanRequest - Future<DescribeChannelBanResult> describeChannelBanAsync(DescribeChannelBanRequest describeChannelBanRequest, AsyncHandler<DescribeChannelBanRequest,DescribeChannelBanResult> asyncHandler)
Returns the full details of a channel ban.
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.
describeChannelBanRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeChannelFlowResult> describeChannelFlowAsync(DescribeChannelFlowRequest describeChannelFlowRequest)
Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.
describeChannelFlowRequest - Future<DescribeChannelFlowResult> describeChannelFlowAsync(DescribeChannelFlowRequest describeChannelFlowRequest, AsyncHandler<DescribeChannelFlowRequest,DescribeChannelFlowResult> asyncHandler)
Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.
describeChannelFlowRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeChannelMembershipResult> describeChannelMembershipAsync(DescribeChannelMembershipRequest describeChannelMembershipRequest)
Returns the full details of a user's channel membership.
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.
describeChannelMembershipRequest - Future<DescribeChannelMembershipResult> describeChannelMembershipAsync(DescribeChannelMembershipRequest describeChannelMembershipRequest, AsyncHandler<DescribeChannelMembershipRequest,DescribeChannelMembershipResult> asyncHandler)
Returns the full details of a user's channel membership.
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.
describeChannelMembershipRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeChannelMembershipForAppInstanceUserResult> describeChannelMembershipForAppInstanceUserAsync(DescribeChannelMembershipForAppInstanceUserRequest describeChannelMembershipForAppInstanceUserRequest)
Returns the details of a channel based on the membership of the specified AppInstanceUser.
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.
describeChannelMembershipForAppInstanceUserRequest - Future<DescribeChannelMembershipForAppInstanceUserResult> describeChannelMembershipForAppInstanceUserAsync(DescribeChannelMembershipForAppInstanceUserRequest describeChannelMembershipForAppInstanceUserRequest, AsyncHandler<DescribeChannelMembershipForAppInstanceUserRequest,DescribeChannelMembershipForAppInstanceUserResult> asyncHandler)
Returns the details of a channel based on the membership of the specified AppInstanceUser.
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.
describeChannelMembershipForAppInstanceUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeChannelModeratedByAppInstanceUserResult> describeChannelModeratedByAppInstanceUserAsync(DescribeChannelModeratedByAppInstanceUserRequest describeChannelModeratedByAppInstanceUserRequest)
Returns the full details of a channel moderated by the specified AppInstanceUser.
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.
describeChannelModeratedByAppInstanceUserRequest - Future<DescribeChannelModeratedByAppInstanceUserResult> describeChannelModeratedByAppInstanceUserAsync(DescribeChannelModeratedByAppInstanceUserRequest describeChannelModeratedByAppInstanceUserRequest, AsyncHandler<DescribeChannelModeratedByAppInstanceUserRequest,DescribeChannelModeratedByAppInstanceUserResult> asyncHandler)
Returns the full details of a channel moderated by the specified AppInstanceUser.
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.
describeChannelModeratedByAppInstanceUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeChannelModeratorResult> describeChannelModeratorAsync(DescribeChannelModeratorRequest describeChannelModeratorRequest)
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.
describeChannelModeratorRequest - Future<DescribeChannelModeratorResult> describeChannelModeratorAsync(DescribeChannelModeratorRequest describeChannelModeratorRequest, AsyncHandler<DescribeChannelModeratorRequest,DescribeChannelModeratorResult> asyncHandler)
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.
describeChannelModeratorRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisassociateChannelFlowResult> disassociateChannelFlowAsync(DisassociateChannelFlowRequest disassociateChannelFlowRequest)
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 AppInstanceUserArn of the user that makes the API call as the
value in the header.
disassociateChannelFlowRequest - Future<DisassociateChannelFlowResult> disassociateChannelFlowAsync(DisassociateChannelFlowRequest disassociateChannelFlowRequest, AsyncHandler<DisassociateChannelFlowRequest,DisassociateChannelFlowResult> asyncHandler)
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 AppInstanceUserArn of the user that makes the API call as the
value in the header.
disassociateChannelFlowRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetChannelMembershipPreferencesResult> getChannelMembershipPreferencesAsync(GetChannelMembershipPreferencesRequest getChannelMembershipPreferencesRequest)
Gets the membership preferences of an AppInstanceUser for the specified channel. The
AppInstanceUser must be a member of the channel. Only the AppInstanceUser who owns the
membership can retrieve preferences. Users in the AppInstanceAdmin and channel moderator roles can't
retrieve preferences for other users. Banned users can't retrieve membership preferences for the channel from
which they are banned.
getChannelMembershipPreferencesRequest - Future<GetChannelMembershipPreferencesResult> getChannelMembershipPreferencesAsync(GetChannelMembershipPreferencesRequest getChannelMembershipPreferencesRequest, AsyncHandler<GetChannelMembershipPreferencesRequest,GetChannelMembershipPreferencesResult> asyncHandler)
Gets the membership preferences of an AppInstanceUser for the specified channel. The
AppInstanceUser must be a member of the channel. Only the AppInstanceUser who owns the
membership can retrieve preferences. Users in the AppInstanceAdmin and channel moderator roles can't
retrieve preferences for other users. Banned users can't retrieve membership preferences for the channel from
which they are banned.
getChannelMembershipPreferencesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetChannelMessageResult> getChannelMessageAsync(GetChannelMessageRequest getChannelMessageRequest)
Gets the full details of a channel message.
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.
getChannelMessageRequest - Future<GetChannelMessageResult> getChannelMessageAsync(GetChannelMessageRequest getChannelMessageRequest, AsyncHandler<GetChannelMessageRequest,GetChannelMessageResult> asyncHandler)
Gets the full details of a channel message.
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.
getChannelMessageRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetChannelMessageStatusResult> getChannelMessageStatusAsync(GetChannelMessageStatusRequest getChannelMessageStatusRequest)
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.
Message processed successfully
Ongoing processing
Processing failed
Messasge 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 AppInstanceUserArn of the
user that makes the API call as the value in the header
getChannelMessageStatusRequest - Future<GetChannelMessageStatusResult> getChannelMessageStatusAsync(GetChannelMessageStatusRequest getChannelMessageStatusRequest, AsyncHandler<GetChannelMessageStatusRequest,GetChannelMessageStatusResult> asyncHandler)
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.
Message processed successfully
Ongoing processing
Processing failed
Messasge 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 AppInstanceUserArn of the
user that makes the API call as the value in the header
getChannelMessageStatusRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetMessagingSessionEndpointResult> getMessagingSessionEndpointAsync(GetMessagingSessionEndpointRequest getMessagingSessionEndpointRequest)
The details of the endpoint for the messaging session.
getMessagingSessionEndpointRequest - Future<GetMessagingSessionEndpointResult> getMessagingSessionEndpointAsync(GetMessagingSessionEndpointRequest getMessagingSessionEndpointRequest, AsyncHandler<GetMessagingSessionEndpointRequest,GetMessagingSessionEndpointResult> asyncHandler)
The details of the endpoint for the messaging session.
getMessagingSessionEndpointRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListChannelBansResult> listChannelBansAsync(ListChannelBansRequest listChannelBansRequest)
Lists all the users banned from a particular 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.
listChannelBansRequest - Future<ListChannelBansResult> listChannelBansAsync(ListChannelBansRequest listChannelBansRequest, AsyncHandler<ListChannelBansRequest,ListChannelBansResult> asyncHandler)
Lists all the users banned from a particular 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.
listChannelBansRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListChannelFlowsResult> listChannelFlowsAsync(ListChannelFlowsRequest listChannelFlowsRequest)
Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.
listChannelFlowsRequest - Future<ListChannelFlowsResult> listChannelFlowsAsync(ListChannelFlowsRequest listChannelFlowsRequest, AsyncHandler<ListChannelFlowsRequest,ListChannelFlowsResult> asyncHandler)
Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.
listChannelFlowsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListChannelMembershipsResult> listChannelMembershipsAsync(ListChannelMembershipsRequest listChannelMembershipsRequest)
Lists all channel memberships in 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.
If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.
listChannelMembershipsRequest - Future<ListChannelMembershipsResult> listChannelMembershipsAsync(ListChannelMembershipsRequest listChannelMembershipsRequest, AsyncHandler<ListChannelMembershipsRequest,ListChannelMembershipsResult> asyncHandler)
Lists all channel memberships in 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.
If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.
listChannelMembershipsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListChannelMembershipsForAppInstanceUserResult> listChannelMembershipsForAppInstanceUserAsync(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest)
Lists all channels that a particular AppInstanceUser 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannelMembershipsForAppInstanceUserRequest - Future<ListChannelMembershipsForAppInstanceUserResult> listChannelMembershipsForAppInstanceUserAsync(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest, AsyncHandler<ListChannelMembershipsForAppInstanceUserRequest,ListChannelMembershipsForAppInstanceUserResult> asyncHandler)
Lists all channels that a particular AppInstanceUser 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannelMembershipsForAppInstanceUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListChannelMessagesResult> listChannelMessagesAsync(ListChannelMessagesRequest listChannelMessagesRequest)
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 AppInstanceUserArn of the user
that makes the API call as the value in the header.
listChannelMessagesRequest - Future<ListChannelMessagesResult> listChannelMessagesAsync(ListChannelMessagesRequest listChannelMessagesRequest, AsyncHandler<ListChannelMessagesRequest,ListChannelMessagesResult> asyncHandler)
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 AppInstanceUserArn of the user
that makes the API call as the value in the header.
listChannelMessagesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListChannelModeratorsResult> listChannelModeratorsAsync(ListChannelModeratorsRequest listChannelModeratorsRequest)
Lists all the moderators for 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.
listChannelModeratorsRequest - Future<ListChannelModeratorsResult> listChannelModeratorsAsync(ListChannelModeratorsRequest listChannelModeratorsRequest, AsyncHandler<ListChannelModeratorsRequest,ListChannelModeratorsResult> asyncHandler)
Lists all the moderators for 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.
listChannelModeratorsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListChannelsResult> listChannelsAsync(ListChannelsRequest listChannelsRequest)
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannelsRequest - Future<ListChannelsResult> listChannelsAsync(ListChannelsRequest listChannelsRequest, AsyncHandler<ListChannelsRequest,ListChannelsResult> asyncHandler)
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannelsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListChannelsAssociatedWithChannelFlowResult> listChannelsAssociatedWithChannelFlowAsync(ListChannelsAssociatedWithChannelFlowRequest listChannelsAssociatedWithChannelFlowRequest)
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.
listChannelsAssociatedWithChannelFlowRequest - Future<ListChannelsAssociatedWithChannelFlowResult> listChannelsAssociatedWithChannelFlowAsync(ListChannelsAssociatedWithChannelFlowRequest listChannelsAssociatedWithChannelFlowRequest, AsyncHandler<ListChannelsAssociatedWithChannelFlowRequest,ListChannelsAssociatedWithChannelFlowResult> asyncHandler)
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.
listChannelsAssociatedWithChannelFlowRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListChannelsModeratedByAppInstanceUserResult> listChannelsModeratedByAppInstanceUserAsync(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest)
A list of the channels moderated by an AppInstanceUser.
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.
listChannelsModeratedByAppInstanceUserRequest - Future<ListChannelsModeratedByAppInstanceUserResult> listChannelsModeratedByAppInstanceUserAsync(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest, AsyncHandler<ListChannelsModeratedByAppInstanceUserRequest,ListChannelsModeratedByAppInstanceUserResult> asyncHandler)
A list of the channels moderated by an AppInstanceUser.
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.
listChannelsModeratedByAppInstanceUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags applied to an Amazon Chime SDK messaging resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists the tags applied to an Amazon Chime SDK messaging resource.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutChannelMembershipPreferencesResult> putChannelMembershipPreferencesAsync(PutChannelMembershipPreferencesRequest putChannelMembershipPreferencesRequest)
Sets the membership preferences of an AppInstanceUser for the specified channel. The
AppInstanceUser must be a member of the channel. Only the AppInstanceUser who owns the
membership can set preferences. Users in the AppInstanceAdmin and channel moderator roles can't set
preferences for other users. Banned users can't set membership preferences for the channel from which they are
banned.
putChannelMembershipPreferencesRequest - Future<PutChannelMembershipPreferencesResult> putChannelMembershipPreferencesAsync(PutChannelMembershipPreferencesRequest putChannelMembershipPreferencesRequest, AsyncHandler<PutChannelMembershipPreferencesRequest,PutChannelMembershipPreferencesResult> asyncHandler)
Sets the membership preferences of an AppInstanceUser for the specified channel. The
AppInstanceUser must be a member of the channel. Only the AppInstanceUser who owns the
membership can set preferences. Users in the AppInstanceAdmin and channel moderator roles can't set
preferences for other users. Banned users can't set membership preferences for the channel from which they are
banned.
putChannelMembershipPreferencesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RedactChannelMessageResult> redactChannelMessageAsync(RedactChannelMessageRequest redactChannelMessageRequest)
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
redactChannelMessageRequest - Future<RedactChannelMessageResult> redactChannelMessageAsync(RedactChannelMessageRequest redactChannelMessageRequest, AsyncHandler<RedactChannelMessageRequest,RedactChannelMessageResult> asyncHandler)
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
redactChannelMessageRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SendChannelMessageResult> sendChannelMessageAsync(SendChannelMessageRequest sendChannelMessageRequest)
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL
messages can contain 30 bytes of data and no metadata.
sendChannelMessageRequest - Future<SendChannelMessageResult> sendChannelMessageAsync(SendChannelMessageRequest sendChannelMessageRequest, AsyncHandler<SendChannelMessageRequest,SendChannelMessageResult> asyncHandler)
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL
messages can contain 30 bytes of data and no metadata.
sendChannelMessageRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Applies the specified tags to the specified Amazon Chime SDK messaging resource.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Applies the specified tags to the specified Amazon Chime SDK messaging resource.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified Amazon Chime SDK messaging resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes the specified tags from the specified Amazon Chime SDK messaging resource.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateChannelResult> updateChannelAsync(UpdateChannelRequest updateChannelRequest)
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
updateChannelRequest - Future<UpdateChannelResult> updateChannelAsync(UpdateChannelRequest updateChannelRequest, AsyncHandler<UpdateChannelRequest,UpdateChannelResult> asyncHandler)
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
updateChannelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateChannelFlowResult> updateChannelFlowAsync(UpdateChannelFlowRequest updateChannelFlowRequest)
Updates channel flow attributes. This is a developer API.
updateChannelFlowRequest - Future<UpdateChannelFlowResult> updateChannelFlowAsync(UpdateChannelFlowRequest updateChannelFlowRequest, AsyncHandler<UpdateChannelFlowRequest,UpdateChannelFlowResult> asyncHandler)
Updates channel flow attributes. This is a developer API.
updateChannelFlowRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateChannelMessageResult> updateChannelMessageAsync(UpdateChannelMessageRequest updateChannelMessageRequest)
Updates the content of a message.
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.
updateChannelMessageRequest - Future<UpdateChannelMessageResult> updateChannelMessageAsync(UpdateChannelMessageRequest updateChannelMessageRequest, AsyncHandler<UpdateChannelMessageRequest,UpdateChannelMessageResult> asyncHandler)
Updates the content of a message.
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.
updateChannelMessageRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateChannelReadMarkerResult> updateChannelReadMarkerAsync(UpdateChannelReadMarkerRequest updateChannelReadMarkerRequest)
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
updateChannelReadMarkerRequest - Future<UpdateChannelReadMarkerResult> updateChannelReadMarkerAsync(UpdateChannelReadMarkerRequest updateChannelReadMarkerRequest, AsyncHandler<UpdateChannelReadMarkerRequest,UpdateChannelReadMarkerResult> asyncHandler)
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
updateChannelReadMarkerRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.