com.amazonaws.services.connectparticipant.AmazonConnectParticipantAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-connectparticipant Show documentation
/*
* Copyright 2015-2020 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 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonConnectParticipantAsync extends AmazonConnectParticipant {
/**
*
* 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.
*
*
* @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. 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.
*
*
* @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. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
*
*
* @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. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
*
*
* @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);
/**
*
* Retrieves a transcript of the session. Note that ConnectionToken is used for invoking this API instead of
* ParticipantToken.
*
*
* @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. Note that ConnectionToken is used for invoking this API instead of
* ParticipantToken.
*
*
* @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. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
*
*
* @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. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
*
*
* @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. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
*
*
* @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. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
*
*
* @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);
}