Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.basicchat.events
Class EventRegistered

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.basicchat.events.EventRegistered
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventRegistered
extends Message

This event indicates that the RequestRegister request was processed successfully. This event includes the UserId of the registered user, as well as the OccurredAt string.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventRegistered create()
          Creates instance of EventRegistered with no parameters set.
static EventRegistered create(java.lang.String occurredAt, java.lang.String userId)
          Creates instance of EventRegistered.
static EventRegistered create(java.lang.String occurredAt, java.lang.String userId, java.lang.String secureKey)
          Creates instance of EventRegistered.
abstract  java.lang.String getOccurredAt()
          Indicates when an event occurred.
abstract  java.lang.Integer getReferenceId()
          The unique reference ID for any requests or events.
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 setOccurredAt(java.lang.String occurredAt)
          Indicates when an event occurred.
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 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 EventRegistered create()
Creates instance of EventRegistered with no parameters set.

Returns:
instance of EventRegistered

create

public static EventRegistered create(java.lang.String occurredAt,
                                     java.lang.String userId)
Creates instance of EventRegistered.

Parameters:
occurredAt - OccurredAt
userId - UserId
Returns:
instance of EventRegistered

create

public static EventRegistered create(java.lang.String occurredAt,
                                     java.lang.String userId,
                                     java.lang.String secureKey)
Creates instance of EventRegistered.

Parameters:
occurredAt - OccurredAt
userId - UserId
secureKey - SecureKey
Returns:
instance of EventRegistered

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.


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.


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)

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.


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.