@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface ChimeSdkMessagingAsyncClient extends SdkClient
builder() method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<AssociateChannelFlowResponse> associateChannelFlow(AssociateChannelFlowRequest associateChannelFlowRequest)
Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow
processors. To stop processing, use the DisassociateChannelFlow API.
Only administrators or channel moderators can associate a channel flow. The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the
value in the header.
associateChannelFlowRequest - default CompletableFuture<AssociateChannelFlowResponse> associateChannelFlow(Consumer<AssociateChannelFlowRequest.Builder> associateChannelFlowRequest)
Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow
processors. To stop processing, use the DisassociateChannelFlow API.
Only administrators or channel moderators can associate a channel flow. The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the
value in the header.
This is a convenience which creates an instance of the AssociateChannelFlowRequest.Builder avoiding the
need to create one manually via AssociateChannelFlowRequest.builder()
associateChannelFlowRequest - A Consumer that will call methods on AssociateChannelFlowRequest.Builder to create a
request.default CompletableFuture<BatchCreateChannelMembershipResponse> batchCreateChannelMembership(BatchCreateChannelMembershipRequest batchCreateChannelMembershipRequest)
Adds a specified number of users to a channel.
batchCreateChannelMembershipRequest - default CompletableFuture<BatchCreateChannelMembershipResponse> batchCreateChannelMembership(Consumer<BatchCreateChannelMembershipRequest.Builder> batchCreateChannelMembershipRequest)
Adds a specified number of users to a channel.
This is a convenience which creates an instance of the BatchCreateChannelMembershipRequest.Builder
avoiding the need to create one manually via BatchCreateChannelMembershipRequest.builder()
batchCreateChannelMembershipRequest - A Consumer that will call methods on BatchCreateChannelMembershipRequest.Builder to create
a request.default CompletableFuture<ChannelFlowCallbackResponse> channelFlowCallback(ChannelFlowCallbackRequest channelFlowCallbackRequest)
Calls back Chime SDK Messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.
You can return one of the following processing responses:
Update message content or metadata
Deny a message
Make no changes to the message
channelFlowCallbackRequest - default CompletableFuture<ChannelFlowCallbackResponse> channelFlowCallback(Consumer<ChannelFlowCallbackRequest.Builder> channelFlowCallbackRequest)
Calls back Chime SDK Messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.
You can return one of the following processing responses:
Update message content or metadata
Deny a message
Make no changes to the message
This is a convenience which creates an instance of the ChannelFlowCallbackRequest.Builder avoiding the
need to create one manually via ChannelFlowCallbackRequest.builder()
channelFlowCallbackRequest - A Consumer that will call methods on ChannelFlowCallbackRequest.Builder to create a
request.default CompletableFuture<CreateChannelResponse> createChannel(CreateChannelRequest createChannelRequest)
Creates a channel to which you can add users and send messages.
Restriction: You can't change a channel's privacy.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
createChannelRequest - default CompletableFuture<CreateChannelResponse> createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest)
Creates a channel to which you can add users and send messages.
Restriction: You can't change a channel's privacy.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the CreateChannelRequest.Builder avoiding the need to
create one manually via CreateChannelRequest.builder()
createChannelRequest - A Consumer that will call methods on CreateChannelRequest.Builder to create a request.default CompletableFuture<CreateChannelBanResponse> createChannelBan(CreateChannelBanRequest createChannelBanRequest)
Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you
first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up
when you delete users or channels.
If you ban a user who is already part of a channel, that user is automatically kicked from the channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
createChannelBanRequest - default CompletableFuture<CreateChannelBanResponse> createChannelBan(Consumer<CreateChannelBanRequest.Builder> createChannelBanRequest)
Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you
first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up
when you delete users or channels.
If you ban a user who is already part of a channel, that user is automatically kicked from the channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the CreateChannelBanRequest.Builder avoiding the need
to create one manually via CreateChannelBanRequest.builder()
createChannelBanRequest - A Consumer that will call methods on CreateChannelBanRequest.Builder to create a request.default CompletableFuture<CreateChannelFlowResponse> createChannelFlow(CreateChannelFlowRequest createChannelFlowRequest)
Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API.
Channel flows process the following items:
New and updated messages
Persistent and non-persistent messages
The Standard message type
Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK Messaging, refer to Message types in the Amazon Chime developer guide.
createChannelFlowRequest - default CompletableFuture<CreateChannelFlowResponse> createChannelFlow(Consumer<CreateChannelFlowRequest.Builder> createChannelFlowRequest)
Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API.
Channel flows process the following items:
New and updated messages
Persistent and non-persistent messages
The Standard message type
Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK Messaging, refer to Message types in the Amazon Chime developer guide.
This is a convenience which creates an instance of the CreateChannelFlowRequest.Builder avoiding the need
to create one manually via CreateChannelFlowRequest.builder()
createChannelFlowRequest - A Consumer that will call methods on CreateChannelFlowRequest.Builder to create a request.default CompletableFuture<CreateChannelMembershipResponse> createChannelMembership(CreateChannelMembershipRequest createChannelMembershipRequest)
Adds a user to a channel. The InvitedBy field in ChannelMembership is derived from the
request header. A channel member can:
List messages
Send messages
Receive messages
Edit their own messages
Leave the channel
Privacy settings impact this action as follows:
Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.
Private Channels: You must be a member to list or send messages.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
createChannelMembershipRequest - default CompletableFuture<CreateChannelMembershipResponse> createChannelMembership(Consumer<CreateChannelMembershipRequest.Builder> createChannelMembershipRequest)
Adds a user to a channel. The InvitedBy field in ChannelMembership is derived from the
request header. A channel member can:
List messages
Send messages
Receive messages
Edit their own messages
Leave the channel
Privacy settings impact this action as follows:
Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.
Private Channels: You must be a member to list or send messages.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the CreateChannelMembershipRequest.Builder avoiding
the need to create one manually via CreateChannelMembershipRequest.builder()
createChannelMembershipRequest - A Consumer that will call methods on CreateChannelMembershipRequest.Builder to create a
request.default CompletableFuture<CreateChannelModeratorResponse> createChannelModerator(CreateChannelModeratorRequest createChannelModeratorRequest)
Creates a new ChannelModerator. A channel moderator can:
Add and remove other members of the channel.
Add and remove other moderators of the channel.
Add and remove user bans for the channel.
Redact messages in the channel.
List messages in the channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
createChannelModeratorRequest - default CompletableFuture<CreateChannelModeratorResponse> createChannelModerator(Consumer<CreateChannelModeratorRequest.Builder> createChannelModeratorRequest)
Creates a new ChannelModerator. A channel moderator can:
Add and remove other members of the channel.
Add and remove other moderators of the channel.
Add and remove user bans for the channel.
Redact messages in the channel.
List messages in the channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the CreateChannelModeratorRequest.Builder avoiding the
need to create one manually via CreateChannelModeratorRequest.builder()
createChannelModeratorRequest - A Consumer that will call methods on CreateChannelModeratorRequest.Builder to create a
request.default CompletableFuture<DeleteChannelResponse> deleteChannel(DeleteChannelRequest deleteChannelRequest)
Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
deleteChannelRequest - default CompletableFuture<DeleteChannelResponse> deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest)
Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the DeleteChannelRequest.Builder avoiding the need to
create one manually via DeleteChannelRequest.builder()
deleteChannelRequest - A Consumer that will call methods on DeleteChannelRequest.Builder to create a request.default CompletableFuture<DeleteChannelBanResponse> deleteChannelBan(DeleteChannelBanRequest deleteChannelBanRequest)
Removes a user from a channel's ban list.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
deleteChannelBanRequest - default CompletableFuture<DeleteChannelBanResponse> deleteChannelBan(Consumer<DeleteChannelBanRequest.Builder> deleteChannelBanRequest)
Removes a user from a channel's ban list.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the DeleteChannelBanRequest.Builder avoiding the need
to create one manually via DeleteChannelBanRequest.builder()
deleteChannelBanRequest - A Consumer that will call methods on DeleteChannelBanRequest.Builder to create a request.default CompletableFuture<DeleteChannelFlowResponse> deleteChannelFlow(DeleteChannelFlowRequest deleteChannelFlowRequest)
Deletes a channel flow, an irreversible process. This is a developer API.
This API works only when the channel flow is not associated with any channel. To get a list of all channels that
a channel flow is associated with, use the ListChannelsAssociatedWithChannelFlow API. Use the
DisassociateChannelFlow API to disassociate a channel flow from all channels.
deleteChannelFlowRequest - default CompletableFuture<DeleteChannelFlowResponse> deleteChannelFlow(Consumer<DeleteChannelFlowRequest.Builder> deleteChannelFlowRequest)
Deletes a channel flow, an irreversible process. This is a developer API.
This API works only when the channel flow is not associated with any channel. To get a list of all channels that
a channel flow is associated with, use the ListChannelsAssociatedWithChannelFlow API. Use the
DisassociateChannelFlow API to disassociate a channel flow from all channels.
This is a convenience which creates an instance of the DeleteChannelFlowRequest.Builder avoiding the need
to create one manually via DeleteChannelFlowRequest.builder()
deleteChannelFlowRequest - A Consumer that will call methods on DeleteChannelFlowRequest.Builder to create a request.default CompletableFuture<DeleteChannelMembershipResponse> deleteChannelMembership(DeleteChannelMembershipRequest deleteChannelMembershipRequest)
Removes a member from a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
deleteChannelMembershipRequest - default CompletableFuture<DeleteChannelMembershipResponse> deleteChannelMembership(Consumer<DeleteChannelMembershipRequest.Builder> deleteChannelMembershipRequest)
Removes a member from a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the DeleteChannelMembershipRequest.Builder avoiding
the need to create one manually via DeleteChannelMembershipRequest.builder()
deleteChannelMembershipRequest - A Consumer that will call methods on DeleteChannelMembershipRequest.Builder to create a
request.default CompletableFuture<DeleteChannelMessageResponse> deleteChannelMessage(DeleteChannelMessageRequest deleteChannelMessageRequest)
Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately.
A background process deletes any revisions created by UpdateChannelMessage.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
deleteChannelMessageRequest - default CompletableFuture<DeleteChannelMessageResponse> deleteChannelMessage(Consumer<DeleteChannelMessageRequest.Builder> deleteChannelMessageRequest)
Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately.
A background process deletes any revisions created by UpdateChannelMessage.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the DeleteChannelMessageRequest.Builder avoiding the
need to create one manually via DeleteChannelMessageRequest.builder()
deleteChannelMessageRequest - A Consumer that will call methods on DeleteChannelMessageRequest.Builder to create a
request.default CompletableFuture<DeleteChannelModeratorResponse> deleteChannelModerator(DeleteChannelModeratorRequest deleteChannelModeratorRequest)
Deletes a channel moderator.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
deleteChannelModeratorRequest - default CompletableFuture<DeleteChannelModeratorResponse> deleteChannelModerator(Consumer<DeleteChannelModeratorRequest.Builder> deleteChannelModeratorRequest)
Deletes a channel moderator.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the DeleteChannelModeratorRequest.Builder avoiding the
need to create one manually via DeleteChannelModeratorRequest.builder()
deleteChannelModeratorRequest - A Consumer that will call methods on DeleteChannelModeratorRequest.Builder to create a
request.default CompletableFuture<DescribeChannelResponse> describeChannel(DescribeChannelRequest describeChannelRequest)
Returns the full details of a channel in an Amazon Chime AppInstance.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
describeChannelRequest - default CompletableFuture<DescribeChannelResponse> describeChannel(Consumer<DescribeChannelRequest.Builder> describeChannelRequest)
Returns the full details of a channel in an Amazon Chime AppInstance.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the DescribeChannelRequest.Builder avoiding the need
to create one manually via DescribeChannelRequest.builder()
describeChannelRequest - A Consumer that will call methods on DescribeChannelRequest.Builder to create a request.default CompletableFuture<DescribeChannelBanResponse> describeChannelBan(DescribeChannelBanRequest describeChannelBanRequest)
Returns the full details of a channel ban.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
describeChannelBanRequest - default CompletableFuture<DescribeChannelBanResponse> describeChannelBan(Consumer<DescribeChannelBanRequest.Builder> describeChannelBanRequest)
Returns the full details of a channel ban.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the DescribeChannelBanRequest.Builder avoiding the
need to create one manually via DescribeChannelBanRequest.builder()
describeChannelBanRequest - A Consumer that will call methods on DescribeChannelBanRequest.Builder to create a
request.default CompletableFuture<DescribeChannelFlowResponse> describeChannelFlow(DescribeChannelFlowRequest describeChannelFlowRequest)
Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.
describeChannelFlowRequest - default CompletableFuture<DescribeChannelFlowResponse> describeChannelFlow(Consumer<DescribeChannelFlowRequest.Builder> describeChannelFlowRequest)
Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.
This is a convenience which creates an instance of the DescribeChannelFlowRequest.Builder avoiding the
need to create one manually via DescribeChannelFlowRequest.builder()
describeChannelFlowRequest - A Consumer that will call methods on DescribeChannelFlowRequest.Builder to create a
request.default CompletableFuture<DescribeChannelMembershipResponse> describeChannelMembership(DescribeChannelMembershipRequest describeChannelMembershipRequest)
Returns the full details of a user's channel membership.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
describeChannelMembershipRequest - default CompletableFuture<DescribeChannelMembershipResponse> describeChannelMembership(Consumer<DescribeChannelMembershipRequest.Builder> describeChannelMembershipRequest)
Returns the full details of a user's channel membership.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the DescribeChannelMembershipRequest.Builder avoiding
the need to create one manually via DescribeChannelMembershipRequest.builder()
describeChannelMembershipRequest - A Consumer that will call methods on DescribeChannelMembershipRequest.Builder to create a
request.default CompletableFuture<DescribeChannelMembershipForAppInstanceUserResponse> describeChannelMembershipForAppInstanceUser(DescribeChannelMembershipForAppInstanceUserRequest describeChannelMembershipForAppInstanceUserRequest)
Returns the details of a channel based on the membership of the specified AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
describeChannelMembershipForAppInstanceUserRequest - default CompletableFuture<DescribeChannelMembershipForAppInstanceUserResponse> describeChannelMembershipForAppInstanceUser(Consumer<DescribeChannelMembershipForAppInstanceUserRequest.Builder> describeChannelMembershipForAppInstanceUserRequest)
Returns the details of a channel based on the membership of the specified AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the
DescribeChannelMembershipForAppInstanceUserRequest.Builder avoiding the need to create one manually via
DescribeChannelMembershipForAppInstanceUserRequest.builder()
describeChannelMembershipForAppInstanceUserRequest - A Consumer that will call methods on
DescribeChannelMembershipForAppInstanceUserRequest.Builder to create a request.default CompletableFuture<DescribeChannelModeratedByAppInstanceUserResponse> describeChannelModeratedByAppInstanceUser(DescribeChannelModeratedByAppInstanceUserRequest describeChannelModeratedByAppInstanceUserRequest)
Returns the full details of a channel moderated by the specified AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
describeChannelModeratedByAppInstanceUserRequest - default CompletableFuture<DescribeChannelModeratedByAppInstanceUserResponse> describeChannelModeratedByAppInstanceUser(Consumer<DescribeChannelModeratedByAppInstanceUserRequest.Builder> describeChannelModeratedByAppInstanceUserRequest)
Returns the full details of a channel moderated by the specified AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the
DescribeChannelModeratedByAppInstanceUserRequest.Builder avoiding the need to create one manually via
DescribeChannelModeratedByAppInstanceUserRequest.builder()
describeChannelModeratedByAppInstanceUserRequest - A Consumer that will call methods on
DescribeChannelModeratedByAppInstanceUserRequest.Builder to create a request.default CompletableFuture<DescribeChannelModeratorResponse> describeChannelModerator(DescribeChannelModeratorRequest describeChannelModeratorRequest)
Returns the full details of a single ChannelModerator.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
describeChannelModeratorRequest - default CompletableFuture<DescribeChannelModeratorResponse> describeChannelModerator(Consumer<DescribeChannelModeratorRequest.Builder> describeChannelModeratorRequest)
Returns the full details of a single ChannelModerator.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the DescribeChannelModeratorRequest.Builder avoiding
the need to create one manually via DescribeChannelModeratorRequest.builder()
describeChannelModeratorRequest - A Consumer that will call methods on DescribeChannelModeratorRequest.Builder to create a
request.default CompletableFuture<DisassociateChannelFlowResponse> disassociateChannelFlow(DisassociateChannelFlowRequest disassociateChannelFlowRequest)
Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor.
Only administrators or channel moderators can disassociate a channel flow. The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the
value in the header.
disassociateChannelFlowRequest - default CompletableFuture<DisassociateChannelFlowResponse> disassociateChannelFlow(Consumer<DisassociateChannelFlowRequest.Builder> disassociateChannelFlowRequest)
Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor.
Only administrators or channel moderators can disassociate a channel flow. The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the
value in the header.
This is a convenience which creates an instance of the DisassociateChannelFlowRequest.Builder avoiding
the need to create one manually via DisassociateChannelFlowRequest.builder()
disassociateChannelFlowRequest - A Consumer that will call methods on DisassociateChannelFlowRequest.Builder to create a
request.default CompletableFuture<GetChannelMembershipPreferencesResponse> getChannelMembershipPreferences(GetChannelMembershipPreferencesRequest getChannelMembershipPreferencesRequest)
Gets the membership preferences of an AppInstanceUser for the specified channel. The
AppInstanceUser must be a member of the channel. Only the AppInstanceUser who owns the
membership can retrieve preferences. Users in the AppInstanceAdmin and channel moderator roles can't
retrieve preferences for other users. Banned users can't retrieve membership preferences for the channel from
which they are banned.
getChannelMembershipPreferencesRequest - default CompletableFuture<GetChannelMembershipPreferencesResponse> getChannelMembershipPreferences(Consumer<GetChannelMembershipPreferencesRequest.Builder> getChannelMembershipPreferencesRequest)
Gets the membership preferences of an AppInstanceUser for the specified channel. The
AppInstanceUser must be a member of the channel. Only the AppInstanceUser who owns the
membership can retrieve preferences. Users in the AppInstanceAdmin and channel moderator roles can't
retrieve preferences for other users. Banned users can't retrieve membership preferences for the channel from
which they are banned.
This is a convenience which creates an instance of the GetChannelMembershipPreferencesRequest.Builder
avoiding the need to create one manually via GetChannelMembershipPreferencesRequest.builder()
getChannelMembershipPreferencesRequest - A Consumer that will call methods on GetChannelMembershipPreferencesRequest.Builder to
create a request.default CompletableFuture<GetChannelMessageResponse> getChannelMessage(GetChannelMessageRequest getChannelMessageRequest)
Gets the full details of a channel message.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that
makes the API call as the value in the header.
getChannelMessageRequest - default CompletableFuture<GetChannelMessageResponse> getChannelMessage(Consumer<GetChannelMessageRequest.Builder> getChannelMessageRequest)
Gets the full details of a channel message.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that
makes the API call as the value in the header.
This is a convenience which creates an instance of the GetChannelMessageRequest.Builder avoiding the need
to create one manually via GetChannelMessageRequest.builder()
getChannelMessageRequest - A Consumer that will call methods on GetChannelMessageRequest.Builder to create a request.default CompletableFuture<GetChannelMessageStatusResponse> getChannelMessageStatus(GetChannelMessageStatusRequest getChannelMessageStatusRequest)
Gets message status for a specified messageId. Use this API to determine the intermediate status of
messages going through channel flow processing. The API provides an alternative to retrieving message status if
the event was not received because a client wasn't connected to a websocket.
Messages can have any one of these statuses.
Message processed successfully
Ongoing processing
Processing failed
Messasge denied by the processor
This API does not return statuses for denied messages, because we don't store them once the processor denies them.
Only the message sender can invoke this API.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header
getChannelMessageStatusRequest - default CompletableFuture<GetChannelMessageStatusResponse> getChannelMessageStatus(Consumer<GetChannelMessageStatusRequest.Builder> getChannelMessageStatusRequest)
Gets message status for a specified messageId. Use this API to determine the intermediate status of
messages going through channel flow processing. The API provides an alternative to retrieving message status if
the event was not received because a client wasn't connected to a websocket.
Messages can have any one of these statuses.
Message processed successfully
Ongoing processing
Processing failed
Messasge denied by the processor
This API does not return statuses for denied messages, because we don't store them once the processor denies them.
Only the message sender can invoke this API.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header
This is a convenience which creates an instance of the GetChannelMessageStatusRequest.Builder avoiding
the need to create one manually via GetChannelMessageStatusRequest.builder()
getChannelMessageStatusRequest - A Consumer that will call methods on GetChannelMessageStatusRequest.Builder to create a
request.default CompletableFuture<GetMessagingSessionEndpointResponse> getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest getMessagingSessionEndpointRequest)
The details of the endpoint for the messaging session.
getMessagingSessionEndpointRequest - default CompletableFuture<GetMessagingSessionEndpointResponse> getMessagingSessionEndpoint(Consumer<GetMessagingSessionEndpointRequest.Builder> getMessagingSessionEndpointRequest)
The details of the endpoint for the messaging session.
This is a convenience which creates an instance of the GetMessagingSessionEndpointRequest.Builder
avoiding the need to create one manually via GetMessagingSessionEndpointRequest.builder()
getMessagingSessionEndpointRequest - A Consumer that will call methods on GetMessagingSessionEndpointRequest.Builder to create
a request.default CompletableFuture<ListChannelBansResponse> listChannelBans(ListChannelBansRequest listChannelBansRequest)
Lists all the users banned from a particular channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannelBansRequest - default CompletableFuture<ListChannelBansResponse> listChannelBans(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest)
Lists all the users banned from a particular channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the ListChannelBansRequest.Builder avoiding the need
to create one manually via ListChannelBansRequest.builder()
listChannelBansRequest - A Consumer that will call methods on ListChannelBansRequest.Builder to create a request.default ListChannelBansPublisher listChannelBansPaginator(ListChannelBansRequest listChannelBansRequest)
Lists all the users banned from a particular channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a variant of
listChannelBans(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelBansPublisher publisher = client.listChannelBansPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelBansPublisher publisher = client.listChannelBansPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelBans(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansRequest)
operation.
listChannelBansRequest - default ListChannelBansPublisher listChannelBansPaginator(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest)
Lists all the users banned from a particular channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a variant of
listChannelBans(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelBansPublisher publisher = client.listChannelBansPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelBansPublisher publisher = client.listChannelBansPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelBans(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansRequest)
operation.
This is a convenience which creates an instance of the ListChannelBansRequest.Builder avoiding the need
to create one manually via ListChannelBansRequest.builder()
listChannelBansRequest - A Consumer that will call methods on ListChannelBansRequest.Builder to create a request.default CompletableFuture<ListChannelFlowsResponse> listChannelFlows(ListChannelFlowsRequest listChannelFlowsRequest)
Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.
listChannelFlowsRequest - default CompletableFuture<ListChannelFlowsResponse> listChannelFlows(Consumer<ListChannelFlowsRequest.Builder> listChannelFlowsRequest)
Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.
This is a convenience which creates an instance of the ListChannelFlowsRequest.Builder avoiding the need
to create one manually via ListChannelFlowsRequest.builder()
listChannelFlowsRequest - A Consumer that will call methods on ListChannelFlowsRequest.Builder to create a request.default ListChannelFlowsPublisher listChannelFlowsPaginator(ListChannelFlowsRequest listChannelFlowsRequest)
Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.
This is a variant of
listChannelFlows(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelFlowsPublisher publisher = client.listChannelFlowsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelFlowsPublisher publisher = client.listChannelFlowsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelFlows(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsRequest)
operation.
listChannelFlowsRequest - default ListChannelFlowsPublisher listChannelFlowsPaginator(Consumer<ListChannelFlowsRequest.Builder> listChannelFlowsRequest)
Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.
This is a variant of
listChannelFlows(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelFlowsPublisher publisher = client.listChannelFlowsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelFlowsPublisher publisher = client.listChannelFlowsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelFlows(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsRequest)
operation.
This is a convenience which creates an instance of the ListChannelFlowsRequest.Builder avoiding the need
to create one manually via ListChannelFlowsRequest.builder()
listChannelFlowsRequest - A Consumer that will call methods on ListChannelFlowsRequest.Builder to create a request.default CompletableFuture<ListChannelMembershipsResponse> listChannelMemberships(ListChannelMembershipsRequest listChannelMembershipsRequest)
Lists all channel memberships in a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.
listChannelMembershipsRequest - default CompletableFuture<ListChannelMembershipsResponse> listChannelMemberships(Consumer<ListChannelMembershipsRequest.Builder> listChannelMembershipsRequest)
Lists all channel memberships in a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.
This is a convenience which creates an instance of the ListChannelMembershipsRequest.Builder avoiding the
need to create one manually via ListChannelMembershipsRequest.builder()
listChannelMembershipsRequest - A Consumer that will call methods on ListChannelMembershipsRequest.Builder to create a
request.default CompletableFuture<ListChannelMembershipsForAppInstanceUserResponse> listChannelMembershipsForAppInstanceUser(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest)
Lists all channels that a particular AppInstanceUser is a part of. Only an
AppInstanceAdmin can call the API with a user ARN that is not their own.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannelMembershipsForAppInstanceUserRequest - default CompletableFuture<ListChannelMembershipsForAppInstanceUserResponse> listChannelMembershipsForAppInstanceUser(Consumer<ListChannelMembershipsForAppInstanceUserRequest.Builder> listChannelMembershipsForAppInstanceUserRequest)
Lists all channels that a particular AppInstanceUser is a part of. Only an
AppInstanceAdmin can call the API with a user ARN that is not their own.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the
ListChannelMembershipsForAppInstanceUserRequest.Builder avoiding the need to create one manually via
ListChannelMembershipsForAppInstanceUserRequest.builder()
listChannelMembershipsForAppInstanceUserRequest - A Consumer that will call methods on
ListChannelMembershipsForAppInstanceUserRequest.Builder to create a request.default ListChannelMembershipsForAppInstanceUserPublisher listChannelMembershipsForAppInstanceUserPaginator(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest)
Lists all channels that a particular AppInstanceUser is a part of. Only an
AppInstanceAdmin can call the API with a user ARN that is not their own.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a variant of
listChannelMembershipsForAppInstanceUser(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsForAppInstanceUserRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsForAppInstanceUserPublisher publisher = client.listChannelMembershipsForAppInstanceUserPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsForAppInstanceUserPublisher publisher = client.listChannelMembershipsForAppInstanceUserPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsForAppInstanceUserResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsForAppInstanceUserResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelMembershipsForAppInstanceUser(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsForAppInstanceUserRequest)
operation.
listChannelMembershipsForAppInstanceUserRequest - default ListChannelMembershipsForAppInstanceUserPublisher listChannelMembershipsForAppInstanceUserPaginator(Consumer<ListChannelMembershipsForAppInstanceUserRequest.Builder> listChannelMembershipsForAppInstanceUserRequest)
Lists all channels that a particular AppInstanceUser is a part of. Only an
AppInstanceAdmin can call the API with a user ARN that is not their own.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a variant of
listChannelMembershipsForAppInstanceUser(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsForAppInstanceUserRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsForAppInstanceUserPublisher publisher = client.listChannelMembershipsForAppInstanceUserPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsForAppInstanceUserPublisher publisher = client.listChannelMembershipsForAppInstanceUserPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsForAppInstanceUserResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsForAppInstanceUserResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelMembershipsForAppInstanceUser(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsForAppInstanceUserRequest)
operation.
This is a convenience which creates an instance of the
ListChannelMembershipsForAppInstanceUserRequest.Builder avoiding the need to create one manually via
ListChannelMembershipsForAppInstanceUserRequest.builder()
listChannelMembershipsForAppInstanceUserRequest - A Consumer that will call methods on
ListChannelMembershipsForAppInstanceUserRequest.Builder to create a request.default ListChannelMembershipsPublisher listChannelMembershipsPaginator(ListChannelMembershipsRequest listChannelMembershipsRequest)
Lists all channel memberships in a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.
This is a variant of
listChannelMemberships(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsPublisher publisher = client.listChannelMembershipsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsPublisher publisher = client.listChannelMembershipsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelMemberships(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsRequest)
operation.
listChannelMembershipsRequest - default ListChannelMembershipsPublisher listChannelMembershipsPaginator(Consumer<ListChannelMembershipsRequest.Builder> listChannelMembershipsRequest)
Lists all channel memberships in a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.
This is a variant of
listChannelMemberships(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsPublisher publisher = client.listChannelMembershipsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsPublisher publisher = client.listChannelMembershipsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelMemberships(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsRequest)
operation.
This is a convenience which creates an instance of the ListChannelMembershipsRequest.Builder avoiding the
need to create one manually via ListChannelMembershipsRequest.builder()
listChannelMembershipsRequest - A Consumer that will call methods on ListChannelMembershipsRequest.Builder to create a
request.default CompletableFuture<ListChannelMessagesResponse> listChannelMessages(ListChannelMessagesRequest listChannelMessagesRequest)
List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted
by creation timestamp in descending order.
Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.
Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user
that makes the API call as the value in the header.
listChannelMessagesRequest - default CompletableFuture<ListChannelMessagesResponse> listChannelMessages(Consumer<ListChannelMessagesRequest.Builder> listChannelMessagesRequest)
List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted
by creation timestamp in descending order.
Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.
Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user
that makes the API call as the value in the header.
This is a convenience which creates an instance of the ListChannelMessagesRequest.Builder avoiding the
need to create one manually via ListChannelMessagesRequest.builder()
listChannelMessagesRequest - A Consumer that will call methods on ListChannelMessagesRequest.Builder to create a
request.default ListChannelMessagesPublisher listChannelMessagesPaginator(ListChannelMessagesRequest listChannelMessagesRequest)
List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted
by creation timestamp in descending order.
Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.
Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user
that makes the API call as the value in the header.
This is a variant of
listChannelMessages(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMessagesPublisher publisher = client.listChannelMessagesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMessagesPublisher publisher = client.listChannelMessagesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelMessages(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesRequest)
operation.
listChannelMessagesRequest - default ListChannelMessagesPublisher listChannelMessagesPaginator(Consumer<ListChannelMessagesRequest.Builder> listChannelMessagesRequest)
List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted
by creation timestamp in descending order.
Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.
Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user
that makes the API call as the value in the header.
This is a variant of
listChannelMessages(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMessagesPublisher publisher = client.listChannelMessagesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMessagesPublisher publisher = client.listChannelMessagesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelMessages(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesRequest)
operation.
This is a convenience which creates an instance of the ListChannelMessagesRequest.Builder avoiding the
need to create one manually via ListChannelMessagesRequest.builder()
listChannelMessagesRequest - A Consumer that will call methods on ListChannelMessagesRequest.Builder to create a
request.default CompletableFuture<ListChannelModeratorsResponse> listChannelModerators(ListChannelModeratorsRequest listChannelModeratorsRequest)
Lists all the moderators for a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannelModeratorsRequest - default CompletableFuture<ListChannelModeratorsResponse> listChannelModerators(Consumer<ListChannelModeratorsRequest.Builder> listChannelModeratorsRequest)
Lists all the moderators for a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the ListChannelModeratorsRequest.Builder avoiding the
need to create one manually via ListChannelModeratorsRequest.builder()
listChannelModeratorsRequest - A Consumer that will call methods on ListChannelModeratorsRequest.Builder to create a
request.default ListChannelModeratorsPublisher listChannelModeratorsPaginator(ListChannelModeratorsRequest listChannelModeratorsRequest)
Lists all the moderators for a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a variant of
listChannelModerators(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelModeratorsPublisher publisher = client.listChannelModeratorsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelModeratorsPublisher publisher = client.listChannelModeratorsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelModerators(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsRequest)
operation.
listChannelModeratorsRequest - default ListChannelModeratorsPublisher listChannelModeratorsPaginator(Consumer<ListChannelModeratorsRequest.Builder> listChannelModeratorsRequest)
Lists all the moderators for a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a variant of
listChannelModerators(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelModeratorsPublisher publisher = client.listChannelModeratorsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelModeratorsPublisher publisher = client.listChannelModeratorsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelModerators(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsRequest)
operation.
This is a convenience which creates an instance of the ListChannelModeratorsRequest.Builder avoiding the
need to create one manually via ListChannelModeratorsRequest.builder()
listChannelModeratorsRequest - A Consumer that will call methods on ListChannelModeratorsRequest.Builder to create a
request.default CompletableFuture<ListChannelsResponse> listChannels(ListChannelsRequest listChannelsRequest)
Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
Use privacy = PUBLIC to retrieve all public channels in the account.
Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an
account.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannelsRequest - default CompletableFuture<ListChannelsResponse> listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
Use privacy = PUBLIC to retrieve all public channels in the account.
Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an
account.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the ListChannelsRequest.Builder avoiding the need to
create one manually via ListChannelsRequest.builder()
listChannelsRequest - A Consumer that will call methods on ListChannelsRequest.Builder to create a request.default CompletableFuture<ListChannelsAssociatedWithChannelFlowResponse> listChannelsAssociatedWithChannelFlow(ListChannelsAssociatedWithChannelFlowRequest listChannelsAssociatedWithChannelFlowRequest)
Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.
listChannelsAssociatedWithChannelFlowRequest - default CompletableFuture<ListChannelsAssociatedWithChannelFlowResponse> listChannelsAssociatedWithChannelFlow(Consumer<ListChannelsAssociatedWithChannelFlowRequest.Builder> listChannelsAssociatedWithChannelFlowRequest)
Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.
This is a convenience which creates an instance of the
ListChannelsAssociatedWithChannelFlowRequest.Builder avoiding the need to create one manually via
ListChannelsAssociatedWithChannelFlowRequest.builder()
listChannelsAssociatedWithChannelFlowRequest - A Consumer that will call methods on ListChannelsAssociatedWithChannelFlowRequest.Builder
to create a request.default ListChannelsAssociatedWithChannelFlowPublisher listChannelsAssociatedWithChannelFlowPaginator(ListChannelsAssociatedWithChannelFlowRequest listChannelsAssociatedWithChannelFlowRequest)
Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.
This is a variant of
listChannelsAssociatedWithChannelFlow(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsAssociatedWithChannelFlowRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsAssociatedWithChannelFlowPublisher publisher = client.listChannelsAssociatedWithChannelFlowPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsAssociatedWithChannelFlowPublisher publisher = client.listChannelsAssociatedWithChannelFlowPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsAssociatedWithChannelFlowResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsAssociatedWithChannelFlowResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelsAssociatedWithChannelFlow(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsAssociatedWithChannelFlowRequest)
operation.
listChannelsAssociatedWithChannelFlowRequest - default ListChannelsAssociatedWithChannelFlowPublisher listChannelsAssociatedWithChannelFlowPaginator(Consumer<ListChannelsAssociatedWithChannelFlowRequest.Builder> listChannelsAssociatedWithChannelFlowRequest)
Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.
This is a variant of
listChannelsAssociatedWithChannelFlow(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsAssociatedWithChannelFlowRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsAssociatedWithChannelFlowPublisher publisher = client.listChannelsAssociatedWithChannelFlowPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsAssociatedWithChannelFlowPublisher publisher = client.listChannelsAssociatedWithChannelFlowPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsAssociatedWithChannelFlowResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsAssociatedWithChannelFlowResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelsAssociatedWithChannelFlow(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsAssociatedWithChannelFlowRequest)
operation.
This is a convenience which creates an instance of the
ListChannelsAssociatedWithChannelFlowRequest.Builder avoiding the need to create one manually via
ListChannelsAssociatedWithChannelFlowRequest.builder()
listChannelsAssociatedWithChannelFlowRequest - A Consumer that will call methods on ListChannelsAssociatedWithChannelFlowRequest.Builder
to create a request.default CompletableFuture<ListChannelsModeratedByAppInstanceUserResponse> listChannelsModeratedByAppInstanceUser(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest)
A list of the channels moderated by an AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannelsModeratedByAppInstanceUserRequest - default CompletableFuture<ListChannelsModeratedByAppInstanceUserResponse> listChannelsModeratedByAppInstanceUser(Consumer<ListChannelsModeratedByAppInstanceUserRequest.Builder> listChannelsModeratedByAppInstanceUserRequest)
A list of the channels moderated by an AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the
ListChannelsModeratedByAppInstanceUserRequest.Builder avoiding the need to create one manually via
ListChannelsModeratedByAppInstanceUserRequest.builder()
listChannelsModeratedByAppInstanceUserRequest - A Consumer that will call methods on ListChannelsModeratedByAppInstanceUserRequest.Builder
to create a request.default ListChannelsModeratedByAppInstanceUserPublisher listChannelsModeratedByAppInstanceUserPaginator(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest)
A list of the channels moderated by an AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a variant of
listChannelsModeratedByAppInstanceUser(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsModeratedByAppInstanceUserRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsModeratedByAppInstanceUserPublisher publisher = client.listChannelsModeratedByAppInstanceUserPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsModeratedByAppInstanceUserPublisher publisher = client.listChannelsModeratedByAppInstanceUserPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsModeratedByAppInstanceUserResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsModeratedByAppInstanceUserResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelsModeratedByAppInstanceUser(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsModeratedByAppInstanceUserRequest)
operation.
listChannelsModeratedByAppInstanceUserRequest - default ListChannelsModeratedByAppInstanceUserPublisher listChannelsModeratedByAppInstanceUserPaginator(Consumer<ListChannelsModeratedByAppInstanceUserRequest.Builder> listChannelsModeratedByAppInstanceUserRequest)
A list of the channels moderated by an AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a variant of
listChannelsModeratedByAppInstanceUser(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsModeratedByAppInstanceUserRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsModeratedByAppInstanceUserPublisher publisher = client.listChannelsModeratedByAppInstanceUserPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsModeratedByAppInstanceUserPublisher publisher = client.listChannelsModeratedByAppInstanceUserPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsModeratedByAppInstanceUserResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsModeratedByAppInstanceUserResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelsModeratedByAppInstanceUser(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsModeratedByAppInstanceUserRequest)
operation.
This is a convenience which creates an instance of the
ListChannelsModeratedByAppInstanceUserRequest.Builder avoiding the need to create one manually via
ListChannelsModeratedByAppInstanceUserRequest.builder()
listChannelsModeratedByAppInstanceUserRequest - A Consumer that will call methods on ListChannelsModeratedByAppInstanceUserRequest.Builder
to create a request.default ListChannelsPublisher listChannelsPaginator(ListChannelsRequest listChannelsRequest)
Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
Use privacy = PUBLIC to retrieve all public channels in the account.
Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an
account.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a variant of
listChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsRequest) operation.
listChannelsRequest - default ListChannelsPublisher listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
Use privacy = PUBLIC to retrieve all public channels in the account.
Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an
account.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a variant of
listChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsRequest) operation.
This is a convenience which creates an instance of the ListChannelsRequest.Builder avoiding the need to
create one manually via ListChannelsRequest.builder()
listChannelsRequest - A Consumer that will call methods on ListChannelsRequest.Builder to create a request.default CompletableFuture<ListSubChannelsResponse> listSubChannels(ListSubChannelsRequest listSubChannelsRequest)
Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.
listSubChannelsRequest - default CompletableFuture<ListSubChannelsResponse> listSubChannels(Consumer<ListSubChannelsRequest.Builder> listSubChannelsRequest)
Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.
This is a convenience which creates an instance of the ListSubChannelsRequest.Builder avoiding the need
to create one manually via ListSubChannelsRequest.builder()
listSubChannelsRequest - A Consumer that will call methods on ListSubChannelsRequest.Builder to create a request.default ListSubChannelsPublisher listSubChannelsPaginator(ListSubChannelsRequest listSubChannelsRequest)
Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.
This is a variant of
listSubChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListSubChannelsPublisher publisher = client.listSubChannelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListSubChannelsPublisher publisher = client.listSubChannelsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSubChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsRequest)
operation.
listSubChannelsRequest - default ListSubChannelsPublisher listSubChannelsPaginator(Consumer<ListSubChannelsRequest.Builder> listSubChannelsRequest)
Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.
This is a variant of
listSubChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListSubChannelsPublisher publisher = client.listSubChannelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListSubChannelsPublisher publisher = client.listSubChannelsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSubChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsRequest)
operation.
This is a convenience which creates an instance of the ListSubChannelsRequest.Builder avoiding the need
to create one manually via ListSubChannelsRequest.builder()
listSubChannelsRequest - A Consumer that will call methods on ListSubChannelsRequest.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags applied to an Amazon Chime SDK messaging resource.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags applied to an Amazon Chime SDK messaging resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<PutChannelMembershipPreferencesResponse> putChannelMembershipPreferences(PutChannelMembershipPreferencesRequest putChannelMembershipPreferencesRequest)
Sets the membership preferences of an AppInstanceUser for the specified channel. The
AppInstanceUser must be a member of the channel. Only the AppInstanceUser who owns the
membership can set preferences. Users in the AppInstanceAdmin and channel moderator roles can't set
preferences for other users. Banned users can't set membership preferences for the channel from which they are
banned.
putChannelMembershipPreferencesRequest - default CompletableFuture<PutChannelMembershipPreferencesResponse> putChannelMembershipPreferences(Consumer<PutChannelMembershipPreferencesRequest.Builder> putChannelMembershipPreferencesRequest)
Sets the membership preferences of an AppInstanceUser for the specified channel. The
AppInstanceUser must be a member of the channel. Only the AppInstanceUser who owns the
membership can set preferences. Users in the AppInstanceAdmin and channel moderator roles can't set
preferences for other users. Banned users can't set membership preferences for the channel from which they are
banned.
This is a convenience which creates an instance of the PutChannelMembershipPreferencesRequest.Builder
avoiding the need to create one manually via PutChannelMembershipPreferencesRequest.builder()
putChannelMembershipPreferencesRequest - A Consumer that will call methods on PutChannelMembershipPreferencesRequest.Builder to
create a request.default CompletableFuture<RedactChannelMessageResponse> redactChannelMessage(RedactChannelMessageRequest redactChannelMessageRequest)
Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
redactChannelMessageRequest - default CompletableFuture<RedactChannelMessageResponse> redactChannelMessage(Consumer<RedactChannelMessageRequest.Builder> redactChannelMessageRequest)
Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the RedactChannelMessageRequest.Builder avoiding the
need to create one manually via RedactChannelMessageRequest.builder()
redactChannelMessageRequest - A Consumer that will call methods on RedactChannelMessageRequest.Builder to create a
request.default CompletableFuture<SearchChannelsResponse> searchChannels(SearchChannelsRequest searchChannelsRequest)
Allows ChimeBearer to search channels by channel members. AppInstanceUsers can search across the
channels that they belong to. AppInstanceAdmins can search across all channels.
searchChannelsRequest - default CompletableFuture<SearchChannelsResponse> searchChannels(Consumer<SearchChannelsRequest.Builder> searchChannelsRequest)
Allows ChimeBearer to search channels by channel members. AppInstanceUsers can search across the
channels that they belong to. AppInstanceAdmins can search across all channels.
This is a convenience which creates an instance of the SearchChannelsRequest.Builder avoiding the need to
create one manually via SearchChannelsRequest.builder()
searchChannelsRequest - A Consumer that will call methods on SearchChannelsRequest.Builder to create a request.default SearchChannelsPublisher searchChannelsPaginator(SearchChannelsRequest searchChannelsRequest)
Allows ChimeBearer to search channels by channel members. AppInstanceUsers can search across the
channels that they belong to. AppInstanceAdmins can search across all channels.
This is a variant of
searchChannels(software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.SearchChannelsPublisher publisher = client.searchChannelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.SearchChannelsPublisher publisher = client.searchChannelsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchChannels(software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsRequest)
operation.
searchChannelsRequest - default SearchChannelsPublisher searchChannelsPaginator(Consumer<SearchChannelsRequest.Builder> searchChannelsRequest)
Allows ChimeBearer to search channels by channel members. AppInstanceUsers can search across the
channels that they belong to. AppInstanceAdmins can search across all channels.
This is a variant of
searchChannels(software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmessaging.paginators.SearchChannelsPublisher publisher = client.searchChannelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmessaging.paginators.SearchChannelsPublisher publisher = client.searchChannelsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchChannels(software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsRequest)
operation.
This is a convenience which creates an instance of the SearchChannelsRequest.Builder avoiding the need to
create one manually via SearchChannelsRequest.builder()
searchChannelsRequest - A Consumer that will call methods on SearchChannelsRequest.Builder to create a request.default CompletableFuture<SendChannelMessageResponse> sendChannelMessage(SendChannelMessageRequest sendChannelMessageRequest)
Sends a message to a particular channel that the member is a part of.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL
messages can contain 30 bytes of data and no metadata.
sendChannelMessageRequest - default CompletableFuture<SendChannelMessageResponse> sendChannelMessage(Consumer<SendChannelMessageRequest.Builder> sendChannelMessageRequest)
Sends a message to a particular channel that the member is a part of.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL
messages can contain 30 bytes of data and no metadata.
This is a convenience which creates an instance of the SendChannelMessageRequest.Builder avoiding the
need to create one manually via SendChannelMessageRequest.builder()
sendChannelMessageRequest - A Consumer that will call methods on SendChannelMessageRequest.Builder to create a
request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Applies the specified tags to the specified Amazon Chime SDK messaging resource.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Applies the specified tags to the specified Amazon Chime SDK messaging resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified Amazon Chime SDK messaging resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the specified tags from the specified Amazon Chime SDK messaging resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdateChannelResponse> updateChannel(UpdateChannelRequest updateChannelRequest)
Update a channel's attributes.
Restriction: You can't change a channel's privacy.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
updateChannelRequest - default CompletableFuture<UpdateChannelResponse> updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest)
Update a channel's attributes.
Restriction: You can't change a channel's privacy.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the UpdateChannelRequest.Builder avoiding the need to
create one manually via UpdateChannelRequest.builder()
updateChannelRequest - A Consumer that will call methods on UpdateChannelRequest.Builder to create a request.default CompletableFuture<UpdateChannelFlowResponse> updateChannelFlow(UpdateChannelFlowRequest updateChannelFlowRequest)
Updates channel flow attributes. This is a developer API.
updateChannelFlowRequest - default CompletableFuture<UpdateChannelFlowResponse> updateChannelFlow(Consumer<UpdateChannelFlowRequest.Builder> updateChannelFlowRequest)
Updates channel flow attributes. This is a developer API.
This is a convenience which creates an instance of the UpdateChannelFlowRequest.Builder avoiding the need
to create one manually via UpdateChannelFlowRequest.builder()
updateChannelFlowRequest - A Consumer that will call methods on UpdateChannelFlowRequest.Builder to create a request.default CompletableFuture<UpdateChannelMessageResponse> updateChannelMessage(UpdateChannelMessageRequest updateChannelMessageRequest)
Updates the content of a message.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
updateChannelMessageRequest - default CompletableFuture<UpdateChannelMessageResponse> updateChannelMessage(Consumer<UpdateChannelMessageRequest.Builder> updateChannelMessageRequest)
Updates the content of a message.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the UpdateChannelMessageRequest.Builder avoiding the
need to create one manually via UpdateChannelMessageRequest.builder()
updateChannelMessageRequest - A Consumer that will call methods on UpdateChannelMessageRequest.Builder to create a
request.default CompletableFuture<UpdateChannelReadMarkerResponse> updateChannelReadMarker(UpdateChannelReadMarkerRequest updateChannelReadMarkerRequest)
The details of the time when a user last read messages in a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
updateChannelReadMarkerRequest - default CompletableFuture<UpdateChannelReadMarkerResponse> updateChannelReadMarker(Consumer<UpdateChannelReadMarkerRequest.Builder> updateChannelReadMarkerRequest)
The details of the time when a user last read messages in a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the UpdateChannelReadMarkerRequest.Builder avoiding
the need to create one manually via UpdateChannelReadMarkerRequest.builder()
updateChannelReadMarkerRequest - A Consumer that will call methods on UpdateChannelReadMarkerRequest.Builder to create a
request.static ChimeSdkMessagingAsyncClient create()
ChimeSdkMessagingAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ChimeSdkMessagingAsyncClientBuilder builder()
ChimeSdkMessagingAsyncClient.Copyright © 2023. All rights reserved.