Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.events
Class EventUserEvent

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

public abstract class EventUserEvent
extends Message

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

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 EventUserEvent create()
Creates instance of EventUserEvent with no parameters set.

Returns:
instance of EventUserEvent

create

public static EventUserEvent create(java.lang.String psTopic)
Creates instance of EventUserEvent.

Parameters:
psTopic - Name of the topic to publish request for.
Returns:
instance of EventUserEvent

create

public static EventUserEvent create(java.lang.Integer proxyClientId,
                                    KeyValueCollection extension,
                                    java.lang.String psTopic,
                                    KeyValueCollection psEventContent)
Creates instance of EventUserEvent.

Parameters:
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
psTopic - Name of the topic to publish request for.
psEventContent - User event content.
Returns:
instance of EventUserEvent

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:


getPsTopic

public abstract java.lang.String getPsTopic()
Name of the topic to be published.


setPsTopic

public abstract void setPsTopic(java.lang.String psTopic)
Name of the topic to be published.


getPsEventContent

public abstract KeyValueCollection getPsEventContent()
User event content.


setPsEventContent

public abstract void setPsEventContent(KeyValueCollection psEventContent)
User event content.


getActorType

public abstract ActorType getActorType()
Values:


setActorType

public abstract void setActorType(ActorType actorType)
Values:


getActorMediaServerId

public abstract java.lang.String getActorMediaServerId()
Media Server name as defined in the configuration. Present only if the Actor is a media server.


setActorMediaServerId

public abstract void setActorMediaServerId(java.lang.String actorMediaServerId)
Media Server name as defined in the configuration. Present only if the Actor is a media server.


getActorTenantId

public abstract java.lang.Integer getActorTenantId()
Tenant identifier of the strategy or resource. Present only if the Actor is a strategy or resource.


setActorTenantId

public abstract void setActorTenantId(java.lang.Integer actorTenantId)
Tenant identifier of the strategy or resource. Present only if the Actor is a strategy or resource.


setActorTenantId

public abstract void setActorTenantId(int actorTenantId)
Tenant identifier of the strategy or resource. Present only if the Actor is a strategy or resource.


getActorStrategyId

public abstract java.lang.String getActorStrategyId()
Strategy name. Present only if the Actor is a strategy.


setActorStrategyId

public abstract void setActorStrategyId(java.lang.String actorStrategyId)
Strategy name. Present only if the Actor is a strategy.


getActorRouterId

public abstract java.lang.String getActorRouterId()
Name of the URS that is executing the strategy. Present only if the Actor is a strategy.


setActorRouterId

public abstract void setActorRouterId(java.lang.String actorRouterId)
Name of the URS that is executing the strategy. Present only if the Actor is a strategy.


getActorPlaceId

public abstract java.lang.String getActorPlaceId()
Place name of the resource. Present only if the Actor is a resource.


setActorPlaceId

public abstract void setActorPlaceId(java.lang.String actorPlaceId)
Place name of the resource. Present only if the Actor is a resource.


getActorAgentId

public abstract java.lang.String getActorAgentId()
Agent employee ID of the resource. Present only if the Actor is a resource and if the resource logged in with its agent identifier (employee ID) specified.


setActorAgentId

public abstract void setActorAgentId(java.lang.String actorAgentId)
Agent employee ID of the resource. Present only if the Actor is a resource and if the resource logged in with its agent identifier (employee ID) specified.


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.