|
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.flexchat.requests.RequestJoin
public abstract class RequestJoin
Issues a request to join a chat interaction.
To connect to an existing session you have to set the correct
values for SessionID
and UserId
.
To create a new session, SessionID
should be null and you must specify
values for UserId
, SecureKey
, Subject
, and QueueKey
.
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 userId,
java.lang.String secureKey,
java.lang.String sessionId,
java.lang.String queueKey,
java.lang.String subject)
Creates instance of RequestJoin. |
static RequestJoin |
create(java.lang.String userId,
java.lang.String secureKey,
java.lang.String sessionId,
java.lang.String queueKey,
java.lang.String subject,
java.lang.Integer fromPosition)
Creates instance of RequestJoin. |
abstract java.lang.Integer |
getFromPosition()
An integer that indicates the current position in the transcript of a chat session. |
abstract java.lang.String |
getQueueKey()
This string specifies which queue to join during a RequestJoin request. |
abstract java.lang.Integer |
getReferenceId()
The unique reference ID for any requests or events. |
abstract java.lang.String |
getSecureKey()
|
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 java.lang.String |
getUserId()
The user ID uniquely identifies chat party/user across all chat sessions. |
abstract void |
setFromPosition(int fromPosition)
An integer that indicates the current position in the transcript of a chat session. |
abstract void |
setFromPosition(java.lang.Integer fromPosition)
An integer that indicates the current position in the transcript of a chat session. |
abstract void |
setQueueKey(java.lang.String queueKey)
This string specifies which queue to join during a RequestJoin request. |
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 |
setSecureKey(java.lang.String secureKey)
|
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 |
setUserId(java.lang.String userId)
The user ID uniquely identifies chat party/user across all chat sessions. |
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 userId, java.lang.String secureKey, java.lang.String sessionId, java.lang.String queueKey, java.lang.String subject)
userId
- UserIdsecureKey
- SecureKeysessionId
- SessionIdqueueKey
- QueueKeysubject
- Subject
public static RequestJoin create(java.lang.String userId, java.lang.String secureKey, java.lang.String sessionId, java.lang.String queueKey, java.lang.String subject, java.lang.Integer fromPosition)
userId
- UserIdsecureKey
- SecureKeysessionId
- SessionIdqueueKey
- QueueKeysubject
- SubjectfromPosition
- FromPosition
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 getUserId()
public abstract void setUserId(java.lang.String userId)
public abstract java.lang.String getSecureKey()
public abstract void setSecureKey(java.lang.String secureKey)
public abstract java.lang.String getSessionId()
public abstract void setSessionId(java.lang.String sessionId)
public abstract java.lang.String getQueueKey()
RequestJoin
request.
public abstract void setQueueKey(java.lang.String queueKey)
RequestJoin
request.
public abstract java.lang.String getSubject()
public abstract void setSubject(java.lang.String subject)
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 |