Package com.mypurecloud.sdk.v2.model

Class QueueConversationSocialExpressionEventTopicMessage

java.lang.Object

com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicMessage

All Implemented Interfaces:

Serializable

public class QueueConversationSocialExpressionEventTopicMessage
extends Object
implements Serializable

QueueConversationSocialExpressionEventTopicMessage

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	QueueConversationSocialExpressionEventTopicMessage.DirectionEnum	Whether a message is inbound or outbound.
static enum	QueueConversationSocialExpressionEventTopicMessage.DisconnectTypeEnum	System defined string indicating what caused the communication to disconnect.
static enum	QueueConversationSocialExpressionEventTopicMessage.InitialStateEnum	Gets or Sets initialState
static enum	QueueConversationSocialExpressionEventTopicMessage.StateEnum	Gets or Sets state
static enum	QueueConversationSocialExpressionEventTopicMessage.TypeEnum	Indicates the type of message platform from which the message originated.

Constructor Summary

Constructors

Constructor	Description
QueueConversationSocialExpressionEventTopicMessage()
QueueConversationSocialExpressionEventTopicMessage(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
QueueConversationSocialExpressionEventTopicMessage	afterCallWork(QueueConversationSocialExpressionEventTopicAfterCallWork afterCallWork)	A communication's after-call work data.
QueueConversationSocialExpressionEventTopicMessage	afterCallWorkRequired(Boolean afterCallWorkRequired)	Indicates if after-call is required for a communication.
QueueConversationSocialExpressionEventTopicMessage	agentAssistantId(String agentAssistantId)	UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation.
QueueConversationSocialExpressionEventTopicMessage	byoSmsIntegrationId(String byoSmsIntegrationId)
QueueConversationSocialExpressionEventTopicMessage	connectedTime(Date connectedTime)	The timestamp when this communication was connected in the cloud clock.
QueueConversationSocialExpressionEventTopicMessage	direction(QueueConversationSocialExpressionEventTopicMessage.DirectionEnum direction)	Whether a message is inbound or outbound.
QueueConversationSocialExpressionEventTopicMessage	disconnectedTime(Date disconnectedTime)	The timestamp when this communication disconnected from the conversation in the provider clock.
QueueConversationSocialExpressionEventTopicMessage	disconnectType(QueueConversationSocialExpressionEventTopicMessage.DisconnectTypeEnum disconnectType)	System defined string indicating what caused the communication to disconnect.
QueueConversationSocialExpressionEventTopicMessage	engagementSource(String engagementSource)	Provide more visibility into what integrations customers are creating with Open Messaging.
boolean	equals(Object o)
QueueConversationSocialExpressionEventTopicMessage	errorInfo(QueueConversationSocialExpressionEventTopicErrorDetails errorInfo)	Detailed information about an error response.
QueueConversationSocialExpressionEventTopicMessage	fromAddress(QueueConversationSocialExpressionEventTopicAddress fromAddress)	Address and name data for a call endpoint.
QueueConversationSocialExpressionEventTopicAfterCallWork	getAfterCallWork()
Boolean	getAfterCallWorkRequired()
String	getAgentAssistantId()
String	getByoSmsIntegrationId()
Date	getConnectedTime()
QueueConversationSocialExpressionEventTopicMessage.DirectionEnum	getDirection()
Date	getDisconnectedTime()
QueueConversationSocialExpressionEventTopicMessage.DisconnectTypeEnum	getDisconnectType()
String	getEngagementSource()
QueueConversationSocialExpressionEventTopicErrorDetails	getErrorInfo()
QueueConversationSocialExpressionEventTopicAddress	getFromAddress()
Boolean	getHeld()
String	getId()
QueueConversationSocialExpressionEventTopicMessage.InitialStateEnum	getInitialState()
QueueConversationSocialExpressionEventTopicJourneyContext	getJourneyContext()
List<QueueConversationSocialExpressionEventTopicMessageDetails>	getMessages()
String	getMessagesTranscriptUri()
Date	getParkTime()
String	getPeerId()
String	getProvider()
QueueConversationSocialExpressionEventTopicQueueMediaSettings	getQueueMediaSettings()
String	getRecipientCountry()
String	getRecipientType()
Date	getResumeTime()
String	getScriptId()
Date	getStartHoldTime()
QueueConversationSocialExpressionEventTopicMessage.StateEnum	getState()
QueueConversationSocialExpressionEventTopicAddress	getToAddress()
QueueConversationSocialExpressionEventTopicMessage.TypeEnum	getType()
QueueConversationSocialExpressionEventTopicWrapup	getWrapup()
int	hashCode()
QueueConversationSocialExpressionEventTopicMessage	held(Boolean held)	True if this call is held and the person on this side hears silence.
QueueConversationSocialExpressionEventTopicMessage	id(String id)	A globally unique identifier for this communication.
QueueConversationSocialExpressionEventTopicMessage	initialState(QueueConversationSocialExpressionEventTopicMessage.InitialStateEnum initialState)
QueueConversationSocialExpressionEventTopicMessage	journeyContext(QueueConversationSocialExpressionEventTopicJourneyContext journeyContext)	A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context).
QueueConversationSocialExpressionEventTopicMessage	messages(List<QueueConversationSocialExpressionEventTopicMessageDetails> messages)	The messages sent on this communication channel.
QueueConversationSocialExpressionEventTopicMessage	messagesTranscriptUri(String messagesTranscriptUri)	the messages transcript file uri.
QueueConversationSocialExpressionEventTopicMessage	parkTime(Date parkTime)	The time when an parked message was parked.
QueueConversationSocialExpressionEventTopicMessage	peerId(String peerId)	The id of the peer communication corresponding to a matching leg for this communication.
QueueConversationSocialExpressionEventTopicMessage	provider(String provider)	The source provider of the email.
QueueConversationSocialExpressionEventTopicMessage	queueMediaSettings(QueueConversationSocialExpressionEventTopicQueueMediaSettings queueMediaSettings)	Represents the queue setting for this media.
QueueConversationSocialExpressionEventTopicMessage	recipientCountry(String recipientCountry)	Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format.
QueueConversationSocialExpressionEventTopicMessage	recipientType(String recipientType)	The type of the recipient.
QueueConversationSocialExpressionEventTopicMessage	resumeTime(Date resumeTime)	The time when a parked message should resume.
QueueConversationSocialExpressionEventTopicMessage	scriptId(String scriptId)	The UUID of the script to use.
void	setAfterCallWork(QueueConversationSocialExpressionEventTopicAfterCallWork afterCallWork)
void	setAfterCallWorkRequired(Boolean afterCallWorkRequired)
void	setAgentAssistantId(String agentAssistantId)
void	setByoSmsIntegrationId(String byoSmsIntegrationId)
void	setConnectedTime(Date connectedTime)
void	setDirection(QueueConversationSocialExpressionEventTopicMessage.DirectionEnum direction)
void	setDisconnectedTime(Date disconnectedTime)
void	setDisconnectType(QueueConversationSocialExpressionEventTopicMessage.DisconnectTypeEnum disconnectType)
void	setEngagementSource(String engagementSource)
void	setErrorInfo(QueueConversationSocialExpressionEventTopicErrorDetails errorInfo)
void	setFromAddress(QueueConversationSocialExpressionEventTopicAddress fromAddress)
void	setHeld(Boolean held)
void	setId(String id)
void	setInitialState(QueueConversationSocialExpressionEventTopicMessage.InitialStateEnum initialState)
void	setJourneyContext(QueueConversationSocialExpressionEventTopicJourneyContext journeyContext)
void	setMessages(List<QueueConversationSocialExpressionEventTopicMessageDetails> messages)
void	setMessagesTranscriptUri(String messagesTranscriptUri)
void	setParkTime(Date parkTime)
void	setPeerId(String peerId)
void	setProvider(String provider)
void	setQueueMediaSettings(QueueConversationSocialExpressionEventTopicQueueMediaSettings queueMediaSettings)
void	setRecipientCountry(String recipientCountry)
void	setRecipientType(String recipientType)
void	setResumeTime(Date resumeTime)
void	setScriptId(String scriptId)
void	setStartHoldTime(Date startHoldTime)
void	setState(QueueConversationSocialExpressionEventTopicMessage.StateEnum state)
void	setToAddress(QueueConversationSocialExpressionEventTopicAddress toAddress)
void	setType(QueueConversationSocialExpressionEventTopicMessage.TypeEnum type)
void	setWrapup(QueueConversationSocialExpressionEventTopicWrapup wrapup)
QueueConversationSocialExpressionEventTopicMessage	startHoldTime(Date startHoldTime)	The timestamp the email was placed on hold in the cloud clock if the email is currently on hold.
QueueConversationSocialExpressionEventTopicMessage	state(QueueConversationSocialExpressionEventTopicMessage.StateEnum state)
QueueConversationSocialExpressionEventTopicMessage	toAddress(QueueConversationSocialExpressionEventTopicAddress toAddress)	Address and name data for a call endpoint.
String	toString()
QueueConversationSocialExpressionEventTopicMessage	type(QueueConversationSocialExpressionEventTopicMessage.TypeEnum type)	Indicates the type of message platform from which the message originated.
QueueConversationSocialExpressionEventTopicMessage	wrapup(QueueConversationSocialExpressionEventTopicWrapup wrapup)	Call wrap up or disposition data.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

