Package com.mypurecloud.sdk.v2.model

Class QueueConversationEventTopicCobrowse

java.lang.Object

com.mypurecloud.sdk.v2.model.QueueConversationEventTopicCobrowse

All Implemented Interfaces:

Serializable

public class QueueConversationEventTopicCobrowse
extends Object
implements Serializable

QueueConversationEventTopicCobrowse

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	QueueConversationEventTopicCobrowse.DisconnectTypeEnum	System defined string indicating what caused the communication to disconnect.
static enum	QueueConversationEventTopicCobrowse.InitialStateEnum	Gets or Sets initialState
static enum	QueueConversationEventTopicCobrowse.StateEnum	Gets or Sets state

Constructor Summary

Constructors

Constructor	Description
QueueConversationEventTopicCobrowse()
QueueConversationEventTopicCobrowse(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
QueueConversationEventTopicCobrowse	afterCallWork(QueueConversationEventTopicAfterCallWork afterCallWork)	A communication's after-call work data.
QueueConversationEventTopicCobrowse	afterCallWorkRequired(Boolean afterCallWorkRequired)	Indicates if after-call is required for a communication.
QueueConversationEventTopicCobrowse	cobrowseRole(String cobrowseRole)	This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer).
QueueConversationEventTopicCobrowse	cobrowseSessionId(String cobrowseSessionId)	The co-browse session ID.
QueueConversationEventTopicCobrowse	connectedTime(Date connectedTime)	The timestamp when this communication was connected in the cloud clock.
QueueConversationEventTopicCobrowse	controlling(List<String> controlling)	ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages).
QueueConversationEventTopicCobrowse	disconnectedTime(Date disconnectedTime)	The timestamp when this communication disconnected from the conversation in the provider clock.
QueueConversationEventTopicCobrowse	disconnectType(QueueConversationEventTopicCobrowse.DisconnectTypeEnum disconnectType)	System defined string indicating what caused the communication to disconnect.
boolean	equals(Object o)
QueueConversationEventTopicAfterCallWork	getAfterCallWork()
Boolean	getAfterCallWorkRequired()
String	getCobrowseRole()
String	getCobrowseSessionId()
Date	getConnectedTime()
List<String>	getControlling()
Date	getDisconnectedTime()
QueueConversationEventTopicCobrowse.DisconnectTypeEnum	getDisconnectType()
String	getId()
QueueConversationEventTopicCobrowse.InitialStateEnum	getInitialState()
String	getPeerId()
String	getProvider()
Date	getProviderEventTime()
QueueConversationEventTopicQueueMediaSettings	getQueueMediaSettings()
String	getRoomId()
String	getScriptId()
QueueConversationEventTopicAddress	getSelf()
QueueConversationEventTopicCobrowse.StateEnum	getState()
String	getViewerUrl()
QueueConversationEventTopicWrapup	getWrapup()
int	hashCode()
QueueConversationEventTopicCobrowse	id(String id)	A globally unique identifier for this communication.
QueueConversationEventTopicCobrowse	initialState(QueueConversationEventTopicCobrowse.InitialStateEnum initialState)
QueueConversationEventTopicCobrowse	peerId(String peerId)	The id of the peer communication corresponding to a matching leg for this communication.
QueueConversationEventTopicCobrowse	provider(String provider)	The source provider of the co-browse communication.
QueueConversationEventTopicCobrowse	providerEventTime(Date providerEventTime)	The time when the provider event which triggered this conversation update happened in the corrected provider clock (milliseconds since 1970-01-01 00:00:00 UTC).
QueueConversationEventTopicCobrowse	queueMediaSettings(QueueConversationEventTopicQueueMediaSettings queueMediaSettings)	Represents the queue setting for this media.
QueueConversationEventTopicCobrowse	roomId(String roomId)	The room id for the chat.
QueueConversationEventTopicCobrowse	scriptId(String scriptId)	The UUID of the script to use.
QueueConversationEventTopicCobrowse	self(QueueConversationEventTopicAddress self)	Address and name data for a call endpoint.
void	setAfterCallWork(QueueConversationEventTopicAfterCallWork afterCallWork)
void	setAfterCallWorkRequired(Boolean afterCallWorkRequired)
void	setCobrowseRole(String cobrowseRole)
void	setCobrowseSessionId(String cobrowseSessionId)
void	setConnectedTime(Date connectedTime)
void	setControlling(List<String> controlling)
void	setDisconnectedTime(Date disconnectedTime)
void	setDisconnectType(QueueConversationEventTopicCobrowse.DisconnectTypeEnum disconnectType)
void	setId(String id)
void	setInitialState(QueueConversationEventTopicCobrowse.InitialStateEnum initialState)
void	setPeerId(String peerId)
void	setProvider(String provider)
void	setProviderEventTime(Date providerEventTime)
void	setQueueMediaSettings(QueueConversationEventTopicQueueMediaSettings queueMediaSettings)
void	setRoomId(String roomId)
void	setScriptId(String scriptId)
void	setSelf(QueueConversationEventTopicAddress self)
void	setState(QueueConversationEventTopicCobrowse.StateEnum state)
void	setViewerUrl(String viewerUrl)
void	setWrapup(QueueConversationEventTopicWrapup wrapup)
QueueConversationEventTopicCobrowse	state(QueueConversationEventTopicCobrowse.StateEnum state)
String	toString()
QueueConversationEventTopicCobrowse	viewerUrl(String viewerUrl)	The URL that can be used to open co-browse session in web browser.
QueueConversationEventTopicCobrowse	wrapup(QueueConversationEventTopicWrapup wrapup)	Call wrap up or disposition data.

Methods inherited from class java.lang.Object

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

Constructor Details

QueueConversationEventTopicCobrowse

public QueueConversationEventTopicCobrowse()

QueueConversationEventTopicCobrowse

public QueueConversationEventTopicCobrowse(Boolean initWithEmptyList)

Method Details

state

public QueueConversationEventTopicCobrowse state(QueueConversationEventTopicCobrowse.StateEnum state)

getState

public QueueConversationEventTopicCobrowse.StateEnum getState()

setState

public void setState(QueueConversationEventTopicCobrowse.StateEnum state)

initialState

public QueueConversationEventTopicCobrowse initialState(QueueConversationEventTopicCobrowse.InitialStateEnum initialState)

getInitialState

public QueueConversationEventTopicCobrowse.InitialStateEnum getInitialState()

setInitialState

public void setInitialState(QueueConversationEventTopicCobrowse.InitialStateEnum initialState)

disconnectType

public QueueConversationEventTopicCobrowse disconnectType(QueueConversationEventTopicCobrowse.DisconnectTypeEnum disconnectType)

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

getDisconnectType

public QueueConversationEventTopicCobrowse.DisconnectTypeEnum getDisconnectType()

setDisconnectType

public void setDisconnectType(QueueConversationEventTopicCobrowse.DisconnectTypeEnum disconnectType)

id

public QueueConversationEventTopicCobrowse id(String id)

A globally unique identifier for this communication.

getId

public String getId()

setId

public void setId(String id)

self

public QueueConversationEventTopicCobrowse self(QueueConversationEventTopicAddress self)

Address and name data for a call endpoint.

getSelf

public QueueConversationEventTopicAddress getSelf()

setSelf

public void setSelf(QueueConversationEventTopicAddress self)

roomId

public QueueConversationEventTopicCobrowse roomId(String roomId)

The room id for the chat.

getRoomId

public String getRoomId()

setRoomId

public void setRoomId(String roomId)

cobrowseSessionId

public QueueConversationEventTopicCobrowse cobrowseSessionId(String cobrowseSessionId)

The co-browse session ID.

getCobrowseSessionId

public String getCobrowseSessionId()

setCobrowseSessionId

public void setCobrowseSessionId(String cobrowseSessionId)

cobrowseRole

public QueueConversationEventTopicCobrowse cobrowseRole(String cobrowseRole)

This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer).

getCobrowseRole

public String getCobrowseRole()

setCobrowseRole

public void setCobrowseRole(String cobrowseRole)

controlling

public QueueConversationEventTopicCobrowse controlling(List<String> controlling)

ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages).

getControlling

public List<String> getControlling()

setControlling

public void setControlling(List<String> controlling)

viewerUrl

public QueueConversationEventTopicCobrowse viewerUrl(String viewerUrl)

The URL that can be used to open co-browse session in web browser.

getViewerUrl

public String getViewerUrl()

setViewerUrl

public void setViewerUrl(String viewerUrl)

provider

public QueueConversationEventTopicCobrowse provider(String provider)

The source provider of the co-browse communication.

getProvider

public String getProvider()

setProvider

public void setProvider(String provider)

scriptId

public QueueConversationEventTopicCobrowse scriptId(String scriptId)

The UUID of the script to use.

getScriptId

public String getScriptId()

setScriptId

public void setScriptId(String scriptId)

peerId

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

providerEventTime

public QueueConversationEventTopicCobrowse providerEventTime(Date providerEventTime)

The time when the provider event which triggered this conversation update happened in the corrected provider clock (milliseconds since 1970-01-01 00:00:00 UTC).

getProviderEventTime

public Date getProviderEventTime()

setProviderEventTime

public void setProviderEventTime(Date providerEventTime)

connectedTime

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

wrapup

public QueueConversationEventTopicCobrowse wrapup(QueueConversationEventTopicWrapup wrapup)

Call wrap up or disposition data.

getWrapup

public QueueConversationEventTopicWrapup getWrapup()

setWrapup

public void setWrapup(QueueConversationEventTopicWrapup wrapup)

afterCallWork

public QueueConversationEventTopicCobrowse afterCallWork(QueueConversationEventTopicAfterCallWork afterCallWork)

A communication's after-call work data.

getAfterCallWork

public QueueConversationEventTopicAfterCallWork getAfterCallWork()

setAfterCallWork

public void setAfterCallWork(QueueConversationEventTopicAfterCallWork afterCallWork)

afterCallWorkRequired

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

queueMediaSettings

public QueueConversationEventTopicCobrowse queueMediaSettings(QueueConversationEventTopicQueueMediaSettings queueMediaSettings)

Represents the queue setting for this media.

getQueueMediaSettings

public QueueConversationEventTopicQueueMediaSettings getQueueMediaSettings()

setQueueMediaSettings

public void setQueueMediaSettings(QueueConversationEventTopicQueueMediaSettings queueMediaSettings)

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