|
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.runtime.CompoundValue
com.genesyslab.platform.webmedia.protocol.basicchat.NoticeInfo
public abstract class NoticeInfo
Constructor Summary | |
---|---|
NoticeInfo()
|
Method Summary | |
---|---|
static NoticeInfo |
create()
Creates instance of NoticeInfo with no parameters set. |
static NoticeInfo |
create(java.lang.String userId,
java.lang.Integer timeShift,
Visibility visibility,
NoticeText noticeText,
MessageText messageText,
KeyValueCollection userData)
Creates instance of NoticeInfo. |
static NoticeInfo |
create(java.lang.String userId,
java.lang.Integer timeShift,
Visibility visibility,
NoticeText noticeText,
MessageText messageText,
KeyValueCollection userData,
java.lang.Integer eventId,
java.lang.String receiverId)
Creates instance of NoticeInfo. |
abstract java.lang.Integer |
getEventId()
|
abstract MessageText |
getMessageText()
|
abstract NoticeText |
getNoticeText()
|
abstract java.lang.String |
getReceiverId()
|
abstract java.lang.Integer |
getTimeShift()
Number of seconds elapsed from the moment when chat session started |
abstract KeyValueCollection |
getUserData()
Pointer to the user data attached to the interaction. |
abstract java.lang.String |
getUserId()
The user ID uniquely identifies chat party/user across all chat sessions. |
abstract Visibility |
getVisibility()
This value determines the visibility of this event for other participants of chat session. |
abstract void |
setEventId(int eventId)
|
abstract void |
setEventId(java.lang.Integer eventId)
|
abstract void |
setMessageText(MessageText messageText)
|
abstract void |
setNoticeText(NoticeText noticeText)
|
abstract void |
setReceiverId(java.lang.String receiverId)
|
abstract void |
setTimeShift(int timeShift)
Number of seconds elapsed from the moment when chat session started |
abstract void |
setTimeShift(java.lang.Integer timeShift)
Number of seconds elapsed from the moment when chat session started |
abstract void |
setUserData(KeyValueCollection userData)
Pointer to the user data attached to the interaction. |
abstract void |
setUserId(java.lang.String userId)
The user ID uniquely identifies chat party/user across all 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.runtime.CompoundValue |
---|
getProtocolDescription |
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 |
Constructor Detail |
---|
public NoticeInfo()
Method Detail |
---|
public static NoticeInfo create()
public static NoticeInfo create(java.lang.String userId, java.lang.Integer timeShift, Visibility visibility, NoticeText noticeText, MessageText messageText, KeyValueCollection userData)
userId
- UserIdtimeShift
- TimeShiftvisibility
- VisibilitynoticeText
- NoticeTextmessageText
- MessageTextuserData
- UserData
public static NoticeInfo create(java.lang.String userId, java.lang.Integer timeShift, Visibility visibility, NoticeText noticeText, MessageText messageText, KeyValueCollection userData, java.lang.Integer eventId, java.lang.String receiverId)
userId
- UserIdtimeShift
- TimeShiftvisibility
- VisibilitynoticeText
- NoticeTextmessageText
- MessageTextuserData
- UserDataeventId
- EventIdreceiverId
- ReceiverId
public abstract java.lang.String getUserId()
public abstract void setUserId(java.lang.String userId)
public abstract java.lang.Integer getTimeShift()
public abstract void setTimeShift(java.lang.Integer timeShift)
public abstract void setTimeShift(int timeShift)
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.Integer getEventId()
public abstract void setEventId(java.lang.Integer eventId)
public abstract void setEventId(int eventId)
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 |