|
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.flexchat.events.EventStatus
public abstract class EventStatus
The EventStatus
event provides information about
the status of a request, including when the request occurred, the
result of that request, a FlexTranscript
of session
details, and an error description (if necessary).
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static EventStatus |
create()
Creates instance of EventStatus with no parameters set. |
static EventStatus |
create(java.lang.String userId,
java.lang.String secureKey,
java.lang.String occurredAt,
java.lang.Integer partyId,
RequestResult requestResult,
FlexTranscript flexTranscript,
Description description)
Creates instance of EventStatus. |
abstract Description |
getDescription()
Event notification or error description structure. |
abstract FlexTranscript |
getFlexTranscript()
|
abstract java.lang.String |
getOccurredAt()
Indicates when an event occurred. |
abstract java.lang.Integer |
getPartyId()
An integer that represents a unique ID number for each party in the session. |
abstract java.lang.Integer |
getReferenceId()
The unique reference ID for any requests or events. |
abstract RequestResult |
getRequestResult()
An EventStatus property that indicates whether
a request was processed correctly. |
abstract java.lang.String |
getSecureKey()
|
abstract java.lang.String |
getServerVersion()
The release number of Chat Server. |
abstract java.lang.String |
getUserId()
The user ID uniquely identifies chat party/user across all chat sessions. |
abstract void |
setDescription(Description description)
Event notification or error description structure. |
abstract void |
setFlexTranscript(FlexTranscript flexTranscript)
|
abstract void |
setOccurredAt(java.lang.String occurredAt)
Indicates when an event occurred. |
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 |
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 |
setRequestResult(RequestResult requestResult)
An EventStatus property that indicates whether
a request was processed correctly. |
abstract void |
setSecureKey(java.lang.String secureKey)
|
abstract void |
setServerVersion(java.lang.String serverVersion)
The release number of Chat Server. |
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 EventStatus create()
public static EventStatus create(java.lang.String userId, java.lang.String secureKey, java.lang.String occurredAt, java.lang.Integer partyId, RequestResult requestResult, FlexTranscript flexTranscript, Description description)
userId
- UserIdsecureKey
- SecureKeyoccurredAt
- OccurredAtpartyId
- PartyIdrequestResult
- RequestResultflexTranscript
- FlexTranscriptdescription
- Event notification or error description structure.
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 getUserId()
public abstract void setUserId(java.lang.String userId)
public abstract java.lang.String getSecureKey()
public abstract void setSecureKey(java.lang.String secureKey)
public abstract java.lang.String getOccurredAt()
public abstract void setOccurredAt(java.lang.String occurredAt)
public abstract java.lang.Integer getPartyId()
public abstract void setPartyId(java.lang.Integer partyId)
public abstract void setPartyId(int partyId)
public abstract RequestResult getRequestResult()
EventStatus
property that indicates whether
a request was processed correctly. Valid values are:
public abstract void setRequestResult(RequestResult requestResult)
EventStatus
property that indicates whether
a request was processed correctly. Valid values are:
public abstract java.lang.String getServerVersion()
public abstract void setServerVersion(java.lang.String serverVersion)
public abstract FlexTranscript getFlexTranscript()
public abstract void setFlexTranscript(FlexTranscript flexTranscript)
public abstract Description getDescription()
public abstract void setDescription(Description description)
description
- new value of the property
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |