|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.runtime.CompoundValue
com.genesyslab.platform.webmedia.protocol.basicchat.UserInfo
public abstract class UserInfo
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 |
---|
public UserInfo()
Method Detail |
---|
public static UserInfo create()
public static UserInfo create(java.lang.String personId, java.lang.String userNickname, UserType userType, ProtocolType protocolType, java.lang.Integer timeZoneOffset)
personId
- PersonIduserNickname
- UserNicknameuserType
- UserTypeprotocolType
- ProtocolTypetimeZoneOffset
- TimeZoneOffset
public static UserInfo create(java.lang.String personId, java.lang.String userNickname, UserType userType, java.lang.String secureKey, ProtocolType protocolType, java.lang.Integer timeZoneOffset)
personId
- PersonIduserNickname
- UserNicknameuserType
- UserTypesecureKey
- SecureKeyprotocolType
- ProtocolTypetimeZoneOffset
- TimeZoneOffset
public abstract java.lang.String getPersonId()
public abstract void setPersonId(java.lang.String personId)
public abstract java.lang.String getUserNickname()
public abstract void setUserNickname(java.lang.String userNickname)
public abstract UserType getUserType()
Client
, Agent
, Supervisor
, and External
.
public abstract void setUserType(UserType userType)
Client
, Agent
, Supervisor
, and External
.
public abstract java.lang.String getSecureKey()
public abstract void setSecureKey(java.lang.String secureKey)
public abstract ProtocolType getProtocolType()
Basic
, Flex
, or Esp
.
public abstract void setProtocolType(ProtocolType protocolType)
Basic
, Flex
, or Esp
.
public abstract java.lang.Integer getTimeZoneOffset()
public abstract void setTimeZoneOffset(java.lang.Integer timeZoneOffset)
public abstract void setTimeZoneOffset(int timeZoneOffset)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |