Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.basicchat.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.basicchat.requests.RequestJoin
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestJoin
extends Message

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


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 sessionId, Visibility visibility, MessageText messageText)
          Creates instance of RequestJoin.
static RequestJoin create(Visibility visibility, java.lang.String queueKey, java.lang.String subject, MessageText messageText)
          Creates instance of RequestJoin.
abstract  java.lang.Integer getFromPosition()
           
abstract  MessageText getMessageText()
           
abstract  java.lang.String getQueueKey()
          This string specifies which ChatServer endpoint is chosen (with the endpoint specifying the Interaction Server queue where this chat interaction is submitted).
abstract  java.lang.Integer getReferenceId()
          The unique reference ID for any requests or events.
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  KeyValueCollection getUserData()
          Pointer to the user data attached to the interaction.
abstract  Visibility getVisibility()
          This value determines the visibility of this event for other participants of chat session.
abstract  void setFromPosition(int fromPosition)
           
abstract  void setFromPosition(java.lang.Integer fromPosition)
           
abstract  void setMessageText(MessageText messageText)
           
abstract  void setQueueKey(java.lang.String queueKey)
          This string specifies which ChatServer endpoint is chosen (with the endpoint specifying the Interaction Server queue where this chat interaction is submitted).
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 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 setUserData(KeyValueCollection userData)
          Pointer to the user data attached to the interaction.
abstract  void setVisibility(Visibility visibility)
          This value determines the visibility of this event for other participants of chat session.
 
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 sessionId,
                                 Visibility visibility,
                                 MessageText messageText)
Creates instance of RequestJoin.

Parameters:
sessionId - SessionId
visibility - Visibility
messageText - MessageText
Returns:
instance of RequestJoin

create

public static RequestJoin create(Visibility visibility,
                                 java.lang.String queueKey,
                                 java.lang.String subject,
                                 MessageText messageText)
Creates instance of RequestJoin.

Parameters:
visibility - Visibility
queueKey - QueueKey
subject - Subject
messageText - MessageText
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.


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.


getVisibility

public abstract Visibility getVisibility()
This value determines the visibility of this event for other participants of chat session. Accepted values are: All (visible for all participants), Int (visible only for agents and supervisors), Vip (visible only for supervisors).


setVisibility

public abstract void setVisibility(Visibility visibility)
This value determines the visibility of this event for other participants of chat session. Accepted values are: All (visible for all participants), Int (visible only for agents and supervisors), Vip (visible only for supervisors).


getQueueKey

public abstract java.lang.String getQueueKey()
This string specifies which ChatServer endpoint is chosen (with the endpoint specifying the Interaction Server queue where this chat interaction is submitted).


setQueueKey

public abstract void setQueueKey(java.lang.String queueKey)
This string specifies which ChatServer endpoint is chosen (with the endpoint specifying the Interaction Server queue where this chat interaction is submitted).


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.


getMessageText

public abstract MessageText getMessageText()

setMessageText

public abstract void setMessageText(MessageText messageText)

getUserData

public abstract KeyValueCollection getUserData()
Pointer to the user data attached to the interaction.


setUserData

public abstract void setUserData(KeyValueCollection userData)
Pointer to the user data attached to the interaction.


getFromPosition

public abstract java.lang.Integer getFromPosition()

setFromPosition

public abstract void setFromPosition(java.lang.Integer fromPosition)

setFromPosition

public abstract void setFromPosition(int fromPosition)

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.