Platform SDK Java 8.5 API Reference

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

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

public abstract class EventCustom
extends Message

Message for passing old style UR events to reporting.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventCustom create()
          Creates instance of EventCustom with no parameters set.
static EventCustom create(java.lang.Integer customMessageType, byte[] customMessageData)
          Creates instance of EventCustom with required parameters set.
static EventCustom create(java.lang.Integer proxyClientId, java.lang.Integer customMessageType, byte[] customMessageData, KeyValueCollection extension)
          Creates instance of EventCustom with all parameters set.
abstract  byte[] getCustomMessageData()
           
abstract  java.lang.Integer getCustomMessageType()
           
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  void setCustomMessageData(byte[] customMessageData)
           
abstract  void setCustomMessageType(int customMessageType)
           
abstract  void setCustomMessageType(java.lang.Integer customMessageType)
           
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.
 
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 EventCustom create()
Creates instance of EventCustom with no parameters set.

Returns:
instance of EventCustom

create

public static EventCustom create(java.lang.Integer proxyClientId,
                                 java.lang.Integer customMessageType,
                                 byte[] customMessageData,
                                 KeyValueCollection extension)
Creates instance of EventCustom with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
customMessageType -
customMessageData -
extension - Extensions.
Returns:
instance of EventCustom

create

public static EventCustom create(java.lang.Integer customMessageType,
                                 byte[] customMessageData)
Creates instance of EventCustom with required parameters set.

Parameters:
customMessageType -
customMessageData -
Returns:
instance of EventCustom

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.


getCustomMessageType

public abstract java.lang.Integer getCustomMessageType()
Returns:
property value

setCustomMessageType

public abstract void setCustomMessageType(java.lang.Integer customMessageType)
Parameters:
customMessageType - new value of the property

setCustomMessageType

public abstract void setCustomMessageType(int customMessageType)
Parameters:
customMessageType - new value of the property

getCustomMessageData

public abstract byte[] getCustomMessageData()
Returns:
property value

setCustomMessageData

public abstract void setCustomMessageData(byte[] customMessageData)
Parameters:
customMessageData - new value of the property

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:


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.