|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.openmedia.protocol.interactionserver.requests.agentmanagement.RequestSubscribe
public abstract class RequestSubscribe
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static RequestSubscribe create()
public static RequestSubscribe create(java.lang.Integer proxyClientId, KeyValueCollection extension, KeyValueCollection psTopicList)
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.
public static RequestSubscribe create(KeyValueCollection psTopicList)
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.
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.Integer getProxyClientId()
public abstract void setProxyClientId(java.lang.Integer proxyClientId)
public abstract void setProxyClientId(int proxyClientId)
public abstract KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
public abstract KeyValueCollection getPsTopicList()
public abstract void setPsTopicList(KeyValueCollection psTopicList)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |