|
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.RequestMessage
public abstract class RequestMessage
Issues a request to add a message to the specified chat session.
To create a RequestMessage
request, you need to set correct values for
SessionID
, Visibility
, and the message text.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestMessage |
create()
Creates instance of RequestMessage with no parameters set. |
static RequestMessage |
create(java.lang.String sessionId,
Visibility visibility)
Creates instance of RequestMessage. |
static RequestMessage |
create(java.lang.String sessionId,
Visibility visibility,
MessageText messageText)
Creates instance of RequestMessage. |
abstract MessageText |
getMessageText()
|
abstract java.lang.String |
getReceiverId()
|
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 Visibility |
getVisibility()
This value determines the visibility of this event for other participants of chat session. |
abstract void |
setMessageText(MessageText messageText)
|
abstract void |
setReceiverId(java.lang.String receiverId)
|
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 |
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 RequestMessage create()
public static RequestMessage create(java.lang.String sessionId, Visibility visibility)
sessionId
- SessionIdvisibility
- Visibility
public static RequestMessage create(java.lang.String sessionId, Visibility visibility, MessageText messageText)
sessionId
- SessionIdvisibility
- VisibilitymessageText
- 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 MessageText getMessageText()
public abstract void setMessageText(MessageText messageText)
public abstract java.lang.String getReceiverId()
public abstract void setReceiverId(java.lang.String receiverId)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |