Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.basicchat.requests
Class RequestReleaseParty

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

public abstract class RequestReleaseParty
extends Message

Issues a request to release one party from the chat session. To create a RequestReleaseParty request, you need to set correct values for AfterAction, SessionID, and UserId.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestReleaseParty create()
          Creates instance of RequestReleaseParty with no parameters set.
static RequestReleaseParty create(java.lang.String sessionId)
          Creates instance of RequestReleaseParty with required parameters set.
static RequestReleaseParty create(java.lang.String sessionId, java.lang.String userId, Action afterAction, MessageText messageText)
          Creates instance of RequestReleaseParty with all parameters set.
abstract  Action getAfterAction()
          Specifies the action to take after a RequestReleaseParty request.
abstract  MessageText getMessageText()
           
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 getUserId()
          The user ID uniquely identifies chat party/user across all chat sessions.
abstract  void setAfterAction(Action afterAction)
          Specifies the action to take after a RequestReleaseParty request.
abstract  void setMessageText(MessageText messageText)
           
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 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 RequestReleaseParty create()
Creates instance of RequestReleaseParty with no parameters set.

Returns:
instance of RequestReleaseParty

create

public static RequestReleaseParty create(java.lang.String sessionId,
                                         java.lang.String userId,
                                         Action afterAction,
                                         MessageText messageText)
Creates instance of RequestReleaseParty with all parameters set.

Parameters:
sessionId - SessionId
userId - UserId
afterAction - AfterAction
messageText - MessageText
Returns:
instance of RequestReleaseParty

create

public static RequestReleaseParty create(java.lang.String sessionId)
Creates instance of RequestReleaseParty with required parameters set.

Parameters:
sessionId - SessionId
Returns:
instance of RequestReleaseParty

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.


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.


getAfterAction

public abstract Action getAfterAction()
Specifies the action to take after a RequestReleaseParty request. Accepted values are: KeepAlive, CloseIfNoAgents, and ForceClose.


setAfterAction

public abstract void setAfterAction(Action afterAction)
Specifies the action to take after a RequestReleaseParty request. Accepted values are: KeepAlive, CloseIfNoAgents, and ForceClose.


getMessageText

public abstract MessageText getMessageText()

setMessageText

public abstract void setMessageText(MessageText messageText)

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.