|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FlexChatProtocolHandshakeOptions
Dedicated interface to represent Flex Chat Server protocol handshake parameters.
FlexChatProtocol
Method Summary | |
---|---|
java.lang.String |
getSecureKey()
Optional, if set with UserId, channel will not send RequestLogin message during opening. |
java.lang.Integer |
getTimeZoneOffset()
Optional, timezone offset. |
KeyValueCollection |
getUserData()
Optional, used for user identification in UCS (Universal Contact Server). |
java.lang.String |
getUserId()
Optional, if set with SecureKey, channel will not send RequestLogin message during opening. |
java.lang.String |
getUserNickname()
Optional, but very desirable for login during channel Open. |
boolean |
isAutoRegister()
Returns flag for automatic client registration request on connection open. By default it is enabled, but sometimes it may be required to do some other operations before client registration request, or there is a need to create custom registration request. In this case user may disable automatic registration and later (after the connection opened) send own registration request. |
void |
setAutoRegister(boolean autoRegister)
Sets flag for automatic client registration request on connection open. By default it is enabled, but sometimes it may be required to do some other operations before client registration request, or there is a need to create custom registration request. In this case user may disable automatic registration and later (after the connection opened) send own registration request. |
void |
setSecureKey(java.lang.String secureKey)
Optional, if set with UserId, channel will not send RequestLogin message during opening. |
void |
setTimeZoneOffset(int timeZoneOffset)
Optional, timezone offset. |
void |
setTimeZoneOffset(java.lang.Integer timeZoneOffset)
Optional, timezone offset. |
void |
setUserData(KeyValueCollection userData)
Optional, used for user identification in UCS (Universal Contact Server). |
void |
setUserId(java.lang.String userId)
Optional, if set with SecureKey, channel will not send RequestLogin message during opening. |
void |
setUserNickname(java.lang.String userNickname)
Optional, but very desirable for login during channel Open. |
Method Detail |
---|
java.lang.Integer getTimeZoneOffset()
void setTimeZoneOffset(java.lang.Integer timeZoneOffset)
timeZoneOffset
- timezone offsetvoid setTimeZoneOffset(int timeZoneOffset)
timeZoneOffset
- timezone offsetKeyValueCollection getUserData()
void setUserData(KeyValueCollection userData)
userData
- user datajava.lang.String getUserNickname()
void setUserNickname(java.lang.String userNickname)
userNickname
- user nicknamejava.lang.String getSecureKey()
void setSecureKey(java.lang.String secureKey)
secureKey
- secure keyjava.lang.String getUserId()
void setUserId(java.lang.String userId)
userId
- user idboolean isAutoRegister()
setAutoRegister(boolean)
,
RequestLogin
void setAutoRegister(boolean autoRegister)
autoRegister
- flag for automatic client registration request allowingRequestLogin
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |