Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol
Interface FlexChatProtocolHandshakeOptions

All Known Implementing Classes:
FlexChatProtocol

public interface FlexChatProtocolHandshakeOptions

Dedicated interface to represent Flex Chat Server protocol handshake parameters.

See Also:
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

getTimeZoneOffset

java.lang.Integer getTimeZoneOffset()
Optional, timezone offset.

Returns:
timezone offset or null

setTimeZoneOffset

void setTimeZoneOffset(java.lang.Integer timeZoneOffset)
Optional, timezone offset.

Parameters:
timeZoneOffset - timezone offset

setTimeZoneOffset

void setTimeZoneOffset(int timeZoneOffset)
Optional, timezone offset.

Parameters:
timeZoneOffset - timezone offset

getUserData

KeyValueCollection getUserData()
Optional, used for user identification in UCS (Universal Contact Server).

Returns:
user data or null

setUserData

void setUserData(KeyValueCollection userData)
Optional, used for user identification in UCS (Universal Contact Server).

Parameters:
userData - user data

getUserNickname

java.lang.String getUserNickname()
Optional, but very desirable for login during channel Open. It will be used for user display name. This field will be ignored in case of setting UserId and SecureKey.

Returns:
user nickname or null

setUserNickname

void setUserNickname(java.lang.String userNickname)
Optional, but very desirable for login during channel Open. It will be used for user display name. This field will be ignored in case of setting UserId and SecureKey.

Parameters:
userNickname - user nickname

getSecureKey

java.lang.String getSecureKey()
Optional, if set with UserId, channel will not send RequestLogin message during opening.

Returns:
secure key or null

setSecureKey

void setSecureKey(java.lang.String secureKey)
Optional, if set with UserId, channel will not send RequestLogin message during opening.

Parameters:
secureKey - secure key

getUserId

java.lang.String getUserId()
Optional, if set with SecureKey, channel will not send RequestLogin message during opening.

Returns:
user id or null

setUserId

void setUserId(java.lang.String userId)
Optional, if set with SecureKey, channel will not send RequestLogin message during opening.

Parameters:
userId - user id

isAutoRegister

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.

Returns:
flag for automatic client registration request allowing
See Also:
setAutoRegister(boolean), RequestLogin

setAutoRegister

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.

Parameters:
autoRegister - flag for automatic client registration request allowing
See Also:
RequestLogin

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.