Package com.mypurecloud.sdk.v2.model

Class QueueConversationVideoEventTopicMessage

java.lang.Object

com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicMessage

All Implemented Interfaces:

Serializable

public class QueueConversationVideoEventTopicMessage
extends Object
implements Serializable

QueueConversationVideoEventTopicMessage

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
QueueConversationVideoEventTopicMessage()
QueueConversationVideoEventTopicMessage(Boolean initWithEmptyList)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

QueueConversationVideoEventTopicMessage

public QueueConversationVideoEventTopicMessage()

QueueConversationVideoEventTopicMessage

public QueueConversationVideoEventTopicMessage(Boolean initWithEmptyList)

Method Details

id

public QueueConversationVideoEventTopicMessage id(String id)

A globally unique identifier for this communication.

getId

public String getId()

setId

public void setId(String id)

state

public QueueConversationVideoEventTopicMessage state(QueueConversationVideoEventTopicMessage.StateEnum state)

getState

public QueueConversationVideoEventTopicMessage.StateEnum getState()

setState

public void setState(QueueConversationVideoEventTopicMessage.StateEnum state)

initialState

public QueueConversationVideoEventTopicMessage initialState(QueueConversationVideoEventTopicMessage.InitialStateEnum initialState)

getInitialState

public QueueConversationVideoEventTopicMessage.InitialStateEnum getInitialState()

setInitialState

public void setInitialState(QueueConversationVideoEventTopicMessage.InitialStateEnum initialState)

direction

public QueueConversationVideoEventTopicMessage direction(QueueConversationVideoEventTopicMessage.DirectionEnum direction)

Whether a message is inbound or outbound.

getDirection

public QueueConversationVideoEventTopicMessage.DirectionEnum getDirection()

setDirection

public void setDirection(QueueConversationVideoEventTopicMessage.DirectionEnum direction)

held

public QueueConversationVideoEventTopicMessage 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 QueueConversationVideoEventTopicMessage errorInfo(QueueConversationVideoEventTopicErrorDetails errorInfo)

Detailed information about an error response.

getErrorInfo

public QueueConversationVideoEventTopicErrorDetails getErrorInfo()

setErrorInfo

public void setErrorInfo(QueueConversationVideoEventTopicErrorDetails errorInfo)

provider

public QueueConversationVideoEventTopicMessage provider(String provider)

The source provider of the email.

getProvider

public String getProvider()

setProvider

public void setProvider(String provider)

scriptId

public QueueConversationVideoEventTopicMessage scriptId(String scriptId)

The UUID of the script to use.

getScriptId

public String getScriptId()

setScriptId

public void setScriptId(String scriptId)

peerId

public QueueConversationVideoEventTopicMessage 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 QueueConversationVideoEventTopicMessage disconnectType(QueueConversationVideoEventTopicMessage.DisconnectTypeEnum disconnectType)

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

getDisconnectType

public QueueConversationVideoEventTopicMessage.DisconnectTypeEnum getDisconnectType()

setDisconnectType

public void setDisconnectType(QueueConversationVideoEventTopicMessage.DisconnectTypeEnum disconnectType)

startHoldTime

public QueueConversationVideoEventTopicMessage 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 QueueConversationVideoEventTopicMessage 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 QueueConversationVideoEventTopicMessage 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 QueueConversationVideoEventTopicMessage toAddress(QueueConversationVideoEventTopicAddress toAddress)

Address and name data for a call endpoint.

getToAddress

public QueueConversationVideoEventTopicAddress getToAddress()

setToAddress

public void setToAddress(QueueConversationVideoEventTopicAddress toAddress)

fromAddress

public QueueConversationVideoEventTopicMessage fromAddress(QueueConversationVideoEventTopicAddress fromAddress)

Address and name data for a call endpoint.

getFromAddress

public QueueConversationVideoEventTopicAddress getFromAddress()

setFromAddress

public void setFromAddress(QueueConversationVideoEventTopicAddress fromAddress)

messages

public QueueConversationVideoEventTopicMessage messages(List<QueueConversationVideoEventTopicMessageDetails> messages)

The messages sent on this communication channel.

getMessages

public List<QueueConversationVideoEventTopicMessageDetails> getMessages()

setMessages

public void setMessages(List<QueueConversationVideoEventTopicMessageDetails> messages)

messagesTranscriptUri

public QueueConversationVideoEventTopicMessage messagesTranscriptUri(String messagesTranscriptUri)

the messages transcript file uri.

getMessagesTranscriptUri

public String getMessagesTranscriptUri()

setMessagesTranscriptUri

public void setMessagesTranscriptUri(String messagesTranscriptUri)

type

public QueueConversationVideoEventTopicMessage type(QueueConversationVideoEventTopicMessage.TypeEnum type)

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

getType

public QueueConversationVideoEventTopicMessage.TypeEnum getType()

setType

public void setType(QueueConversationVideoEventTopicMessage.TypeEnum type)

recipientCountry

public QueueConversationVideoEventTopicMessage 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 QueueConversationVideoEventTopicMessage 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 QueueConversationVideoEventTopicMessage journeyContext(QueueConversationVideoEventTopicJourneyContext 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 QueueConversationVideoEventTopicJourneyContext getJourneyContext()

setJourneyContext

public void setJourneyContext(QueueConversationVideoEventTopicJourneyContext journeyContext)

wrapup

public QueueConversationVideoEventTopicMessage wrapup(QueueConversationVideoEventTopicWrapup wrapup)

Call wrap up or disposition data.

getWrapup

public QueueConversationVideoEventTopicWrapup getWrapup()

setWrapup

public void setWrapup(QueueConversationVideoEventTopicWrapup wrapup)

afterCallWork

public QueueConversationVideoEventTopicMessage afterCallWork(QueueConversationVideoEventTopicAfterCallWork afterCallWork)

A communication's after-call work data.

getAfterCallWork

public QueueConversationVideoEventTopicAfterCallWork getAfterCallWork()

setAfterCallWork

public void setAfterCallWork(QueueConversationVideoEventTopicAfterCallWork afterCallWork)

afterCallWorkRequired

public QueueConversationVideoEventTopicMessage 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 QueueConversationVideoEventTopicMessage 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 QueueConversationVideoEventTopicMessage 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 QueueConversationVideoEventTopicMessage byoSmsIntegrationId(String byoSmsIntegrationId)

getByoSmsIntegrationId

public String getByoSmsIntegrationId()

setByoSmsIntegrationId

public void setByoSmsIntegrationId(String byoSmsIntegrationId)

queueMediaSettings

public QueueConversationVideoEventTopicMessage queueMediaSettings(QueueConversationVideoEventTopicQueueMediaSettings queueMediaSettings)

Represents the queue setting for this media.

getQueueMediaSettings

public QueueConversationVideoEventTopicQueueMediaSettings getQueueMediaSettings()

setQueueMediaSettings

public void setQueueMediaSettings(QueueConversationVideoEventTopicQueueMediaSettings queueMediaSettings)

resumeTime

public QueueConversationVideoEventTopicMessage resumeTime(Date resumeTime)

The time when a parked message should resume.

getResumeTime

public Date getResumeTime()

setResumeTime

public void setResumeTime(Date resumeTime)

parkTime

public QueueConversationVideoEventTopicMessage 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