public class PersistentChat
extends java.lang.Object
implements java.io.Serializable
Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.
| Constructor and Description |
|---|
PersistentChat() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getRehydrationType()
The contactId that is used for rehydration depends on the rehydration
type.
|
java.lang.String |
getSourceContactId()
The contactId from which a persistent chat session must be started.
|
int |
hashCode() |
void |
setRehydrationType(RehydrationType rehydrationType)
The contactId that is used for rehydration depends on the rehydration
type.
|
void |
setRehydrationType(java.lang.String rehydrationType)
The contactId that is used for rehydration depends on the rehydration
type.
|
void |
setSourceContactId(java.lang.String sourceContactId)
The contactId from which a persistent chat session must be started.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
PersistentChat |
withRehydrationType(RehydrationType rehydrationType)
The contactId that is used for rehydration depends on the rehydration
type.
|
PersistentChat |
withRehydrationType(java.lang.String rehydrationType)
The contactId that is used for rehydration depends on the rehydration
type.
|
PersistentChat |
withSourceContactId(java.lang.String sourceContactId)
The contactId from which a persistent chat session must be started.
|
public java.lang.String getRehydrationType()
The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat.
ENTIRE_PAST_SESSION: Rehydrates a chat from the most
recently terminated past chat contact of the specified past ended chat
session. To use this type, provide the initialContactId of
the past ended chat session in the sourceContactId field. In
this type, Amazon Connect determines the most recent chat contact on the
specified chat session that has ended, and uses it to start a persistent
chat.
FROM_SEGMENT: Rehydrates a chat from the past chat contact
that is specified in the sourceContactId field.
The actual contactId used for rehydration is provided in the response of this API.
Constraints:
Allowed Values: ENTIRE_PAST_SESSION, FROM_SEGMENT
The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat.
ENTIRE_PAST_SESSION: Rehydrates a chat from the most
recently terminated past chat contact of the specified past ended
chat session. To use this type, provide the
initialContactId of the past ended chat session in
the sourceContactId field. In this type, Amazon
Connect determines the most recent chat contact on the specified
chat session that has ended, and uses it to start a persistent
chat.
FROM_SEGMENT: Rehydrates a chat from the past chat
contact that is specified in the sourceContactId
field.
The actual contactId used for rehydration is provided in the response of this API.
RehydrationTypepublic void setRehydrationType(java.lang.String rehydrationType)
The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat.
ENTIRE_PAST_SESSION: Rehydrates a chat from the most
recently terminated past chat contact of the specified past ended chat
session. To use this type, provide the initialContactId of
the past ended chat session in the sourceContactId field. In
this type, Amazon Connect determines the most recent chat contact on the
specified chat session that has ended, and uses it to start a persistent
chat.
FROM_SEGMENT: Rehydrates a chat from the past chat contact
that is specified in the sourceContactId field.
The actual contactId used for rehydration is provided in the response of this API.
Constraints:
Allowed Values: ENTIRE_PAST_SESSION, FROM_SEGMENT
rehydrationType - The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat.
ENTIRE_PAST_SESSION: Rehydrates a chat from the
most recently terminated past chat contact of the specified
past ended chat session. To use this type, provide the
initialContactId of the past ended chat session
in the sourceContactId field. In this type,
Amazon Connect determines the most recent chat contact on the
specified chat session that has ended, and uses it to start a
persistent chat.
FROM_SEGMENT: Rehydrates a chat from the past
chat contact that is specified in the
sourceContactId field.
The actual contactId used for rehydration is provided in the response of this API.
RehydrationTypepublic PersistentChat withRehydrationType(java.lang.String rehydrationType)
The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat.
ENTIRE_PAST_SESSION: Rehydrates a chat from the most
recently terminated past chat contact of the specified past ended chat
session. To use this type, provide the initialContactId of
the past ended chat session in the sourceContactId field. In
this type, Amazon Connect determines the most recent chat contact on the
specified chat session that has ended, and uses it to start a persistent
chat.
FROM_SEGMENT: Rehydrates a chat from the past chat contact
that is specified in the sourceContactId field.
The actual contactId used for rehydration is provided in the response of this API.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ENTIRE_PAST_SESSION, FROM_SEGMENT
rehydrationType - The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat.
ENTIRE_PAST_SESSION: Rehydrates a chat from the
most recently terminated past chat contact of the specified
past ended chat session. To use this type, provide the
initialContactId of the past ended chat session
in the sourceContactId field. In this type,
Amazon Connect determines the most recent chat contact on the
specified chat session that has ended, and uses it to start a
persistent chat.
FROM_SEGMENT: Rehydrates a chat from the past
chat contact that is specified in the
sourceContactId field.
The actual contactId used for rehydration is provided in the response of this API.
RehydrationTypepublic void setRehydrationType(RehydrationType rehydrationType)
The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat.
ENTIRE_PAST_SESSION: Rehydrates a chat from the most
recently terminated past chat contact of the specified past ended chat
session. To use this type, provide the initialContactId of
the past ended chat session in the sourceContactId field. In
this type, Amazon Connect determines the most recent chat contact on the
specified chat session that has ended, and uses it to start a persistent
chat.
FROM_SEGMENT: Rehydrates a chat from the past chat contact
that is specified in the sourceContactId field.
The actual contactId used for rehydration is provided in the response of this API.
Constraints:
Allowed Values: ENTIRE_PAST_SESSION, FROM_SEGMENT
rehydrationType - The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat.
ENTIRE_PAST_SESSION: Rehydrates a chat from the
most recently terminated past chat contact of the specified
past ended chat session. To use this type, provide the
initialContactId of the past ended chat session
in the sourceContactId field. In this type,
Amazon Connect determines the most recent chat contact on the
specified chat session that has ended, and uses it to start a
persistent chat.
FROM_SEGMENT: Rehydrates a chat from the past
chat contact that is specified in the
sourceContactId field.
The actual contactId used for rehydration is provided in the response of this API.
RehydrationTypepublic PersistentChat withRehydrationType(RehydrationType rehydrationType)
The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat.
ENTIRE_PAST_SESSION: Rehydrates a chat from the most
recently terminated past chat contact of the specified past ended chat
session. To use this type, provide the initialContactId of
the past ended chat session in the sourceContactId field. In
this type, Amazon Connect determines the most recent chat contact on the
specified chat session that has ended, and uses it to start a persistent
chat.
FROM_SEGMENT: Rehydrates a chat from the past chat contact
that is specified in the sourceContactId field.
The actual contactId used for rehydration is provided in the response of this API.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ENTIRE_PAST_SESSION, FROM_SEGMENT
rehydrationType - The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat.
ENTIRE_PAST_SESSION: Rehydrates a chat from the
most recently terminated past chat contact of the specified
past ended chat session. To use this type, provide the
initialContactId of the past ended chat session
in the sourceContactId field. In this type,
Amazon Connect determines the most recent chat contact on the
specified chat session that has ended, and uses it to start a
persistent chat.
FROM_SEGMENT: Rehydrates a chat from the past
chat contact that is specified in the
sourceContactId field.
The actual contactId used for rehydration is provided in the response of this API.
RehydrationTypepublic java.lang.String getSourceContactId()
The contactId from which a persistent chat session must be started.
Constraints:
Length: 1 - 256
The contactId from which a persistent chat session must be started.
public void setSourceContactId(java.lang.String sourceContactId)
The contactId from which a persistent chat session must be started.
Constraints:
Length: 1 - 256
sourceContactId - The contactId from which a persistent chat session must be started.
public PersistentChat withSourceContactId(java.lang.String sourceContactId)
The contactId from which a persistent chat session must be started.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 256
sourceContactId - The contactId from which a persistent chat session must be started.
public java.lang.String toString()
toString in class java.lang.ObjectObject.toString()public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Object