Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestLogout
extends Message

Issues a logout request to Interaction Server. To logout from Interaction Server, you need to set correct values for UserId, SecureKey, and FromPosition.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestLogout create()
          Creates instance of RequestLogout with no parameters set.
static RequestLogout create(java.lang.String userId, java.lang.String secureKey, java.lang.Integer fromPosition)
          Creates instance of RequestLogout with all parameters set.
abstract  java.lang.Integer getFromPosition()
          An integer that indicates the current position in the transcript of a chat session.
abstract  java.lang.Integer getReferenceId()
          The unique reference ID for any requests or events.
abstract  java.lang.String getSecureKey()
           
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 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 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 RequestLogout create()
Creates instance of RequestLogout with no parameters set.

Returns:
instance of RequestLogout

create

public static RequestLogout create(java.lang.String userId,
                                   java.lang.String secureKey,
                                   java.lang.Integer fromPosition)
Creates instance of RequestLogout with all parameters set.

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

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.


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.