com.amazonaws.services.connectparticipant

Class AbstractAmazonConnectParticipant

java.lang.Object

com.amazonaws.services.connectparticipant.AbstractAmazonConnectParticipant

All Implemented Interfaces:

AmazonConnectParticipant

Direct Known Subclasses:

AbstractAmazonConnectParticipantAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonConnectParticipant
extends Object
implements AmazonConnectParticipant

Abstract implementation of AmazonConnectParticipant. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.connectparticipant.AmazonConnectParticipant

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
CreateParticipantConnectionResult	createParticipantConnection(CreateParticipantConnectionRequest request) Creates the participant's connection.
DisconnectParticipantResult	disconnectParticipant(DisconnectParticipantRequest request) Disconnects a participant.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetTranscriptResult	getTranscript(GetTranscriptRequest request) Retrieves a transcript of the session.
SendEventResult	sendEvent(SendEventRequest request) Sends an event.
SendMessageResult	sendMessage(SendMessageRequest request) Sends a message.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createParticipantConnection

public CreateParticipantConnectionResult createParticipantConnection(CreateParticipantConnectionRequest request)

Description copied from interface: 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.

Specified by:

createParticipantConnection in interface AmazonConnectParticipant

Returns:

Result of the CreateParticipantConnection operation returned by the service.

See Also:

AWS API Documentation

disconnectParticipant

public DisconnectParticipantResult disconnectParticipant(DisconnectParticipantRequest request)

Description copied from interface: AmazonConnectParticipant

Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

Specified by:

disconnectParticipant in interface AmazonConnectParticipant

Returns:

Result of the DisconnectParticipant operation returned by the service.

See Also:

AWS API Documentation

getTranscript

public GetTranscriptResult getTranscript(GetTranscriptRequest request)

Description copied from interface: AmazonConnectParticipant

Retrieves a transcript of the session. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

Specified by:

getTranscript in interface AmazonConnectParticipant

Returns:

Result of the GetTranscript operation returned by the service.

See Also:

AWS API Documentation

sendEvent

public SendEventResult sendEvent(SendEventRequest request)

Description copied from interface: AmazonConnectParticipant

Sends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

Specified by:

sendEvent in interface AmazonConnectParticipant

Returns:

Result of the SendEvent operation returned by the service.

See Also:

AWS API Documentation

sendMessage

public SendMessageResult sendMessage(SendMessageRequest request)

Description copied from interface: AmazonConnectParticipant

Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

Specified by:

sendMessage in interface AmazonConnectParticipant

Returns:

Result of the SendMessage operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonConnectParticipant

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonConnectParticipant

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonConnectParticipant

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Specified by:

getCachedResponseMetadata in interface AmazonConnectParticipant

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.