|
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.flexchat.requests.RequestLogin
public abstract class RequestLogin
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static RequestLogin create()
public static RequestLogin create(java.lang.String userNickname, java.lang.Integer timezoneOffset, KeyValueCollection userData)
userNickname
- UserNicknametimezoneOffset
- TimezoneOffsetuserData
- UserData
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 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)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |