@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonConnectParticipant extends Object implements AmazonConnectParticipant
AmazonConnectParticipant. Convenient method forms pass through to the
corresponding overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| 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.
|
public CreateParticipantConnectionResult createParticipantConnection(CreateParticipantConnectionRequest request)
AmazonConnectParticipantCreates 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.
createParticipantConnection in interface AmazonConnectParticipantpublic DisconnectParticipantResult disconnectParticipant(DisconnectParticipantRequest request)
AmazonConnectParticipantDisconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
disconnectParticipant in interface AmazonConnectParticipantpublic GetTranscriptResult getTranscript(GetTranscriptRequest request)
AmazonConnectParticipantRetrieves a transcript of the session. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
getTranscript in interface AmazonConnectParticipantpublic SendEventResult sendEvent(SendEventRequest request)
AmazonConnectParticipantSends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
sendEvent in interface AmazonConnectParticipantpublic SendMessageResult sendMessage(SendMessageRequest request)
AmazonConnectParticipantSends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
sendMessage in interface AmazonConnectParticipantpublic void shutdown()
AmazonConnectParticipantshutdown in interface AmazonConnectParticipantpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonConnectParticipantResponse 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.
getCachedResponseMetadata in interface AmazonConnectParticipantrequest - The originally executed request.