|
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.RequestLogout
public abstract class RequestLogout
Issues a logout request to Interaction Server. To logout
from Interaction Server, you need to set correct values for
UserId
, SecureKey
, and FromPosition
.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestLogout |
create()
Creates instance of RequestLogout with no parameters set. |
static RequestLogout |
create(java.lang.String userId,
java.lang.String secureKey,
java.lang.Integer fromPosition)
Creates instance of RequestLogout with all parameters set. |
abstract java.lang.Integer |
getFromPosition()
An integer that indicates the current position in the transcript of a chat session. |
abstract java.lang.Integer |
getReferenceId()
The unique reference ID for any requests or events. |
abstract java.lang.String |
getSecureKey()
|
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 |
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 |
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 RequestLogout create()
public static RequestLogout create(java.lang.String userId, java.lang.String secureKey, java.lang.Integer fromPosition)
userId
- UserIdsecureKey
- SecureKeyfromPosition
- 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.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 |