|
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.Message
com.genesyslab.platform.webmedia.protocol.basicchat.requests.RequestRegister
public abstract class RequestRegister
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static RequestRegister create()
public static RequestRegister create(java.lang.String userNickname, UserType userType, java.lang.String personId, java.lang.Integer timeZoneOffset, KeyValueCollection userData)
userNickname
- UserNicknameuserType
- UserTypepersonId
- PersonIdtimeZoneOffset
- TimeZoneOffsetuserData
- UserData
public static RequestRegister create(java.lang.String userNickname, UserType userType, java.lang.String personId, java.lang.Integer timeZoneOffset, KeyValueCollection userData, java.lang.String userId)
userNickname
- UserNicknameuserType
- UserTypepersonId
- PersonIdtimeZoneOffset
- TimeZoneOffsetuserData
- UserDatauserId
- UserId
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
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 getPersonId()
public abstract void setPersonId(java.lang.String personId)
public abstract java.lang.Integer getTimeZoneOffset()
public abstract void setTimeZoneOffset(java.lang.Integer timeZoneOffset)
public abstract void setTimeZoneOffset(int timeZoneOffset)
public abstract KeyValueCollection getUserData()
public abstract void setUserData(KeyValueCollection userData)
public abstract java.lang.String getUserId()
public abstract void setUserId(java.lang.String userId)
public abstract java.lang.String getSecureKey()
public abstract void setSecureKey(java.lang.String secureKey)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |