Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.basicchat
Class UserInfo

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.runtime.CompoundValue
          extended by com.genesyslab.platform.webmedia.protocol.basicchat.UserInfo
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class UserInfo
extends com.genesyslab.platform.commons.protocol.runtime.CompoundValue


Constructor Summary
UserInfo()
           
 
Method Summary
static UserInfo create()
          Creates instance of UserInfo with no parameters set.
static UserInfo create(java.lang.String personId, java.lang.String userNickname, UserType userType, ProtocolType protocolType, java.lang.Integer timeZoneOffset)
          Creates instance of UserInfo.
static UserInfo create(java.lang.String personId, java.lang.String userNickname, UserType userType, java.lang.String secureKey, ProtocolType protocolType, java.lang.Integer timeZoneOffset)
          Creates instance of UserInfo.
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  ProtocolType getProtocolType()
          The protocol type for this chat session.
abstract  java.lang.String getSecureKey()
           
abstract  java.lang.Integer getTimeZoneOffset()
          Integer indicating the timezone offset for a chat session.
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 setProtocolType(ProtocolType protocolType)
          The protocol type for this chat session.
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 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.runtime.CompoundValue
getProtocolDescription
 
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
 

Constructor Detail

UserInfo

public UserInfo()
Method Detail

create

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

Returns:
instance of UserInfo

create

public static UserInfo create(java.lang.String personId,
                              java.lang.String userNickname,
                              UserType userType,
                              ProtocolType protocolType,
                              java.lang.Integer timeZoneOffset)
Creates instance of UserInfo.

Parameters:
personId - PersonId
userNickname - UserNickname
userType - UserType
protocolType - ProtocolType
timeZoneOffset - TimeZoneOffset
Returns:
instance of UserInfo

create

public static UserInfo create(java.lang.String personId,
                              java.lang.String userNickname,
                              UserType userType,
                              java.lang.String secureKey,
                              ProtocolType protocolType,
                              java.lang.Integer timeZoneOffset)
Creates instance of UserInfo.

Parameters:
personId - PersonId
userNickname - UserNickname
userType - UserType
secureKey - SecureKey
protocolType - ProtocolType
timeZoneOffset - TimeZoneOffset
Returns:
instance of UserInfo

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.


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.


getSecureKey

public abstract java.lang.String getSecureKey()

setSecureKey

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

getProtocolType

public abstract ProtocolType getProtocolType()
The protocol type for this chat session. Accepted values are: Basic, Flex, or Esp.


setProtocolType

public abstract void setProtocolType(ProtocolType protocolType)
The protocol type for this chat session. Accepted values are: Basic, Flex, or Esp.


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.


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.