/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.chimesdkmessaging;
import javax.annotation.Generated;
import com.amazonaws.services.chimesdkmessaging.model.*;
/**
* Interface for accessing Amazon Chime SDK Messaging asynchronously. Each asynchronous method will return a Java Future
* object representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
* notification when an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.chimesdkmessaging.AbstractAmazonChimeSDKMessagingAsync} instead.
*
*
*
* The Amazon Chime SDK messaging APIs in this section allow software developers to send and receive messages in custom
* messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK identity APIs. For more
* information about the messaging APIs, see Amazon
* Chime SDK messaging.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonChimeSDKMessagingAsync extends AmazonChimeSDKMessaging {
/**
*
* Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow
* processors. To stop processing, use the DisassociateChannelFlow
API.
*
*
*
* Only administrators or channel moderators can associate a channel flow. The x-amz-chime-bearer
* request header is mandatory. Use the ARN of the AppInstanceUser
or AppInstanceBot
that
* makes the API call as the value in the header.
*
*
*
* @param associateChannelFlowRequest
* @return A Java Future containing the result of the AssociateChannelFlow operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.AssociateChannelFlow
* @see AWS API Documentation
*/
java.util.concurrent.Future associateChannelFlowAsync(AssociateChannelFlowRequest associateChannelFlowRequest);
/**
*
* Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow
* processors. To stop processing, use the DisassociateChannelFlow
API.
*
*
*
* Only administrators or channel moderators can associate a channel flow. The x-amz-chime-bearer
* request header is mandatory. Use the ARN of the AppInstanceUser
or AppInstanceBot
that
* makes the API call as the value in the header.
*
*
*
* @param associateChannelFlowRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the AssociateChannelFlow operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.AssociateChannelFlow
* @see AWS API Documentation
*/
java.util.concurrent.Future associateChannelFlowAsync(AssociateChannelFlowRequest associateChannelFlowRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Adds a specified number of users and bots to a channel.
*
*
* @param batchCreateChannelMembershipRequest
* @return A Java Future containing the result of the BatchCreateChannelMembership operation returned by the
* service.
* @sample AmazonChimeSDKMessagingAsync.BatchCreateChannelMembership
* @see AWS API Documentation
*/
java.util.concurrent.Future batchCreateChannelMembershipAsync(
BatchCreateChannelMembershipRequest batchCreateChannelMembershipRequest);
/**
*
* Adds a specified number of users and bots to a channel.
*
*
* @param batchCreateChannelMembershipRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the BatchCreateChannelMembership operation returned by the
* service.
* @sample AmazonChimeSDKMessagingAsyncHandler.BatchCreateChannelMembership
* @see AWS API Documentation
*/
java.util.concurrent.Future batchCreateChannelMembershipAsync(
BatchCreateChannelMembershipRequest batchCreateChannelMembershipRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Calls back Amazon Chime SDK messaging with a processing response message. This should be invoked from the
* processor Lambda. This is a developer API.
*
*
* You can return one of the following processing responses:
*
*
*
* @param channelFlowCallbackRequest
* @return A Java Future containing the result of the ChannelFlowCallback operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.ChannelFlowCallback
* @see AWS API Documentation
*/
java.util.concurrent.Future channelFlowCallbackAsync(ChannelFlowCallbackRequest channelFlowCallbackRequest);
/**
*
* Calls back Amazon Chime SDK messaging with a processing response message. This should be invoked from the
* processor Lambda. This is a developer API.
*
*
* You can return one of the following processing responses:
*
*
*
* @param channelFlowCallbackRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ChannelFlowCallback operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.ChannelFlowCallback
* @see AWS API Documentation
*/
java.util.concurrent.Future channelFlowCallbackAsync(ChannelFlowCallbackRequest channelFlowCallbackRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a channel to which you can add users and send messages.
*
*
* Restriction: You can't change a channel's privacy.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param createChannelRequest
* @return A Java Future containing the result of the CreateChannel operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.CreateChannel
* @see AWS API Documentation
*/
java.util.concurrent.Future createChannelAsync(CreateChannelRequest createChannelRequest);
/**
*
* Creates a channel to which you can add users and send messages.
*
*
* Restriction: You can't change a channel's privacy.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param createChannelRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateChannel operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.CreateChannel
* @see AWS API Documentation
*/
java.util.concurrent.Future createChannelAsync(CreateChannelRequest createChannelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you
* first have to DeleteChannelBan
, and then CreateChannelMembership
. Bans are cleaned up
* when you delete users or channels.
*
*
* If you ban a user who is already part of a channel, that user is automatically kicked from the channel.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param createChannelBanRequest
* @return A Java Future containing the result of the CreateChannelBan operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.CreateChannelBan
* @see AWS API Documentation
*/
java.util.concurrent.Future createChannelBanAsync(CreateChannelBanRequest createChannelBanRequest);
/**
*
* Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you
* first have to DeleteChannelBan
, and then CreateChannelMembership
. Bans are cleaned up
* when you delete users or channels.
*
*
* If you ban a user who is already part of a channel, that user is automatically kicked from the channel.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param createChannelBanRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateChannelBan operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.CreateChannelBan
* @see AWS API Documentation
*/
java.util.concurrent.Future createChannelBanAsync(CreateChannelBanRequest createChannelBanRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on
* chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors
* in the channel flow then take action on all messages sent to that channel. This is a developer API.
*
*
* Channel flows process the following items:
*
*
* -
*
* New and updated messages
*
*
* -
*
* Persistent and non-persistent messages
*
*
* -
*
* The Standard message type
*
*
*
*
*
* Channel flows don't process Control or System messages. For more information about the message types provided by
* Chime SDK messaging, refer to Message types in
* the Amazon Chime developer guide.
*
*
*
* @param createChannelFlowRequest
* @return A Java Future containing the result of the CreateChannelFlow operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.CreateChannelFlow
* @see AWS API Documentation
*/
java.util.concurrent.Future createChannelFlowAsync(CreateChannelFlowRequest createChannelFlowRequest);
/**
*
* Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on
* chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors
* in the channel flow then take action on all messages sent to that channel. This is a developer API.
*
*
* Channel flows process the following items:
*
*
* -
*
* New and updated messages
*
*
* -
*
* Persistent and non-persistent messages
*
*
* -
*
* The Standard message type
*
*
*
*
*
* Channel flows don't process Control or System messages. For more information about the message types provided by
* Chime SDK messaging, refer to Message types in
* the Amazon Chime developer guide.
*
*
*
* @param createChannelFlowRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateChannelFlow operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.CreateChannelFlow
* @see AWS API Documentation
*/
java.util.concurrent.Future createChannelFlowAsync(CreateChannelFlowRequest createChannelFlowRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Adds a member to a channel. The InvitedBy
field in ChannelMembership
is derived from
* the request header. A channel member can:
*
*
*
* Privacy settings impact this action as follows:
*
*
* -
*
* Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.
*
*
* -
*
* Private Channels: You must be a member to list or send messages.
*
*
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the
* AppInstanceUserArn
or AppInstanceBot
that makes the API call as the value in the
* header.
*
*
*
* @param createChannelMembershipRequest
* @return A Java Future containing the result of the CreateChannelMembership operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.CreateChannelMembership
* @see AWS API Documentation
*/
java.util.concurrent.Future createChannelMembershipAsync(CreateChannelMembershipRequest createChannelMembershipRequest);
/**
*
* Adds a member to a channel. The InvitedBy
field in ChannelMembership
is derived from
* the request header. A channel member can:
*
*
*
* Privacy settings impact this action as follows:
*
*
* -
*
* Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.
*
*
* -
*
* Private Channels: You must be a member to list or send messages.
*
*
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the
* AppInstanceUserArn
or AppInstanceBot
that makes the API call as the value in the
* header.
*
*
*
* @param createChannelMembershipRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateChannelMembership operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.CreateChannelMembership
* @see AWS API Documentation
*/
java.util.concurrent.Future createChannelMembershipAsync(CreateChannelMembershipRequest createChannelMembershipRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a new ChannelModerator
. A channel moderator can:
*
*
* -
*
* Add and remove other members of the channel.
*
*
* -
*
* Add and remove other moderators of the channel.
*
*
* -
*
* Add and remove user bans for the channel.
*
*
* -
*
* Redact messages in the channel.
*
*
* -
*
* List messages in the channel.
*
*
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
of the user that makes the API call as the value in the header.
*
*
*
* @param createChannelModeratorRequest
* @return A Java Future containing the result of the CreateChannelModerator operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.CreateChannelModerator
* @see AWS API Documentation
*/
java.util.concurrent.Future createChannelModeratorAsync(CreateChannelModeratorRequest createChannelModeratorRequest);
/**
*
* Creates a new ChannelModerator
. A channel moderator can:
*
*
* -
*
* Add and remove other members of the channel.
*
*
* -
*
* Add and remove other moderators of the channel.
*
*
* -
*
* Add and remove user bans for the channel.
*
*
* -
*
* Redact messages in the channel.
*
*
* -
*
* List messages in the channel.
*
*
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
of the user that makes the API call as the value in the header.
*
*
*
* @param createChannelModeratorRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateChannelModerator operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.CreateChannelModerator
* @see AWS API Documentation
*/
java.util.concurrent.Future createChannelModeratorAsync(CreateChannelModeratorRequest createChannelModeratorRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible
* process.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the
* AppInstanceUserArn
or AppInstanceBot
that makes the API call as the value in the
* header.
*
*
*
* @param deleteChannelRequest
* @return A Java Future containing the result of the DeleteChannel operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.DeleteChannel
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteChannelAsync(DeleteChannelRequest deleteChannelRequest);
/**
*
* Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible
* process.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the
* AppInstanceUserArn
or AppInstanceBot
that makes the API call as the value in the
* header.
*
*
*
* @param deleteChannelRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteChannel operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.DeleteChannel
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteChannelAsync(DeleteChannelRequest deleteChannelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes a member from a channel's ban list.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param deleteChannelBanRequest
* @return A Java Future containing the result of the DeleteChannelBan operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.DeleteChannelBan
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteChannelBanAsync(DeleteChannelBanRequest deleteChannelBanRequest);
/**
*
* Removes a member from a channel's ban list.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param deleteChannelBanRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteChannelBan operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.DeleteChannelBan
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteChannelBanAsync(DeleteChannelBanRequest deleteChannelBanRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a channel flow, an irreversible process. This is a developer API.
*
*
*
* This API works only when the channel flow is not associated with any channel. To get a list of all channels that
* a channel flow is associated with, use the ListChannelsAssociatedWithChannelFlow
API. Use the
* DisassociateChannelFlow
API to disassociate a channel flow from all channels.
*
*
*
* @param deleteChannelFlowRequest
* @return A Java Future containing the result of the DeleteChannelFlow operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.DeleteChannelFlow
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteChannelFlowAsync(DeleteChannelFlowRequest deleteChannelFlowRequest);
/**
*
* Deletes a channel flow, an irreversible process. This is a developer API.
*
*
*
* This API works only when the channel flow is not associated with any channel. To get a list of all channels that
* a channel flow is associated with, use the ListChannelsAssociatedWithChannelFlow
API. Use the
* DisassociateChannelFlow
API to disassociate a channel flow from all channels.
*
*
*
* @param deleteChannelFlowRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteChannelFlow operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.DeleteChannelFlow
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteChannelFlowAsync(DeleteChannelFlowRequest deleteChannelFlowRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes a member from a channel.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
*
*
* @param deleteChannelMembershipRequest
* @return A Java Future containing the result of the DeleteChannelMembership operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.DeleteChannelMembership
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteChannelMembershipAsync(DeleteChannelMembershipRequest deleteChannelMembershipRequest);
/**
*
* Removes a member from a channel.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
*
*
* @param deleteChannelMembershipRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteChannelMembership operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.DeleteChannelMembership
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteChannelMembershipAsync(DeleteChannelMembershipRequest deleteChannelMembershipRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately.
* A background process deletes any revisions created by UpdateChannelMessage
.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param deleteChannelMessageRequest
* @return A Java Future containing the result of the DeleteChannelMessage operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.DeleteChannelMessage
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteChannelMessageAsync(DeleteChannelMessageRequest deleteChannelMessageRequest);
/**
*
* Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately.
* A background process deletes any revisions created by UpdateChannelMessage
.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param deleteChannelMessageRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteChannelMessage operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.DeleteChannelMessage
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteChannelMessageAsync(DeleteChannelMessageRequest deleteChannelMessageRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a channel moderator.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param deleteChannelModeratorRequest
* @return A Java Future containing the result of the DeleteChannelModerator operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.DeleteChannelModerator
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteChannelModeratorAsync(DeleteChannelModeratorRequest deleteChannelModeratorRequest);
/**
*
* Deletes a channel moderator.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param deleteChannelModeratorRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteChannelModerator operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.DeleteChannelModerator
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteChannelModeratorAsync(DeleteChannelModeratorRequest deleteChannelModeratorRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes the streaming configurations for an AppInstance
. For more information, see Streaming messaging data in the
* Amazon Chime SDK Developer Guide.
*
*
* @param deleteMessagingStreamingConfigurationsRequest
* @return A Java Future containing the result of the DeleteMessagingStreamingConfigurations operation returned by
* the service.
* @sample AmazonChimeSDKMessagingAsync.DeleteMessagingStreamingConfigurations
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteMessagingStreamingConfigurationsAsync(
DeleteMessagingStreamingConfigurationsRequest deleteMessagingStreamingConfigurationsRequest);
/**
*
* Deletes the streaming configurations for an AppInstance
. For more information, see Streaming messaging data in the
* Amazon Chime SDK Developer Guide.
*
*
* @param deleteMessagingStreamingConfigurationsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteMessagingStreamingConfigurations operation returned by
* the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.DeleteMessagingStreamingConfigurations
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteMessagingStreamingConfigurationsAsync(
DeleteMessagingStreamingConfigurationsRequest deleteMessagingStreamingConfigurationsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns the full details of a channel in an Amazon Chime AppInstance
.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param describeChannelRequest
* @return A Java Future containing the result of the DescribeChannel operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.DescribeChannel
* @see AWS API Documentation
*/
java.util.concurrent.Future describeChannelAsync(DescribeChannelRequest describeChannelRequest);
/**
*
* Returns the full details of a channel in an Amazon Chime AppInstance
.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param describeChannelRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeChannel operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.DescribeChannel
* @see AWS API Documentation
*/
java.util.concurrent.Future describeChannelAsync(DescribeChannelRequest describeChannelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns the full details of a channel ban.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param describeChannelBanRequest
* @return A Java Future containing the result of the DescribeChannelBan operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.DescribeChannelBan
* @see AWS API Documentation
*/
java.util.concurrent.Future describeChannelBanAsync(DescribeChannelBanRequest describeChannelBanRequest);
/**
*
* Returns the full details of a channel ban.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param describeChannelBanRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeChannelBan operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.DescribeChannelBan
* @see AWS API Documentation
*/
java.util.concurrent.Future describeChannelBanAsync(DescribeChannelBanRequest describeChannelBanRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns the full details of a channel flow in an Amazon Chime AppInstance
. This is a developer API.
*
*
* @param describeChannelFlowRequest
* @return A Java Future containing the result of the DescribeChannelFlow operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.DescribeChannelFlow
* @see AWS API Documentation
*/
java.util.concurrent.Future describeChannelFlowAsync(DescribeChannelFlowRequest describeChannelFlowRequest);
/**
*
* Returns the full details of a channel flow in an Amazon Chime AppInstance
. This is a developer API.
*
*
* @param describeChannelFlowRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeChannelFlow operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.DescribeChannelFlow
* @see AWS API Documentation
*/
java.util.concurrent.Future describeChannelFlowAsync(DescribeChannelFlowRequest describeChannelFlowRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns the full details of a user's channel membership.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param describeChannelMembershipRequest
* @return A Java Future containing the result of the DescribeChannelMembership operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.DescribeChannelMembership
* @see AWS API Documentation
*/
java.util.concurrent.Future describeChannelMembershipAsync(
DescribeChannelMembershipRequest describeChannelMembershipRequest);
/**
*
* Returns the full details of a user's channel membership.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param describeChannelMembershipRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeChannelMembership operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.DescribeChannelMembership
* @see AWS API Documentation
*/
java.util.concurrent.Future describeChannelMembershipAsync(
DescribeChannelMembershipRequest describeChannelMembershipRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns the details of a channel based on the membership of the specified AppInstanceUser
or
* AppInstanceBot
.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param describeChannelMembershipForAppInstanceUserRequest
* @return A Java Future containing the result of the DescribeChannelMembershipForAppInstanceUser operation returned
* by the service.
* @sample AmazonChimeSDKMessagingAsync.DescribeChannelMembershipForAppInstanceUser
* @see AWS API Documentation
*/
java.util.concurrent.Future describeChannelMembershipForAppInstanceUserAsync(
DescribeChannelMembershipForAppInstanceUserRequest describeChannelMembershipForAppInstanceUserRequest);
/**
*
* Returns the details of a channel based on the membership of the specified AppInstanceUser
or
* AppInstanceBot
.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param describeChannelMembershipForAppInstanceUserRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeChannelMembershipForAppInstanceUser operation returned
* by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.DescribeChannelMembershipForAppInstanceUser
* @see AWS API Documentation
*/
java.util.concurrent.Future describeChannelMembershipForAppInstanceUserAsync(
DescribeChannelMembershipForAppInstanceUserRequest describeChannelMembershipForAppInstanceUserRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns the full details of a channel moderated by the specified AppInstanceUser
or
* AppInstanceBot
.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param describeChannelModeratedByAppInstanceUserRequest
* @return A Java Future containing the result of the DescribeChannelModeratedByAppInstanceUser operation returned
* by the service.
* @sample AmazonChimeSDKMessagingAsync.DescribeChannelModeratedByAppInstanceUser
* @see AWS API Documentation
*/
java.util.concurrent.Future describeChannelModeratedByAppInstanceUserAsync(
DescribeChannelModeratedByAppInstanceUserRequest describeChannelModeratedByAppInstanceUserRequest);
/**
*
* Returns the full details of a channel moderated by the specified AppInstanceUser
or
* AppInstanceBot
.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param describeChannelModeratedByAppInstanceUserRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeChannelModeratedByAppInstanceUser operation returned
* by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.DescribeChannelModeratedByAppInstanceUser
* @see AWS API Documentation
*/
java.util.concurrent.Future describeChannelModeratedByAppInstanceUserAsync(
DescribeChannelModeratedByAppInstanceUserRequest describeChannelModeratedByAppInstanceUserRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns the full details of a single ChannelModerator.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
*
*
* @param describeChannelModeratorRequest
* @return A Java Future containing the result of the DescribeChannelModerator operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.DescribeChannelModerator
* @see AWS API Documentation
*/
java.util.concurrent.Future describeChannelModeratorAsync(DescribeChannelModeratorRequest describeChannelModeratorRequest);
/**
*
* Returns the full details of a single ChannelModerator.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
*
*
* @param describeChannelModeratorRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeChannelModerator operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.DescribeChannelModerator
* @see AWS API Documentation
*/
java.util.concurrent.Future describeChannelModeratorAsync(DescribeChannelModeratorRequest describeChannelModeratorRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going
* through the channel flow processor.
*
*
*
* Only administrators or channel moderators can disassociate a channel flow.
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param disassociateChannelFlowRequest
* @return A Java Future containing the result of the DisassociateChannelFlow operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.DisassociateChannelFlow
* @see AWS API Documentation
*/
java.util.concurrent.Future disassociateChannelFlowAsync(DisassociateChannelFlowRequest disassociateChannelFlowRequest);
/**
*
* Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going
* through the channel flow processor.
*
*
*
* Only administrators or channel moderators can disassociate a channel flow.
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param disassociateChannelFlowRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DisassociateChannelFlow operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.DisassociateChannelFlow
* @see AWS API Documentation
*/
java.util.concurrent.Future disassociateChannelFlowAsync(DisassociateChannelFlowRequest disassociateChannelFlowRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the membership preferences of an AppInstanceUser
or AppInstanceBot
for the
* specified channel. A user or a bot must be a member of the channel and own the membership in order to retrieve
* membership preferences. Users or bots in the AppInstanceAdmin
and channel moderator roles can't
* retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the
* channel from which they are banned.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param getChannelMembershipPreferencesRequest
* @return A Java Future containing the result of the GetChannelMembershipPreferences operation returned by the
* service.
* @sample AmazonChimeSDKMessagingAsync.GetChannelMembershipPreferences
* @see AWS API Documentation
*/
java.util.concurrent.Future getChannelMembershipPreferencesAsync(
GetChannelMembershipPreferencesRequest getChannelMembershipPreferencesRequest);
/**
*
* Gets the membership preferences of an AppInstanceUser
or AppInstanceBot
for the
* specified channel. A user or a bot must be a member of the channel and own the membership in order to retrieve
* membership preferences. Users or bots in the AppInstanceAdmin
and channel moderator roles can't
* retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the
* channel from which they are banned.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param getChannelMembershipPreferencesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetChannelMembershipPreferences operation returned by the
* service.
* @sample AmazonChimeSDKMessagingAsyncHandler.GetChannelMembershipPreferences
* @see AWS API Documentation
*/
java.util.concurrent.Future getChannelMembershipPreferencesAsync(
GetChannelMembershipPreferencesRequest getChannelMembershipPreferencesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the full details of a channel message.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param getChannelMessageRequest
* @return A Java Future containing the result of the GetChannelMessage operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.GetChannelMessage
* @see AWS API Documentation
*/
java.util.concurrent.Future getChannelMessageAsync(GetChannelMessageRequest getChannelMessageRequest);
/**
*
* Gets the full details of a channel message.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param getChannelMessageRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetChannelMessage operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.GetChannelMessage
* @see AWS API Documentation
*/
java.util.concurrent.Future getChannelMessageAsync(GetChannelMessageRequest getChannelMessageRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets message status for a specified messageId
. Use this API to determine the intermediate status of
* messages going through channel flow processing. The API provides an alternative to retrieving message status if
* the event was not received because a client wasn't connected to a websocket.
*
*
* Messages can have any one of these statuses.
*
*
* - SENT
* -
*
* Message processed successfully
*
*
* - PENDING
* -
*
* Ongoing processing
*
*
* - FAILED
* -
*
* Processing failed
*
*
* - DENIED
* -
*
* Message denied by the processor
*
*
*
*
*
* -
*
* This API does not return statuses for denied messages, because we don't store them once the processor denies
* them.
*
*
* -
*
* Only the message sender can invoke this API.
*
*
* -
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
*
*
* @param getChannelMessageStatusRequest
* @return A Java Future containing the result of the GetChannelMessageStatus operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.GetChannelMessageStatus
* @see AWS API Documentation
*/
java.util.concurrent.Future getChannelMessageStatusAsync(GetChannelMessageStatusRequest getChannelMessageStatusRequest);
/**
*
* Gets message status for a specified messageId
. Use this API to determine the intermediate status of
* messages going through channel flow processing. The API provides an alternative to retrieving message status if
* the event was not received because a client wasn't connected to a websocket.
*
*
* Messages can have any one of these statuses.
*
*
* - SENT
* -
*
* Message processed successfully
*
*
* - PENDING
* -
*
* Ongoing processing
*
*
* - FAILED
* -
*
* Processing failed
*
*
* - DENIED
* -
*
* Message denied by the processor
*
*
*
*
*
* -
*
* This API does not return statuses for denied messages, because we don't store them once the processor denies
* them.
*
*
* -
*
* Only the message sender can invoke this API.
*
*
* -
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
*
*
* @param getChannelMessageStatusRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetChannelMessageStatus operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.GetChannelMessageStatus
* @see AWS API Documentation
*/
java.util.concurrent.Future getChannelMessageStatusAsync(GetChannelMessageStatusRequest getChannelMessageStatusRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* The details of the endpoint for the messaging session.
*
*
* @param getMessagingSessionEndpointRequest
* @return A Java Future containing the result of the GetMessagingSessionEndpoint operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.GetMessagingSessionEndpoint
* @see AWS API Documentation
*/
java.util.concurrent.Future getMessagingSessionEndpointAsync(
GetMessagingSessionEndpointRequest getMessagingSessionEndpointRequest);
/**
*
* The details of the endpoint for the messaging session.
*
*
* @param getMessagingSessionEndpointRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetMessagingSessionEndpoint operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.GetMessagingSessionEndpoint
* @see AWS API Documentation
*/
java.util.concurrent.Future getMessagingSessionEndpointAsync(
GetMessagingSessionEndpointRequest getMessagingSessionEndpointRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves the data streaming configuration for an AppInstance
. For more information, see Streaming messaging data in the
* Amazon Chime SDK Developer Guide.
*
*
* @param getMessagingStreamingConfigurationsRequest
* @return A Java Future containing the result of the GetMessagingStreamingConfigurations operation returned by the
* service.
* @sample AmazonChimeSDKMessagingAsync.GetMessagingStreamingConfigurations
* @see AWS API Documentation
*/
java.util.concurrent.Future getMessagingStreamingConfigurationsAsync(
GetMessagingStreamingConfigurationsRequest getMessagingStreamingConfigurationsRequest);
/**
*
* Retrieves the data streaming configuration for an AppInstance
. For more information, see Streaming messaging data in the
* Amazon Chime SDK Developer Guide.
*
*
* @param getMessagingStreamingConfigurationsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetMessagingStreamingConfigurations operation returned by the
* service.
* @sample AmazonChimeSDKMessagingAsyncHandler.GetMessagingStreamingConfigurations
* @see AWS API Documentation
*/
java.util.concurrent.Future getMessagingStreamingConfigurationsAsync(
GetMessagingStreamingConfigurationsRequest getMessagingStreamingConfigurationsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all the users and bots banned from a particular channel.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param listChannelBansRequest
* @return A Java Future containing the result of the ListChannelBans operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.ListChannelBans
* @see AWS API Documentation
*/
java.util.concurrent.Future listChannelBansAsync(ListChannelBansRequest listChannelBansRequest);
/**
*
* Lists all the users and bots banned from a particular channel.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param listChannelBansRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListChannelBans operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.ListChannelBans
* @see AWS API Documentation
*/
java.util.concurrent.Future listChannelBansAsync(ListChannelBansRequest listChannelBansRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.
*
*
* @param listChannelFlowsRequest
* @return A Java Future containing the result of the ListChannelFlows operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.ListChannelFlows
* @see AWS API Documentation
*/
java.util.concurrent.Future listChannelFlowsAsync(ListChannelFlowsRequest listChannelFlowsRequest);
/**
*
* Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.
*
*
* @param listChannelFlowsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListChannelFlows operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.ListChannelFlows
* @see AWS API Documentation
*/
java.util.concurrent.Future listChannelFlowsAsync(ListChannelFlowsRequest listChannelFlowsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all channel memberships in a channel.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.
*
*
* @param listChannelMembershipsRequest
* @return A Java Future containing the result of the ListChannelMemberships operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.ListChannelMemberships
* @see AWS API Documentation
*/
java.util.concurrent.Future listChannelMembershipsAsync(ListChannelMembershipsRequest listChannelMembershipsRequest);
/**
*
* Lists all channel memberships in a channel.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.
*
*
* @param listChannelMembershipsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListChannelMemberships operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.ListChannelMemberships
* @see AWS API Documentation
*/
java.util.concurrent.Future listChannelMembershipsAsync(ListChannelMembershipsRequest listChannelMembershipsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all channels that an AppInstanceUser
or AppInstanceBot
is a part of. Only an
* AppInstanceAdmin
can call the API with a user ARN that is not their own.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param listChannelMembershipsForAppInstanceUserRequest
* @return A Java Future containing the result of the ListChannelMembershipsForAppInstanceUser operation returned by
* the service.
* @sample AmazonChimeSDKMessagingAsync.ListChannelMembershipsForAppInstanceUser
* @see AWS API Documentation
*/
java.util.concurrent.Future listChannelMembershipsForAppInstanceUserAsync(
ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest);
/**
*
* Lists all channels that an AppInstanceUser
or AppInstanceBot
is a part of. Only an
* AppInstanceAdmin
can call the API with a user ARN that is not their own.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param listChannelMembershipsForAppInstanceUserRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListChannelMembershipsForAppInstanceUser operation returned by
* the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.ListChannelMembershipsForAppInstanceUser
* @see AWS API Documentation
*/
java.util.concurrent.Future listChannelMembershipsForAppInstanceUserAsync(
ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* List all the messages in a channel. Returns a paginated list of ChannelMessages
. By default, sorted
* by creation timestamp in descending order.
*
*
*
* Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do
* not appear in the results. This action always returns the latest version of an edited message.
*
*
* Also, the x-amz-chime-bearer
request header is mandatory. Use the ARN of the
* AppInstanceUser
or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param listChannelMessagesRequest
* @return A Java Future containing the result of the ListChannelMessages operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.ListChannelMessages
* @see AWS API Documentation
*/
java.util.concurrent.Future listChannelMessagesAsync(ListChannelMessagesRequest listChannelMessagesRequest);
/**
*
* List all the messages in a channel. Returns a paginated list of ChannelMessages
. By default, sorted
* by creation timestamp in descending order.
*
*
*
* Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do
* not appear in the results. This action always returns the latest version of an edited message.
*
*
* Also, the x-amz-chime-bearer
request header is mandatory. Use the ARN of the
* AppInstanceUser
or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param listChannelMessagesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListChannelMessages operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.ListChannelMessages
* @see AWS API Documentation
*/
java.util.concurrent.Future listChannelMessagesAsync(ListChannelMessagesRequest listChannelMessagesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all the moderators for a channel.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param listChannelModeratorsRequest
* @return A Java Future containing the result of the ListChannelModerators operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.ListChannelModerators
* @see AWS API Documentation
*/
java.util.concurrent.Future listChannelModeratorsAsync(ListChannelModeratorsRequest listChannelModeratorsRequest);
/**
*
* Lists all the moderators for a channel.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param listChannelModeratorsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListChannelModerators operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.ListChannelModerators
* @see AWS API Documentation
*/
java.util.concurrent.Future listChannelModeratorsAsync(ListChannelModeratorsRequest listChannelModeratorsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow
* results.
*
*
* Functionality & restrictions
*
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param listChannelsRequest
* @return A Java Future containing the result of the ListChannels operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.ListChannels
* @see AWS API Documentation
*/
java.util.concurrent.Future listChannelsAsync(ListChannelsRequest listChannelsRequest);
/**
*
* Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow
* results.
*
*
* Functionality & restrictions
*
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param listChannelsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListChannels operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.ListChannels
* @see AWS API Documentation
*/
java.util.concurrent.Future listChannelsAsync(ListChannelsRequest listChannelsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple
* channels, but you can only associate a channel with one channel flow. This is a developer API.
*
*
* @param listChannelsAssociatedWithChannelFlowRequest
* @return A Java Future containing the result of the ListChannelsAssociatedWithChannelFlow operation returned by
* the service.
* @sample AmazonChimeSDKMessagingAsync.ListChannelsAssociatedWithChannelFlow
* @see AWS API Documentation
*/
java.util.concurrent.Future listChannelsAssociatedWithChannelFlowAsync(
ListChannelsAssociatedWithChannelFlowRequest listChannelsAssociatedWithChannelFlowRequest);
/**
*
* Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple
* channels, but you can only associate a channel with one channel flow. This is a developer API.
*
*
* @param listChannelsAssociatedWithChannelFlowRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListChannelsAssociatedWithChannelFlow operation returned by
* the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.ListChannelsAssociatedWithChannelFlow
* @see AWS API Documentation
*/
java.util.concurrent.Future listChannelsAssociatedWithChannelFlowAsync(
ListChannelsAssociatedWithChannelFlowRequest listChannelsAssociatedWithChannelFlowRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* A list of the channels moderated by an AppInstanceUser
.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param listChannelsModeratedByAppInstanceUserRequest
* @return A Java Future containing the result of the ListChannelsModeratedByAppInstanceUser operation returned by
* the service.
* @sample AmazonChimeSDKMessagingAsync.ListChannelsModeratedByAppInstanceUser
* @see AWS API Documentation
*/
java.util.concurrent.Future listChannelsModeratedByAppInstanceUserAsync(
ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest);
/**
*
* A list of the channels moderated by an AppInstanceUser
.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param listChannelsModeratedByAppInstanceUserRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListChannelsModeratedByAppInstanceUser operation returned by
* the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.ListChannelsModeratedByAppInstanceUser
* @see AWS API Documentation
*/
java.util.concurrent.Future listChannelsModeratedByAppInstanceUserAsync(
ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param listSubChannelsRequest
* @return A Java Future containing the result of the ListSubChannels operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.ListSubChannels
* @see AWS API Documentation
*/
java.util.concurrent.Future listSubChannelsAsync(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.
*
*
* @param listSubChannelsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListSubChannels operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.ListSubChannels
* @see AWS API Documentation
*/
java.util.concurrent.Future listSubChannelsAsync(ListSubChannelsRequest listSubChannelsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the tags applied to an Amazon Chime SDK messaging resource.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.ListTagsForResource
* @see AWS API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Lists the tags applied to an Amazon Chime SDK messaging resource.
*
*
* @param listTagsForResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.ListTagsForResource
* @see AWS API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Sets the number of days before the channel is automatically deleted.
*
*
*
* -
*
* A background process deletes expired channels within 6 hours of expiration. Actual deletion times may vary.
*
*
* -
*
* Expired channels that have not yet been deleted appear as active, and you can update their expiration settings.
* The system honors the new settings.
*
*
* -
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
*
*
* @param putChannelExpirationSettingsRequest
* @return A Java Future containing the result of the PutChannelExpirationSettings operation returned by the
* service.
* @sample AmazonChimeSDKMessagingAsync.PutChannelExpirationSettings
* @see AWS API Documentation
*/
java.util.concurrent.Future putChannelExpirationSettingsAsync(
PutChannelExpirationSettingsRequest putChannelExpirationSettingsRequest);
/**
*
* Sets the number of days before the channel is automatically deleted.
*
*
*
* -
*
* A background process deletes expired channels within 6 hours of expiration. Actual deletion times may vary.
*
*
* -
*
* Expired channels that have not yet been deleted appear as active, and you can update their expiration settings.
* The system honors the new settings.
*
*
* -
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
*
*
* @param putChannelExpirationSettingsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the PutChannelExpirationSettings operation returned by the
* service.
* @sample AmazonChimeSDKMessagingAsyncHandler.PutChannelExpirationSettings
* @see AWS API Documentation
*/
java.util.concurrent.Future putChannelExpirationSettingsAsync(
PutChannelExpirationSettingsRequest putChannelExpirationSettingsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Sets the membership preferences of an AppInstanceUser
or AppInstanceBot
for the
* specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the membership
* can set preferences. Users or bots in the AppInstanceAdmin
and channel moderator roles can't set
* preferences for other users. Banned users or bots can't set membership preferences for the channel from which
* they are banned.
*
*
*
* The x-amz-chime-bearer request header is mandatory. Use the ARN of an AppInstanceUser
or
* AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param putChannelMembershipPreferencesRequest
* @return A Java Future containing the result of the PutChannelMembershipPreferences operation returned by the
* service.
* @sample AmazonChimeSDKMessagingAsync.PutChannelMembershipPreferences
* @see AWS API Documentation
*/
java.util.concurrent.Future putChannelMembershipPreferencesAsync(
PutChannelMembershipPreferencesRequest putChannelMembershipPreferencesRequest);
/**
*
* Sets the membership preferences of an AppInstanceUser
or AppInstanceBot
for the
* specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the membership
* can set preferences. Users or bots in the AppInstanceAdmin
and channel moderator roles can't set
* preferences for other users. Banned users or bots can't set membership preferences for the channel from which
* they are banned.
*
*
*
* The x-amz-chime-bearer request header is mandatory. Use the ARN of an AppInstanceUser
or
* AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param putChannelMembershipPreferencesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the PutChannelMembershipPreferences operation returned by the
* service.
* @sample AmazonChimeSDKMessagingAsyncHandler.PutChannelMembershipPreferences
* @see AWS API Documentation
*/
java.util.concurrent.Future putChannelMembershipPreferencesAsync(
PutChannelMembershipPreferencesRequest putChannelMembershipPreferencesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Sets the data streaming configuration for an AppInstance
. For more information, see Streaming messaging data in the
* Amazon Chime SDK Developer Guide.
*
*
* @param putMessagingStreamingConfigurationsRequest
* @return A Java Future containing the result of the PutMessagingStreamingConfigurations operation returned by the
* service.
* @sample AmazonChimeSDKMessagingAsync.PutMessagingStreamingConfigurations
* @see AWS API Documentation
*/
java.util.concurrent.Future putMessagingStreamingConfigurationsAsync(
PutMessagingStreamingConfigurationsRequest putMessagingStreamingConfigurationsRequest);
/**
*
* Sets the data streaming configuration for an AppInstance
. For more information, see Streaming messaging data in the
* Amazon Chime SDK Developer Guide.
*
*
* @param putMessagingStreamingConfigurationsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the PutMessagingStreamingConfigurations operation returned by the
* service.
* @sample AmazonChimeSDKMessagingAsyncHandler.PutMessagingStreamingConfigurations
* @see AWS API Documentation
*/
java.util.concurrent.Future putMessagingStreamingConfigurationsAsync(
PutMessagingStreamingConfigurationsRequest putMessagingStreamingConfigurationsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Redacts message content, but not metadata. The message exists in the back end, but the action returns null
* content, and the state shows as redacted.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param redactChannelMessageRequest
* @return A Java Future containing the result of the RedactChannelMessage operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.RedactChannelMessage
* @see AWS API Documentation
*/
java.util.concurrent.Future redactChannelMessageAsync(RedactChannelMessageRequest redactChannelMessageRequest);
/**
*
* Redacts message content, but not metadata. The message exists in the back end, but the action returns null
* content, and the state shows as redacted.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param redactChannelMessageRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the RedactChannelMessage operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.RedactChannelMessage
* @see AWS API Documentation
*/
java.util.concurrent.Future redactChannelMessageAsync(RedactChannelMessageRequest redactChannelMessageRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Allows the ChimeBearer
to search channels by channel members. Users or bots can search across the
* channels that they belong to. Users in the AppInstanceAdmin
role can search across all channels.
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
* @param searchChannelsRequest
* @return A Java Future containing the result of the SearchChannels operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.SearchChannels
* @see AWS API Documentation
*/
java.util.concurrent.Future searchChannelsAsync(SearchChannelsRequest searchChannelsRequest);
/**
*
* Allows the ChimeBearer
to search channels by channel members. Users or bots can search across the
* channels that they belong to. Users in the AppInstanceAdmin
role can search across all channels.
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
* @param searchChannelsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the SearchChannels operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.SearchChannels
* @see AWS API Documentation
*/
java.util.concurrent.Future searchChannelsAsync(SearchChannelsRequest searchChannelsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Sends a message to a particular channel that the member is a part of.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
* Also, STANDARD
messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and
* you can use it in a variety of ways, such as containing a link to an attachment.
*
*
* CONTROL
messages are limited to 30 bytes and do not contain metadata.
*
*
*
* @param sendChannelMessageRequest
* @return A Java Future containing the result of the SendChannelMessage operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.SendChannelMessage
* @see AWS API Documentation
*/
java.util.concurrent.Future sendChannelMessageAsync(SendChannelMessageRequest sendChannelMessageRequest);
/**
*
* Sends a message to a particular channel that the member is a part of.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
* Also, STANDARD
messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and
* you can use it in a variety of ways, such as containing a link to an attachment.
*
*
* CONTROL
messages are limited to 30 bytes and do not contain metadata.
*
*
*
* @param sendChannelMessageRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the SendChannelMessage operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.SendChannelMessage
* @see AWS API Documentation
*/
java.util.concurrent.Future sendChannelMessageAsync(SendChannelMessageRequest sendChannelMessageRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Applies the specified tags to the specified Amazon Chime SDK messaging resource.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.TagResource
* @see AWS API Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest);
/**
*
* Applies the specified tags to the specified Amazon Chime SDK messaging resource.
*
*
* @param tagResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.TagResource
* @see AWS API Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes the specified tags from the specified Amazon Chime SDK messaging resource.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.UntagResource
* @see AWS API Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* Removes the specified tags from the specified Amazon Chime SDK messaging resource.
*
*
* @param untagResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.UntagResource
* @see AWS API Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Update a channel's attributes.
*
*
* Restriction: You can't change a channel's privacy.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param updateChannelRequest
* @return A Java Future containing the result of the UpdateChannel operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.UpdateChannel
* @see AWS API Documentation
*/
java.util.concurrent.Future updateChannelAsync(UpdateChannelRequest updateChannelRequest);
/**
*
* Update a channel's attributes.
*
*
* Restriction: You can't change a channel's privacy.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param updateChannelRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateChannel operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.UpdateChannel
* @see AWS API Documentation
*/
java.util.concurrent.Future updateChannelAsync(UpdateChannelRequest updateChannelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates channel flow attributes. This is a developer API.
*
*
* @param updateChannelFlowRequest
* @return A Java Future containing the result of the UpdateChannelFlow operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.UpdateChannelFlow
* @see AWS API Documentation
*/
java.util.concurrent.Future updateChannelFlowAsync(UpdateChannelFlowRequest updateChannelFlowRequest);
/**
*
* Updates channel flow attributes. This is a developer API.
*
*
* @param updateChannelFlowRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateChannelFlow operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.UpdateChannelFlow
* @see AWS API Documentation
*/
java.util.concurrent.Future updateChannelFlowAsync(UpdateChannelFlowRequest updateChannelFlowRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates the content of a message.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param updateChannelMessageRequest
* @return A Java Future containing the result of the UpdateChannelMessage operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.UpdateChannelMessage
* @see AWS API Documentation
*/
java.util.concurrent.Future updateChannelMessageAsync(UpdateChannelMessageRequest updateChannelMessageRequest);
/**
*
* Updates the content of a message.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param updateChannelMessageRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateChannelMessage operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.UpdateChannelMessage
* @see AWS API Documentation
*/
java.util.concurrent.Future updateChannelMessageAsync(UpdateChannelMessageRequest updateChannelMessageRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* The details of the time when a user last read messages in a channel.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param updateChannelReadMarkerRequest
* @return A Java Future containing the result of the UpdateChannelReadMarker operation returned by the service.
* @sample AmazonChimeSDKMessagingAsync.UpdateChannelReadMarker
* @see AWS API Documentation
*/
java.util.concurrent.Future updateChannelReadMarkerAsync(UpdateChannelReadMarkerRequest updateChannelReadMarkerRequest);
/**
*
* The details of the time when a user last read messages in a channel.
*
*
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
* or AppInstanceBot
that makes the API call as the value in the header.
*
*
*
* @param updateChannelReadMarkerRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateChannelReadMarker operation returned by the service.
* @sample AmazonChimeSDKMessagingAsyncHandler.UpdateChannelReadMarker
* @see AWS API Documentation
*/
java.util.concurrent.Future updateChannelReadMarkerAsync(UpdateChannelReadMarkerRequest updateChannelReadMarkerRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}