Package com.mypurecloud.sdk.v2.model

Class QueueConversationSocialExpressionEventTopicCall

java.lang.Object

com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicCall

All Implemented Interfaces:

Serializable

public class QueueConversationSocialExpressionEventTopicCall
extends Object
implements Serializable

QueueConversationSocialExpressionEventTopicCall

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
QueueConversationSocialExpressionEventTopicCall()
QueueConversationSocialExpressionEventTopicCall(Boolean initWithEmptyList)

Method Summary

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

QueueConversationSocialExpressionEventTopicCall

public QueueConversationSocialExpressionEventTopicCall()

QueueConversationSocialExpressionEventTopicCall

public QueueConversationSocialExpressionEventTopicCall(Boolean initWithEmptyList)

Method Details

id

public QueueConversationSocialExpressionEventTopicCall id(String id)

A globally unique identifier for this communication.

getId

public String getId()

setId

public void setId(String id)

state

public QueueConversationSocialExpressionEventTopicCall state(QueueConversationSocialExpressionEventTopicCall.StateEnum state)

getState

public QueueConversationSocialExpressionEventTopicCall.StateEnum getState()

setState

public void setState(QueueConversationSocialExpressionEventTopicCall.StateEnum state)

initialState

public QueueConversationSocialExpressionEventTopicCall initialState(QueueConversationSocialExpressionEventTopicCall.InitialStateEnum initialState)

getInitialState

public QueueConversationSocialExpressionEventTopicCall.InitialStateEnum getInitialState()

setInitialState

public void setInitialState(QueueConversationSocialExpressionEventTopicCall.InitialStateEnum initialState)

recording

public QueueConversationSocialExpressionEventTopicCall recording(Boolean recording)

True if this call is being recorded.

getRecording

public Boolean getRecording()

setRecording

public void setRecording(Boolean recording)

recordingState

public QueueConversationSocialExpressionEventTopicCall recordingState(QueueConversationSocialExpressionEventTopicCall.RecordingStateEnum recordingState)

State of recording on this call.

getRecordingState

public QueueConversationSocialExpressionEventTopicCall.RecordingStateEnum getRecordingState()

setRecordingState

public void setRecordingState(QueueConversationSocialExpressionEventTopicCall.RecordingStateEnum recordingState)

recordersState

public QueueConversationSocialExpressionEventTopicCall recordersState(QueueConversationSocialExpressionEventTopicRecordersState recordersState)

getRecordersState

public QueueConversationSocialExpressionEventTopicRecordersState getRecordersState()

setRecordersState

public void setRecordersState(QueueConversationSocialExpressionEventTopicRecordersState recordersState)

muted

public QueueConversationSocialExpressionEventTopicCall 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 QueueConversationSocialExpressionEventTopicCall 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 QueueConversationSocialExpressionEventTopicCall 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 QueueConversationSocialExpressionEventTopicCall 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 QueueConversationSocialExpressionEventTopicCall errorInfo(QueueConversationSocialExpressionEventTopicErrorDetails errorInfo)

getErrorInfo

public QueueConversationSocialExpressionEventTopicErrorDetails getErrorInfo()

setErrorInfo

public void setErrorInfo(QueueConversationSocialExpressionEventTopicErrorDetails errorInfo)

disconnectType

public QueueConversationSocialExpressionEventTopicCall disconnectType(QueueConversationSocialExpressionEventTopicCall.DisconnectTypeEnum disconnectType)

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

getDisconnectType

public QueueConversationSocialExpressionEventTopicCall.DisconnectTypeEnum getDisconnectType()

setDisconnectType

public void setDisconnectType(QueueConversationSocialExpressionEventTopicCall.DisconnectTypeEnum disconnectType)

startHoldTime

public QueueConversationSocialExpressionEventTopicCall 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 QueueConversationSocialExpressionEventTopicCall direction(QueueConversationSocialExpressionEventTopicCall.DirectionEnum direction)

Whether a call is inbound or outbound.

getDirection

public QueueConversationSocialExpressionEventTopicCall.DirectionEnum getDirection()

setDirection

public void setDirection(QueueConversationSocialExpressionEventTopicCall.DirectionEnum direction)

documentId

public QueueConversationSocialExpressionEventTopicCall 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 QueueConversationSocialExpressionEventTopicCall self(QueueConversationSocialExpressionEventTopicAddress self)

getSelf

public QueueConversationSocialExpressionEventTopicAddress getSelf()

setSelf

public void setSelf(QueueConversationSocialExpressionEventTopicAddress self)

other

public QueueConversationSocialExpressionEventTopicCall other(QueueConversationSocialExpressionEventTopicAddress other)

Address and name data for a call endpoint.

getOther

public QueueConversationSocialExpressionEventTopicAddress getOther()

setOther

public void setOther(QueueConversationSocialExpressionEventTopicAddress other)

provider

public QueueConversationSocialExpressionEventTopicCall provider(String provider)

The source provider of the call.

getProvider

public String getProvider()

setProvider

public void setProvider(String provider)

scriptId

public QueueConversationSocialExpressionEventTopicCall scriptId(String scriptId)

The UUID of the script to use.

getScriptId

public String getScriptId()

setScriptId

public void setScriptId(String scriptId)

peerId

public QueueConversationSocialExpressionEventTopicCall 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 QueueConversationSocialExpressionEventTopicCall 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 QueueConversationSocialExpressionEventTopicCall 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 QueueConversationSocialExpressionEventTopicCall disconnectReasons(List<QueueConversationSocialExpressionEventTopicDisconnectReason> disconnectReasons)

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

getDisconnectReasons

public List<QueueConversationSocialExpressionEventTopicDisconnectReason> getDisconnectReasons()

setDisconnectReasons

public void setDisconnectReasons(List<QueueConversationSocialExpressionEventTopicDisconnectReason> disconnectReasons)

faxStatus

public QueueConversationSocialExpressionEventTopicCall faxStatus(QueueConversationSocialExpressionEventTopicFaxStatus faxStatus)

getFaxStatus

public QueueConversationSocialExpressionEventTopicFaxStatus getFaxStatus()

setFaxStatus

public void setFaxStatus(QueueConversationSocialExpressionEventTopicFaxStatus faxStatus)

uuiData

public QueueConversationSocialExpressionEventTopicCall 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 QueueConversationSocialExpressionEventTopicCall 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 QueueConversationSocialExpressionEventTopicCall wrapup(QueueConversationSocialExpressionEventTopicWrapup wrapup)

Call wrap up or disposition data.

getWrapup

public QueueConversationSocialExpressionEventTopicWrapup getWrapup()

setWrapup

public void setWrapup(QueueConversationSocialExpressionEventTopicWrapup wrapup)

afterCallWork

public QueueConversationSocialExpressionEventTopicCall afterCallWork(QueueConversationSocialExpressionEventTopicAfterCallWork afterCallWork)

getAfterCallWork

public QueueConversationSocialExpressionEventTopicAfterCallWork getAfterCallWork()

setAfterCallWork

public void setAfterCallWork(QueueConversationSocialExpressionEventTopicAfterCallWork afterCallWork)

afterCallWorkRequired

public QueueConversationSocialExpressionEventTopicCall 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 QueueConversationSocialExpressionEventTopicCall 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 QueueConversationSocialExpressionEventTopicCall queueMediaSettings(QueueConversationSocialExpressionEventTopicQueueMediaSettings queueMediaSettings)

getQueueMediaSettings

public QueueConversationSocialExpressionEventTopicQueueMediaSettings getQueueMediaSettings()

setQueueMediaSettings

public void setQueueMediaSettings(QueueConversationSocialExpressionEventTopicQueueMediaSettings queueMediaSettings)

disposition

public QueueConversationSocialExpressionEventTopicCall disposition(QueueConversationSocialExpressionEventTopicDisposition disposition)

getDisposition

public QueueConversationSocialExpressionEventTopicDisposition getDisposition()

setDisposition

public void setDisposition(QueueConversationSocialExpressionEventTopicDisposition disposition)

transferSource

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