com.amazonaws.services.connectparticipant.model

Class CreateParticipantConnectionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connectparticipant.model.CreateParticipantConnectionRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreateParticipantConnectionRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

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

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateParticipantConnectionRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getParticipantToken() This is a header parameter.
java.util.List<java.lang.String>	getType() Type of connection information required.
int	hashCode()
void	setParticipantToken(java.lang.String participantToken) This is a header parameter.
void	setType(java.util.Collection<java.lang.String> type) Type of connection information required.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateParticipantConnectionRequest	withParticipantToken(java.lang.String participantToken) This is a header parameter.
CreateParticipantConnectionRequest	withType(java.util.Collection<java.lang.String> type) Type of connection information required.
CreateParticipantConnectionRequest	withType(java.lang.String... type) Type of connection information required.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateParticipantConnectionRequest

public CreateParticipantConnectionRequest()

Method Detail

getType

public java.util.List<java.lang.String> getType()

Type of connection information required.

Returns:

Type of connection information required.

setType

public void setType(java.util.Collection<java.lang.String> type)

Type of connection information required.

Parameters:

type -

Type of connection information required.

withType

public CreateParticipantConnectionRequest withType(java.lang.String... type)

Type of connection information required.

Returns a reference to this object so that method calls can be chained together.

Parameters:

type -

Type of connection information required.

Returns:

A reference to this updated object so that method calls can be chained together.

withType

public CreateParticipantConnectionRequest withType(java.util.Collection<java.lang.String> type)

Type of connection information required.

Returns a reference to this object so that method calls can be chained together.

Parameters:

type -

Type of connection information required.

Returns:

A reference to this updated object so that method calls can be chained together.

getParticipantToken

public java.lang.String getParticipantToken()

This is a header parameter.

The Participant Token as obtained from StartChatContact API response.

Constraints:
Length: 1 - 1000

Returns:

This is a header parameter.

The Participant Token as obtained from StartChatContact API response.

setParticipantToken

public void setParticipantToken(java.lang.String participantToken)

This is a header parameter.

The Participant Token as obtained from StartChatContact API response.

Constraints:
Length: 1 - 1000

Parameters:

participantToken -

This is a header parameter.

The Participant Token as obtained from StartChatContact API response.

withParticipantToken

public CreateParticipantConnectionRequest withParticipantToken(java.lang.String participantToken)

This is a header parameter.

The Participant Token as obtained from StartChatContact API response.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 1000

Parameters:

participantToken -

This is a header parameter.

The Participant Token as obtained from StartChatContact API response.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object