|
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.RequestRefresh
public abstract class RequestRefresh
Issues a request to refresh the current flexchat session. To refresh
an existing session, you need to specify correct values for
UserId
, SecureKey
, and FromPosition
.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestRefresh |
create()
Creates instance of RequestRefresh with no parameters set. |
static RequestRefresh |
create(java.lang.String userId,
java.lang.String secureKey,
java.lang.Integer fromPosition)
Creates instance of RequestRefresh. |
static RequestRefresh |
create(java.lang.String userId,
java.lang.String secureKey,
java.lang.Integer fromPosition,
MessageText messageText)
Creates instance of RequestRefresh. |
static RequestRefresh |
create(java.lang.String userId,
java.lang.String secureKey,
java.lang.Integer fromPosition,
MessageText messageText,
java.lang.String sessionId)
Creates instance of RequestRefresh. |
static RequestRefresh |
create(java.lang.String userId,
java.lang.String secureKey,
java.lang.Integer fromPosition,
NoticeText noticeText)
Creates instance of RequestRefresh. |
static RequestRefresh |
create(java.lang.String userId,
java.lang.String secureKey,
java.lang.Integer fromPosition,
NoticeText noticeText,
KeyValueCollection userData)
Creates instance of RequestRefresh. |
static RequestRefresh |
create(java.lang.String userId,
java.lang.String secureKey,
java.lang.Integer fromPosition,
NoticeText noticeText,
KeyValueCollection userData,
java.lang.String sessionId)
Creates instance of RequestRefresh. |
static RequestRefresh |
create(java.lang.String userId,
java.lang.String secureKey,
java.lang.Integer fromPosition,
NoticeText noticeText,
MessageText messageText)
Creates instance of RequestRefresh. While the Refresh method allow to add both Notice and Message - chat server will process only Notice and the Message will be skipped when both are specified. |
abstract java.lang.Integer |
getFromPosition()
An integer that indicates the current position in the transcript of a chat session. |
abstract MessageText |
getMessageText()
|
abstract NoticeText |
getNoticeText()
|
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 KeyValueCollection |
getUserData()
Pointer to the user data that should be attached to the 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 |
setMessageText(MessageText messageText)
|
abstract void |
setNoticeText(NoticeText noticeText)
|
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 |
setUserData(KeyValueCollection userData)
Pointer to the user data that should be attached to the 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 RequestRefresh create()
public static RequestRefresh create(java.lang.String userId, java.lang.String secureKey, java.lang.Integer fromPosition, NoticeText noticeText, MessageText messageText)
userId
- UserIdsecureKey
- SecureKeyfromPosition
- FromPositionnoticeText
- NoticeTextmessageText
- MessageText
public static RequestRefresh create(java.lang.String userId, java.lang.String secureKey, java.lang.Integer fromPosition)
userId
- UserIdsecureKey
- SecureKeyfromPosition
- FromPosition
public static RequestRefresh create(java.lang.String userId, java.lang.String secureKey, java.lang.Integer fromPosition, MessageText messageText)
userId
- UserIdsecureKey
- SecureKeyfromPosition
- FromPositionmessageText
- MessageText
public static RequestRefresh create(java.lang.String userId, java.lang.String secureKey, java.lang.Integer fromPosition, NoticeText noticeText)
userId
- UserIdsecureKey
- SecureKeyfromPosition
- FromPositionnoticeText
- NoticeText
public static RequestRefresh create(java.lang.String userId, java.lang.String secureKey, java.lang.Integer fromPosition, NoticeText noticeText, KeyValueCollection userData)
userId
- UserIdsecureKey
- SecureKeyfromPosition
- FromPositionnoticeText
- NoticeTextuserData
- UserData
public static RequestRefresh create(java.lang.String userId, java.lang.String secureKey, java.lang.Integer fromPosition, NoticeText noticeText, KeyValueCollection userData, java.lang.String sessionId)
userId
- UserIdsecureKey
- SecureKeyfromPosition
- FromPositionnoticeText
- NoticeTextuserData
- UserDatasessionId
- SessionId
public static RequestRefresh create(java.lang.String userId, java.lang.String secureKey, java.lang.Integer fromPosition, MessageText messageText, java.lang.String sessionId)
userId
- UserIdsecureKey
- SecureKeyfromPosition
- FromPositionmessageText
- MessageTextsessionId
- SessionId
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)
public abstract NoticeText getNoticeText()
public abstract void setNoticeText(NoticeText noticeText)
public abstract MessageText getMessageText()
public abstract void setMessageText(MessageText messageText)
public abstract KeyValueCollection getUserData()
public abstract void setUserData(KeyValueCollection userData)
public abstract java.lang.String getSessionId()
public abstract void setSessionId(java.lang.String sessionId)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |