Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol
Interface BasicChatProtocolHandshakeOptions

All Known Implementing Classes:
BasicChatProtocol

public interface BasicChatProtocolHandshakeOptions

Dedicated interface to represent Basic Chat Server protocol handshake parameters.

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

getUserNickname

java.lang.String getUserNickname()

setUserNickname

void setUserNickname(java.lang.String userNickname)

getUserType

UserType getUserType()

setUserType

void setUserType(UserType userType)

getPersonId

java.lang.String getPersonId()

setPersonId

void setPersonId(java.lang.String personId)

getUserId

java.lang.String getUserId()

setUserId

void setUserId(java.lang.String userId)

getSecureKey

java.lang.String getSecureKey()
Optional, if set with UserId, channel will use it to restore previously registered session.

Returns:
secure key or null

setSecureKey

void setSecureKey(java.lang.String secureKey)
Optional, if set with UserId, channel will use it to restore previously registered session.

Parameters:
secureKey - secure key

getTimeZoneOffset

int getTimeZoneOffset()
Optional, timezone offset.

Returns:
timezone offset or null

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

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), RequestRegister

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:
RequestRegister

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.