Package com.mypurecloud.sdk.v2.model

Class ConversationEventTopicParticipant

java.lang.Object

com.mypurecloud.sdk.v2.model.ConversationEventTopicParticipant

All Implemented Interfaces:

Serializable

public class ConversationEventTopicParticipant
extends Object
implements Serializable

ConversationEventTopicParticipant

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ConversationEventTopicParticipant()
ConversationEventTopicParticipant(Boolean initWithEmptyList)

Method Summary

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

ConversationEventTopicParticipant

public ConversationEventTopicParticipant()

ConversationEventTopicParticipant

public ConversationEventTopicParticipant(Boolean initWithEmptyList)

Method Details

id

public ConversationEventTopicParticipant id(String id)

A globally unique identifier for this conversation.

getId

public String getId()

setId

public void setId(String id)

connectedTime

public ConversationEventTopicParticipant 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 ConversationEventTopicParticipant 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 ConversationEventTopicParticipant 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 ConversationEventTopicParticipant 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 ConversationEventTopicParticipant 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 ConversationEventTopicParticipant 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 ConversationEventTopicParticipant name(String name)

A human readable name identifying the participant.

getName

public String getName()

setName

public void setName(String name)

queueId

public ConversationEventTopicParticipant 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 ConversationEventTopicParticipant groupId(String groupId)

If present, the group id that the participant represents.

getGroupId

public String getGroupId()

setGroupId

public void setGroupId(String groupId)

teamId

public ConversationEventTopicParticipant 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 ConversationEventTopicParticipant 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 ConversationEventTopicParticipant 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 ConversationEventTopicParticipant 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 ConversationEventTopicParticipant 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 ConversationEventTopicParticipant 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 ConversationEventTopicParticipant 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 ConversationEventTopicParticipant wrapupTimeoutMs(Long wrapupTimeoutMs)

Specifies how long a timed ACW session will last.

getWrapupTimeoutMs

public Long getWrapupTimeoutMs()

setWrapupTimeoutMs

public void setWrapupTimeoutMs(Long wrapupTimeoutMs)

wrapup

public ConversationEventTopicParticipant wrapup(ConversationEventTopicWrapup wrapup)

getWrapup

public ConversationEventTopicWrapup getWrapup()

setWrapup

public void setWrapup(ConversationEventTopicWrapup wrapup)

startAcwTime

public ConversationEventTopicParticipant startAcwTime(Date startAcwTime)

The timestamp when this participant started after-call work.

getStartAcwTime

public Date getStartAcwTime()

setStartAcwTime

public void setStartAcwTime(Date startAcwTime)

endAcwTime

public ConversationEventTopicParticipant endAcwTime(Date endAcwTime)

The timestamp when this participant ended after-call work.

getEndAcwTime

public Date getEndAcwTime()

setEndAcwTime

public void setEndAcwTime(Date endAcwTime)

conversationRoutingData

public ConversationEventTopicParticipant conversationRoutingData(ConversationEventTopicConversationRoutingData conversationRoutingData)

getConversationRoutingData

public ConversationEventTopicConversationRoutingData getConversationRoutingData()

setConversationRoutingData

public void setConversationRoutingData(ConversationEventTopicConversationRoutingData conversationRoutingData)

alertingTimeoutMs

public ConversationEventTopicParticipant 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 ConversationEventTopicParticipant 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 ConversationEventTopicParticipant 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 ConversationEventTopicParticipant 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 ConversationEventTopicParticipant 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 ConversationEventTopicParticipant 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 ConversationEventTopicParticipant screenRecordingState(ConversationEventTopicParticipant.ScreenRecordingStateEnum screenRecordingState)

The current screen recording state for this participant.

getScreenRecordingState

public ConversationEventTopicParticipant.ScreenRecordingStateEnum getScreenRecordingState()

setScreenRecordingState

public void setScreenRecordingState(ConversationEventTopicParticipant.ScreenRecordingStateEnum screenRecordingState)

flaggedReason

public ConversationEventTopicParticipant 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 ConversationEventTopicParticipant attributes(Map<String,String> attributes)

Additional participant attributes

getAttributes

public Map<String,String> getAttributes()

setAttributes

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

calls

public ConversationEventTopicParticipant calls(List<ConversationEventTopicCall> calls)

getCalls

public List<ConversationEventTopicCall> getCalls()

setCalls

public void setCalls(List<ConversationEventTopicCall> calls)

callbacks

public ConversationEventTopicParticipant callbacks(List<ConversationEventTopicCallback> callbacks)

getCallbacks

public List<ConversationEventTopicCallback> getCallbacks()

setCallbacks

public void setCallbacks(List<ConversationEventTopicCallback> callbacks)

chats

public ConversationEventTopicParticipant chats(List<ConversationEventTopicChat> chats)

getChats

public List<ConversationEventTopicChat> getChats()

setChats

public void setChats(List<ConversationEventTopicChat> chats)

cobrowsesessions

public ConversationEventTopicParticipant cobrowsesessions(List<ConversationEventTopicCobrowse> cobrowsesessions)

getCobrowsesessions

public List<ConversationEventTopicCobrowse> getCobrowsesessions()

setCobrowsesessions

public void setCobrowsesessions(List<ConversationEventTopicCobrowse> cobrowsesessions)

emails

public ConversationEventTopicParticipant emails(List<ConversationEventTopicEmail> emails)

getEmails

public List<ConversationEventTopicEmail> getEmails()

setEmails

public void setEmails(List<ConversationEventTopicEmail> emails)

messages

public ConversationEventTopicParticipant messages(List<ConversationEventTopicMessage> messages)

getMessages

public List<ConversationEventTopicMessage> getMessages()

setMessages

public void setMessages(List<ConversationEventTopicMessage> messages)

internalMessages

public ConversationEventTopicParticipant internalMessages(List<ConversationEventTopicInternalMessage> internalMessages)

getInternalMessages

public List<ConversationEventTopicInternalMessage> getInternalMessages()

setInternalMessages

public void setInternalMessages(List<ConversationEventTopicInternalMessage> internalMessages)

screenMonitorings

public ConversationEventTopicParticipant screenMonitorings(List<ConversationEventTopicScreenMonitoring> screenMonitorings)

getScreenMonitorings

public List<ConversationEventTopicScreenMonitoring> getScreenMonitorings()

setScreenMonitorings

public void setScreenMonitorings(List<ConversationEventTopicScreenMonitoring> screenMonitorings)

screenshares

public ConversationEventTopicParticipant screenshares(List<ConversationEventTopicScreenShare> screenshares)

getScreenshares

public List<ConversationEventTopicScreenShare> getScreenshares()

setScreenshares

public void setScreenshares(List<ConversationEventTopicScreenShare> screenshares)

socialExpressions

public ConversationEventTopicParticipant socialExpressions(List<ConversationEventTopicSocialExpression> socialExpressions)

getSocialExpressions

public List<ConversationEventTopicSocialExpression> getSocialExpressions()

setSocialExpressions

public void setSocialExpressions(List<ConversationEventTopicSocialExpression> socialExpressions)

videos

public ConversationEventTopicParticipant videos(List<ConversationEventTopicVideo> videos)

getVideos

public List<ConversationEventTopicVideo> getVideos()

setVideos

public void setVideos(List<ConversationEventTopicVideo> videos)

workflow

public ConversationEventTopicParticipant workflow(ConversationEventTopicWorkflow workflow)

getWorkflow

public ConversationEventTopicWorkflow getWorkflow()

setWorkflow

public void setWorkflow(ConversationEventTopicWorkflow 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