|
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 BasicChatProtocolHandshakeOptions
Dedicated interface to represent Basic Chat Server protocol handshake parameters.
BasicChatProtocol
Method Summary | |
---|---|
java.lang.String |
getPersonId()
|
java.lang.String |
getSecureKey()
Optional, if set with UserId, channel will use it to restore previously registered session. |
int |
getTimeZoneOffset()
Optional, timezone offset. |
KeyValueCollection |
getUserData()
Optional, used for user identification in UCS (Universal Contact Server). |
java.lang.String |
getUserId()
|
java.lang.String |
getUserNickname()
|
UserType |
getUserType()
|
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 |
setPersonId(java.lang.String personId)
|
void |
setSecureKey(java.lang.String secureKey)
Optional, if set with UserId, channel will use it to restore previously registered session. |
void |
setTimeZoneOffset(int timeZoneOffset)
Optional, timezone offset. |
void |
setUserData(KeyValueCollection userData)
Optional, used for user identification in UCS (Universal Contact Server). |
void |
setUserId(java.lang.String userId)
|
void |
setUserNickname(java.lang.String userNickname)
|
void |
setUserType(UserType userType)
|
Method Detail |
---|
java.lang.String getUserNickname()
void setUserNickname(java.lang.String userNickname)
UserType getUserType()
void setUserType(UserType userType)
java.lang.String getPersonId()
void setPersonId(java.lang.String personId)
java.lang.String getUserId()
void setUserId(java.lang.String userId)
java.lang.String getSecureKey()
void setSecureKey(java.lang.String secureKey)
secureKey
- secure keyint getTimeZoneOffset()
void setTimeZoneOffset(int timeZoneOffset)
timeZoneOffset
- timezone offsetKeyValueCollection getUserData()
void setUserData(KeyValueCollection userData)
userData
- user databoolean isAutoRegister()
setAutoRegister(boolean)
,
RequestRegister
void setAutoRegister(boolean autoRegister)
autoRegister
- flag for automatic client registration request allowingRequestRegister
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |