|
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.RequestNotify
public abstract class RequestNotify
Issues a request to add a notice (that is, a notification) to the current chat session.
To create a RequestNotify
request, you need to set correct values for SessionID
,
NoticeText
, and Visibility
. (Additionally, NoticeType
must not be set to
None
.)
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestNotify |
create()
Creates instance of RequestNotify with no parameters set. |
static RequestNotify |
create(java.lang.String sessionId,
Visibility visibility)
Creates instance of RequestNotify. |
static RequestNotify |
create(java.lang.String sessionId,
Visibility visibility,
NoticeText noticeText,
MessageText messageText,
KeyValueCollection userData)
Creates instance of RequestNotify. |
abstract MessageText |
getMessageText()
|
abstract NoticeText |
getNoticeText()
|
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 KeyValueCollection |
getUserData()
Pointer to the user data attached to the interaction. |
abstract Visibility |
getVisibility()
This value determines the visibility of this event for other participants of chat session. |
abstract void |
setMessageText(MessageText messageText)
|
abstract void |
setNoticeText(NoticeText noticeText)
|
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 |
setUserData(KeyValueCollection userData)
Pointer to the user data attached to the interaction. |
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 RequestNotify create()
public static RequestNotify create(java.lang.String sessionId, Visibility visibility)
sessionId
- SessionIdvisibility
- Visibility
public static RequestNotify create(java.lang.String sessionId, Visibility visibility, NoticeText noticeText, MessageText messageText, KeyValueCollection userData)
sessionId
- SessionIdvisibility
- VisibilitynoticeText
- NoticeTextmessageText
- MessageTextuserData
- UserData
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 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 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 |