QueueConversationSocialExpressionEventTopicMessage

public QueueConversationSocialExpressionEventTopicMessage()

QueueConversationSocialExpressionEventTopicMessage

public QueueConversationSocialExpressionEventTopicMessage(Boolean initWithEmptyList)

Method Details

id

public QueueConversationSocialExpressionEventTopicMessage id(String id)

A globally unique identifier for this communication.

getId

public String getId()

setId

public void setId(String id)

state

public QueueConversationSocialExpressionEventTopicMessage state(QueueConversationSocialExpressionEventTopicMessage.StateEnum state)

getState

public QueueConversationSocialExpressionEventTopicMessage.StateEnum getState()

setState

public void setState(QueueConversationSocialExpressionEventTopicMessage.StateEnum state)

initialState

public QueueConversationSocialExpressionEventTopicMessage initialState(QueueConversationSocialExpressionEventTopicMessage.InitialStateEnum initialState)

getInitialState

public QueueConversationSocialExpressionEventTopicMessage.InitialStateEnum getInitialState()

setInitialState

public void setInitialState(QueueConversationSocialExpressionEventTopicMessage.InitialStateEnum initialState)

direction

public QueueConversationSocialExpressionEventTopicMessage direction(QueueConversationSocialExpressionEventTopicMessage.DirectionEnum direction)

Whether a message is inbound or outbound.

getDirection

public QueueConversationSocialExpressionEventTopicMessage.DirectionEnum getDirection()

setDirection

public void setDirection(QueueConversationSocialExpressionEventTopicMessage.DirectionEnum direction)

held

public QueueConversationSocialExpressionEventTopicMessage held(Boolean held)

True if this call is held and the person on this side hears silence.

getHeld

public Boolean getHeld()

setHeld

public void setHeld(Boolean held)

errorInfo

public QueueConversationSocialExpressionEventTopicMessage errorInfo(QueueConversationSocialExpressionEventTopicErrorDetails errorInfo)

Detailed information about an error response.

getErrorInfo

public QueueConversationSocialExpressionEventTopicErrorDetails getErrorInfo()

setErrorInfo

public void setErrorInfo(QueueConversationSocialExpressionEventTopicErrorDetails errorInfo)

provider

public QueueConversationSocialExpressionEventTopicMessage provider(String provider)

The source provider of the email.

getProvider

public String getProvider()

setProvider

public void setProvider(String provider)

scriptId

public QueueConversationSocialExpressionEventTopicMessage scriptId(String scriptId)

The UUID of the script to use.

getScriptId

public String getScriptId()

setScriptId

public void setScriptId(String scriptId)

peerId

public QueueConversationSocialExpressionEventTopicMessage peerId(String peerId)

The id of the peer communication corresponding to a matching leg for this communication.

getPeerId

public String getPeerId()

setPeerId

public void setPeerId(String peerId)

disconnectType

public QueueConversationSocialExpressionEventTopicMessage disconnectType(QueueConversationSocialExpressionEventTopicMessage.DisconnectTypeEnum disconnectType)

System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.

getDisconnectType

public QueueConversationSocialExpressionEventTopicMessage.DisconnectTypeEnum getDisconnectType()

setDisconnectType

public void setDisconnectType(QueueConversationSocialExpressionEventTopicMessage.DisconnectTypeEnum disconnectType)

startHoldTime

public QueueConversationSocialExpressionEventTopicMessage startHoldTime(Date startHoldTime)

The timestamp the email was placed on hold in the cloud clock if the email is currently on hold.

getStartHoldTime

public Date getStartHoldTime()

setStartHoldTime

public void setStartHoldTime(Date startHoldTime)

connectedTime

public QueueConversationSocialExpressionEventTopicMessage connectedTime(Date connectedTime)

The timestamp when this communication was connected in the cloud clock.

getConnectedTime

public Date getConnectedTime()

setConnectedTime

public void setConnectedTime(Date connectedTime)

disconnectedTime

public QueueConversationSocialExpressionEventTopicMessage disconnectedTime(Date disconnectedTime)

The timestamp when this communication disconnected from the conversation in the provider clock.

getDisconnectedTime

public Date getDisconnectedTime()

setDisconnectedTime

public void setDisconnectedTime(Date disconnectedTime)

toAddress

public QueueConversationSocialExpressionEventTopicMessage toAddress(QueueConversationSocialExpressionEventTopicAddress toAddress)

Address and name data for a call endpoint.

getToAddress

public QueueConversationSocialExpressionEventTopicAddress getToAddress()

setToAddress

public void setToAddress(QueueConversationSocialExpressionEventTopicAddress toAddress)

fromAddress

public QueueConversationSocialExpressionEventTopicMessage fromAddress(QueueConversationSocialExpressionEventTopicAddress fromAddress)

Address and name data for a call endpoint.

getFromAddress

public QueueConversationSocialExpressionEventTopicAddress getFromAddress()

setFromAddress

public void setFromAddress(QueueConversationSocialExpressionEventTopicAddress fromAddress)

messages

public QueueConversationSocialExpressionEventTopicMessage messages(List<QueueConversationSocialExpressionEventTopicMessageDetails> messages)

The messages sent on this communication channel.

getMessages

public List<QueueConversationSocialExpressionEventTopicMessageDetails> getMessages()

setMessages

public void setMessages(List<QueueConversationSocialExpressionEventTopicMessageDetails> messages)

messagesTranscriptUri

public QueueConversationSocialExpressionEventTopicMessage messagesTranscriptUri(String messagesTranscriptUri)

the messages transcript file uri.

getMessagesTranscriptUri

public String getMessagesTranscriptUri()

setMessagesTranscriptUri

public void setMessagesTranscriptUri(String messagesTranscriptUri)

type

public QueueConversationSocialExpressionEventTopicMessage type(QueueConversationSocialExpressionEventTopicMessage.TypeEnum type)

Indicates the type of message platform from which the message originated.

getType

public QueueConversationSocialExpressionEventTopicMessage.TypeEnum getType()

setType

public void setType(QueueConversationSocialExpressionEventTopicMessage.TypeEnum type)

recipientCountry

public QueueConversationSocialExpressionEventTopicMessage recipientCountry(String recipientCountry)

Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format.

