@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 .
configFactoryclient, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_PREFIXbatchCreateChannelMembership, builder, createChannel, createChannelBan, createChannelMembership, createChannelModerator, deleteChannel, deleteChannelBan, deleteChannelMembership, deleteChannelMessage, deleteChannelModerator, describeChannel, describeChannelBan, describeChannelMembership, describeChannelMembershipForAppInstanceUser, describeChannelModeratedByAppInstanceUser, describeChannelModerator, getCachedResponseMetadata, getChannelMessage, getMessagingSessionEndpoint, listChannelBans, listChannelMemberships, listChannelMembershipsForAppInstanceUser, listChannelMessages, listChannelModerators, listChannels, listChannelsModeratedByAppInstanceUser, redactChannelMessage, sendChannelMessage, updateChannel, updateChannelMessage, updateChannelReadMarkeraddRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitbatchCreateChannelMembership, createChannel, createChannelBan, createChannelMembership, createChannelModerator, deleteChannel, deleteChannelBan, deleteChannelMembership, deleteChannelMessage, deleteChannelModerator, describeChannel, describeChannelBan, describeChannelMembership, describeChannelMembershipForAppInstanceUser, describeChannelModeratedByAppInstanceUser, describeChannelModerator, getCachedResponseMetadata, getChannelMessage, getMessagingSessionEndpoint, listChannelBans, listChannelMemberships, listChannelMembershipsForAppInstanceUser, listChannelMessages, listChannelModerators, listChannels, listChannelsModeratedByAppInstanceUser, redactChannelMessage, sendChannelMessage, updateChannel, updateChannelMessage, updateChannelReadMarkerpublic static AmazonChimeSDKMessagingAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<BatchCreateChannelMembershipResult> batchCreateChannelMembershipAsync(BatchCreateChannelMembershipRequest request)
AmazonChimeSDKMessagingAsyncAdds a specified number of users to a channel.
batchCreateChannelMembershipAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<BatchCreateChannelMembershipResult> batchCreateChannelMembershipAsync(BatchCreateChannelMembershipRequest request, AsyncHandler<BatchCreateChannelMembershipRequest,BatchCreateChannelMembershipResult> asyncHandler)
AmazonChimeSDKMessagingAsyncAdds a specified number of users 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<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 AppInstanceUserArn of the
user 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 AppInstanceUserArn of the
user 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 AppInstanceUserArn of the
user 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 AppInstanceUserArn of the
user 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<CreateChannelMembershipResult> createChannelMembershipAsync(CreateChannelMembershipRequest request)
AmazonChimeSDKMessagingAsync
Adds a user to a channel. The InvitedBy response field 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.
createChannelMembershipAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<CreateChannelMembershipResult> createChannelMembershipAsync(CreateChannelMembershipRequest request, AsyncHandler<CreateChannelMembershipRequest,CreateChannelMembershipResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Adds a user to a channel. The InvitedBy response field 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.
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 AppInstanceUserArn of 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 AppInstanceUserArn of 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 AppInstanceUserArn of the
user 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 AppInstanceUserArn of the
user 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 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.
deleteChannelBanAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<DeleteChannelBanResult> deleteChannelBanAsync(DeleteChannelBanRequest request, AsyncHandler<DeleteChannelBanRequest,DeleteChannelBanResult> asyncHandler)
AmazonChimeSDKMessagingAsyncRemoves 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.
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<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 AppInstanceUserArn of the
user 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 AppInstanceUserArn of the
user 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 AppInstanceUserArn of the
user 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 AppInstanceUserArn of the
user 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<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 AppInstanceUserArn of the
user 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 AppInstanceUserArn of the
user 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 AppInstanceUserArn of the
user 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 AppInstanceUserArn of the
user 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<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 AppInstanceUserArn of the
user 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 AppInstanceUserArn of the
user 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.
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.
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.
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.
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.
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.
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.
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.
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<GetChannelMessageResult> getChannelMessageAsync(GetChannelMessageRequest request)
AmazonChimeSDKMessagingAsyncGets 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.
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 AppInstanceUserArn of the user 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<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<ListChannelBansResult> listChannelBansAsync(ListChannelBansRequest request)
AmazonChimeSDKMessagingAsyncLists 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.
listChannelBansAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<ListChannelBansResult> listChannelBansAsync(ListChannelBansRequest request, AsyncHandler<ListChannelBansRequest,ListChannelBansResult> asyncHandler)
AmazonChimeSDKMessagingAsyncLists 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.
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<ListChannelMembershipsResult> listChannelMembershipsAsync(ListChannelMembershipsRequest request)
AmazonChimeSDKMessagingAsyncLists 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.
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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
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 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.
listChannelMembershipsForAppInstanceUserAsync in interface AmazonChimeSDKMessagingAsyncpublic Future<ListChannelMembershipsForAppInstanceUserResult> listChannelMembershipsForAppInstanceUserAsync(ListChannelMembershipsForAppInstanceUserRequest request, AsyncHandler<ListChannelMembershipsForAppInstanceUserRequest,ListChannelMembershipsForAppInstanceUserResult> asyncHandler)
AmazonChimeSDKMessagingAsync
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.
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 AppInstanceUserArn of the user
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 AppInstanceUserArn of the user
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 AppInstanceUserArn of the
user 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 AppInstanceUserArn of the
user 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 AppInstanceUserArn of the
user 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 AppInstanceUserArn of the
user 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<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 AppInstanceUserArn of the
user 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 AppInstanceUserArn of the
user 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<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 AppInstanceUserArn of the
user 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 AppInstanceUserArn of the
user 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<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 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.
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 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.
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<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 AppInstanceUserArn of the
user 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 AppInstanceUserArn of the
user 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<UpdateChannelMessageResult> updateChannelMessageAsync(UpdateChannelMessageRequest request)
AmazonChimeSDKMessagingAsyncUpdates 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.
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 AppInstanceUserArn of the
user 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 AppInstanceUserArn of the
user 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 AppInstanceUserArn of the
user 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 AmazonChimeSDKMessagingClientCopyright © 2021. All rights reserved.