ProtocolDescriptionSupport
@Generated(value="com.genesyslab.platform.commons.protocol.generator.Generator", date="2021-06-14T15:46:12.394-07:00") public abstract class RequestJoin extends Message
SessionID
and Visibility
.SessionID
should be null and you must specify
values for QueueKey
, Subject
, and Visibility
.Modifier and Type | Method | Description |
---|---|---|
static RequestJoin |
create() |
Creates instance of RequestJoin with no parameters set.
|
static RequestJoin |
create(Visibility visibility,
java.lang.String queueKey,
java.lang.String subject,
MessageText messageText) |
Creates instance of RequestJoin.
|
static RequestJoin |
create(java.lang.String sessionId,
Visibility visibility,
MessageText messageText) |
Creates instance of RequestJoin.
|
abstract KeyValueCollection |
getEventAttributes() |
|
abstract java.lang.Integer |
getFromPosition() |
|
abstract MessageText |
getMessageText() |
|
abstract java.lang.String |
getQueueKey() |
This string specifies which ChatServer endpoint is chosen (with the endpoint
specifying the Interaction Server queue where this chat interaction is submitted).
|
abstract java.lang.Integer |
getReferenceId() |
The unique reference ID for any requests or events.
|
abstract java.lang.String |
getSessionId() |
The unique session ID for chat sessions.
|
abstract java.lang.String |
getSubject() |
The chat subject line that is attached to this interaction.
|
abstract KeyValueCollection |
getUserData() |
Pointer to the user data attached to the interaction.
|
abstract Visibility |
getVisibility() |
This value determines the visibility of this event for other
participants of chat session.
|
abstract void |
setEventAttributes(KeyValueCollection eventAttributes) |
|
abstract void |
setFromPosition(int fromPosition) |
|
abstract void |
setFromPosition(java.lang.Integer fromPosition) |
|
abstract void |
setMessageText(MessageText messageText) |
|
abstract void |
setQueueKey(java.lang.String queueKey) |
This string specifies which ChatServer endpoint is chosen (with the endpoint
specifying the Interaction Server queue where this chat interaction is submitted).
|
abstract void |
setReferenceId(int referenceId) |
The unique reference ID for any requests or events.
|
abstract void |
setReferenceId(java.lang.Integer referenceId) |
The unique reference ID for any requests or events.
|
abstract void |
setSessionId(java.lang.String sessionId) |
The unique session ID for chat sessions.
|
abstract void |
setSubject(java.lang.String subject) |
The chat subject line that is attached to this interaction.
|
abstract void |
setUserData(KeyValueCollection userData) |
Pointer to the user data attached to the interaction.
|
abstract void |
setVisibility(Visibility visibility) |
This value determines the visibility of this event for other
participants of chat session.
|
equals, hashCode, toString, toString
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription
public static final int ID
public static final java.lang.String NAME
public static RequestJoin create()
public static RequestJoin create(java.lang.String sessionId, Visibility visibility, MessageText messageText)
sessionId
- SessionIdvisibility
- VisibilitymessageText
- MessageTextpublic static RequestJoin create(Visibility visibility, java.lang.String queueKey, java.lang.String subject, MessageText messageText)
visibility
- VisibilityqueueKey
- QueueKeysubject
- SubjectmessageText
- MessageTextpublic abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.String getSessionId()
public abstract void setSessionId(java.lang.String sessionId)
public abstract Visibility getVisibility()
All
(visible for all participants),
Int
(visible only for agents and supervisors), Vip
(visible only for supervisors).public abstract void setVisibility(Visibility visibility)
All
(visible for all participants),
Int
(visible only for agents and supervisors), Vip
(visible only for supervisors).public abstract java.lang.String getQueueKey()
public abstract void setQueueKey(java.lang.String queueKey)
public abstract java.lang.String getSubject()
public abstract void setSubject(java.lang.String subject)
public abstract MessageText getMessageText()
public abstract void setMessageText(MessageText messageText)
public abstract KeyValueCollection getUserData()
public abstract void setUserData(KeyValueCollection userData)
public abstract KeyValueCollection getEventAttributes()
public abstract void setEventAttributes(KeyValueCollection eventAttributes)
public abstract java.lang.Integer getFromPosition()
public abstract void setFromPosition(java.lang.Integer fromPosition)
public abstract void setFromPosition(int fromPosition)
Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 9.0.006.00
Copyright © 2006–2019 Genesys Telecommunications Laboratories, Inc. All rights reserved.