@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonChimeSDKMessagingAsyncClient extends AmazonChimeSDKMessagingClient implements AmazonChimeSDKMessagingAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXassociateChannelFlow, batchCreateChannelMembership, builder, channelFlowCallback, createChannel, createChannelBan, createChannelFlow, createChannelMembership, createChannelModerator, deleteChannel, deleteChannelBan, deleteChannelFlow, deleteChannelMembership, deleteChannelMessage, deleteChannelModerator, deleteMessagingStreamingConfigurations, describeChannel, describeChannelBan, describeChannelFlow, describeChannelMembership, describeChannelMembershipForAppInstanceUser, describeChannelModeratedByAppInstanceUser, describeChannelModerator, disassociateChannelFlow, getCachedResponseMetadata, getChannelMembershipPreferences, getChannelMessage, getChannelMessageStatus, getMessagingSessionEndpoint, getMessagingStreamingConfigurations, listChannelBans, listChannelFlows, listChannelMemberships, listChannelMembershipsForAppInstanceUser, listChannelMessages, listChannelModerators, listChannels, listChannelsAssociatedWithChannelFlow, listChannelsModeratedByAppInstanceUser, listSubChannels, listTagsForResource, putChannelExpirationSettings, putChannelMembershipPreferences, putMessagingStreamingConfigurations, redactChannelMessage, searchChannels, sendChannelMessage, tagResource, untagResource, updateChannel, updateChannelFlow, updateChannelMessage, updateChannelReadMarkeraddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitassociateChannelFlow, batchCreateChannelMembership, channelFlowCallback, createChannel, createChannelBan, createChannelFlow, createChannelMembership, createChannelModerator, deleteChannel, deleteChannelBan, deleteChannelFlow, deleteChannelMembership, deleteChannelMessage, deleteChannelModerator, deleteMessagingStreamingConfigurations, describeChannel, describeChannelBan, describeChannelFlow, describeChannelMembership, describeChannelMembershipForAppInstanceUser, describeChannelModeratedByAppInstanceUser, describeChannelModerator, disassociateChannelFlow, getCachedResponseMetadata, getChannelMembershipPreferences, getChannelMessage, getChannelMessageStatus, getMessagingSessionEndpoint, getMessagingStreamingConfigurations, listChannelBans, listChannelFlows, listChannelMemberships, listChannelMembershipsForAppInstanceUser, listChannelMessages, listChannelModerators, listChannels, listChannelsAssociatedWithChannelFlow, listChannelsModeratedByAppInstanceUser, listSubChannels, listTagsForResource, putChannelExpirationSettings, putChannelMembershipPreferences, putMessagingStreamingConfigurations, redactChannelMessage, searchChannels, sendChannelMessage, tagResource, untagResource, updateChannel, updateChannelFlow, updateChannelMessage, updateChannelReadMarkerpublic static AmazonChimeSDKMessagingAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AssociateChannelFlowResult> associateChannelFlowAsync(AssociateChannelFlowRequest request)
AmazonChimeSDKMessagingAsync
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.
associateChannelFlowAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<AssociateChannelFlowResult> associateChannelFlowAsync(AssociateChannelFlowRequest request, AsyncHandler<AssociateChannelFlowRequest,AssociateChannelFlowResult> asyncHandler)
AmazonChimeSDKMessagingAsync
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.
associateChannelFlowAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<BatchCreateChannelMembershipResult> batchCreateChannelMembershipAsync(BatchCreateChannelMembershipRequest request)
AmazonChimeSDKMessagingAsyncAdds a specified number of users and bots to a channel.
batchCreateChannelMembershipAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<BatchCreateChannelMembershipResult> batchCreateChannelMembershipAsync(BatchCreateChannelMembershipRequest request, AsyncHandler<BatchCreateChannelMembershipRequest,BatchCreateChannelMembershipResult> asyncHandler)
AmazonChimeSDKMessagingAsyncAdds a specified number of users and bots to a channel.
batchCreateChannelMembershipAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<ChannelFlowCallbackResult> channelFlowCallbackAsync(ChannelFlowCallbackRequest request)
AmazonChimeSDKMessagingAsyncCalls 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
channelFlowCallbackAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<ChannelFlowCallbackResult> channelFlowCallbackAsync(ChannelFlowCallbackRequest request, AsyncHandler<ChannelFlowCallbackRequest,ChannelFlowCallbackResult> asyncHandler)
AmazonChimeSDKMessagingAsyncCalls 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
channelFlowCallbackAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<CreateChannelResult> createChannelAsync(CreateChannelRequest request)
AmazonChimeSDKMessagingAsyncCreates 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.
createChannelAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<CreateChannelResult> createChannelAsync(CreateChannelRequest request, AsyncHandler<CreateChannelRequest,CreateChannelResult> asyncHandler)
AmazonChimeSDKMessagingAsyncCreates 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.
createChannelAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<CreateChannelBanResult> createChannelBanAsync(CreateChannelBanRequest request)
AmazonChimeSDKMessagingAsync
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.
createChannelBanAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<CreateChannelBanResult> createChannelBanAsync(CreateChannelBanRequest request, AsyncHandler<CreateChannelBanRequest,CreateChannelBanResult> asyncHandler)
AmazonChimeSDKMessagingAsync
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.
createChannelBanAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<CreateChannelFlowResult> createChannelFlowAsync(CreateChannelFlowRequest request)
AmazonChimeSDKMessagingAsyncCreates 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.
createChannelFlowAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<CreateChannelFlowResult> createChannelFlowAsync(CreateChannelFlowRequest request, AsyncHandler<CreateChannelFlowRequest,CreateChannelFlowResult> asyncHandler)
AmazonChimeSDKMessagingAsyncCreates 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.
createChannelFlowAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<CreateChannelMembershipResult> createChannelMembershipAsync(CreateChannelMembershipRequest request)
AmazonChimeSDKMessagingAsync
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.
createChannelMembershipAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<CreateChannelMembershipResult> createChannelMembershipAsync(CreateChannelMembershipRequest request, AsyncHandler<CreateChannelMembershipRequest,CreateChannelMembershipResult> asyncHandler)
AmazonChimeSDKMessagingAsync
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.
createChannelMembershipAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<CreateChannelModeratorResult> createChannelModeratorAsync(CreateChannelModeratorRequest request)
AmazonChimeSDKMessagingAsync
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.
createChannelModeratorAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<CreateChannelModeratorResult> createChannelModeratorAsync(CreateChannelModeratorRequest request, AsyncHandler<CreateChannelModeratorRequest,CreateChannelModeratorResult> asyncHandler)
AmazonChimeSDKMessagingAsync
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.
createChannelModeratorAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<DeleteChannelResult> deleteChannelAsync(DeleteChannelRequest request)
AmazonChimeSDKMessagingAsyncImmediately 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.
deleteChannelAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<DeleteChannelResult> deleteChannelAsync(DeleteChannelRequest request, AsyncHandler<DeleteChannelRequest,DeleteChannelResult> asyncHandler)
AmazonChimeSDKMessagingAsyncImmediately 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.
deleteChannelAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<DeleteChannelBanResult> deleteChannelBanAsync(DeleteChannelBanRequest request)
AmazonChimeSDKMessagingAsyncRemoves 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.
deleteChannelBanAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<DeleteChannelBanResult> deleteChannelBanAsync(DeleteChannelBanRequest request, AsyncHandler<DeleteChannelBanRequest,DeleteChannelBanResult> asyncHandler)
AmazonChimeSDKMessagingAsyncRemoves 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.
deleteChannelBanAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<DeleteChannelFlowResult> deleteChannelFlowAsync(DeleteChannelFlowRequest request)
AmazonChimeSDKMessagingAsyncDeletes 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.
deleteChannelFlowAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<DeleteChannelFlowResult> deleteChannelFlowAsync(DeleteChannelFlowRequest request, AsyncHandler<DeleteChannelFlowRequest,DeleteChannelFlowResult> asyncHandler)
AmazonChimeSDKMessagingAsyncDeletes 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.
deleteChannelFlowAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<DeleteChannelMembershipResult> deleteChannelMembershipAsync(DeleteChannelMembershipRequest request)
AmazonChimeSDKMessagingAsyncRemoves 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.
deleteChannelMembershipAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<DeleteChannelMembershipResult> deleteChannelMembershipAsync(DeleteChannelMembershipRequest request, AsyncHandler<DeleteChannelMembershipRequest,DeleteChannelMembershipResult> asyncHandler)
AmazonChimeSDKMessagingAsyncRemoves 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.
deleteChannelMembershipAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<DeleteChannelMessageResult> deleteChannelMessageAsync(DeleteChannelMessageRequest request)
AmazonChimeSDKMessagingAsync
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.
deleteChannelMessageAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<DeleteChannelMessageResult> deleteChannelMessageAsync(DeleteChannelMessageRequest request, AsyncHandler<DeleteChannelMessageRequest,DeleteChannelMessageResult> asyncHandler)
AmazonChimeSDKMessagingAsync
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.
deleteChannelMessageAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<DeleteChannelModeratorResult> deleteChannelModeratorAsync(DeleteChannelModeratorRequest request)
AmazonChimeSDKMessagingAsyncDeletes 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.
deleteChannelModeratorAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<DeleteChannelModeratorResult> deleteChannelModeratorAsync(DeleteChannelModeratorRequest request, AsyncHandler<DeleteChannelModeratorRequest,DeleteChannelModeratorResult> asyncHandler)
AmazonChimeSDKMessagingAsyncDeletes 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.
deleteChannelModeratorAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<DeleteMessagingStreamingConfigurationsResult> deleteMessagingStreamingConfigurationsAsync(DeleteMessagingStreamingConfigurationsRequest request)
AmazonChimeSDKMessagingAsync
Deletes the streaming configurations for an AppInstance. For more information, see Streaming messaging data in the
Amazon Chime SDK Developer Guide.
deleteMessagingStreamingConfigurationsAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<DeleteMessagingStreamingConfigurationsResult> deleteMessagingStreamingConfigurationsAsync(DeleteMessagingStreamingConfigurationsRequest request, AsyncHandler<DeleteMessagingStreamingConfigurationsRequest,DeleteMessagingStreamingConfigurationsResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Deletes the streaming configurations for an AppInstance. For more information, see Streaming messaging data in the
Amazon Chime SDK Developer Guide.
deleteMessagingStreamingConfigurationsAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<DescribeChannelResult> describeChannelAsync(DescribeChannelRequest request)
AmazonChimeSDKMessagingAsync
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.
describeChannelAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<DescribeChannelResult> describeChannelAsync(DescribeChannelRequest request, AsyncHandler<DescribeChannelRequest,DescribeChannelResult> asyncHandler)
AmazonChimeSDKMessagingAsync
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.
describeChannelAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<DescribeChannelBanResult> describeChannelBanAsync(DescribeChannelBanRequest request)
AmazonChimeSDKMessagingAsyncReturns 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.
describeChannelBanAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<DescribeChannelBanResult> describeChannelBanAsync(DescribeChannelBanRequest request, AsyncHandler<DescribeChannelBanRequest,DescribeChannelBanResult> asyncHandler)
AmazonChimeSDKMessagingAsyncReturns 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.
describeChannelBanAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<DescribeChannelFlowResult> describeChannelFlowAsync(DescribeChannelFlowRequest request)
AmazonChimeSDKMessagingAsync
Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.
describeChannelFlowAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<DescribeChannelFlowResult> describeChannelFlowAsync(DescribeChannelFlowRequest request, AsyncHandler<DescribeChannelFlowRequest,DescribeChannelFlowResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.
describeChannelFlowAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<DescribeChannelMembershipResult> describeChannelMembershipAsync(DescribeChannelMembershipRequest request)
AmazonChimeSDKMessagingAsyncReturns 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.
describeChannelMembershipAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<DescribeChannelMembershipResult> describeChannelMembershipAsync(DescribeChannelMembershipRequest request, AsyncHandler<DescribeChannelMembershipRequest,DescribeChannelMembershipResult> asyncHandler)
AmazonChimeSDKMessagingAsyncReturns 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.
describeChannelMembershipAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<DescribeChannelMembershipForAppInstanceUserResult> describeChannelMembershipForAppInstanceUserAsync(DescribeChannelMembershipForAppInstanceUserRequest request)
AmazonChimeSDKMessagingAsync
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.
describeChannelMembershipForAppInstanceUserAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<DescribeChannelMembershipForAppInstanceUserResult> describeChannelMembershipForAppInstanceUserAsync(DescribeChannelMembershipForAppInstanceUserRequest request, AsyncHandler<DescribeChannelMembershipForAppInstanceUserRequest,DescribeChannelMembershipForAppInstanceUserResult> asyncHandler)
AmazonChimeSDKMessagingAsync
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.
describeChannelMembershipForAppInstanceUserAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<DescribeChannelModeratedByAppInstanceUserResult> describeChannelModeratedByAppInstanceUserAsync(DescribeChannelModeratedByAppInstanceUserRequest request)
AmazonChimeSDKMessagingAsync
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.
describeChannelModeratedByAppInstanceUserAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<DescribeChannelModeratedByAppInstanceUserResult> describeChannelModeratedByAppInstanceUserAsync(DescribeChannelModeratedByAppInstanceUserRequest request, AsyncHandler<DescribeChannelModeratedByAppInstanceUserRequest,DescribeChannelModeratedByAppInstanceUserResult> asyncHandler)
AmazonChimeSDKMessagingAsync
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.
describeChannelModeratedByAppInstanceUserAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<DescribeChannelModeratorResult> describeChannelModeratorAsync(DescribeChannelModeratorRequest request)
AmazonChimeSDKMessagingAsyncReturns 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.
describeChannelModeratorAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<DescribeChannelModeratorResult> describeChannelModeratorAsync(DescribeChannelModeratorRequest request, AsyncHandler<DescribeChannelModeratorRequest,DescribeChannelModeratorResult> asyncHandler)
AmazonChimeSDKMessagingAsyncReturns 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.
describeChannelModeratorAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<DisassociateChannelFlowResult> disassociateChannelFlowAsync(DisassociateChannelFlowRequest request)
AmazonChimeSDKMessagingAsyncDisassociates 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.
disassociateChannelFlowAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<DisassociateChannelFlowResult> disassociateChannelFlowAsync(DisassociateChannelFlowRequest request, AsyncHandler<DisassociateChannelFlowRequest,DisassociateChannelFlowResult> asyncHandler)
AmazonChimeSDKMessagingAsyncDisassociates 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.
disassociateChannelFlowAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<GetChannelMembershipPreferencesResult> getChannelMembershipPreferencesAsync(GetChannelMembershipPreferencesRequest request)
AmazonChimeSDKMessagingAsync
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.
getChannelMembershipPreferencesAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<GetChannelMembershipPreferencesResult> getChannelMembershipPreferencesAsync(GetChannelMembershipPreferencesRequest request, AsyncHandler<GetChannelMembershipPreferencesRequest,GetChannelMembershipPreferencesResult> asyncHandler)
AmazonChimeSDKMessagingAsync
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.
getChannelMembershipPreferencesAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<GetChannelMessageResult> getChannelMessageAsync(GetChannelMessageRequest request)
AmazonChimeSDKMessagingAsyncGets 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.
getChannelMessageAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<GetChannelMessageResult> getChannelMessageAsync(GetChannelMessageRequest request, AsyncHandler<GetChannelMessageRequest,GetChannelMessageResult> asyncHandler)
AmazonChimeSDKMessagingAsyncGets 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.
getChannelMessageAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<GetChannelMessageStatusResult> getChannelMessageStatusAsync(GetChannelMessageStatusRequest request)
AmazonChimeSDKMessagingAsync
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
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.
getChannelMessageStatusAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<GetChannelMessageStatusResult> getChannelMessageStatusAsync(GetChannelMessageStatusRequest request, AsyncHandler<GetChannelMessageStatusRequest,GetChannelMessageStatusResult> asyncHandler)
AmazonChimeSDKMessagingAsync
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
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.
getChannelMessageStatusAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<GetMessagingSessionEndpointResult> getMessagingSessionEndpointAsync(GetMessagingSessionEndpointRequest request)
AmazonChimeSDKMessagingAsyncThe details of the endpoint for the messaging session.
getMessagingSessionEndpointAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<GetMessagingSessionEndpointResult> getMessagingSessionEndpointAsync(GetMessagingSessionEndpointRequest request, AsyncHandler<GetMessagingSessionEndpointRequest,GetMessagingSessionEndpointResult> asyncHandler)
AmazonChimeSDKMessagingAsyncThe details of the endpoint for the messaging session.
getMessagingSessionEndpointAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<GetMessagingStreamingConfigurationsResult> getMessagingStreamingConfigurationsAsync(GetMessagingStreamingConfigurationsRequest request)
AmazonChimeSDKMessagingAsync
Retrieves the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the
Amazon Chime SDK Developer Guide.
getMessagingStreamingConfigurationsAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<GetMessagingStreamingConfigurationsResult> getMessagingStreamingConfigurationsAsync(GetMessagingStreamingConfigurationsRequest request, AsyncHandler<GetMessagingStreamingConfigurationsRequest,GetMessagingStreamingConfigurationsResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Retrieves the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the
Amazon Chime SDK Developer Guide.
getMessagingStreamingConfigurationsAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<ListChannelBansResult> listChannelBansAsync(ListChannelBansRequest request)
AmazonChimeSDKMessagingAsyncLists 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.
listChannelBansAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<ListChannelBansResult> listChannelBansAsync(ListChannelBansRequest request, AsyncHandler<ListChannelBansRequest,ListChannelBansResult> asyncHandler)
AmazonChimeSDKMessagingAsyncLists 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.
listChannelBansAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<ListChannelFlowsResult> listChannelFlowsAsync(ListChannelFlowsRequest request)
AmazonChimeSDKMessagingAsyncReturns a paginated lists of all the channel flows created under a single Chime. This is a developer API.
listChannelFlowsAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<ListChannelFlowsResult> listChannelFlowsAsync(ListChannelFlowsRequest request, AsyncHandler<ListChannelFlowsRequest,ListChannelFlowsResult> asyncHandler)
AmazonChimeSDKMessagingAsyncReturns a paginated lists of all the channel flows created under a single Chime. This is a developer API.
listChannelFlowsAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<ListChannelMembershipsResult> listChannelMembershipsAsync(ListChannelMembershipsRequest request)
AmazonChimeSDKMessagingAsyncLists 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.
listChannelMembershipsAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<ListChannelMembershipsResult> listChannelMembershipsAsync(ListChannelMembershipsRequest request, AsyncHandler<ListChannelMembershipsRequest,ListChannelMembershipsResult> asyncHandler)
AmazonChimeSDKMessagingAsyncLists 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.
listChannelMembershipsAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<ListChannelMembershipsForAppInstanceUserResult> listChannelMembershipsForAppInstanceUserAsync(ListChannelMembershipsForAppInstanceUserRequest request)
AmazonChimeSDKMessagingAsync
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.
listChannelMembershipsForAppInstanceUserAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<ListChannelMembershipsForAppInstanceUserResult> listChannelMembershipsForAppInstanceUserAsync(ListChannelMembershipsForAppInstanceUserRequest request, AsyncHandler<ListChannelMembershipsForAppInstanceUserRequest,ListChannelMembershipsForAppInstanceUserResult> asyncHandler)
AmazonChimeSDKMessagingAsync
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.
listChannelMembershipsForAppInstanceUserAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<ListChannelMessagesResult> listChannelMessagesAsync(ListChannelMessagesRequest request)
AmazonChimeSDKMessagingAsync
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.
listChannelMessagesAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<ListChannelMessagesResult> listChannelMessagesAsync(ListChannelMessagesRequest request, AsyncHandler<ListChannelMessagesRequest,ListChannelMessagesResult> asyncHandler)
AmazonChimeSDKMessagingAsync
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.
listChannelMessagesAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<ListChannelModeratorsResult> listChannelModeratorsAsync(ListChannelModeratorsRequest request)
AmazonChimeSDKMessagingAsyncLists 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.
listChannelModeratorsAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<ListChannelModeratorsResult> listChannelModeratorsAsync(ListChannelModeratorsRequest request, AsyncHandler<ListChannelModeratorsRequest,ListChannelModeratorsResult> asyncHandler)
AmazonChimeSDKMessagingAsyncLists 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.
listChannelModeratorsAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<ListChannelsResult> listChannelsAsync(ListChannelsRequest request)
AmazonChimeSDKMessagingAsyncLists 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.
listChannelsAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<ListChannelsResult> listChannelsAsync(ListChannelsRequest request, AsyncHandler<ListChannelsRequest,ListChannelsResult> asyncHandler)
AmazonChimeSDKMessagingAsyncLists 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.
listChannelsAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<ListChannelsAssociatedWithChannelFlowResult> listChannelsAssociatedWithChannelFlowAsync(ListChannelsAssociatedWithChannelFlowRequest request)
AmazonChimeSDKMessagingAsyncLists 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.
listChannelsAssociatedWithChannelFlowAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<ListChannelsAssociatedWithChannelFlowResult> listChannelsAssociatedWithChannelFlowAsync(ListChannelsAssociatedWithChannelFlowRequest request, AsyncHandler<ListChannelsAssociatedWithChannelFlowRequest,ListChannelsAssociatedWithChannelFlowResult> asyncHandler)
AmazonChimeSDKMessagingAsyncLists 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.
listChannelsAssociatedWithChannelFlowAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<ListChannelsModeratedByAppInstanceUserResult> listChannelsModeratedByAppInstanceUserAsync(ListChannelsModeratedByAppInstanceUserRequest request)
AmazonChimeSDKMessagingAsync
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.
listChannelsModeratedByAppInstanceUserAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<ListChannelsModeratedByAppInstanceUserResult> listChannelsModeratedByAppInstanceUserAsync(ListChannelsModeratedByAppInstanceUserRequest request, AsyncHandler<ListChannelsModeratedByAppInstanceUserRequest,ListChannelsModeratedByAppInstanceUserResult> asyncHandler)
AmazonChimeSDKMessagingAsync
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.
listChannelsModeratedByAppInstanceUserAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<ListSubChannelsResult> listSubChannelsAsync(ListSubChannelsRequest request)
AmazonChimeSDKMessagingAsyncLists 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.
listSubChannelsAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<ListSubChannelsResult> listSubChannelsAsync(ListSubChannelsRequest request, AsyncHandler<ListSubChannelsRequest,ListSubChannelsResult> asyncHandler)
AmazonChimeSDKMessagingAsyncLists 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.
listSubChannelsAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonChimeSDKMessagingAsyncLists the tags applied to an Amazon Chime SDK messaging resource.
listTagsForResourceAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonChimeSDKMessagingAsyncLists the tags applied to an Amazon Chime SDK messaging resource.
listTagsForResourceAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<PutChannelExpirationSettingsResult> putChannelExpirationSettingsAsync(PutChannelExpirationSettingsRequest request)
AmazonChimeSDKMessagingAsyncSets 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.
putChannelExpirationSettingsAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<PutChannelExpirationSettingsResult> putChannelExpirationSettingsAsync(PutChannelExpirationSettingsRequest request, AsyncHandler<PutChannelExpirationSettingsRequest,PutChannelExpirationSettingsResult> asyncHandler)
AmazonChimeSDKMessagingAsyncSets 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.
putChannelExpirationSettingsAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<PutChannelMembershipPreferencesResult> putChannelMembershipPreferencesAsync(PutChannelMembershipPreferencesRequest request)
AmazonChimeSDKMessagingAsync
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.
putChannelMembershipPreferencesAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<PutChannelMembershipPreferencesResult> putChannelMembershipPreferencesAsync(PutChannelMembershipPreferencesRequest request, AsyncHandler<PutChannelMembershipPreferencesRequest,PutChannelMembershipPreferencesResult> asyncHandler)
AmazonChimeSDKMessagingAsync
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.
putChannelMembershipPreferencesAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<PutMessagingStreamingConfigurationsResult> putMessagingStreamingConfigurationsAsync(PutMessagingStreamingConfigurationsRequest request)
AmazonChimeSDKMessagingAsync
Sets the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the
Amazon Chime SDK Developer Guide.
putMessagingStreamingConfigurationsAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<PutMessagingStreamingConfigurationsResult> putMessagingStreamingConfigurationsAsync(PutMessagingStreamingConfigurationsRequest request, AsyncHandler<PutMessagingStreamingConfigurationsRequest,PutMessagingStreamingConfigurationsResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Sets the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the
Amazon Chime SDK Developer Guide.
putMessagingStreamingConfigurationsAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<RedactChannelMessageResult> redactChannelMessageAsync(RedactChannelMessageRequest request)
AmazonChimeSDKMessagingAsyncRedacts 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.
redactChannelMessageAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<RedactChannelMessageResult> redactChannelMessageAsync(RedactChannelMessageRequest request, AsyncHandler<RedactChannelMessageRequest,RedactChannelMessageResult> asyncHandler)
AmazonChimeSDKMessagingAsyncRedacts 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.
redactChannelMessageAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<SearchChannelsResult> searchChannelsAsync(SearchChannelsRequest request)
AmazonChimeSDKMessagingAsync
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.
searchChannelsAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<SearchChannelsResult> searchChannelsAsync(SearchChannelsRequest request, AsyncHandler<SearchChannelsRequest,SearchChannelsResult> asyncHandler)
AmazonChimeSDKMessagingAsync
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.
searchChannelsAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<SendChannelMessageResult> sendChannelMessageAsync(SendChannelMessageRequest request)
AmazonChimeSDKMessagingAsyncSends 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.
sendChannelMessageAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<SendChannelMessageResult> sendChannelMessageAsync(SendChannelMessageRequest request, AsyncHandler<SendChannelMessageRequest,SendChannelMessageResult> asyncHandler)
AmazonChimeSDKMessagingAsyncSends 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.
sendChannelMessageAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonChimeSDKMessagingAsyncApplies the specified tags to the specified Amazon Chime SDK messaging resource.
tagResourceAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonChimeSDKMessagingAsyncApplies the specified tags to the specified Amazon Chime SDK messaging resource.
tagResourceAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonChimeSDKMessagingAsyncRemoves the specified tags from the specified Amazon Chime SDK messaging resource.
untagResourceAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonChimeSDKMessagingAsyncRemoves the specified tags from the specified Amazon Chime SDK messaging resource.
untagResourceAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<UpdateChannelResult> updateChannelAsync(UpdateChannelRequest request)
AmazonChimeSDKMessagingAsyncUpdate 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.
updateChannelAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<UpdateChannelResult> updateChannelAsync(UpdateChannelRequest request, AsyncHandler<UpdateChannelRequest,UpdateChannelResult> asyncHandler)
AmazonChimeSDKMessagingAsyncUpdate 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.
updateChannelAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<UpdateChannelFlowResult> updateChannelFlowAsync(UpdateChannelFlowRequest request)
AmazonChimeSDKMessagingAsyncUpdates channel flow attributes. This is a developer API.
updateChannelFlowAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<UpdateChannelFlowResult> updateChannelFlowAsync(UpdateChannelFlowRequest request, AsyncHandler<UpdateChannelFlowRequest,UpdateChannelFlowResult> asyncHandler)
AmazonChimeSDKMessagingAsyncUpdates channel flow attributes. This is a developer API.
updateChannelFlowAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<UpdateChannelMessageResult> updateChannelMessageAsync(UpdateChannelMessageRequest request)
AmazonChimeSDKMessagingAsyncUpdates 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.
updateChannelMessageAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<UpdateChannelMessageResult> updateChannelMessageAsync(UpdateChannelMessageRequest request, AsyncHandler<UpdateChannelMessageRequest,UpdateChannelMessageResult> asyncHandler)
AmazonChimeSDKMessagingAsyncUpdates 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.
updateChannelMessageAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public Future<UpdateChannelReadMarkerResult> updateChannelReadMarkerAsync(UpdateChannelReadMarkerRequest request)
AmazonChimeSDKMessagingAsyncThe 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.
updateChannelReadMarkerAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<UpdateChannelReadMarkerResult> updateChannelReadMarkerAsync(UpdateChannelReadMarkerRequest request, AsyncHandler<UpdateChannelReadMarkerRequest,UpdateChannelReadMarkerResult> asyncHandler)
AmazonChimeSDKMessagingAsyncThe 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.
updateChannelReadMarkerAsync in interface AmazonChimeSDKMessagingAsyncasyncHandler - 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonChimeSDKMessagingshutdown in class AmazonChimeSDKMessagingClient