@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonConnectParticipantAsync extends AmazonConnectParticipant
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
AbstractAmazonConnectParticipantAsync instead.
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.
ENDPOINT_PREFIXcreateParticipantConnection, disconnectParticipant, getCachedResponseMetadata, getTranscript, sendEvent, sendMessage, shutdownFuture<CreateParticipantConnectionResult> createParticipantConnectionAsync(CreateParticipantConnectionRequest createParticipantConnectionRequest)
Creates 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.
createParticipantConnectionRequest - Future<CreateParticipantConnectionResult> createParticipantConnectionAsync(CreateParticipantConnectionRequest createParticipantConnectionRequest, AsyncHandler<CreateParticipantConnectionRequest,CreateParticipantConnectionResult> asyncHandler)
Creates 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.
createParticipantConnectionRequest - 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.Future<DisconnectParticipantResult> disconnectParticipantAsync(DisconnectParticipantRequest disconnectParticipantRequest)
Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
disconnectParticipantRequest - Future<DisconnectParticipantResult> disconnectParticipantAsync(DisconnectParticipantRequest disconnectParticipantRequest, AsyncHandler<DisconnectParticipantRequest,DisconnectParticipantResult> asyncHandler)
Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
disconnectParticipantRequest - 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.Future<GetTranscriptResult> getTranscriptAsync(GetTranscriptRequest getTranscriptRequest)
Retrieves a transcript of the session. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
getTranscriptRequest - Future<GetTranscriptResult> getTranscriptAsync(GetTranscriptRequest getTranscriptRequest, AsyncHandler<GetTranscriptRequest,GetTranscriptResult> asyncHandler)
Retrieves a transcript of the session. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
getTranscriptRequest - 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.Future<SendEventResult> sendEventAsync(SendEventRequest sendEventRequest)
Sends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
sendEventRequest - Future<SendEventResult> sendEventAsync(SendEventRequest sendEventRequest, AsyncHandler<SendEventRequest,SendEventResult> asyncHandler)
Sends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
sendEventRequest - 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.Future<SendMessageResult> sendMessageAsync(SendMessageRequest sendMessageRequest)
Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
sendMessageRequest - Future<SendMessageResult> sendMessageAsync(SendMessageRequest sendMessageRequest, AsyncHandler<SendMessageRequest,SendMessageResult> asyncHandler)
Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
sendMessageRequest - 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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.