|
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.flexchat.EventInfo
public abstract class EventInfo
Constructor Summary | |
---|---|
EventInfo()
|
Method Summary | |
---|---|
static EventInfo |
create()
Creates instance of EventInfo with no parameters set. |
static EventInfo |
create(java.lang.Integer partyId,
EventType eventType,
java.lang.String userNickname,
UserType userType,
java.lang.Integer timeOffset,
java.lang.String messageType,
java.lang.String text,
NoticeType noticeType)
Creates instance of EventInfo. |
static EventInfo |
create(java.lang.Integer partyId,
EventType eventType,
java.lang.String userNickname,
UserType userType,
java.lang.Integer timeOffset,
java.lang.String messageType,
java.lang.String text,
NoticeType noticeType,
java.lang.Integer eventId)
Creates instance of EventInfo. |
abstract java.lang.Integer |
getEventId()
|
abstract EventType |
getEventType()
The event type returned as part of an EventInfo object. |
abstract java.lang.String |
getMessageType()
Defines the message type for each |
abstract MsgCheck |
getMsgCheck()
Defines message checking information. |
abstract NoticeText |
getNoticeText()
|
abstract NoticeType |
getNoticeType()
Type of notification, as defined by the NoticeType enumeration. |
abstract java.lang.Integer |
getPartyId()
An integer that represents a unique ID number for each party in the session. |
abstract java.lang.String |
getText()
If NoticeType is not equal to None , then this property contains the notification text. |
abstract java.lang.Integer |
getTimeOffset()
Number of seconds elapsed from the moment when chat session started. |
abstract KeyValueCollection |
getUserData()
Pointer to the user data that should be attached to the interaction. |
abstract java.lang.String |
getUserNickname()
The nickname of the chat user in the chat session. |
abstract UserType |
getUserType()
The user type attached to the interaction. |
abstract void |
setEventId(int eventId)
|
abstract void |
setEventId(java.lang.Integer eventId)
|
abstract void |
setEventType(EventType eventType)
The event type returned as part of an EventInfo object. |
abstract void |
setMessageType(java.lang.String messageType)
Defines the message type for each |
abstract void |
setMsgCheck(MsgCheck msgCheck)
Defines message checking information. |
abstract void |
setNoticeText(NoticeText noticeText)
|
abstract void |
setNoticeType(NoticeType noticeType)
Type of notification, as defined by the NoticeType enumeration. |
abstract void |
setPartyId(int partyId)
An integer that represents a unique ID number for each party in the session. |
abstract void |
setPartyId(java.lang.Integer partyId)
An integer that represents a unique ID number for each party in the session. |
abstract void |
setText(java.lang.String text)
If NoticeType is not equal to None , then this property contains the notification text. |
abstract void |
setTimeOffset(int timeOffset)
Number of seconds elapsed from the moment when chat session started. |
abstract void |
setTimeOffset(java.lang.Integer timeOffset)
Number of seconds elapsed from the moment when chat session started. |
abstract void |
setUserData(KeyValueCollection userData)
Pointer to the user data that should be attached to the interaction. |
abstract void |
setUserNickname(java.lang.String userNickname)
The nickname of the chat user in the chat session. |
abstract void |
setUserType(UserType userType)
The user type attached to the interaction. |
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 EventInfo()
Method Detail |
---|
public static EventInfo create()
public static EventInfo create(java.lang.Integer partyId, EventType eventType, java.lang.String userNickname, UserType userType, java.lang.Integer timeOffset, java.lang.String messageType, java.lang.String text, NoticeType noticeType)
partyId
- PartyIdeventType
- EventTypeuserNickname
- UserNicknameuserType
- UserTypetimeOffset
- TimeOffsetmessageType
- MessageTypetext
- TextnoticeType
- NoticeType
public static EventInfo create(java.lang.Integer partyId, EventType eventType, java.lang.String userNickname, UserType userType, java.lang.Integer timeOffset, java.lang.String messageType, java.lang.String text, NoticeType noticeType, java.lang.Integer eventId)
partyId
- PartyIdeventType
- EventTypeuserNickname
- UserNicknameuserType
- UserTypetimeOffset
- TimeOffsetmessageType
- MessageTypetext
- TextnoticeType
- NoticeTypeeventId
- EventId
public abstract java.lang.Integer getPartyId()
public abstract void setPartyId(java.lang.Integer partyId)
public abstract void setPartyId(int partyId)
public abstract EventType getEventType()
EventInfo
object. Valid values are:
public abstract void setEventType(EventType eventType)
EventInfo
object. Valid values are:
public abstract MsgCheck getMsgCheck()
public abstract void setMsgCheck(MsgCheck msgCheck)
public abstract java.lang.String getUserNickname()
public abstract void setUserNickname(java.lang.String userNickname)
public abstract UserType getUserType()
public abstract void setUserType(UserType userType)
public abstract java.lang.Integer getTimeOffset()
public abstract void setTimeOffset(java.lang.Integer timeOffset)
public abstract void setTimeOffset(int timeOffset)
public abstract java.lang.String getMessageType()
public abstract void setMessageType(java.lang.String messageType)
public abstract java.lang.String getText()
NoticeType
is not equal to None
, then this property contains the notification text. Otherwise, it holds the message text.
public abstract void setText(java.lang.String text)
NoticeType
is not equal to None
, then this property contains the notification text. Otherwise, it holds the message text.
public abstract NoticeType getNoticeType()
NoticeType
enumeration.
public abstract void setNoticeType(NoticeType noticeType)
NoticeType
enumeration.
public abstract java.lang.Integer getEventId()
public abstract void setEventId(java.lang.Integer eventId)
public abstract void setEventId(int eventId)
public abstract NoticeText getNoticeText()
public abstract void setNoticeText(NoticeText noticeText)
public abstract KeyValueCollection getUserData()
public abstract void setUserData(KeyValueCollection userData)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |