Package com.mypurecloud.sdk.v2.model

Class QueueConversationVideoEventTopicCall

java.lang.Object

com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicCall

All Implemented Interfaces:

Serializable

public class QueueConversationVideoEventTopicCall
extends Object
implements Serializable

QueueConversationVideoEventTopicCall

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	QueueConversationVideoEventTopicCall.DirectionEnum	Whether a call is inbound or outbound.
static enum	QueueConversationVideoEventTopicCall.DisconnectTypeEnum	System defined string indicating what caused the communication to disconnect.
static enum	QueueConversationVideoEventTopicCall.InitialStateEnum	Gets or Sets initialState
static enum	QueueConversationVideoEventTopicCall.RecordingStateEnum	State of recording on this call.
static enum	QueueConversationVideoEventTopicCall.StateEnum	Gets or Sets state

Constructor Summary

Constructors

Constructor	Description
QueueConversationVideoEventTopicCall()
QueueConversationVideoEventTopicCall(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
QueueConversationVideoEventTopicCall	afterCallWork(QueueConversationVideoEventTopicAfterCallWork afterCallWork)
QueueConversationVideoEventTopicCall	afterCallWorkRequired(Boolean afterCallWorkRequired)	Indicates if after-call is required for a communication.
QueueConversationVideoEventTopicCall	agentAssistantId(String agentAssistantId)	UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation.
QueueConversationVideoEventTopicCall	bargedTime(Date bargedTime)	The timestamp when this participant was connected to the barge conference in the provider clock.
QueueConversationVideoEventTopicCall	confined(Boolean confined)	True if this call is held and the person on this side hears hold music.
QueueConversationVideoEventTopicCall	connectedTime(Date connectedTime)	The timestamp when this communication was connected in the cloud clock.
QueueConversationVideoEventTopicCall	direction(QueueConversationVideoEventTopicCall.DirectionEnum direction)	Whether a call is inbound or outbound.
QueueConversationVideoEventTopicCall	disconnectedTime(Date disconnectedTime)	The timestamp when this communication disconnected from the conversation in the provider clock.
QueueConversationVideoEventTopicCall	disconnectReasons(List<QueueConversationVideoEventTopicDisconnectReason> disconnectReasons)	List of reasons that this call was disconnected.
QueueConversationVideoEventTopicCall	disconnectType(QueueConversationVideoEventTopicCall.DisconnectTypeEnum disconnectType)	System defined string indicating what caused the communication to disconnect.
QueueConversationVideoEventTopicCall	disposition(QueueConversationVideoEventTopicDisposition disposition)
QueueConversationVideoEventTopicCall	documentId(String documentId)	If call is a fax of a document in content management, the id of the document in content management.
boolean	equals(Object o)
QueueConversationVideoEventTopicCall	errorInfo(QueueConversationVideoEventTopicErrorDetails errorInfo)
QueueConversationVideoEventTopicCall	faxStatus(QueueConversationVideoEventTopicFaxStatus faxStatus)
QueueConversationVideoEventTopicAfterCallWork	getAfterCallWork()
Boolean	getAfterCallWorkRequired()
String	getAgentAssistantId()
Date	getBargedTime()
Boolean	getConfined()
Date	getConnectedTime()
QueueConversationVideoEventTopicCall.DirectionEnum	getDirection()
Date	getDisconnectedTime()
List<QueueConversationVideoEventTopicDisconnectReason>	getDisconnectReasons()
QueueConversationVideoEventTopicCall.DisconnectTypeEnum	getDisconnectType()
QueueConversationVideoEventTopicDisposition	getDisposition()
String	getDocumentId()
QueueConversationVideoEventTopicErrorDetails	getErrorInfo()
QueueConversationVideoEventTopicFaxStatus	getFaxStatus()
Boolean	getHeld()
String	getId()
QueueConversationVideoEventTopicCall.InitialStateEnum	getInitialState()
Boolean	getMuted()
QueueConversationVideoEventTopicAddress	getOther()
String	getPeerId()
String	getProvider()
QueueConversationVideoEventTopicQueueMediaSettings	getQueueMediaSettings()
QueueConversationVideoEventTopicRecordersState	getRecordersState()
Boolean	getRecording()
QueueConversationVideoEventTopicCall.RecordingStateEnum	getRecordingState()
String	getScriptId()
Boolean	getSecurePause()
QueueConversationVideoEventTopicAddress	getSelf()
Date	getStartHoldTime()
QueueConversationVideoEventTopicCall.StateEnum	getState()
String	getTransferSource()
String	getUuiData()
QueueConversationVideoEventTopicWrapup	getWrapup()
int	hashCode()
QueueConversationVideoEventTopicCall	held(Boolean held)	True if this call is held and the person on this side hears silence.
QueueConversationVideoEventTopicCall	id(String id)	A globally unique identifier for this communication.
QueueConversationVideoEventTopicCall	initialState(QueueConversationVideoEventTopicCall.InitialStateEnum initialState)
QueueConversationVideoEventTopicCall	muted(Boolean muted)	True if this call is muted so that remote participants can't hear any audio from this end.
QueueConversationVideoEventTopicCall	other(QueueConversationVideoEventTopicAddress other)	Address and name data for a call endpoint.
QueueConversationVideoEventTopicCall	peerId(String peerId)	The id of the peer communication corresponding to a matching leg for this communication.
QueueConversationVideoEventTopicCall	provider(String provider)	The source provider of the call.
QueueConversationVideoEventTopicCall	queueMediaSettings(QueueConversationVideoEventTopicQueueMediaSettings queueMediaSettings)
QueueConversationVideoEventTopicCall	recordersState(QueueConversationVideoEventTopicRecordersState recordersState)
QueueConversationVideoEventTopicCall	recording(Boolean recording)	True if this call is being recorded.
QueueConversationVideoEventTopicCall	recordingState(QueueConversationVideoEventTopicCall.RecordingStateEnum recordingState)	State of recording on this call.
QueueConversationVideoEventTopicCall	scriptId(String scriptId)	The UUID of the script to use.
QueueConversationVideoEventTopicCall	securePause(Boolean securePause)	True when the recording of this call is in secure pause status.
QueueConversationVideoEventTopicCall	self(QueueConversationVideoEventTopicAddress self)
void	setAfterCallWork(QueueConversationVideoEventTopicAfterCallWork afterCallWork)
void	setAfterCallWorkRequired(Boolean afterCallWorkRequired)
void	setAgentAssistantId(String agentAssistantId)
void	setBargedTime(Date bargedTime)
void	setConfined(Boolean confined)
void	setConnectedTime(Date connectedTime)
void	setDirection(QueueConversationVideoEventTopicCall.DirectionEnum direction)
void	setDisconnectedTime(Date disconnectedTime)
void	setDisconnectReasons(List<QueueConversationVideoEventTopicDisconnectReason> disconnectReasons)
void	setDisconnectType(QueueConversationVideoEventTopicCall.DisconnectTypeEnum disconnectType)
void	setDisposition(QueueConversationVideoEventTopicDisposition disposition)
void	setDocumentId(String documentId)
void	setErrorInfo(QueueConversationVideoEventTopicErrorDetails errorInfo)
void	setFaxStatus(QueueConversationVideoEventTopicFaxStatus faxStatus)
void	setHeld(Boolean held)
void	setId(String id)
void	setInitialState(QueueConversationVideoEventTopicCall.InitialStateEnum initialState)
void	setMuted(Boolean muted)
void	setOther(QueueConversationVideoEventTopicAddress other)
void	setPeerId(String peerId)
void	setProvider(String provider)
void	setQueueMediaSettings(QueueConversationVideoEventTopicQueueMediaSettings queueMediaSettings)
void	setRecordersState(QueueConversationVideoEventTopicRecordersState recordersState)
void	setRecording(Boolean recording)
void	setRecordingState(QueueConversationVideoEventTopicCall.RecordingStateEnum recordingState)
void	setScriptId(String scriptId)
void	setSecurePause(Boolean securePause)
void	setSelf(QueueConversationVideoEventTopicAddress self)
void	setStartHoldTime(Date startHoldTime)
void	setState(QueueConversationVideoEventTopicCall.StateEnum state)
void	setTransferSource(String transferSource)
void	setUuiData(String uuiData)
void	setWrapup(QueueConversationVideoEventTopicWrapup wrapup)
QueueConversationVideoEventTopicCall	startHoldTime(Date startHoldTime)	The timestamp the call was placed on hold in the cloud clock if the call is currently on hold.
QueueConversationVideoEventTopicCall	state(QueueConversationVideoEventTopicCall.StateEnum state)
String	toString()
QueueConversationVideoEventTopicCall	transferSource(String transferSource)	Indicates how call reaches the agent.
QueueConversationVideoEventTopicCall	uuiData(String uuiData)	User to User Information (UUI) data managed by SIP session application.
QueueConversationVideoEventTopicCall	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

QueueConversationVideoEventTopicCall

public QueueConversationVideoEventTopicCall()

QueueConversationVideoEventTopicCall

public QueueConversationVideoEventTopicCall(Boolean initWithEmptyList)

Method Details

id

public QueueConversationVideoEventTopicCall id(String id)

A globally unique identifier for this communication.

getId

public String getId()

setId

public void setId(String id)

state

public QueueConversationVideoEventTopicCall state(QueueConversationVideoEventTopicCall.StateEnum state)

getState

public QueueConversationVideoEventTopicCall.StateEnum getState()

setState

public void setState(QueueConversationVideoEventTopicCall.StateEnum state)

initialState

public QueueConversationVideoEventTopicCall initialState(QueueConversationVideoEventTopicCall.InitialStateEnum initialState)

getInitialState

public QueueConversationVideoEventTopicCall.InitialStateEnum getInitialState()

setInitialState

public void setInitialState(QueueConversationVideoEventTopicCall.InitialStateEnum initialState)

recording

public QueueConversationVideoEventTopicCall recording(Boolean recording)

True if this call is being recorded.

getRecording

public Boolean getRecording()

setRecording

public void setRecording(Boolean recording)

recordingState

public QueueConversationVideoEventTopicCall recordingState(QueueConversationVideoEventTopicCall.RecordingStateEnum recordingState)

State of recording on this call.

getRecordingState

public QueueConversationVideoEventTopicCall.RecordingStateEnum getRecordingState()

setRecordingState

public void setRecordingState(QueueConversationVideoEventTopicCall.RecordingStateEnum recordingState)

recordersState

public QueueConversationVideoEventTopicCall recordersState(QueueConversationVideoEventTopicRecordersState recordersState)

getRecordersState

public QueueConversationVideoEventTopicRecordersState getRecordersState()

setRecordersState

public void setRecordersState(QueueConversationVideoEventTopicRecordersState recordersState)

muted

public QueueConversationVideoEventTopicCall muted(Boolean muted)

True if this call is muted so that remote participants can't hear any audio from this end.

getMuted

public Boolean getMuted()

setMuted

public void setMuted(Boolean muted)

confined

public QueueConversationVideoEventTopicCall confined(Boolean confined)

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

getConfined

public Boolean getConfined()

setConfined

public void setConfined(Boolean confined)

held

public QueueConversationVideoEventTopicCall 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)

