@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonConnectParticipantAsync extends AbstractAmazonConnectParticipant implements AmazonConnectParticipantAsync
AmazonConnectParticipantAsync. Convenient method forms pass through to the
corresponding overload that takes a request object and an AsyncHandler, which throws an
UnsupportedOperationException.ENDPOINT_PREFIX| Modifier | Constructor and Description |
|---|---|
protected |
AbstractAmazonConnectParticipantAsync() |
completeAttachmentUpload, createParticipantConnection, describeView, disconnectParticipant, getAttachment, getCachedResponseMetadata, getTranscript, sendEvent, sendMessage, shutdown, startAttachmentUploadclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcompleteAttachmentUpload, createParticipantConnection, describeView, disconnectParticipant, getAttachment, getCachedResponseMetadata, getTranscript, sendEvent, sendMessage, shutdown, startAttachmentUploadprotected AbstractAmazonConnectParticipantAsync()
public Future<CompleteAttachmentUploadResult> completeAttachmentUploadAsync(CompleteAttachmentUploadRequest request)
AmazonConnectParticipantAsyncAllows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
completeAttachmentUploadAsync in interface AmazonConnectParticipantAsyncpublic Future<CompleteAttachmentUploadResult> completeAttachmentUploadAsync(CompleteAttachmentUploadRequest request, AsyncHandler<CompleteAttachmentUploadRequest,CompleteAttachmentUploadResult> asyncHandler)
AmazonConnectParticipantAsyncAllows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
completeAttachmentUploadAsync 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<CreateParticipantConnectionResult> createParticipantConnectionAsync(CreateParticipantConnectionRequest request)
AmazonConnectParticipantAsyncCreates the participant's connection.
ParticipantToken is used for invoking this API instead of ConnectionToken.
The participant token is valid for the lifetime of the participant – until 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.
Message streaming support: This API can also be used together with the StartContactStreaming API to create a participant connection for chat contacts that are not using a websocket. For more information about message streaming, Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
Feature specifications: For information about feature specifications, such as the allowed number of open websocket connections per participant, see Feature specifications in the Amazon Connect Administrator Guide.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
createParticipantConnectionAsync in interface AmazonConnectParticipantAsyncpublic Future<CreateParticipantConnectionResult> createParticipantConnectionAsync(CreateParticipantConnectionRequest request, AsyncHandler<CreateParticipantConnectionRequest,CreateParticipantConnectionResult> asyncHandler)
AmazonConnectParticipantAsyncCreates the participant's connection.
ParticipantToken is used for invoking this API instead of ConnectionToken.
The participant token is valid for the lifetime of the participant – until 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.
Message streaming support: This API can also be used together with the StartContactStreaming API to create a participant connection for chat contacts that are not using a websocket. For more information about message streaming, Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
Feature specifications: For information about feature specifications, such as the allowed number of open websocket connections per participant, see Feature specifications in the Amazon Connect Administrator Guide.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
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<DescribeViewResult> describeViewAsync(DescribeViewRequest request)
AmazonConnectParticipantAsyncRetrieves the view for the specified view token.
describeViewAsync in interface AmazonConnectParticipantAsyncpublic Future<DescribeViewResult> describeViewAsync(DescribeViewRequest request, AsyncHandler<DescribeViewRequest,DescribeViewResult> asyncHandler)
AmazonConnectParticipantAsyncRetrieves the view for the specified view token.
describeViewAsync 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.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
disconnectParticipantAsync in interface AmazonConnectParticipantAsyncpublic Future<DisconnectParticipantResult> disconnectParticipantAsync(DisconnectParticipantRequest request, AsyncHandler<DisconnectParticipantRequest,DisconnectParticipantResult> asyncHandler)
AmazonConnectParticipantAsyncDisconnects a participant.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
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<GetAttachmentResult> getAttachmentAsync(GetAttachmentRequest request)
AmazonConnectParticipantAsyncProvides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
getAttachmentAsync in interface AmazonConnectParticipantAsyncpublic Future<GetAttachmentResult> getAttachmentAsync(GetAttachmentRequest request, AsyncHandler<GetAttachmentRequest,GetAttachmentResult> asyncHandler)
AmazonConnectParticipantAsyncProvides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
getAttachmentAsync 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, including details about any attachments. For information about accessing past chat contact transcripts for a persistent chat, see Enable persistent chat.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
getTranscriptAsync in interface AmazonConnectParticipantAsyncpublic Future<GetTranscriptResult> getTranscriptAsync(GetTranscriptRequest request, AsyncHandler<GetTranscriptRequest,GetTranscriptResult> asyncHandler)
AmazonConnectParticipantAsyncRetrieves a transcript of the session, including details about any attachments. For information about accessing past chat contact transcripts for a persistent chat, see Enable persistent chat.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
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.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
sendEventAsync in interface AmazonConnectParticipantAsyncpublic Future<SendEventResult> sendEventAsync(SendEventRequest request, AsyncHandler<SendEventRequest,SendEventResult> asyncHandler)
AmazonConnectParticipantAsyncSends an event.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
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.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
sendMessageAsync in interface AmazonConnectParticipantAsyncpublic Future<SendMessageResult> sendMessageAsync(SendMessageRequest request, AsyncHandler<SendMessageRequest,SendMessageResult> asyncHandler)
AmazonConnectParticipantAsyncSends a message.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
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 Future<StartAttachmentUploadResult> startAttachmentUploadAsync(StartAttachmentUploadRequest request)
AmazonConnectParticipantAsyncProvides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
startAttachmentUploadAsync in interface AmazonConnectParticipantAsyncpublic Future<StartAttachmentUploadResult> startAttachmentUploadAsync(StartAttachmentUploadRequest request, AsyncHandler<StartAttachmentUploadRequest,StartAttachmentUploadResult> asyncHandler)
AmazonConnectParticipantAsyncProvides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
startAttachmentUploadAsync 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.Copyright © 2023. All rights reserved.