getRecipientCountry

public String getRecipientCountry()

setRecipientCountry

public void setRecipientCountry(String recipientCountry)

recipientType

public QueueConversationSocialExpressionEventTopicMessage recipientType(String recipientType)

The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type.

getRecipientType

public String getRecipientType()

setRecipientType

public void setRecipientType(String recipientType)

journeyContext

public QueueConversationSocialExpressionEventTopicMessage journeyContext(QueueConversationSocialExpressionEventTopicJourneyContext journeyContext)

A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context).

getJourneyContext

public QueueConversationSocialExpressionEventTopicJourneyContext getJourneyContext()

setJourneyContext

public void setJourneyContext(QueueConversationSocialExpressionEventTopicJourneyContext journeyContext)

wrapup

public QueueConversationSocialExpressionEventTopicMessage wrapup(QueueConversationSocialExpressionEventTopicWrapup wrapup)

Call wrap up or disposition data.

getWrapup

public QueueConversationSocialExpressionEventTopicWrapup getWrapup()

setWrapup

public void setWrapup(QueueConversationSocialExpressionEventTopicWrapup wrapup)

afterCallWork

public QueueConversationSocialExpressionEventTopicMessage afterCallWork(QueueConversationSocialExpressionEventTopicAfterCallWork afterCallWork)

A communication's after-call work data.

getAfterCallWork

public QueueConversationSocialExpressionEventTopicAfterCallWork getAfterCallWork()

setAfterCallWork

public void setAfterCallWork(QueueConversationSocialExpressionEventTopicAfterCallWork afterCallWork)

afterCallWorkRequired

public QueueConversationSocialExpressionEventTopicMessage afterCallWorkRequired(Boolean afterCallWorkRequired)

Indicates if after-call is required for a communication. Only used when the ACW Setting is Agent Requested.

getAfterCallWorkRequired

public Boolean getAfterCallWorkRequired()

setAfterCallWorkRequired

public void setAfterCallWorkRequired(Boolean afterCallWorkRequired)

agentAssistantId

public QueueConversationSocialExpressionEventTopicMessage agentAssistantId(String agentAssistantId)

UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation.

getAgentAssistantId

public String getAgentAssistantId()

setAgentAssistantId

public void setAgentAssistantId(String agentAssistantId)

engagementSource

public QueueConversationSocialExpressionEventTopicMessage engagementSource(String engagementSource)

Provide more visibility into what integrations customers are creating with Open Messaging. String values are defined in the Constants.java named ENGAGEMENT_SOURCE_*

getEngagementSource

public String getEngagementSource()

setEngagementSource

public void setEngagementSource(String engagementSource)

byoSmsIntegrationId

public QueueConversationSocialExpressionEventTopicMessage byoSmsIntegrationId(String byoSmsIntegrationId)

getByoSmsIntegrationId

public String getByoSmsIntegrationId()

setByoSmsIntegrationId

public void setByoSmsIntegrationId(String byoSmsIntegrationId)

queueMediaSettings

public QueueConversationSocialExpressionEventTopicMessage queueMediaSettings(QueueConversationSocialExpressionEventTopicQueueMediaSettings queueMediaSettings)

Represents the queue setting for this media.

getQueueMediaSettings

public QueueConversationSocialExpressionEventTopicQueueMediaSettings getQueueMediaSettings()

setQueueMediaSettings

public void setQueueMediaSettings(QueueConversationSocialExpressionEventTopicQueueMediaSettings queueMediaSettings)

resumeTime

public QueueConversationSocialExpressionEventTopicMessage resumeTime(Date resumeTime)

The time when a parked message should resume.

getResumeTime

public Date getResumeTime()

setResumeTime

public void setResumeTime(Date resumeTime)

parkTime

public QueueConversationSocialExpressionEventTopicMessage parkTime(Date parkTime)

The time when an parked message was parked.

getParkTime

public Date getParkTime()

setParkTime

public void setParkTime(Date parkTime)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object