Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.flexchat.requests
Class RequestJoin

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.webmedia.protocol.flexchat.requests.RequestJoin
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestJoin
extends Message

Issues a request to join a chat interaction. To connect to an existing session you have to set the correct values for SessionID and UserId.
To create a new session, SessionID should be null and you must specify values for UserId, SecureKey, Subject, and QueueKey.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestJoin create()
          Creates instance of RequestJoin with no parameters set.
static RequestJoin create(java.lang.String userId, java.lang.String secureKey, java.lang.String sessionId, java.lang.String queueKey, java.lang.String subject)
          Creates instance of RequestJoin.
static RequestJoin create(java.lang.String userId, java.lang.String secureKey, java.lang.String sessionId, java.lang.String queueKey, java.lang.String subject, java.lang.Integer fromPosition)
          Creates instance of RequestJoin.
abstract  java.lang.Integer getFromPosition()
          An integer that indicates the current position in the transcript of a chat session.
abstract  java.lang.String getQueueKey()
          This string specifies which queue to join during a RequestJoin request.
abstract  java.lang.Integer getReferenceId()
          The unique reference ID for any requests or events.
abstract  java.lang.String getSecureKey()
           
abstract  java.lang.String getSessionId()
          The unique session ID for chat sessions.
abstract  java.lang.String getSubject()
          The chat subject line that is attached to this interaction.
abstract  java.lang.String getUserId()
          The user ID uniquely identifies chat party/user across all chat sessions.
abstract  void setFromPosition(int fromPosition)
          An integer that indicates the current position in the transcript of a chat session.
abstract  void setFromPosition(java.lang.Integer fromPosition)
          An integer that indicates the current position in the transcript of a chat session.
abstract  void setQueueKey(java.lang.String queueKey)
          This string specifies which queue to join during a RequestJoin request.
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 setSecureKey(java.lang.String secureKey)
           
abstract  void setSessionId(java.lang.String sessionId)
          The unique session ID for chat sessions.
abstract  void setSubject(java.lang.String subject)
          The chat subject line that is attached to this interaction.
abstract  void setUserId(java.lang.String userId)
          The user ID uniquely identifies chat party/user across all chat sessions.
 
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

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Method Detail

create

public static RequestJoin create()
Creates instance of RequestJoin with no parameters set.

Returns:
instance of RequestJoin

create

public static RequestJoin create(java.lang.String userId,
                                 java.lang.String secureKey,
                                 java.lang.String sessionId,
                                 java.lang.String queueKey,
                                 java.lang.String subject)
Creates instance of RequestJoin.

Parameters:
userId - UserId
secureKey - SecureKey
sessionId - SessionId
queueKey - QueueKey
subject - Subject
Returns:
instance of RequestJoin

create

public static RequestJoin create(java.lang.String userId,
                                 java.lang.String secureKey,
                                 java.lang.String sessionId,
                                 java.lang.String queueKey,
                                 java.lang.String subject,
                                 java.lang.Integer fromPosition)
Creates instance of RequestJoin.

Parameters:
userId - UserId
secureKey - SecureKey
sessionId - SessionId
queueKey - QueueKey
subject - Subject
fromPosition - FromPosition
Returns:
instance of RequestJoin

getReferenceId

public abstract java.lang.Integer getReferenceId()
The unique reference ID for any requests or events.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
The unique reference ID for any requests or events.


setReferenceId

public abstract void setReferenceId(int referenceId)
The unique reference ID for any requests or events.


getUserId

public abstract java.lang.String getUserId()
The user ID uniquely identifies chat party/user across all chat sessions.


setUserId

public abstract void setUserId(java.lang.String userId)
The user ID uniquely identifies chat party/user across all chat sessions.


getSecureKey

public abstract java.lang.String getSecureKey()

setSecureKey

public abstract void setSecureKey(java.lang.String secureKey)

getSessionId

public abstract java.lang.String getSessionId()
The unique session ID for chat sessions. This property must be specified when a party joins (or is released from) an existing chat session. Leave this property empty when creating a new chat session.


setSessionId

public abstract void setSessionId(java.lang.String sessionId)
The unique session ID for chat sessions. This property must be specified when a party joins (or is released from) an existing chat session. Leave this property empty when creating a new chat session.


getQueueKey

public abstract java.lang.String getQueueKey()
This string specifies which queue to join during a RequestJoin request.


setQueueKey

public abstract void setQueueKey(java.lang.String queueKey)
This string specifies which queue to join during a RequestJoin request.


getSubject

public abstract java.lang.String getSubject()
The chat subject line that is attached to this interaction.


setSubject

public abstract void setSubject(java.lang.String subject)
The chat subject line that is attached to this interaction.


getFromPosition

public abstract java.lang.Integer getFromPosition()
An integer that indicates the current position in the transcript of a chat session. Used with refresh or logout requests.


setFromPosition

public abstract void setFromPosition(java.lang.Integer fromPosition)
An integer that indicates the current position in the transcript of a chat session. Used with refresh or logout requests.


setFromPosition

public abstract void setFromPosition(int fromPosition)
An integer that indicates the current position in the transcript of a chat session. Used with refresh or logout requests.


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.