Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.flexchat.events
Class EventStatus

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.webmedia.protocol.flexchat.events.EventStatus
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventStatus
extends Message

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

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Method Detail

create

public static EventStatus create()
Creates instance of EventStatus with no parameters set.

Returns:
instance of 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)
Creates instance of EventStatus.

Parameters:
userId - UserId
secureKey - SecureKey
occurredAt - OccurredAt
partyId - PartyId
requestResult - RequestResult
flexTranscript - FlexTranscript
description - Event notification or error description structure.
Returns:
instance of EventStatus

getReferenceId

public abstract java.lang.Integer getReferenceId()
The unique reference ID for any requests or events.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
The unique reference ID for any requests or events.


setReferenceId

public abstract void setReferenceId(int referenceId)
The unique reference ID for any requests or events.


getUserId

public abstract java.lang.String getUserId()
The user ID uniquely identifies chat party/user across all chat sessions.


setUserId

public abstract void setUserId(java.lang.String userId)
The user ID uniquely identifies chat party/user across all chat sessions.


getSecureKey

public abstract java.lang.String getSecureKey()

setSecureKey

public abstract void setSecureKey(java.lang.String secureKey)

getOccurredAt

public abstract java.lang.String getOccurredAt()
Indicates when an event occurred.


setOccurredAt

public abstract void setOccurredAt(java.lang.String occurredAt)
Indicates when an event occurred.


getPartyId

public abstract java.lang.Integer getPartyId()
An integer that represents a unique ID number for each party in the session. This ID is unique only within this particular chat session, not across different chat session.


setPartyId

public abstract void setPartyId(java.lang.Integer partyId)
An integer that represents a unique ID number for each party in the session. This ID is unique only within this particular chat session, not across different chat session.


setPartyId

public abstract void setPartyId(int partyId)
An integer that represents a unique ID number for each party in the session. This ID is unique only within this particular chat session, not across different chat session.


getRequestResult

public abstract RequestResult getRequestResult()
An EventStatus property that indicates whether a request was processed correctly. Valid values are:
Success - The request was handled without any problems.
Error - An error occurred processing the request.


setRequestResult

public abstract void setRequestResult(RequestResult requestResult)
An EventStatus property that indicates whether a request was processed correctly. Valid values are:
Success - The request was handled without any problems.
Error - An error occurred processing the request.


getServerVersion

public abstract java.lang.String getServerVersion()
The release number of Chat Server.


setServerVersion

public abstract void setServerVersion(java.lang.String serverVersion)
The release number of Chat Server.


getFlexTranscript

public abstract FlexTranscript getFlexTranscript()

setFlexTranscript

public abstract void setFlexTranscript(FlexTranscript flexTranscript)

getDescription

public abstract Description getDescription()
Event notification or error description structure.

Returns:
property value

setDescription

public abstract void setDescription(Description description)
Event notification or error description structure.

Parameters:
description - new value of the property

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.