Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.requests.agentmanagement
Class RequestSubscribe

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.openmedia.protocol.interactionserver.requests.agentmanagement.RequestSubscribe
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestSubscribe
extends Message

With this request, any client (except a proxy) can subscribe to receive user events regarding specified topic(s). See also RequestPublish and RequestUnsubscribe.

Direction: From client application to Interaction Server.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestSubscribe create()
          Creates instance of RequestSubscribe with no parameters set.
static RequestSubscribe create(java.lang.Integer proxyClientId, KeyValueCollection extension, KeyValueCollection psTopicList)
          Creates instance of RequestSubscribe with all parameters set.
static RequestSubscribe create(KeyValueCollection psTopicList)
          Creates instance of RequestSubscribe with required parameters set.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  KeyValueCollection getPsTopicList()
          List of topics.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setProxyClientId(int proxyClientId)
          Proxy client identifier.
abstract  void setProxyClientId(java.lang.Integer proxyClientId)
          Proxy client identifier.
abstract  void setPsTopicList(KeyValueCollection psTopicList)
          List of topics.
abstract  void setReferenceId(int referenceId)
          Reference identifier of the request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference identifier of the request.
 
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 RequestSubscribe create()
Creates instance of RequestSubscribe with no parameters set.

Returns:
instance of RequestSubscribe

create

public static RequestSubscribe create(java.lang.Integer proxyClientId,
                                      KeyValueCollection extension,
                                      KeyValueCollection psTopicList)
Creates instance of RequestSubscribe with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
psTopicList - List of topics. Each key in the list represent client's defined topic name. If later other client publishes the event regarding the specified topic, all the subscribed clients will receive the copy of the event.
Returns:
instance of RequestSubscribe

create

public static RequestSubscribe create(KeyValueCollection psTopicList)
Creates instance of RequestSubscribe with required parameters set.

Parameters:
psTopicList - List of topics. Each key in the list represent client's defined topic name. If later other client publishes the event regarding the specified topic, all the subscribed clients will receive the copy of the event.
Returns:
instance of RequestSubscribe

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(int referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


getProxyClientId

public abstract java.lang.Integer getProxyClientId()
Proxy client identifier. Mandatory if client connects via proxy.


setProxyClientId

public abstract void setProxyClientId(java.lang.Integer proxyClientId)
Proxy client identifier. Mandatory if client connects via proxy.


setProxyClientId

public abstract void setProxyClientId(int proxyClientId)
Proxy client identifier. Mandatory if client connects via proxy.


getExtension

public abstract KeyValueCollection getExtension()
A key-value list of extensions. For media servers the following extensions are defined, with values of type integer:


setExtension

public abstract void setExtension(KeyValueCollection extension)
A key-value list of extensions. For media servers the following extensions are defined, with values of type integer:


getPsTopicList

public abstract KeyValueCollection getPsTopicList()
List of topics. Each key in the list represents a topic as defined by the client. If later some other client publishes an event regarding the specified topic, all subscribed clients will receive the event.


setPsTopicList

public abstract void setPsTopicList(KeyValueCollection psTopicList)
List of topics. Each key in the list represents a topic as defined by the client. If later some other client publishes an event regarding the specified topic, all subscribed clients will receive the event.


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.