|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.webmedia.protocol.basicchat.requests.RequestJoin
public abstract class RequestJoin
Issues a request to create or join a chat session.
To connect to an existing session you have to set the correct
values for SessionID
and Visibility
.
To create a new session, SessionID
should be null and you must specify
values for QueueKey
, Subject
, and Visibility
.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestJoin |
create()
Creates instance of RequestJoin with no parameters set. |
static RequestJoin |
create(java.lang.String sessionId,
Visibility visibility,
MessageText messageText)
Creates instance of RequestJoin. |
static RequestJoin |
create(Visibility visibility,
java.lang.String queueKey,
java.lang.String subject,
MessageText messageText)
Creates instance of RequestJoin. |
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 |
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. |
Methods inherited from class com.genesyslab.platform.commons.protocol.Message |
---|
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription |
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject |
---|
equals, hashCode, toString, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static RequestJoin create()
public static RequestJoin create(java.lang.String sessionId, Visibility visibility, MessageText messageText)
sessionId
- SessionIdvisibility
- VisibilitymessageText
- MessageText
public static RequestJoin create(Visibility visibility, java.lang.String queueKey, java.lang.String subject, MessageText messageText)
visibility
- VisibilityqueueKey
- QueueKeysubject
- SubjectmessageText
- MessageText
public 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 java.lang.Integer getFromPosition()
public abstract void setFromPosition(java.lang.Integer fromPosition)
public abstract void setFromPosition(int fromPosition)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |