Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.basicchat.requests
Class RequestRegister

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.requests.RequestRegister
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestRegister
extends Message

Issues a request to register with Chat Server. To register with Chat Server, you need to set correct values for UserType. Other parameters are optional, including PersonId, TimeZoneOffset, UserData, and UserNickname.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestRegister create()
          Creates instance of RequestRegister with no parameters set.
static RequestRegister create(java.lang.String userNickname, UserType userType, java.lang.String personId, java.lang.Integer timeZoneOffset, KeyValueCollection userData)
          Creates instance of RequestRegister.
static RequestRegister create(java.lang.String userNickname, UserType userType, java.lang.String personId, java.lang.Integer timeZoneOffset, KeyValueCollection userData, java.lang.String userId)
          Creates instance of RequestRegister.
abstract  java.lang.String getPersonId()
          The person ID used when a new chat session is registered, or when a party is added to the session.
abstract  java.lang.Integer getReferenceId()
          The unique reference ID for any requests or events.
abstract  java.lang.String getSecureKey()
           
abstract  java.lang.Integer getTimeZoneOffset()
          Integer indicating the timezone offset for a chat session.
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  java.lang.String getUserNickname()
          The user name attached to the chat party/user across all chat sessions.
abstract  UserType getUserType()
          The type of user that is attached to this chat interaction.
abstract  void setPersonId(java.lang.String personId)
          The person ID used when a new chat session is registered, or when a party is added to 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 setSecureKey(java.lang.String secureKey)
           
abstract  void setTimeZoneOffset(int timeZoneOffset)
          Integer indicating the timezone offset for a chat session.
abstract  void setTimeZoneOffset(java.lang.Integer timeZoneOffset)
          Integer indicating the timezone offset for a chat session.
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 setUserNickname(java.lang.String userNickname)
          The user name attached to the chat party/user across all chat sessions.
abstract  void setUserType(UserType userType)
          The type of user that is attached to this chat interaction.
 
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 RequestRegister create()
Creates instance of RequestRegister with no parameters set.

Returns:
instance of RequestRegister

create

public static RequestRegister create(java.lang.String userNickname,
                                     UserType userType,
                                     java.lang.String personId,
                                     java.lang.Integer timeZoneOffset,
                                     KeyValueCollection userData)
Creates instance of RequestRegister.

Parameters:
userNickname - UserNickname
userType - UserType
personId - PersonId
timeZoneOffset - TimeZoneOffset
userData - UserData
Returns:
instance of RequestRegister

create

public static RequestRegister create(java.lang.String userNickname,
                                     UserType userType,
                                     java.lang.String personId,
                                     java.lang.Integer timeZoneOffset,
                                     KeyValueCollection userData,
                                     java.lang.String userId)
Creates instance of RequestRegister.

Parameters:
userNickname - UserNickname
userType - UserType
personId - PersonId
timeZoneOffset - TimeZoneOffset
userData - UserData
userId - UserId
Returns:
instance of RequestRegister

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.


getUserNickname

public abstract java.lang.String getUserNickname()
The user name attached to the chat party/user across all chat sessions.


setUserNickname

public abstract void setUserNickname(java.lang.String userNickname)
The user name attached to the chat party/user across all chat sessions.


getUserType

public abstract UserType getUserType()
The type of user that is attached to this chat interaction. Accepted values are: Client, Agent, Supervisor, and External.


setUserType

public abstract void setUserType(UserType userType)
The type of user that is attached to this chat interaction. Accepted values are: Client, Agent, Supervisor, and External.


getPersonId

public abstract java.lang.String getPersonId()
The person ID used when a new chat session is registered, or when a party is added to the session.


setPersonId

public abstract void setPersonId(java.lang.String personId)
The person ID used when a new chat session is registered, or when a party is added to the session.


getTimeZoneOffset

public abstract java.lang.Integer getTimeZoneOffset()
Integer indicating the timezone offset for a chat session.


setTimeZoneOffset

public abstract void setTimeZoneOffset(java.lang.Integer timeZoneOffset)
Integer indicating the timezone offset for a chat session.


setTimeZoneOffset

public abstract void setTimeZoneOffset(int timeZoneOffset)
Integer indicating the timezone offset for a chat session.


getUserData

public abstract KeyValueCollection getUserData()
Pointer to the user data attached to the interaction.


setUserData

public abstract void setUserData(KeyValueCollection userData)
Pointer to the user data attached to the interaction.


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)

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.