Package com.mypurecloud.sdk.v2.model

Class ConversationEventTopicCobrowse

java.lang.Object

com.mypurecloud.sdk.v2.model.ConversationEventTopicCobrowse

All Implemented Interfaces:

Serializable

public class ConversationEventTopicCobrowse
extends Object
implements Serializable

ConversationEventTopicCobrowse

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ConversationEventTopicCobrowse()
ConversationEventTopicCobrowse(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
ConversationEventTopicCobrowse	afterCallWork(ConversationEventTopicAfterCallWork afterCallWork)	A communication's after-call work data.
ConversationEventTopicCobrowse	afterCallWorkRequired(Boolean afterCallWorkRequired)	Indicates if after-call is required for a communication.
ConversationEventTopicCobrowse	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).
ConversationEventTopicCobrowse	cobrowseSessionId(String cobrowseSessionId)	The co-browse session ID.
ConversationEventTopicCobrowse	connectedTime(Date connectedTime)	The timestamp when this communication was connected in the cloud clock.
ConversationEventTopicCobrowse	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).
ConversationEventTopicCobrowse	disconnectedTime(Date disconnectedTime)	The timestamp when this communication disconnected from the conversation in the provider clock.
ConversationEventTopicCobrowse	disconnectType(ConversationEventTopicCobrowse.DisconnectTypeEnum disconnectType)	System defined string indicating what caused the communication to disconnect.
boolean	equals(Object o)
ConversationEventTopicAfterCallWork	getAfterCallWork()
Boolean	getAfterCallWorkRequired()
String	getCobrowseRole()
String	getCobrowseSessionId()
Date	getConnectedTime()
List<String>	getControlling()
Date	getDisconnectedTime()
ConversationEventTopicCobrowse.DisconnectTypeEnum	getDisconnectType()
String	getId()
ConversationEventTopicCobrowse.InitialStateEnum	getInitialState()
String	getPeerId()
String	getProvider()
Date	getProviderEventTime()
ConversationEventTopicQueueMediaSettings	getQueueMediaSettings()
String	getRoomId()
String	getScriptId()
ConversationEventTopicAddress	getSelf()
ConversationEventTopicCobrowse.StateEnum	getState()
String	getViewerUrl()
ConversationEventTopicWrapup	getWrapup()
int	hashCode()
ConversationEventTopicCobrowse	id(String id)	A globally unique identifier for this communication.
ConversationEventTopicCobrowse	initialState(ConversationEventTopicCobrowse.InitialStateEnum initialState)
ConversationEventTopicCobrowse	peerId(String peerId)	The id of the peer communication corresponding to a matching leg for this communication.
ConversationEventTopicCobrowse	provider(String provider)	The source provider of the co-browse communication.
ConversationEventTopicCobrowse	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).
ConversationEventTopicCobrowse	queueMediaSettings(ConversationEventTopicQueueMediaSettings queueMediaSettings)	Represents the queue setting for this media.
ConversationEventTopicCobrowse	roomId(String roomId)	The room id for the chat.
ConversationEventTopicCobrowse	scriptId(String scriptId)	The UUID of the script to use.
ConversationEventTopicCobrowse	self(ConversationEventTopicAddress self)	Address and name data for a call endpoint.
void	setAfterCallWork(ConversationEventTopicAfterCallWork 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(ConversationEventTopicCobrowse.DisconnectTypeEnum disconnectType)
void	setId(String id)
void	setInitialState(ConversationEventTopicCobrowse.InitialStateEnum initialState)
void	setPeerId(String peerId)
void	setProvider(String provider)
void	setProviderEventTime(Date providerEventTime)
void	setQueueMediaSettings(ConversationEventTopicQueueMediaSettings queueMediaSettings)
void	setRoomId(String roomId)
void	setScriptId(String scriptId)
void	setSelf(ConversationEventTopicAddress self)
void	setState(ConversationEventTopicCobrowse.StateEnum state)
void	setViewerUrl(String viewerUrl)
void	setWrapup(ConversationEventTopicWrapup wrapup)
ConversationEventTopicCobrowse	state(ConversationEventTopicCobrowse.StateEnum state)
String	toString()
ConversationEventTopicCobrowse	viewerUrl(String viewerUrl)	The URL that can be used to open co-browse session in web browser.
ConversationEventTopicCobrowse	wrapup(ConversationEventTopicWrapup wrapup)	Call wrap up or disposition data.

Methods inherited from class java.lang.Object

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

Constructor Details

ConversationEventTopicCobrowse

public ConversationEventTopicCobrowse()

ConversationEventTopicCobrowse

public ConversationEventTopicCobrowse(Boolean initWithEmptyList)

Method Details

state

public ConversationEventTopicCobrowse state(ConversationEventTopicCobrowse.StateEnum state)

getState

public ConversationEventTopicCobrowse.StateEnum getState()

setState

public void setState(ConversationEventTopicCobrowse.StateEnum state)

initialState

public ConversationEventTopicCobrowse initialState(ConversationEventTopicCobrowse.InitialStateEnum initialState)

getInitialState

public ConversationEventTopicCobrowse.InitialStateEnum getInitialState()

setInitialState

public void setInitialState(ConversationEventTopicCobrowse.InitialStateEnum initialState)

disconnectType

public ConversationEventTopicCobrowse disconnectType(ConversationEventTopicCobrowse.DisconnectTypeEnum disconnectType)

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

getDisconnectType

public ConversationEventTopicCobrowse.DisconnectTypeEnum getDisconnectType()

setDisconnectType

public void setDisconnectType(ConversationEventTopicCobrowse.DisconnectTypeEnum disconnectType)

id

public ConversationEventTopicCobrowse id(String id)

A globally unique identifier for this communication.

getId

public String getId()

setId

public void setId(String id)

self

public ConversationEventTopicCobrowse self(ConversationEventTopicAddress self)

Address and name data for a call endpoint.

getSelf

public ConversationEventTopicAddress getSelf()

setSelf

public void setSelf(ConversationEventTopicAddress self)

roomId

public ConversationEventTopicCobrowse roomId(String roomId)

The room id for the chat.

getRoomId

public String getRoomId()

setRoomId

public void setRoomId(String roomId)

cobrowseSessionId

public ConversationEventTopicCobrowse cobrowseSessionId(String cobrowseSessionId)

The co-browse session ID.

getCobrowseSessionId

public String getCobrowseSessionId()

setCobrowseSessionId

public void setCobrowseSessionId(String cobrowseSessionId)

cobrowseRole

public ConversationEventTopicCobrowse 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 ConversationEventTopicCobrowse 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 ConversationEventTopicCobrowse 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 ConversationEventTopicCobrowse provider(String provider)

The source provider of the co-browse communication.

getProvider

public String getProvider()

setProvider

public void setProvider(String provider)

scriptId

public ConversationEventTopicCobrowse scriptId(String scriptId)

The UUID of the script to use.

getScriptId

public String getScriptId()

setScriptId

public void setScriptId(String scriptId)

peerId

public ConversationEventTopicCobrowse 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 ConversationEventTopicCobrowse 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 ConversationEventTopicCobrowse 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 ConversationEventTopicCobrowse 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 ConversationEventTopicCobrowse wrapup(ConversationEventTopicWrapup wrapup)

Call wrap up or disposition data.

getWrapup

public ConversationEventTopicWrapup getWrapup()

setWrapup

public void setWrapup(ConversationEventTopicWrapup wrapup)

afterCallWork

public ConversationEventTopicCobrowse afterCallWork(ConversationEventTopicAfterCallWork afterCallWork)

A communication's after-call work data.

getAfterCallWork

public ConversationEventTopicAfterCallWork getAfterCallWork()

setAfterCallWork

public void setAfterCallWork(ConversationEventTopicAfterCallWork afterCallWork)

afterCallWorkRequired

public ConversationEventTopicCobrowse 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 ConversationEventTopicCobrowse queueMediaSettings(ConversationEventTopicQueueMediaSettings queueMediaSettings)

Represents the queue setting for this media.

getQueueMediaSettings

public ConversationEventTopicQueueMediaSettings getQueueMediaSettings()

setQueueMediaSettings

public void setQueueMediaSettings(ConversationEventTopicQueueMediaSettings 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