@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonConnectParticipantAsyncClient extends AmazonConnectParticipantClient implements AmazonConnectParticipantAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect enables customer contacts through voice or chat.
The APIs described here are used by chat participants, such as agents and customers.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, createParticipantConnection, disconnectParticipant, getCachedResponseMetadata, getTranscript, sendEvent, sendMessageaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateParticipantConnection, disconnectParticipant, getCachedResponseMetadata, getTranscript, sendEvent, sendMessagepublic static AmazonConnectParticipantAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateParticipantConnectionResult> createParticipantConnectionAsync(CreateParticipantConnectionRequest request)
AmazonConnectParticipantAsyncCreates the participant's connection. Note that ParticipantToken is used for invoking this API instead of ConnectionToken.
The participant token is valid for the lifetime of the participant – until the they are part of a contact.
The response URL for WEBSOCKET Type has a connect expiry timeout of 100s. Clients must manually
connect to the returned websocket URL and subscribe to the desired topic.
For chat, you need to publish the following on the established websocket connection:
{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}
Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before.
createParticipantConnectionAsync in interface AmazonConnectParticipantAsyncpublic Future<CreateParticipantConnectionResult> createParticipantConnectionAsync(CreateParticipantConnectionRequest request, AsyncHandler<CreateParticipantConnectionRequest,CreateParticipantConnectionResult> asyncHandler)
AmazonConnectParticipantAsyncCreates the participant's connection. Note that ParticipantToken is used for invoking this API instead of ConnectionToken.
The participant token is valid for the lifetime of the participant – until the they are part of a contact.
The response URL for WEBSOCKET Type has a connect expiry timeout of 100s. Clients must manually
connect to the returned websocket URL and subscribe to the desired topic.
For chat, you need to publish the following on the established websocket connection:
{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}
Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before.
createParticipantConnectionAsync in interface AmazonConnectParticipantAsyncasyncHandler - 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<DisconnectParticipantResult> disconnectParticipantAsync(DisconnectParticipantRequest request)
AmazonConnectParticipantAsyncDisconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
disconnectParticipantAsync in interface AmazonConnectParticipantAsyncpublic Future<DisconnectParticipantResult> disconnectParticipantAsync(DisconnectParticipantRequest request, AsyncHandler<DisconnectParticipantRequest,DisconnectParticipantResult> asyncHandler)
AmazonConnectParticipantAsyncDisconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
disconnectParticipantAsync in interface AmazonConnectParticipantAsyncasyncHandler - 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<GetTranscriptResult> getTranscriptAsync(GetTranscriptRequest request)
AmazonConnectParticipantAsyncRetrieves a transcript of the session. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
getTranscriptAsync in interface AmazonConnectParticipantAsyncpublic Future<GetTranscriptResult> getTranscriptAsync(GetTranscriptRequest request, AsyncHandler<GetTranscriptRequest,GetTranscriptResult> asyncHandler)
AmazonConnectParticipantAsyncRetrieves a transcript of the session. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
getTranscriptAsync in interface AmazonConnectParticipantAsyncasyncHandler - 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)
AmazonConnectParticipantAsyncSends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
sendEventAsync in interface AmazonConnectParticipantAsyncpublic Future<SendEventResult> sendEventAsync(SendEventRequest request, AsyncHandler<SendEventRequest,SendEventResult> asyncHandler)
AmazonConnectParticipantAsyncSends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
sendEventAsync in interface AmazonConnectParticipantAsyncasyncHandler - 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<SendMessageResult> sendMessageAsync(SendMessageRequest request)
AmazonConnectParticipantAsyncSends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
sendMessageAsync in interface AmazonConnectParticipantAsyncpublic Future<SendMessageResult> sendMessageAsync(SendMessageRequest request, AsyncHandler<SendMessageRequest,SendMessageResult> asyncHandler)
AmazonConnectParticipantAsyncSends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
sendMessageAsync in interface AmazonConnectParticipantAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonConnectParticipantshutdown in class AmazonWebServiceClient