Platform SDK Java 8.5 API Reference

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

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

public abstract class EventMessagePing
extends Message

Uses for testing purpose.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventMessagePing create()
          Creates instance of EventMessagePing with no parameters set.
static EventMessagePing create(java.util.Date eventTime)
          Creates instance of EventMessagePing with required parameters set.
static EventMessagePing create(java.lang.Integer proxyClientId, java.util.Date eventTime, KeyValueCollection userData, KeyValueCollection pingInfo, KeyValueCollection extension)
          Creates instance of EventMessagePing with all parameters set.
abstract  java.util.Date getEventTime()
          Date and time of the event.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  KeyValueCollection getPingInfo()
          Uses for testing purpose.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  KeyValueCollection getUserData()
          Pointer to any user data that should be attached to the interaction.
abstract  void setEventTime(java.util.Date eventTime)
          Date and time of the event.
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setPingInfo(KeyValueCollection pingInfo)
          Uses for testing purpose.
abstract  void setProxyClientId(int proxyClientId)
          Proxy client identifier.
abstract  void setProxyClientId(java.lang.Integer proxyClientId)
          Proxy client identifier.
abstract  void setReferenceId(int referenceId)
          Reference identifier of the request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference identifier of the request.
abstract  void setUserData(KeyValueCollection userData)
          Pointer to any user data that should be attached to the interaction.
 
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 EventMessagePing create()
Creates instance of EventMessagePing with no parameters set.

Returns:
instance of EventMessagePing

create

public static EventMessagePing create(java.lang.Integer proxyClientId,
                                      java.util.Date eventTime,
                                      KeyValueCollection userData,
                                      KeyValueCollection pingInfo,
                                      KeyValueCollection extension)
Creates instance of EventMessagePing with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
eventTime - Date and time of the event.
userData - Any interaction related data.
pingInfo - Uses for testing purpose.
extension - Extensions.
Returns:
instance of EventMessagePing

create

public static EventMessagePing create(java.util.Date eventTime)
Creates instance of EventMessagePing with required parameters set.

Parameters:
eventTime - Date and time of the event.
Returns:
instance of EventMessagePing

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.


getEventTime

public abstract java.util.Date getEventTime()
Date and time of the event.


setEventTime

public abstract void setEventTime(java.util.Date eventTime)
Date and time of the event.


getUserData

public abstract KeyValueCollection getUserData()
Pointer to any user data that should be attached to the interaction.


setUserData

public abstract void setUserData(KeyValueCollection userData)
Pointer to any user data that should be attached to the interaction.


getPingInfo

public abstract KeyValueCollection getPingInfo()
Uses for testing purpose.

Returns:
property value

setPingInfo

public abstract void setPingInfo(KeyValueCollection pingInfo)
Uses for testing purpose.

Parameters:
pingInfo - 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.