Platform SDK Java 8.5 API Reference

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

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

public abstract class EventSnapshotInteractions
extends Message

With this event, Interaction Server indicates:

Direction: From Interaction Server to agent application.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventSnapshotInteractions create()
          Creates instance of EventSnapshotInteractions with no parameters set.
static EventSnapshotInteractions create(java.lang.Integer snapshotId, KeyValueCollection interactions)
          Creates instance of EventSnapshotInteractions with required parameters set.
static EventSnapshotInteractions create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.Integer snapshotId, KeyValueCollection interactions)
          Creates instance of EventSnapshotInteractions with all parameters set.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  KeyValueCollection getInteractions()
          List containing interaction data.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  java.lang.Integer getSnapshotId()
          If specified, must be the identifier of a snapshot that the client has taken previously.
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setInteractions(KeyValueCollection interactions)
          List containing interaction data.
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 setSnapshotId(int snapshotId)
          If specified, must be the identifier of a snapshot that the client has taken previously.
abstract  void setSnapshotId(java.lang.Integer snapshotId)
          If specified, must be the identifier of a snapshot that the client has taken previously.
 
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 EventSnapshotInteractions create()
Creates instance of EventSnapshotInteractions with no parameters set.

Returns:
instance of EventSnapshotInteractions

create

public static EventSnapshotInteractions create(java.lang.Integer proxyClientId,
                                               KeyValueCollection extension,
                                               java.lang.Integer snapshotId,
                                               KeyValueCollection interactions)
Creates instance of EventSnapshotInteractions with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
snapshotId - If specified, should represent an identifier of the snapshot that client has taken before. The new snapshot will inherit all the locks that the older snapshot held. The identifier of the new snapshot is the same as the old snapshot. Old snapshot is automatically released.
interactions - Key-value list that contains interaction data. Each key in the list is an interaction identifier. Values are key-value lists that contain interaction properties.
Returns:
instance of EventSnapshotInteractions

create

public static EventSnapshotInteractions create(java.lang.Integer snapshotId,
                                               KeyValueCollection interactions)
Creates instance of EventSnapshotInteractions with required parameters set.

Parameters:
snapshotId - If specified, should represent an identifier of the snapshot that client has taken before. The new snapshot will inherit all the locks that the older snapshot held. The identifier of the new snapshot is the same as the old snapshot. Old snapshot is automatically released.
interactions - Key-value list that contains interaction data. Each key in the list is an interaction identifier. Values are key-value lists that contain interaction properties.
Returns:
instance of EventSnapshotInteractions

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:


getSnapshotId

public abstract java.lang.Integer getSnapshotId()
If specified, must be the identifier of a snapshot that the client has taken previously. The new snapshot inherits all the locks that the older snapshot held. The new snapshot takes on the identifier of the old snapshot, and the old snapshot is released.


setSnapshotId

public abstract void setSnapshotId(java.lang.Integer snapshotId)
If specified, must be the identifier of a snapshot that the client has taken previously. The new snapshot inherits all the locks that the older snapshot held. The new snapshot takes on the identifier of the old snapshot, and the old snapshot is released.


setSnapshotId

public abstract void setSnapshotId(int snapshotId)
If specified, must be the identifier of a snapshot that the client has taken previously. The new snapshot inherits all the locks that the older snapshot held. The new snapshot takes on the identifier of the old snapshot, and the old snapshot is released.


getInteractions

public abstract KeyValueCollection getInteractions()
List containing interaction data. Each key in the list is an interaction identifier. Values are key-value lists that contain interaction properties.


setInteractions

public abstract void setInteractions(KeyValueCollection interactions)
List containing interaction data. Each key in the list is an interaction identifier. Values are key-value lists that contain interaction properties.


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.