|
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.events.EventUserEvent
public abstract class EventUserEvent
The event is distributed to all client subscribed to user events regarding the specific topic.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static EventUserEvent |
create()
Creates instance of EventUserEvent with no parameters set. |
static EventUserEvent |
create(java.lang.Integer proxyClientId,
KeyValueCollection extension,
java.lang.String psTopic,
KeyValueCollection psEventContent)
Creates instance of EventUserEvent. |
static EventUserEvent |
create(java.lang.String psTopic)
Creates instance of EventUserEvent. |
abstract java.lang.String |
getActorAgentId()
Agent employee ID of the resource. |
abstract java.lang.String |
getActorMediaServerId()
Media Server name as defined in the configuration. |
abstract java.lang.String |
getActorPlaceId()
Place name of the resource. |
abstract java.lang.String |
getActorRouterId()
Name of the URS that is executing the strategy. |
abstract java.lang.String |
getActorStrategyId()
Strategy name. |
abstract java.lang.Integer |
getActorTenantId()
Tenant identifier of the strategy or resource. |
abstract ActorType |
getActorType()
Values: 1: Actor is a strategy. 2: Actor is a resource. 3: Actor is a media server. |
abstract KeyValueCollection |
getExtension()
A key-value list of extensions. |
abstract java.lang.Integer |
getProxyClientId()
Proxy client identifier. |
abstract KeyValueCollection |
getPsEventContent()
User event content. |
abstract java.lang.String |
getPsTopic()
Name of the topic to be published. |
abstract java.lang.Integer |
getReferenceId()
Reference identifier of the request. |
abstract void |
setActorAgentId(java.lang.String actorAgentId)
Agent employee ID of the resource. |
abstract void |
setActorMediaServerId(java.lang.String actorMediaServerId)
Media Server name as defined in the configuration. |
abstract void |
setActorPlaceId(java.lang.String actorPlaceId)
Place name of the resource. |
abstract void |
setActorRouterId(java.lang.String actorRouterId)
Name of the URS that is executing the strategy. |
abstract void |
setActorStrategyId(java.lang.String actorStrategyId)
Strategy name. |
abstract void |
setActorTenantId(int actorTenantId)
Tenant identifier of the strategy or resource. |
abstract void |
setActorTenantId(java.lang.Integer actorTenantId)
Tenant identifier of the strategy or resource. |
abstract void |
setActorType(ActorType actorType)
Values: 1: Actor is a strategy. 2: Actor is a resource. 3: Actor is a media server. |
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 |
setPsEventContent(KeyValueCollection psEventContent)
User event content. |
abstract void |
setPsTopic(java.lang.String psTopic)
Name of the topic to be published. |
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 EventUserEvent create()
public static EventUserEvent create(java.lang.String psTopic)
psTopic
- Name of the topic to publish request for.
public static EventUserEvent create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String psTopic, KeyValueCollection psEventContent)
proxyClientId
- The identifier of the client of proxy.extension
- Extensions.psTopic
- Name of the topic to publish request for.psEventContent
- User event content.
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 java.lang.String getPsTopic()
public abstract void setPsTopic(java.lang.String psTopic)
public abstract KeyValueCollection getPsEventContent()
public abstract void setPsEventContent(KeyValueCollection psEventContent)
public abstract ActorType getActorType()
public abstract void setActorType(ActorType actorType)
public abstract java.lang.String getActorMediaServerId()
public abstract void setActorMediaServerId(java.lang.String actorMediaServerId)
public abstract java.lang.Integer getActorTenantId()
public abstract void setActorTenantId(java.lang.Integer actorTenantId)
public abstract void setActorTenantId(int actorTenantId)
public abstract java.lang.String getActorStrategyId()
public abstract void setActorStrategyId(java.lang.String actorStrategyId)
public abstract java.lang.String getActorRouterId()
public abstract void setActorRouterId(java.lang.String actorRouterId)
public abstract java.lang.String getActorPlaceId()
public abstract void setActorPlaceId(java.lang.String actorPlaceId)
public abstract java.lang.String getActorAgentId()
public abstract void setActorAgentId(java.lang.String actorAgentId)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |