/* * 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.connectparticipant; import javax.annotation.Generated; import com.amazonaws.services.connectparticipant.model.*; /** * Interface for accessing Amazon Connect Participant 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.connectparticipant.AbstractAmazonConnectParticipantAsync} instead. *

*

*

* Amazon Connect is an easy-to-use omnichannel cloud contact center service that enables companies of any size to * deliver superior customer service at a lower cost. Amazon Connect communications capabilities make it easy for * companies to deliver personalized interactions across communication channels, including chat. *

*

* Use the Amazon Connect Participant Service to manage participants (for example, agents, customers, and managers * listening in), and to send messages and events within a chat contact. The APIs in the service enable the following: * sending chat messages, attachment sharing, managing a participant's connection state and message events, and * retrieving chat transcripts. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonConnectParticipantAsync extends AmazonConnectParticipant { /** *

* Allows 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. *

* * @param completeAttachmentUploadRequest * @return A Java Future containing the result of the CompleteAttachmentUpload operation returned by the service. * @sample AmazonConnectParticipantAsync.CompleteAttachmentUpload * @see AWS API Documentation */ java.util.concurrent.Future completeAttachmentUploadAsync(CompleteAttachmentUploadRequest completeAttachmentUploadRequest); /** *

* Allows 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. *

* * @param completeAttachmentUploadRequest * @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 CompleteAttachmentUpload operation returned by the service. * @sample AmazonConnectParticipantAsyncHandler.CompleteAttachmentUpload * @see AWS API Documentation */ java.util.concurrent.Future completeAttachmentUploadAsync(CompleteAttachmentUploadRequest completeAttachmentUploadRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Creates 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. *

* * * @param createParticipantConnectionRequest * @return A Java Future containing the result of the CreateParticipantConnection operation returned by the service. * @sample AmazonConnectParticipantAsync.CreateParticipantConnection * @see AWS API Documentation */ java.util.concurrent.Future createParticipantConnectionAsync( CreateParticipantConnectionRequest createParticipantConnectionRequest); /** *

* Creates 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. *

* * * @param createParticipantConnectionRequest * @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 CreateParticipantConnection operation returned by the service. * @sample AmazonConnectParticipantAsyncHandler.CreateParticipantConnection * @see AWS API Documentation */ java.util.concurrent.Future createParticipantConnectionAsync( CreateParticipantConnectionRequest createParticipantConnectionRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Disconnects 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. *

* * @param disconnectParticipantRequest * @return A Java Future containing the result of the DisconnectParticipant operation returned by the service. * @sample AmazonConnectParticipantAsync.DisconnectParticipant * @see AWS API Documentation */ java.util.concurrent.Future disconnectParticipantAsync(DisconnectParticipantRequest disconnectParticipantRequest); /** *

* Disconnects 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. *

* * @param disconnectParticipantRequest * @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 DisconnectParticipant operation returned by the service. * @sample AmazonConnectParticipantAsyncHandler.DisconnectParticipant * @see AWS API Documentation */ java.util.concurrent.Future disconnectParticipantAsync(DisconnectParticipantRequest disconnectParticipantRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Provides 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. *

* * @param getAttachmentRequest * @return A Java Future containing the result of the GetAttachment operation returned by the service. * @sample AmazonConnectParticipantAsync.GetAttachment * @see AWS API Documentation */ java.util.concurrent.Future getAttachmentAsync(GetAttachmentRequest getAttachmentRequest); /** *

* Provides 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. *

* * @param getAttachmentRequest * @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 GetAttachment operation returned by the service. * @sample AmazonConnectParticipantAsyncHandler.GetAttachment * @see AWS API Documentation */ java.util.concurrent.Future getAttachmentAsync(GetAttachmentRequest getAttachmentRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Retrieves 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. *

* * @param getTranscriptRequest * @return A Java Future containing the result of the GetTranscript operation returned by the service. * @sample AmazonConnectParticipantAsync.GetTranscript * @see AWS API Documentation */ java.util.concurrent.Future getTranscriptAsync(GetTranscriptRequest getTranscriptRequest); /** *

* Retrieves 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. *

* * @param getTranscriptRequest * @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 GetTranscript operation returned by the service. * @sample AmazonConnectParticipantAsyncHandler.GetTranscript * @see AWS API Documentation */ java.util.concurrent.Future getTranscriptAsync(GetTranscriptRequest getTranscriptRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Sends 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. *

* * @param sendEventRequest * @return A Java Future containing the result of the SendEvent operation returned by the service. * @sample AmazonConnectParticipantAsync.SendEvent * @see AWS * API Documentation */ java.util.concurrent.Future sendEventAsync(SendEventRequest sendEventRequest); /** *

* Sends 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. *

* * @param sendEventRequest * @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 SendEvent operation returned by the service. * @sample AmazonConnectParticipantAsyncHandler.SendEvent * @see AWS * API Documentation */ java.util.concurrent.Future sendEventAsync(SendEventRequest sendEventRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Sends 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. *

* * @param sendMessageRequest * @return A Java Future containing the result of the SendMessage operation returned by the service. * @sample AmazonConnectParticipantAsync.SendMessage * @see AWS * API Documentation */ java.util.concurrent.Future sendMessageAsync(SendMessageRequest sendMessageRequest); /** *

* Sends 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. *

* * @param sendMessageRequest * @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 SendMessage operation returned by the service. * @sample AmazonConnectParticipantAsyncHandler.SendMessage * @see AWS * API Documentation */ java.util.concurrent.Future sendMessageAsync(SendMessageRequest sendMessageRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Provides 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. *

* * @param startAttachmentUploadRequest * @return A Java Future containing the result of the StartAttachmentUpload operation returned by the service. * @sample AmazonConnectParticipantAsync.StartAttachmentUpload * @see AWS API Documentation */ java.util.concurrent.Future startAttachmentUploadAsync(StartAttachmentUploadRequest startAttachmentUploadRequest); /** *

* Provides 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. *

* * @param startAttachmentUploadRequest * @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 StartAttachmentUpload operation returned by the service. * @sample AmazonConnectParticipantAsyncHandler.StartAttachmentUpload * @see AWS API Documentation */ java.util.concurrent.Future startAttachmentUploadAsync(StartAttachmentUploadRequest startAttachmentUploadRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); }