Package com.mypurecloud.sdk.v2.model

Class QueueConversationEventTopicParticipant

java.lang.Object

com.mypurecloud.sdk.v2.model.QueueConversationEventTopicParticipant

All Implemented Interfaces:

Serializable

public class QueueConversationEventTopicParticipant
extends Object
implements Serializable

QueueConversationEventTopicParticipant

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	QueueConversationEventTopicParticipant.ScreenRecordingStateEnum	The current screen recording state for this participant.

Constructor Summary

Constructors

Constructor	Description
QueueConversationEventTopicParticipant()
QueueConversationEventTopicParticipant(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
QueueConversationEventTopicParticipant	address(String address)	The address for the this participant.
QueueConversationEventTopicParticipant	alertingTimeoutMs(Long alertingTimeoutMs)	Specifies how long the agent has to answer an interaction before being marked as not responding.
QueueConversationEventTopicParticipant	attributes(Map<String,String> attributes)	Additional participant attributes
QueueConversationEventTopicParticipant	bargedParticipantId(String bargedParticipantId)	If this participant created a barge in conference, then this will be the id of the participant that is barged in.
QueueConversationEventTopicParticipant	callbacks(List<QueueConversationEventTopicCallback> callbacks)
QueueConversationEventTopicParticipant	calls(List<QueueConversationEventTopicCall> calls)
QueueConversationEventTopicParticipant	chats(List<QueueConversationEventTopicChat> chats)
QueueConversationEventTopicParticipant	coachedParticipantId(String coachedParticipantId)	If this participant is a coach, then this will be the id of the participant that is being coached.
QueueConversationEventTopicParticipant	cobrowsesessions(List<QueueConversationEventTopicCobrowse> cobrowsesessions)
QueueConversationEventTopicParticipant	connectedTime(Date connectedTime)	The timestamp when this participant was connected to the conversation in the provider clock.
QueueConversationEventTopicParticipant	consultParticipantId(String consultParticipantId)	If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred.
QueueConversationEventTopicParticipant	conversationRoutingData(QueueConversationEventTopicConversationRoutingData conversationRoutingData)
QueueConversationEventTopicParticipant	emails(List<QueueConversationEventTopicEmail> emails)
QueueConversationEventTopicParticipant	endAcwTime(Date endAcwTime)	The timestamp when this participant ended after-call work.
QueueConversationEventTopicParticipant	endTime(Date endTime)	The timestamp when this participant disconnected from the conversation in the provider clock.
boolean	equals(Object o)
QueueConversationEventTopicParticipant	externalContactId(String externalContactId)	If this participant represents an external contact, then this will be the globally unique identifier for the external contact.
QueueConversationEventTopicParticipant	externalContactInitialDivisionId(String externalContactInitialDivisionId)	If this participant represents an external contact, then this will be the initial division for the external contact.
QueueConversationEventTopicParticipant	externalOrganizationId(String externalOrganizationId)	If this participant represents an external org, then this will be the globally unique identifier for the external org.
QueueConversationEventTopicParticipant	flaggedReason(String flaggedReason)	If this participant has flagged the conversation, the reason code given.
String	getAddress()
Long	getAlertingTimeoutMs()
Map<String,String>	getAttributes()
String	getBargedParticipantId()
List<QueueConversationEventTopicCallback>	getCallbacks()
List<QueueConversationEventTopicCall>	getCalls()
List<QueueConversationEventTopicChat>	getChats()
String	getCoachedParticipantId()
List<QueueConversationEventTopicCobrowse>	getCobrowsesessions()
Date	getConnectedTime()
String	getConsultParticipantId()
QueueConversationEventTopicConversationRoutingData	getConversationRoutingData()
List<QueueConversationEventTopicEmail>	getEmails()
Date	getEndAcwTime()
Date	getEndTime()
String	getExternalContactId()
String	getExternalContactInitialDivisionId()
String	getExternalOrganizationId()
String	getFlaggedReason()
String	getGroupId()
String	getId()
List<QueueConversationEventTopicInternalMessage>	getInternalMessages()
List<String>	getMediaRoles()
List<QueueConversationEventTopicMessage>	getMessages()
String	getMonitoredParticipantId()
String	getName()
String	getPurpose()
String	getQueueId()
String	getScreenMonitoredParticipantId()
List<QueueConversationEventTopicScreenMonitoring>	getScreenMonitorings()
QueueConversationEventTopicParticipant.ScreenRecordingStateEnum	getScreenRecordingState()
List<QueueConversationEventTopicScreenShare>	getScreenshares()
List<QueueConversationEventTopicSocialExpression>	getSocialExpressions()
Date	getStartAcwTime()
String	getTeamId()
String	getUserId()
List<QueueConversationEventTopicVideo>	getVideos()
QueueConversationEventTopicWorkflow	getWorkflow()
QueueConversationEventTopicWrapup	getWrapup()
Boolean	getWrapupExpected()
String	getWrapupPrompt()
Boolean	getWrapupRequired()
Long	getWrapupTimeoutMs()
QueueConversationEventTopicParticipant	groupId(String groupId)	If present, the group id that the participant represents.
int	hashCode()
QueueConversationEventTopicParticipant	id(String id)	A globally unique identifier for this conversation.
QueueConversationEventTopicParticipant	internalMessages(List<QueueConversationEventTopicInternalMessage> internalMessages)
QueueConversationEventTopicParticipant	mediaRoles(List<String> mediaRoles)	List of roles this participant's media has had on the conversation, ie monitor, coach, etc.
QueueConversationEventTopicParticipant	messages(List<QueueConversationEventTopicMessage> messages)
QueueConversationEventTopicParticipant	monitoredParticipantId(String monitoredParticipantId)	If this participant is a monitor, then this will be the id of the participant that is being monitored.
QueueConversationEventTopicParticipant	name(String name)	A human readable name identifying the participant.
QueueConversationEventTopicParticipant	purpose(String purpose)	A well known string that specifies the purpose or type of this participant.
QueueConversationEventTopicParticipant	queueId(String queueId)	If present, the queue id that the communication channel came in on.
QueueConversationEventTopicParticipant	screenMonitoredParticipantId(String screenMonitoredParticipantId)	If this participant is a screen monitor, then this will be the id of the participant that is being screen monitored.
QueueConversationEventTopicParticipant	screenMonitorings(List<QueueConversationEventTopicScreenMonitoring> screenMonitorings)
QueueConversationEventTopicParticipant	screenRecordingState(QueueConversationEventTopicParticipant.ScreenRecordingStateEnum screenRecordingState)	The current screen recording state for this participant.
QueueConversationEventTopicParticipant	screenshares(List<QueueConversationEventTopicScreenShare> screenshares)
void	setAddress(String address)
void	setAlertingTimeoutMs(Long alertingTimeoutMs)
void	setAttributes(Map<String,String> attributes)
void	setBargedParticipantId(String bargedParticipantId)
void	setCallbacks(List<QueueConversationEventTopicCallback> callbacks)
void	setCalls(List<QueueConversationEventTopicCall> calls)
void	setChats(List<QueueConversationEventTopicChat> chats)
void	setCoachedParticipantId(String coachedParticipantId)
void	setCobrowsesessions(List<QueueConversationEventTopicCobrowse> cobrowsesessions)
void	setConnectedTime(Date connectedTime)
void	setConsultParticipantId(String consultParticipantId)
void	setConversationRoutingData(QueueConversationEventTopicConversationRoutingData conversationRoutingData)
void	setEmails(List<QueueConversationEventTopicEmail> emails)
void	setEndAcwTime(Date endAcwTime)
void	setEndTime(Date endTime)
void	setExternalContactId(String externalContactId)
void	setExternalContactInitialDivisionId(String externalContactInitialDivisionId)
void	setExternalOrganizationId(String externalOrganizationId)
void	setFlaggedReason(String flaggedReason)
void	setGroupId(String groupId)
void	setId(String id)
void	setInternalMessages(List<QueueConversationEventTopicInternalMessage> internalMessages)
void	setMediaRoles(List<String> mediaRoles)
void	setMessages(List<QueueConversationEventTopicMessage> messages)
void	setMonitoredParticipantId(String monitoredParticipantId)
void	setName(String name)
void	setPurpose(String purpose)
void	setQueueId(String queueId)
void	setScreenMonitoredParticipantId(String screenMonitoredParticipantId)
void	setScreenMonitorings(List<QueueConversationEventTopicScreenMonitoring> screenMonitorings)
void	setScreenRecordingState(QueueConversationEventTopicParticipant.ScreenRecordingStateEnum screenRecordingState)
void	setScreenshares(List<QueueConversationEventTopicScreenShare> screenshares)
void	setSocialExpressions(List<QueueConversationEventTopicSocialExpression> socialExpressions)
void	setStartAcwTime(Date startAcwTime)
void	setTeamId(String teamId)
void	setUserId(String userId)
void	setVideos(List<QueueConversationEventTopicVideo> videos)
void	setWorkflow(QueueConversationEventTopicWorkflow workflow)
void	setWrapup(QueueConversationEventTopicWrapup wrapup)
void	setWrapupExpected(Boolean wrapupExpected)
void	setWrapupPrompt(String wrapupPrompt)
void	setWrapupRequired(Boolean wrapupRequired)
void	setWrapupTimeoutMs(Long wrapupTimeoutMs)
QueueConversationEventTopicParticipant	socialExpressions(List<QueueConversationEventTopicSocialExpression> socialExpressions)
QueueConversationEventTopicParticipant	startAcwTime(Date startAcwTime)	The timestamp when this participant started after-call work.
QueueConversationEventTopicParticipant	teamId(String teamId)	The team id that this participant is a member of when added to the conversation.
String	toString()
QueueConversationEventTopicParticipant	userId(String userId)	If this participant represents a user, then this will be the globally unique identifier for the user.
QueueConversationEventTopicParticipant	videos(List<QueueConversationEventTopicVideo> videos)
QueueConversationEventTopicParticipant	workflow(QueueConversationEventTopicWorkflow workflow)
QueueConversationEventTopicParticipant	wrapup(QueueConversationEventTopicWrapup wrapup)
QueueConversationEventTopicParticipant	wrapupExpected(Boolean wrapupExpected)	True when a participant is expected to enter a wrapup code once the call connects.
QueueConversationEventTopicParticipant	wrapupPrompt(String wrapupPrompt)	This field controls how the UI prompts the agent for a wrapup.
QueueConversationEventTopicParticipant	wrapupRequired(Boolean wrapupRequired)	True iff this participant is required to enter wrapup for this conversation.
QueueConversationEventTopicParticipant	wrapupTimeoutMs(Long wrapupTimeoutMs)	Specifies how long a timed ACW session will last.

Methods inherited from class java.lang.Object

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

Constructor Details

QueueConversationEventTopicParticipant

public QueueConversationEventTopicParticipant()

QueueConversationEventTopicParticipant

public QueueConversationEventTopicParticipant(Boolean initWithEmptyList)

Method Details

id

public QueueConversationEventTopicParticipant id(String id)

A globally unique identifier for this conversation.

getId

public String getId()

setId

public void setId(String id)

connectedTime

public QueueConversationEventTopicParticipant connectedTime(Date connectedTime)

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

getConnectedTime

public Date getConnectedTime()

setConnectedTime

public void setConnectedTime(Date connectedTime)

endTime

public QueueConversationEventTopicParticipant endTime(Date endTime)

The timestamp when this participant disconnected from the conversation in the provider clock.

getEndTime

public Date getEndTime()

setEndTime

public void setEndTime(Date endTime)

userId

public QueueConversationEventTopicParticipant userId(String userId)

If this participant represents a user, then this will be the globally unique identifier for the user.

getUserId

public String getUserId()

setUserId

public void setUserId(String userId)

externalContactId

public QueueConversationEventTopicParticipant externalContactId(String externalContactId)

If this participant represents an external contact, then this will be the globally unique identifier for the external contact.

getExternalContactId

public String getExternalContactId()

setExternalContactId

public void setExternalContactId(String externalContactId)

externalContactInitialDivisionId

public QueueConversationEventTopicParticipant externalContactInitialDivisionId(String externalContactInitialDivisionId)

If this participant represents an external contact, then this will be the initial division for the external contact. This value will not be updated if the external contact is reassigned.

getExternalContactInitialDivisionId

public String getExternalContactInitialDivisionId()

setExternalContactInitialDivisionId

public void setExternalContactInitialDivisionId(String externalContactInitialDivisionId)

externalOrganizationId

public QueueConversationEventTopicParticipant externalOrganizationId(String externalOrganizationId)

If this participant represents an external org, then this will be the globally unique identifier for the external org.

getExternalOrganizationId

public String getExternalOrganizationId()

setExternalOrganizationId

public void setExternalOrganizationId(String externalOrganizationId)

name

public QueueConversationEventTopicParticipant name(String name)

A human readable name identifying the participant.

getName

public String getName()

setName

public void setName(String name)

queueId

public QueueConversationEventTopicParticipant queueId(String queueId)

If present, the queue id that the communication channel came in on.

getQueueId

public String getQueueId()

setQueueId

public void setQueueId(String queueId)

groupId

public QueueConversationEventTopicParticipant groupId(String groupId)

If present, the group id that the participant represents.

getGroupId

public String getGroupId()

setGroupId

public void setGroupId(String groupId)

teamId

public QueueConversationEventTopicParticipant teamId(String teamId)

The team id that this participant is a member of when added to the conversation.

getTeamId

public String getTeamId()

setTeamId

public void setTeamId(String teamId)

purpose

public QueueConversationEventTopicParticipant purpose(String purpose)

A well known string that specifies the purpose or type of this participant.

getPurpose

public String getPurpose()

setPurpose

public void setPurpose(String purpose)

consultParticipantId

public QueueConversationEventTopicParticipant consultParticipantId(String consultParticipantId)

If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred.

getConsultParticipantId

public String getConsultParticipantId()

setConsultParticipantId

public void setConsultParticipantId(String consultParticipantId)

address

public QueueConversationEventTopicParticipant address(String address)

The address for the this participant. For a phone call this will be the ANI.

getAddress

public String getAddress()

setAddress

public void setAddress(String address)

wrapupRequired

public QueueConversationEventTopicParticipant wrapupRequired(Boolean wrapupRequired)

True iff this participant is required to enter wrapup for this conversation.

getWrapupRequired

public Boolean getWrapupRequired()

setWrapupRequired

public void setWrapupRequired(Boolean wrapupRequired)

wrapupExpected

public QueueConversationEventTopicParticipant wrapupExpected(Boolean wrapupExpected)

True when a participant is expected to enter a wrapup code once the call connects.

getWrapupExpected

public Boolean getWrapupExpected()

setWrapupExpected

public void setWrapupExpected(Boolean wrapupExpected)

wrapupPrompt

public QueueConversationEventTopicParticipant wrapupPrompt(String wrapupPrompt)

This field controls how the UI prompts the agent for a wrapup.

getWrapupPrompt

public String getWrapupPrompt()

setWrapupPrompt

public void setWrapupPrompt(String wrapupPrompt)

wrapupTimeoutMs

public QueueConversationEventTopicParticipant wrapupTimeoutMs(Long wrapupTimeoutMs)

Specifies how long a timed ACW session will last.

getWrapupTimeoutMs

public Long getWrapupTimeoutMs()

setWrapupTimeoutMs

public void setWrapupTimeoutMs(Long wrapupTimeoutMs)

wrapup

public QueueConversationEventTopicParticipant wrapup(QueueConversationEventTopicWrapup wrapup)

getWrapup

public QueueConversationEventTopicWrapup getWrapup()

setWrapup

public void setWrapup(QueueConversationEventTopicWrapup wrapup)

startAcwTime

public QueueConversationEventTopicParticipant startAcwTime(Date startAcwTime)

The timestamp when this participant started after-call work.

getStartAcwTime

public Date getStartAcwTime()

setStartAcwTime

public void setStartAcwTime(Date startAcwTime)

endAcwTime

public QueueConversationEventTopicParticipant endAcwTime(Date endAcwTime)

The timestamp when this participant ended after-call work.

getEndAcwTime

public Date getEndAcwTime()

setEndAcwTime

public void setEndAcwTime(Date endAcwTime)

conversationRoutingData

public QueueConversationEventTopicParticipant conversationRoutingData(QueueConversationEventTopicConversationRoutingData conversationRoutingData)

getConversationRoutingData

public QueueConversationEventTopicConversationRoutingData getConversationRoutingData()

setConversationRoutingData

public void setConversationRoutingData(QueueConversationEventTopicConversationRoutingData conversationRoutingData)

alertingTimeoutMs

public QueueConversationEventTopicParticipant alertingTimeoutMs(Long alertingTimeoutMs)

Specifies how long the agent has to answer an interaction before being marked as not responding.

getAlertingTimeoutMs

public Long getAlertingTimeoutMs()

setAlertingTimeoutMs

public void setAlertingTimeoutMs(Long alertingTimeoutMs)

monitoredParticipantId

public QueueConversationEventTopicParticipant monitoredParticipantId(String monitoredParticipantId)

If this participant is a monitor, then this will be the id of the participant that is being monitored.

getMonitoredParticipantId

public String getMonitoredParticipantId()

setMonitoredParticipantId

public void setMonitoredParticipantId(String monitoredParticipantId)

screenMonitoredParticipantId

public QueueConversationEventTopicParticipant screenMonitoredParticipantId(String screenMonitoredParticipantId)

If this participant is a screen monitor, then this will be the id of the participant that is being screen monitored.

getScreenMonitoredParticipantId

public String getScreenMonitoredParticipantId()

setScreenMonitoredParticipantId

public void setScreenMonitoredParticipantId(String screenMonitoredParticipantId)

coachedParticipantId

public QueueConversationEventTopicParticipant coachedParticipantId(String coachedParticipantId)

If this participant is a coach, then this will be the id of the participant that is being coached.

getCoachedParticipantId

public String getCoachedParticipantId()

setCoachedParticipantId

public void setCoachedParticipantId(String coachedParticipantId)

bargedParticipantId

public QueueConversationEventTopicParticipant bargedParticipantId(String bargedParticipantId)

If this participant created a barge in conference, then this will be the id of the participant that is barged in.

getBargedParticipantId

public String getBargedParticipantId()

setBargedParticipantId

public void setBargedParticipantId(String bargedParticipantId)

mediaRoles

public QueueConversationEventTopicParticipant mediaRoles(List<String> mediaRoles)

List of roles this participant's media has had on the conversation, ie monitor, coach, etc.

getMediaRoles

public List<String> getMediaRoles()

setMediaRoles

public void setMediaRoles(List<String> mediaRoles)

screenRecordingState

public QueueConversationEventTopicParticipant screenRecordingState(QueueConversationEventTopicParticipant.ScreenRecordingStateEnum screenRecordingState)

The current screen recording state for this participant.

getScreenRecordingState

public QueueConversationEventTopicParticipant.ScreenRecordingStateEnum getScreenRecordingState()

setScreenRecordingState

public void setScreenRecordingState(QueueConversationEventTopicParticipant.ScreenRecordingStateEnum screenRecordingState)

flaggedReason

public QueueConversationEventTopicParticipant flaggedReason(String flaggedReason)

If this participant has flagged the conversation, the reason code given.

getFlaggedReason

public String getFlaggedReason()

setFlaggedReason

public void setFlaggedReason(String flaggedReason)

attributes

public QueueConversationEventTopicParticipant attributes(Map<String,String> attributes)

Additional participant attributes

getAttributes

public Map<String,String> getAttributes()

setAttributes

public void setAttributes(Map<String,String> attributes)

calls

public QueueConversationEventTopicParticipant calls(List<QueueConversationEventTopicCall> calls)

getCalls

public List<QueueConversationEventTopicCall> getCalls()

setCalls

public void setCalls(List<QueueConversationEventTopicCall> calls)

callbacks

public QueueConversationEventTopicParticipant callbacks(List<QueueConversationEventTopicCallback> callbacks)

getCallbacks

public List<QueueConversationEventTopicCallback> getCallbacks()

setCallbacks

public void setCallbacks(List<QueueConversationEventTopicCallback> callbacks)

chats

public QueueConversationEventTopicParticipant chats(List<QueueConversationEventTopicChat> chats)

getChats

public List<QueueConversationEventTopicChat> getChats()

setChats

public void setChats(List<QueueConversationEventTopicChat> chats)

cobrowsesessions

public QueueConversationEventTopicParticipant cobrowsesessions(List<QueueConversationEventTopicCobrowse> cobrowsesessions)

getCobrowsesessions

public List<QueueConversationEventTopicCobrowse> getCobrowsesessions()

setCobrowsesessions

public void setCobrowsesessions(List<QueueConversationEventTopicCobrowse> cobrowsesessions)

emails

public QueueConversationEventTopicParticipant emails(List<QueueConversationEventTopicEmail> emails)

getEmails

public List<QueueConversationEventTopicEmail> getEmails()

setEmails

public void setEmails(List<QueueConversationEventTopicEmail> emails)

messages

public QueueConversationEventTopicParticipant messages(List<QueueConversationEventTopicMessage> messages)

getMessages

public List<QueueConversationEventTopicMessage> getMessages()

setMessages

public void setMessages(List<QueueConversationEventTopicMessage> messages)

internalMessages

public QueueConversationEventTopicParticipant internalMessages(List<QueueConversationEventTopicInternalMessage> internalMessages)

getInternalMessages

public List<QueueConversationEventTopicInternalMessage> getInternalMessages()

setInternalMessages

public void setInternalMessages(List<QueueConversationEventTopicInternalMessage> internalMessages)

screenMonitorings

public QueueConversationEventTopicParticipant screenMonitorings(List<QueueConversationEventTopicScreenMonitoring> screenMonitorings)

getScreenMonitorings

public List<QueueConversationEventTopicScreenMonitoring> getScreenMonitorings()

setScreenMonitorings

public void setScreenMonitorings(List<QueueConversationEventTopicScreenMonitoring> screenMonitorings)

screenshares

public QueueConversationEventTopicParticipant screenshares(List<QueueConversationEventTopicScreenShare> screenshares)

getScreenshares

public List<QueueConversationEventTopicScreenShare> getScreenshares()

setScreenshares

public void setScreenshares(List<QueueConversationEventTopicScreenShare> screenshares)

socialExpressions

public QueueConversationEventTopicParticipant socialExpressions(List<QueueConversationEventTopicSocialExpression> socialExpressions)

getSocialExpressions

public List<QueueConversationEventTopicSocialExpression> getSocialExpressions()

setSocialExpressions

public void setSocialExpressions(List<QueueConversationEventTopicSocialExpression> socialExpressions)

videos

public QueueConversationEventTopicParticipant videos(List<QueueConversationEventTopicVideo> videos)

getVideos

public List<QueueConversationEventTopicVideo> getVideos()

setVideos

public void setVideos(List<QueueConversationEventTopicVideo> videos)

workflow

public QueueConversationEventTopicParticipant workflow(QueueConversationEventTopicWorkflow workflow)

getWorkflow

public QueueConversationEventTopicWorkflow getWorkflow()

setWorkflow

public void setWorkflow(QueueConversationEventTopicWorkflow workflow)

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