public class ParticipantTimerConfiguration
extends java.lang.Object
implements java.io.Serializable
Configuration information for the timer. After the timer configuration is set, it persists for the duration of the chat. It persists across new contacts in the chain, for example, transfer contacts.
For more information about how chat timeouts work, see Set up chat timeouts for human participants.
| Constructor and Description |
|---|
ParticipantTimerConfiguration() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getParticipantRole()
The role of the participant in the chat conversation.
|
java.lang.String |
getTimerType()
The type of timer.
|
ParticipantTimerValue |
getTimerValue()
The value of the timer.
|
int |
hashCode() |
void |
setParticipantRole(java.lang.String participantRole)
The role of the participant in the chat conversation.
|
void |
setParticipantRole(TimerEligibleParticipantRoles participantRole)
The role of the participant in the chat conversation.
|
void |
setTimerType(ParticipantTimerType timerType)
The type of timer.
|
void |
setTimerType(java.lang.String timerType)
The type of timer.
|
void |
setTimerValue(ParticipantTimerValue timerValue)
The value of the timer.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ParticipantTimerConfiguration |
withParticipantRole(java.lang.String participantRole)
The role of the participant in the chat conversation.
|
ParticipantTimerConfiguration |
withParticipantRole(TimerEligibleParticipantRoles participantRole)
The role of the participant in the chat conversation.
|
ParticipantTimerConfiguration |
withTimerType(ParticipantTimerType timerType)
The type of timer.
|
ParticipantTimerConfiguration |
withTimerType(java.lang.String timerType)
The type of timer.
|
ParticipantTimerConfiguration |
withTimerValue(ParticipantTimerValue timerValue)
The value of the timer.
|
public java.lang.String getParticipantRole()
The role of the participant in the chat conversation.
Constraints:
Allowed Values: CUSTOMER, AGENT
The role of the participant in the chat conversation.
TimerEligibleParticipantRolespublic void setParticipantRole(java.lang.String participantRole)
The role of the participant in the chat conversation.
Constraints:
Allowed Values: CUSTOMER, AGENT
participantRole - The role of the participant in the chat conversation.
TimerEligibleParticipantRolespublic ParticipantTimerConfiguration withParticipantRole(java.lang.String participantRole)
The role of the participant in the chat conversation.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CUSTOMER, AGENT
participantRole - The role of the participant in the chat conversation.
TimerEligibleParticipantRolespublic void setParticipantRole(TimerEligibleParticipantRoles participantRole)
The role of the participant in the chat conversation.
Constraints:
Allowed Values: CUSTOMER, AGENT
participantRole - The role of the participant in the chat conversation.
TimerEligibleParticipantRolespublic ParticipantTimerConfiguration withParticipantRole(TimerEligibleParticipantRoles participantRole)
The role of the participant in the chat conversation.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CUSTOMER, AGENT
participantRole - The role of the participant in the chat conversation.
TimerEligibleParticipantRolespublic java.lang.String getTimerType()
The type of timer. IDLE indicates the timer applies for
considering a human chat participant as idle.
DISCONNECT_NONCUSTOMER indicates the timer applies to
automatically disconnecting a chat participant due to idleness.
Constraints:
Allowed Values: IDLE, DISCONNECT_NONCUSTOMER
The type of timer. IDLE indicates the timer applies
for considering a human chat participant as idle.
DISCONNECT_NONCUSTOMER indicates the timer applies
to automatically disconnecting a chat participant due to
idleness.
ParticipantTimerTypepublic void setTimerType(java.lang.String timerType)
The type of timer. IDLE indicates the timer applies for
considering a human chat participant as idle.
DISCONNECT_NONCUSTOMER indicates the timer applies to
automatically disconnecting a chat participant due to idleness.
Constraints:
Allowed Values: IDLE, DISCONNECT_NONCUSTOMER
timerType -
The type of timer. IDLE indicates the timer
applies for considering a human chat participant as idle.
DISCONNECT_NONCUSTOMER indicates the timer
applies to automatically disconnecting a chat participant due
to idleness.
ParticipantTimerTypepublic ParticipantTimerConfiguration withTimerType(java.lang.String timerType)
The type of timer. IDLE indicates the timer applies for
considering a human chat participant as idle.
DISCONNECT_NONCUSTOMER indicates the timer applies to
automatically disconnecting a chat participant due to idleness.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: IDLE, DISCONNECT_NONCUSTOMER
timerType -
The type of timer. IDLE indicates the timer
applies for considering a human chat participant as idle.
DISCONNECT_NONCUSTOMER indicates the timer
applies to automatically disconnecting a chat participant due
to idleness.
ParticipantTimerTypepublic void setTimerType(ParticipantTimerType timerType)
The type of timer. IDLE indicates the timer applies for
considering a human chat participant as idle.
DISCONNECT_NONCUSTOMER indicates the timer applies to
automatically disconnecting a chat participant due to idleness.
Constraints:
Allowed Values: IDLE, DISCONNECT_NONCUSTOMER
timerType -
The type of timer. IDLE indicates the timer
applies for considering a human chat participant as idle.
DISCONNECT_NONCUSTOMER indicates the timer
applies to automatically disconnecting a chat participant due
to idleness.
ParticipantTimerTypepublic ParticipantTimerConfiguration withTimerType(ParticipantTimerType timerType)
The type of timer. IDLE indicates the timer applies for
considering a human chat participant as idle.
DISCONNECT_NONCUSTOMER indicates the timer applies to
automatically disconnecting a chat participant due to idleness.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: IDLE, DISCONNECT_NONCUSTOMER
timerType -
The type of timer. IDLE indicates the timer
applies for considering a human chat participant as idle.
DISCONNECT_NONCUSTOMER indicates the timer
applies to automatically disconnecting a chat participant due
to idleness.
ParticipantTimerTypepublic ParticipantTimerValue getTimerValue()
The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.
The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.
public void setTimerValue(ParticipantTimerValue timerValue)
The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.
timerValue - The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.
public ParticipantTimerConfiguration withTimerValue(ParticipantTimerValue timerValue)
The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.
Returns a reference to this object so that method calls can be chained together.
timerValue - The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.
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