Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.flexchat.requests
Class RequestLogin

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

public abstract class RequestLogin
extends Message

Issues a login request to Interaction Server. To register with Interaction Server, you need to set correct values for UserNickname, TimeZoneOffset, and UserData.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestLogin create()
          Creates instance of RequestLogin with no parameters set.
static RequestLogin create(java.lang.String userNickname, java.lang.Integer timezoneOffset, KeyValueCollection userData)
          Creates instance of RequestLogin with all parameters set.
abstract  java.lang.Integer getReferenceId()
          The unique reference ID for any requests or events.
abstract  java.lang.Integer getTimezoneOffset()
          Integer indicating the timezone offset for a chat session.
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  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 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 that should be attached to the interaction.
abstract  void setUserNickname(java.lang.String userNickname)
          The nickname of the chat user in the chat session.
 
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 RequestLogin create()
Creates instance of RequestLogin with no parameters set.

Returns:
instance of RequestLogin

create

public static RequestLogin create(java.lang.String userNickname,
                                  java.lang.Integer timezoneOffset,
                                  KeyValueCollection userData)
Creates instance of RequestLogin with all parameters set.

Parameters:
userNickname - UserNickname
timezoneOffset - TimezoneOffset
userData - UserData
Returns:
instance of RequestLogin

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 nickname of the chat user in the chat session.


setUserNickname

public abstract void setUserNickname(java.lang.String userNickname)
The nickname of the chat user in the chat 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 that should be attached to the interaction.


setUserData

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


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.