securePause

public QueueConversationVideoEventTopicCall securePause(Boolean securePause)

True when the recording of this call is in secure pause status.

getSecurePause

public Boolean getSecurePause()

setSecurePause

public void setSecurePause(Boolean securePause)

errorInfo

public QueueConversationVideoEventTopicCall errorInfo(QueueConversationVideoEventTopicErrorDetails errorInfo)

getErrorInfo

public QueueConversationVideoEventTopicErrorDetails getErrorInfo()

setErrorInfo

public void setErrorInfo(QueueConversationVideoEventTopicErrorDetails errorInfo)

disconnectType

public QueueConversationVideoEventTopicCall disconnectType(QueueConversationVideoEventTopicCall.DisconnectTypeEnum disconnectType)

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

getDisconnectType

public QueueConversationVideoEventTopicCall.DisconnectTypeEnum getDisconnectType()

setDisconnectType

public void setDisconnectType(QueueConversationVideoEventTopicCall.DisconnectTypeEnum disconnectType)

startHoldTime

public QueueConversationVideoEventTopicCall startHoldTime(Date startHoldTime)

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

getStartHoldTime

public Date getStartHoldTime()

setStartHoldTime

public void setStartHoldTime(Date startHoldTime)

direction

public QueueConversationVideoEventTopicCall direction(QueueConversationVideoEventTopicCall.DirectionEnum direction)

Whether a call is inbound or outbound.

getDirection

public QueueConversationVideoEventTopicCall.DirectionEnum getDirection()

setDirection

public void setDirection(QueueConversationVideoEventTopicCall.DirectionEnum direction)

documentId

public QueueConversationVideoEventTopicCall documentId(String documentId)

If call is a fax of a document in content management, the id of the document in content management.

getDocumentId

public String getDocumentId()

setDocumentId

public void setDocumentId(String documentId)

self

public QueueConversationVideoEventTopicCall self(QueueConversationVideoEventTopicAddress self)

getSelf

public QueueConversationVideoEventTopicAddress getSelf()

setSelf

public void setSelf(QueueConversationVideoEventTopicAddress self)

other

public QueueConversationVideoEventTopicCall other(QueueConversationVideoEventTopicAddress other)

Address and name data for a call endpoint.

getOther

public QueueConversationVideoEventTopicAddress getOther()

setOther

public void setOther(QueueConversationVideoEventTopicAddress other)

provider

public QueueConversationVideoEventTopicCall provider(String provider)

The source provider of the call.

getProvider

public String getProvider()

setProvider

public void setProvider(String provider)

scriptId

public QueueConversationVideoEventTopicCall scriptId(String scriptId)

The UUID of the script to use.

getScriptId

public String getScriptId()

setScriptId

public void setScriptId(String scriptId)

peerId

public QueueConversationVideoEventTopicCall 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)

connectedTime

public QueueConversationVideoEventTopicCall 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 QueueConversationVideoEventTopicCall 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)

disconnectReasons

public QueueConversationVideoEventTopicCall disconnectReasons(List<QueueConversationVideoEventTopicDisconnectReason> disconnectReasons)

List of reasons that this call was disconnected. This will be set once the call disconnects.

getDisconnectReasons

public List<QueueConversationVideoEventTopicDisconnectReason> getDisconnectReasons()

setDisconnectReasons

public void setDisconnectReasons(List<QueueConversationVideoEventTopicDisconnectReason> disconnectReasons)

faxStatus

public QueueConversationVideoEventTopicCall faxStatus(QueueConversationVideoEventTopicFaxStatus faxStatus)

getFaxStatus

public QueueConversationVideoEventTopicFaxStatus getFaxStatus()

setFaxStatus

public void setFaxStatus(QueueConversationVideoEventTopicFaxStatus faxStatus)

uuiData

public QueueConversationVideoEventTopicCall uuiData(String uuiData)

User to User Information (UUI) data managed by SIP session application.

getUuiData

public String getUuiData()

setUuiData

public void setUuiData(String uuiData)

bargedTime

public QueueConversationVideoEventTopicCall bargedTime(Date bargedTime)

The timestamp when this participant was connected to the barge conference in the provider clock.

getBargedTime

public Date getBargedTime()

setBargedTime

public void setBargedTime(Date bargedTime)

wrapup

public QueueConversationVideoEventTopicCall wrapup(QueueConversationVideoEventTopicWrapup wrapup)

Call wrap up or disposition data.

getWrapup

public QueueConversationVideoEventTopicWrapup getWrapup()

setWrapup

public void setWrapup(QueueConversationVideoEventTopicWrapup wrapup)

afterCallWork

public QueueConversationVideoEventTopicCall afterCallWork(QueueConversationVideoEventTopicAfterCallWork afterCallWork)

getAfterCallWork

public QueueConversationVideoEventTopicAfterCallWork getAfterCallWork()

setAfterCallWork

public void setAfterCallWork(QueueConversationVideoEventTopicAfterCallWork afterCallWork)

afterCallWorkRequired

public QueueConversationVideoEventTopicCall 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 QueueConversationVideoEventTopicCall 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)

queueMediaSettings

public QueueConversationVideoEventTopicCall queueMediaSettings(QueueConversationVideoEventTopicQueueMediaSettings queueMediaSettings)

getQueueMediaSettings

public QueueConversationVideoEventTopicQueueMediaSettings getQueueMediaSettings()

setQueueMediaSettings

public void setQueueMediaSettings(QueueConversationVideoEventTopicQueueMediaSettings queueMediaSettings)

disposition

public QueueConversationVideoEventTopicCall disposition(QueueConversationVideoEventTopicDisposition disposition)

getDisposition

public QueueConversationVideoEventTopicDisposition getDisposition()

setDisposition

public void setDisposition(QueueConversationVideoEventTopicDisposition disposition)

transferSource

public QueueConversationVideoEventTopicCall transferSource(String transferSource)

Indicates how call reaches the agent.

getTransferSource

public String getTransferSource()

setTransferSource

public void setTransferSource(String transferSource)

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