@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonivschatAsync extends AbstractAmazonivschat implements AmazonivschatAsync
AmazonivschatAsync
. Convenient method forms pass through to the corresponding
overload that takes a request object and an AsyncHandler
, which throws an
UnsupportedOperationException
.ENDPOINT_PREFIX
createChatToken, createLoggingConfiguration, createRoom, deleteLoggingConfiguration, deleteMessage, deleteRoom, disconnectUser, getCachedResponseMetadata, getLoggingConfiguration, getRoom, listLoggingConfigurations, listRooms, listTagsForResource, sendEvent, shutdown, tagResource, untagResource, updateLoggingConfiguration, updateRoom
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createChatToken, createLoggingConfiguration, createRoom, deleteLoggingConfiguration, deleteMessage, deleteRoom, disconnectUser, getCachedResponseMetadata, getLoggingConfiguration, getRoom, listLoggingConfigurations, listRooms, listTagsForResource, sendEvent, shutdown, tagResource, untagResource, updateLoggingConfiguration, updateRoom
public Future<CreateChatTokenResult> createChatTokenAsync(CreateChatTokenRequest request)
AmazonivschatAsync
Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response.
Use the capabilities
field to permit an end user to send messages or moderate a room.
The attributes
field securely attaches structured data to the chat session; the data is included
within each message sent by the end user and received by other participants in the room. Common use cases for
attributes include passing end-user profile data like an icon, display name, colors, badges, and other display
features.
Encryption keys are owned by Amazon IVS Chat and never used directly by your application.
createChatTokenAsync
in interface AmazonivschatAsync
public Future<CreateChatTokenResult> createChatTokenAsync(CreateChatTokenRequest request, AsyncHandler<CreateChatTokenRequest,CreateChatTokenResult> asyncHandler)
AmazonivschatAsync
Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response.
Use the capabilities
field to permit an end user to send messages or moderate a room.
The attributes
field securely attaches structured data to the chat session; the data is included
within each message sent by the end user and received by other participants in the room. Common use cases for
attributes include passing end-user profile data like an icon, display name, colors, badges, and other display
features.
Encryption keys are owned by Amazon IVS Chat and never used directly by your application.
createChatTokenAsync
in interface AmazonivschatAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLoggingConfigurationResult> createLoggingConfigurationAsync(CreateLoggingConfigurationRequest request)
AmazonivschatAsync
Creates a logging configuration that allows clients to store and record sent messages.
createLoggingConfigurationAsync
in interface AmazonivschatAsync
public Future<CreateLoggingConfigurationResult> createLoggingConfigurationAsync(CreateLoggingConfigurationRequest request, AsyncHandler<CreateLoggingConfigurationRequest,CreateLoggingConfigurationResult> asyncHandler)
AmazonivschatAsync
Creates a logging configuration that allows clients to store and record sent messages.
createLoggingConfigurationAsync
in interface AmazonivschatAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateRoomResult> createRoomAsync(CreateRoomRequest request)
AmazonivschatAsync
Creates a room that allows clients to connect and pass messages.
createRoomAsync
in interface AmazonivschatAsync
public Future<CreateRoomResult> createRoomAsync(CreateRoomRequest request, AsyncHandler<CreateRoomRequest,CreateRoomResult> asyncHandler)
AmazonivschatAsync
Creates a room that allows clients to connect and pass messages.
createRoomAsync
in interface AmazonivschatAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteLoggingConfigurationResult> deleteLoggingConfigurationAsync(DeleteLoggingConfigurationRequest request)
AmazonivschatAsync
Deletes the specified logging configuration.
deleteLoggingConfigurationAsync
in interface AmazonivschatAsync
public Future<DeleteLoggingConfigurationResult> deleteLoggingConfigurationAsync(DeleteLoggingConfigurationRequest request, AsyncHandler<DeleteLoggingConfigurationRequest,DeleteLoggingConfigurationResult> asyncHandler)
AmazonivschatAsync
Deletes the specified logging configuration.
deleteLoggingConfigurationAsync
in interface AmazonivschatAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteMessageResult> deleteMessageAsync(DeleteMessageRequest request)
AmazonivschatAsync
Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from
view and delete it from the client’s chat history. This event’s EventName
is
aws:DELETE_MESSAGE
. This replicates the
DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.
deleteMessageAsync
in interface AmazonivschatAsync
public Future<DeleteMessageResult> deleteMessageAsync(DeleteMessageRequest request, AsyncHandler<DeleteMessageRequest,DeleteMessageResult> asyncHandler)
AmazonivschatAsync
Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from
view and delete it from the client’s chat history. This event’s EventName
is
aws:DELETE_MESSAGE
. This replicates the
DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.
deleteMessageAsync
in interface AmazonivschatAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteRoomResult> deleteRoomAsync(DeleteRoomRequest request)
AmazonivschatAsync
Deletes the specified room.
deleteRoomAsync
in interface AmazonivschatAsync
public Future<DeleteRoomResult> deleteRoomAsync(DeleteRoomRequest request, AsyncHandler<DeleteRoomRequest,DeleteRoomResult> asyncHandler)
AmazonivschatAsync
Deletes the specified room.
deleteRoomAsync
in interface AmazonivschatAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisconnectUserResult> disconnectUserAsync(DisconnectUserRequest request)
AmazonivschatAsync
Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
disconnectUserAsync
in interface AmazonivschatAsync
public Future<DisconnectUserResult> disconnectUserAsync(DisconnectUserRequest request, AsyncHandler<DisconnectUserRequest,DisconnectUserResult> asyncHandler)
AmazonivschatAsync
Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
disconnectUserAsync
in interface AmazonivschatAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetLoggingConfigurationResult> getLoggingConfigurationAsync(GetLoggingConfigurationRequest request)
AmazonivschatAsync
Gets the specified logging configuration.
getLoggingConfigurationAsync
in interface AmazonivschatAsync
public Future<GetLoggingConfigurationResult> getLoggingConfigurationAsync(GetLoggingConfigurationRequest request, AsyncHandler<GetLoggingConfigurationRequest,GetLoggingConfigurationResult> asyncHandler)
AmazonivschatAsync
Gets the specified logging configuration.
getLoggingConfigurationAsync
in interface AmazonivschatAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetRoomResult> getRoomAsync(GetRoomRequest request)
AmazonivschatAsync
Gets the specified room.
getRoomAsync
in interface AmazonivschatAsync
public Future<GetRoomResult> getRoomAsync(GetRoomRequest request, AsyncHandler<GetRoomRequest,GetRoomResult> asyncHandler)
AmazonivschatAsync
Gets the specified room.
getRoomAsync
in interface AmazonivschatAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListLoggingConfigurationsResult> listLoggingConfigurationsAsync(ListLoggingConfigurationsRequest request)
AmazonivschatAsync
Gets summary information about all your logging configurations in the AWS region where the API request is processed.
listLoggingConfigurationsAsync
in interface AmazonivschatAsync
public Future<ListLoggingConfigurationsResult> listLoggingConfigurationsAsync(ListLoggingConfigurationsRequest request, AsyncHandler<ListLoggingConfigurationsRequest,ListLoggingConfigurationsResult> asyncHandler)
AmazonivschatAsync
Gets summary information about all your logging configurations in the AWS region where the API request is processed.
listLoggingConfigurationsAsync
in interface AmazonivschatAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListRoomsResult> listRoomsAsync(ListRoomsRequest request)
AmazonivschatAsync
Gets summary information about all your rooms in the AWS region where the API request is processed. Results are
sorted in descending order of updateTime
.
listRoomsAsync
in interface AmazonivschatAsync
public Future<ListRoomsResult> listRoomsAsync(ListRoomsRequest request, AsyncHandler<ListRoomsRequest,ListRoomsResult> asyncHandler)
AmazonivschatAsync
Gets summary information about all your rooms in the AWS region where the API request is processed. Results are
sorted in descending order of updateTime
.
listRoomsAsync
in interface AmazonivschatAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonivschatAsync
Gets information about AWS tags for the specified ARN.
listTagsForResourceAsync
in interface AmazonivschatAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonivschatAsync
Gets information about AWS tags for the specified ARN.
listTagsForResourceAsync
in interface AmazonivschatAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SendEventResult> sendEventAsync(SendEventRequest request)
AmazonivschatAsync
Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.
sendEventAsync
in interface AmazonivschatAsync
public Future<SendEventResult> sendEventAsync(SendEventRequest request, AsyncHandler<SendEventRequest,SendEventResult> asyncHandler)
AmazonivschatAsync
Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.
sendEventAsync
in interface AmazonivschatAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonivschatAsync
Adds or updates tags for the AWS resource with the specified ARN.
tagResourceAsync
in interface AmazonivschatAsync
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonivschatAsync
Adds or updates tags for the AWS resource with the specified ARN.
tagResourceAsync
in interface AmazonivschatAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonivschatAsync
Removes tags from the resource with the specified ARN.
untagResourceAsync
in interface AmazonivschatAsync
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonivschatAsync
Removes tags from the resource with the specified ARN.
untagResourceAsync
in interface AmazonivschatAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateLoggingConfigurationResult> updateLoggingConfigurationAsync(UpdateLoggingConfigurationRequest request)
AmazonivschatAsync
Updates a specified logging configuration.
updateLoggingConfigurationAsync
in interface AmazonivschatAsync
public Future<UpdateLoggingConfigurationResult> updateLoggingConfigurationAsync(UpdateLoggingConfigurationRequest request, AsyncHandler<UpdateLoggingConfigurationRequest,UpdateLoggingConfigurationResult> asyncHandler)
AmazonivschatAsync
Updates a specified logging configuration.
updateLoggingConfigurationAsync
in interface AmazonivschatAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateRoomResult> updateRoomAsync(UpdateRoomRequest request)
AmazonivschatAsync
Updates a room’s configuration.
updateRoomAsync
in interface AmazonivschatAsync
public Future<UpdateRoomResult> updateRoomAsync(UpdateRoomRequest request, AsyncHandler<UpdateRoomRequest,UpdateRoomResult> asyncHandler)
AmazonivschatAsync
Updates a room’s configuration.
updateRoomAsync
in interface AmazonivschatAsync
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.