Platform SDK Java 8.5 API Reference

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

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.RequestRefresh
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestRefresh
extends Message

Issues a request to refresh the current flexchat session. To refresh an existing session, you need to specify correct values for UserId, SecureKey, and FromPosition.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestRefresh create()
          Creates instance of RequestRefresh with no parameters set.
static RequestRefresh create(java.lang.String userId, java.lang.String secureKey, java.lang.Integer fromPosition)
          Creates instance of RequestRefresh.
static RequestRefresh create(java.lang.String userId, java.lang.String secureKey, java.lang.Integer fromPosition, MessageText messageText)
          Creates instance of RequestRefresh.
static RequestRefresh create(java.lang.String userId, java.lang.String secureKey, java.lang.Integer fromPosition, MessageText messageText, java.lang.String sessionId)
          Creates instance of RequestRefresh.
static RequestRefresh create(java.lang.String userId, java.lang.String secureKey, java.lang.Integer fromPosition, NoticeText noticeText)
          Creates instance of RequestRefresh.
static RequestRefresh create(java.lang.String userId, java.lang.String secureKey, java.lang.Integer fromPosition, NoticeText noticeText, KeyValueCollection userData)
          Creates instance of RequestRefresh.
static RequestRefresh create(java.lang.String userId, java.lang.String secureKey, java.lang.Integer fromPosition, NoticeText noticeText, KeyValueCollection userData, java.lang.String sessionId)
          Creates instance of RequestRefresh.
static RequestRefresh create(java.lang.String userId, java.lang.String secureKey, java.lang.Integer fromPosition, NoticeText noticeText, MessageText messageText)
          Creates instance of RequestRefresh.
While the Refresh method allow to add both Notice and Message - chat server will process only Notice and the Message will be skipped when both are specified.
abstract  java.lang.Integer getFromPosition()
          An integer that indicates the current position in the transcript of a chat session.
abstract  MessageText getMessageText()
           
abstract  NoticeText getNoticeText()
           
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  KeyValueCollection getUserData()
          Pointer to the user data that should be attached to the 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 setMessageText(MessageText messageText)
           
abstract  void setNoticeText(NoticeText noticeText)
           
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 setUserData(KeyValueCollection userData)
          Pointer to the user data that should be attached to the 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 RequestRefresh create()
Creates instance of RequestRefresh with no parameters set.

Returns:
instance of RequestRefresh

create

public static RequestRefresh create(java.lang.String userId,
                                    java.lang.String secureKey,
                                    java.lang.Integer fromPosition,
                                    NoticeText noticeText,
                                    MessageText messageText)
Creates instance of RequestRefresh.
While the Refresh method allow to add both Notice and Message - chat server will process only Notice and the Message will be skipped when both are specified. So Refresh request will be considered:

Parameters:
userId - UserId
secureKey - SecureKey
fromPosition - FromPosition
noticeText - NoticeText
messageText - MessageText
Returns:
instance of RequestRefresh

create

public static RequestRefresh create(java.lang.String userId,
                                    java.lang.String secureKey,
                                    java.lang.Integer fromPosition)
Creates instance of RequestRefresh.

Parameters:
userId - UserId
secureKey - SecureKey
fromPosition - FromPosition
Returns:
instance of RequestRefresh

create

public static RequestRefresh create(java.lang.String userId,
                                    java.lang.String secureKey,
                                    java.lang.Integer fromPosition,
                                    MessageText messageText)
Creates instance of RequestRefresh.

Parameters:
userId - UserId
secureKey - SecureKey
fromPosition - FromPosition
messageText - MessageText
Returns:
instance of RequestRefresh

create

public static RequestRefresh create(java.lang.String userId,
                                    java.lang.String secureKey,
                                    java.lang.Integer fromPosition,
                                    NoticeText noticeText)
Creates instance of RequestRefresh.

Parameters:
userId - UserId
secureKey - SecureKey
fromPosition - FromPosition
noticeText - NoticeText
Returns:
instance of RequestRefresh

create

public static RequestRefresh create(java.lang.String userId,
                                    java.lang.String secureKey,
                                    java.lang.Integer fromPosition,
                                    NoticeText noticeText,
                                    KeyValueCollection userData)
Creates instance of RequestRefresh.

Parameters:
userId - UserId
secureKey - SecureKey
fromPosition - FromPosition
noticeText - NoticeText
userData - UserData
Returns:
instance of RequestRefresh

create

public static RequestRefresh create(java.lang.String userId,
                                    java.lang.String secureKey,
                                    java.lang.Integer fromPosition,
                                    NoticeText noticeText,
                                    KeyValueCollection userData,
                                    java.lang.String sessionId)
Creates instance of RequestRefresh.

Parameters:
userId - UserId
secureKey - SecureKey
fromPosition - FromPosition
noticeText - NoticeText
userData - UserData
sessionId - SessionId
Returns:
instance of RequestRefresh

create

public static RequestRefresh create(java.lang.String userId,
                                    java.lang.String secureKey,
                                    java.lang.Integer fromPosition,
                                    MessageText messageText,
                                    java.lang.String sessionId)
Creates instance of RequestRefresh.

Parameters:
userId - UserId
secureKey - SecureKey
fromPosition - FromPosition
messageText - MessageText
sessionId - SessionId
Returns:
instance of RequestRefresh

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)

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.


getNoticeText

public abstract NoticeText getNoticeText()

setNoticeText

public abstract void setNoticeText(NoticeText noticeText)

getMessageText

public abstract MessageText getMessageText()

setMessageText

public abstract void setMessageText(MessageText messageText)

getUserData

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


setUserData

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


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.


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.