|
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.RequestReleaseParty
public abstract class RequestReleaseParty
Issues a request to release one party from the chat session.
To create a RequestReleaseParty
request, you need to set correct values for
AfterAction
, SessionID
, and UserId
.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestReleaseParty |
create()
Creates instance of RequestReleaseParty with no parameters set. |
static RequestReleaseParty |
create(java.lang.String sessionId)
Creates instance of RequestReleaseParty with required parameters set. |
static RequestReleaseParty |
create(java.lang.String sessionId,
java.lang.String userId,
Action afterAction,
MessageText messageText)
Creates instance of RequestReleaseParty with all parameters set. |
abstract Action |
getAfterAction()
Specifies the action to take after a RequestReleaseParty
request. |
abstract MessageText |
getMessageText()
|
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 |
getUserId()
The user ID uniquely identifies chat party/user across all chat sessions. |
abstract void |
setAfterAction(Action afterAction)
Specifies the action to take after a RequestReleaseParty
request. |
abstract void |
setMessageText(MessageText messageText)
|
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 |
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 RequestReleaseParty create()
public static RequestReleaseParty create(java.lang.String sessionId, java.lang.String userId, Action afterAction, MessageText messageText)
sessionId
- SessionIduserId
- UserIdafterAction
- AfterActionmessageText
- MessageText
public static RequestReleaseParty create(java.lang.String sessionId)
sessionId
- 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 getSessionId()
public abstract void setSessionId(java.lang.String sessionId)
public abstract java.lang.String getUserId()
public abstract void setUserId(java.lang.String userId)
public abstract Action getAfterAction()
RequestReleaseParty
request. Accepted values are: KeepAlive
, CloseIfNoAgents
,
and ForceClose
.
public abstract void setAfterAction(Action afterAction)
RequestReleaseParty
request. Accepted values are: KeepAlive
, CloseIfNoAgents
,
and ForceClose
.
public abstract MessageText getMessageText()
public abstract void setMessageText(MessageText messageText)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |