@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonChimeSDKMessagingAsync extends AbstractAmazonChimeSDKMessaging implements AmazonChimeSDKMessagingAsync
AmazonChimeSDKMessagingAsync
. Convenient method forms pass through to the
corresponding overload that takes a request object and an AsyncHandler
, which throws an
UnsupportedOperationException
.ENDPOINT_PREFIX
batchCreateChannelMembership, 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, shutdown, updateChannel, updateChannelMessage, updateChannelReadMarker
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
batchCreateChannelMembership, 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, shutdown, updateChannel, updateChannelMessage, updateChannelReadMarker
public Future<BatchCreateChannelMembershipResult> batchCreateChannelMembershipAsync(BatchCreateChannelMembershipRequest request)
AmazonChimeSDKMessagingAsync
Adds a specified number of users to a channel.
batchCreateChannelMembershipAsync
in interface AmazonChimeSDKMessagingAsync
public Future<BatchCreateChannelMembershipResult> batchCreateChannelMembershipAsync(BatchCreateChannelMembershipRequest request, AsyncHandler<BatchCreateChannelMembershipRequest,BatchCreateChannelMembershipResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Adds a specified number of users to a channel.
batchCreateChannelMembershipAsync
in interface AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateChannelResult> createChannelAsync(CreateChannelRequest request)
AmazonChimeSDKMessagingAsync
Creates a channel to which you can add users and send messages.
Restriction: You can't change a channel's privacy.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
createChannelAsync
in interface AmazonChimeSDKMessagingAsync
public Future<CreateChannelResult> createChannelAsync(CreateChannelRequest request, AsyncHandler<CreateChannelRequest,CreateChannelResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Creates a channel to which you can add users and send messages.
Restriction: You can't change a channel's privacy.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
createChannelAsync
in interface AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.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 AmazonChimeSDKMessagingAsync
public 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 AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.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 AmazonChimeSDKMessagingAsync
public 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 AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.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 AmazonChimeSDKMessagingAsync
public 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 AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteChannelResult> deleteChannelAsync(DeleteChannelRequest request)
AmazonChimeSDKMessagingAsync
Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
deleteChannelAsync
in interface AmazonChimeSDKMessagingAsync
public Future<DeleteChannelResult> deleteChannelAsync(DeleteChannelRequest request, AsyncHandler<DeleteChannelRequest,DeleteChannelResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
deleteChannelAsync
in interface AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteChannelBanResult> deleteChannelBanAsync(DeleteChannelBanRequest request)
AmazonChimeSDKMessagingAsync
Removes a user from a channel's ban list.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
deleteChannelBanAsync
in interface AmazonChimeSDKMessagingAsync
public Future<DeleteChannelBanResult> deleteChannelBanAsync(DeleteChannelBanRequest request, AsyncHandler<DeleteChannelBanRequest,DeleteChannelBanResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Removes a user from a channel's ban list.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
deleteChannelBanAsync
in interface AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteChannelMembershipResult> deleteChannelMembershipAsync(DeleteChannelMembershipRequest request)
AmazonChimeSDKMessagingAsync
Removes a member from a channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
deleteChannelMembershipAsync
in interface AmazonChimeSDKMessagingAsync
public Future<DeleteChannelMembershipResult> deleteChannelMembershipAsync(DeleteChannelMembershipRequest request, AsyncHandler<DeleteChannelMembershipRequest,DeleteChannelMembershipResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Removes a member from a channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
deleteChannelMembershipAsync
in interface AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.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 AmazonChimeSDKMessagingAsync
public 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 AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteChannelModeratorResult> deleteChannelModeratorAsync(DeleteChannelModeratorRequest request)
AmazonChimeSDKMessagingAsync
Deletes a channel moderator.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
deleteChannelModeratorAsync
in interface AmazonChimeSDKMessagingAsync
public Future<DeleteChannelModeratorResult> deleteChannelModeratorAsync(DeleteChannelModeratorRequest request, AsyncHandler<DeleteChannelModeratorRequest,DeleteChannelModeratorResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Deletes a channel moderator.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
deleteChannelModeratorAsync
in interface AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.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 AmazonChimeSDKMessagingAsync
public 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 AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeChannelBanResult> describeChannelBanAsync(DescribeChannelBanRequest request)
AmazonChimeSDKMessagingAsync
Returns the full details of a channel ban.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
describeChannelBanAsync
in interface AmazonChimeSDKMessagingAsync
public Future<DescribeChannelBanResult> describeChannelBanAsync(DescribeChannelBanRequest request, AsyncHandler<DescribeChannelBanRequest,DescribeChannelBanResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Returns the full details of a channel ban.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
describeChannelBanAsync
in interface AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeChannelMembershipResult> describeChannelMembershipAsync(DescribeChannelMembershipRequest request)
AmazonChimeSDKMessagingAsync
Returns the full details of a user's channel membership.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
describeChannelMembershipAsync
in interface AmazonChimeSDKMessagingAsync
public Future<DescribeChannelMembershipResult> describeChannelMembershipAsync(DescribeChannelMembershipRequest request, AsyncHandler<DescribeChannelMembershipRequest,DescribeChannelMembershipResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Returns the full details of a user's channel membership.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
describeChannelMembershipAsync
in interface AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.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 AmazonChimeSDKMessagingAsync
public 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 AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.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 AmazonChimeSDKMessagingAsync
public 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 AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeChannelModeratorResult> describeChannelModeratorAsync(DescribeChannelModeratorRequest request)
AmazonChimeSDKMessagingAsync
Returns the full details of a single ChannelModerator.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
describeChannelModeratorAsync
in interface AmazonChimeSDKMessagingAsync
public Future<DescribeChannelModeratorResult> describeChannelModeratorAsync(DescribeChannelModeratorRequest request, AsyncHandler<DescribeChannelModeratorRequest,DescribeChannelModeratorResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Returns the full details of a single ChannelModerator.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
describeChannelModeratorAsync
in interface AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetChannelMessageResult> getChannelMessageAsync(GetChannelMessageRequest request)
AmazonChimeSDKMessagingAsync
Gets the full details of a channel message.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn
of the user that
makes the API call as the value in the header.
getChannelMessageAsync
in interface AmazonChimeSDKMessagingAsync
public Future<GetChannelMessageResult> getChannelMessageAsync(GetChannelMessageRequest request, AsyncHandler<GetChannelMessageRequest,GetChannelMessageResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Gets the full details of a channel message.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn
of the user that
makes the API call as the value in the header.
getChannelMessageAsync
in interface AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetMessagingSessionEndpointResult> getMessagingSessionEndpointAsync(GetMessagingSessionEndpointRequest request)
AmazonChimeSDKMessagingAsync
The details of the endpoint for the messaging session.
getMessagingSessionEndpointAsync
in interface AmazonChimeSDKMessagingAsync
public Future<GetMessagingSessionEndpointResult> getMessagingSessionEndpointAsync(GetMessagingSessionEndpointRequest request, AsyncHandler<GetMessagingSessionEndpointRequest,GetMessagingSessionEndpointResult> asyncHandler)
AmazonChimeSDKMessagingAsync
The details of the endpoint for the messaging session.
getMessagingSessionEndpointAsync
in interface AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListChannelBansResult> listChannelBansAsync(ListChannelBansRequest request)
AmazonChimeSDKMessagingAsync
Lists all the users banned from a particular channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
listChannelBansAsync
in interface AmazonChimeSDKMessagingAsync
public Future<ListChannelBansResult> listChannelBansAsync(ListChannelBansRequest request, AsyncHandler<ListChannelBansRequest,ListChannelBansResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Lists all the users banned from a particular channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
listChannelBansAsync
in interface AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListChannelMembershipsResult> listChannelMembershipsAsync(ListChannelMembershipsRequest request)
AmazonChimeSDKMessagingAsync
Lists all channel memberships in a channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
listChannelMembershipsAsync
in interface AmazonChimeSDKMessagingAsync
public Future<ListChannelMembershipsResult> listChannelMembershipsAsync(ListChannelMembershipsRequest request, AsyncHandler<ListChannelMembershipsRequest,ListChannelMembershipsResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Lists all channel memberships in a channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
listChannelMembershipsAsync
in interface AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.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 AmazonChimeSDKMessagingAsync
public 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 AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.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 AmazonChimeSDKMessagingAsync
public 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 AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListChannelModeratorsResult> listChannelModeratorsAsync(ListChannelModeratorsRequest request)
AmazonChimeSDKMessagingAsync
Lists all the moderators for a channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
listChannelModeratorsAsync
in interface AmazonChimeSDKMessagingAsync
public Future<ListChannelModeratorsResult> listChannelModeratorsAsync(ListChannelModeratorsRequest request, AsyncHandler<ListChannelModeratorsRequest,ListChannelModeratorsResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Lists all the moderators for a channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
listChannelModeratorsAsync
in interface AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListChannelsResult> listChannelsAsync(ListChannelsRequest request)
AmazonChimeSDKMessagingAsync
Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
Use privacy = PUBLIC
to retrieve all public channels in the account.
Only an AppInstanceAdmin
can set privacy = PRIVATE
to list the private channels in an
account.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
listChannelsAsync
in interface AmazonChimeSDKMessagingAsync
public Future<ListChannelsResult> listChannelsAsync(ListChannelsRequest request, AsyncHandler<ListChannelsRequest,ListChannelsResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
Use privacy = PUBLIC
to retrieve all public channels in the account.
Only an AppInstanceAdmin
can set privacy = PRIVATE
to list the private channels in an
account.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
listChannelsAsync
in interface AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.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 AmazonChimeSDKMessagingAsync
public 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 AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RedactChannelMessageResult> redactChannelMessageAsync(RedactChannelMessageRequest request)
AmazonChimeSDKMessagingAsync
Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
redactChannelMessageAsync
in interface AmazonChimeSDKMessagingAsync
public Future<RedactChannelMessageResult> redactChannelMessageAsync(RedactChannelMessageRequest request, AsyncHandler<RedactChannelMessageRequest,RedactChannelMessageResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
redactChannelMessageAsync
in interface AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SendChannelMessageResult> sendChannelMessageAsync(SendChannelMessageRequest request)
AmazonChimeSDKMessagingAsync
Sends a message to a particular channel that the member is a part of.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
Also, STANDARD
messages can contain 4KB of data and the 1KB of metadata. CONTROL
messages can contain 30 bytes of data and no metadata.
sendChannelMessageAsync
in interface AmazonChimeSDKMessagingAsync
public Future<SendChannelMessageResult> sendChannelMessageAsync(SendChannelMessageRequest request, AsyncHandler<SendChannelMessageRequest,SendChannelMessageResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Sends a message to a particular channel that the member is a part of.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
Also, STANDARD
messages can contain 4KB of data and the 1KB of metadata. CONTROL
messages can contain 30 bytes of data and no metadata.
sendChannelMessageAsync
in interface AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateChannelResult> updateChannelAsync(UpdateChannelRequest request)
AmazonChimeSDKMessagingAsync
Update a channel's attributes.
Restriction: You can't change a channel's privacy.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
updateChannelAsync
in interface AmazonChimeSDKMessagingAsync
public Future<UpdateChannelResult> updateChannelAsync(UpdateChannelRequest request, AsyncHandler<UpdateChannelRequest,UpdateChannelResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Update a channel's attributes.
Restriction: You can't change a channel's privacy.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
updateChannelAsync
in interface AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateChannelMessageResult> updateChannelMessageAsync(UpdateChannelMessageRequest request)
AmazonChimeSDKMessagingAsync
Updates the content of a message.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
updateChannelMessageAsync
in interface AmazonChimeSDKMessagingAsync
public Future<UpdateChannelMessageResult> updateChannelMessageAsync(UpdateChannelMessageRequest request, AsyncHandler<UpdateChannelMessageRequest,UpdateChannelMessageResult> asyncHandler)
AmazonChimeSDKMessagingAsync
Updates the content of a message.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
updateChannelMessageAsync
in interface AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateChannelReadMarkerResult> updateChannelReadMarkerAsync(UpdateChannelReadMarkerRequest request)
AmazonChimeSDKMessagingAsync
The details of the time when a user last read messages in a channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
updateChannelReadMarkerAsync
in interface AmazonChimeSDKMessagingAsync
public Future<UpdateChannelReadMarkerResult> updateChannelReadMarkerAsync(UpdateChannelReadMarkerRequest request, AsyncHandler<UpdateChannelReadMarkerRequest,UpdateChannelReadMarkerResult> asyncHandler)
AmazonChimeSDKMessagingAsync
The details of the time when a user last read messages in a channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
updateChannelReadMarkerAsync
in interface AmazonChimeSDKMessagingAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.