Platform SDK Java 8.5 API Reference

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

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

public abstract class EventInvite
extends Message

This event is sent to an agent application to notify the agent that he or she has been selected to take part in processing an interaction. The event could be a result of routing, or of transfer from or conference with another agent. Direction: From Interaction Server to agent application.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventInvite create()
          Creates instance of EventInvite with no parameters set.
static EventInvite create(java.lang.Integer proxyClientId, java.lang.Integer ticketId, java.util.Date submittedToRouterAt, InteractionProperties interaction, KeyValueCollection parties, KeyValueCollection inQueues, KeyValueCollection outQueues, VisibilityMode visibilityMode, KeyValueCollection extension)
          Creates instance of EventInvite with all parameters set.
static EventInvite create(java.lang.Integer ticketId, InteractionProperties interaction)
          Creates instance of EventInvite with required parameters set.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  KeyValueCollection getInQueues()
          List of queues supplied by interaction workflow as suggested places for the agent to place the original interaction.
abstract  InteractionProperties getInteraction()
           
abstract  KeyValueCollection getOutQueues()
          List of queues supplied by interaction workflow as suggested places for the agent to place the reply interaction.
abstract  KeyValueCollection getParties()
          List of parties that are already participating in processing this interaction.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  java.util.Date getSubmittedToRouterAt()
          Date and time that the interaction was first submitted to the router.
abstract  java.lang.Integer getTicketId()
          Invitation ticket identifier (received with EventInvite).
abstract  VisibilityMode getVisibilityMode()
          Values: 0-unknown 1-conference 2-monitor 3-coach
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setInQueues(KeyValueCollection inQueues)
          List of queues supplied by interaction workflow as suggested places for the agent to place the original interaction.
abstract  void setInteraction(InteractionProperties interaction)
           
abstract  void setOutQueues(KeyValueCollection outQueues)
          List of queues supplied by interaction workflow as suggested places for the agent to place the reply interaction.
abstract  void setParties(KeyValueCollection parties)
          List of parties that are already participating in processing this interaction.
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 setSubmittedToRouterAt(java.util.Date submittedToRouterAt)
          Date and time that the interaction was first submitted to the router.
abstract  void setTicketId(int ticketId)
          Invitation ticket identifier (received with EventInvite).
abstract  void setTicketId(java.lang.Integer ticketId)
          Invitation ticket identifier (received with EventInvite).
abstract  void setVisibilityMode(VisibilityMode visibilityMode)
          Values: 0-unknown 1-conference 2-monitor 3-coach
 
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 EventInvite create()
Creates instance of EventInvite with no parameters set.

Returns:
instance of EventInvite

create

public static EventInvite create(java.lang.Integer proxyClientId,
                                 java.lang.Integer ticketId,
                                 java.util.Date submittedToRouterAt,
                                 InteractionProperties interaction,
                                 KeyValueCollection parties,
                                 KeyValueCollection inQueues,
                                 KeyValueCollection outQueues,
                                 VisibilityMode visibilityMode,
                                 KeyValueCollection extension)
Creates instance of EventInvite with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
ticketId - An invitation identifier generated by Interaction Server and provided in EventInvite.
submittedToRouterAt - Date and time, set by Interaction Server, the interaction has been submitted to router.
interaction - Interaction
parties - List of parties that are already participating in interaction processing.
inQueues - List of queue names to place the original interaction to. Suggested to agent by workflow definition.
outQueues - List of queue names to place the reply interaction to. Suggested to agent by workflow definition.
visibilityMode - The following values are possible: 1 - conference, 2 - monitor, 3 - coach. Default value is 1 - conference.
extension - Extensions.
Returns:
instance of EventInvite

create

public static EventInvite create(java.lang.Integer ticketId,
                                 InteractionProperties interaction)
Creates instance of EventInvite with required parameters set.

Parameters:
ticketId - An invitation identifier generated by Interaction Server and provided in EventInvite.
interaction - Interaction
Returns:
instance of EventInvite

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.


getTicketId

public abstract java.lang.Integer getTicketId()
Invitation ticket identifier (received with EventInvite).


setTicketId

public abstract void setTicketId(java.lang.Integer ticketId)
Invitation ticket identifier (received with EventInvite).


setTicketId

public abstract void setTicketId(int ticketId)
Invitation ticket identifier (received with EventInvite).


getSubmittedToRouterAt

public abstract java.util.Date getSubmittedToRouterAt()
Date and time that the interaction was first submitted to the router.


setSubmittedToRouterAt

public abstract void setSubmittedToRouterAt(java.util.Date submittedToRouterAt)
Date and time that the interaction was first submitted to the router.


getInteraction

public abstract InteractionProperties getInteraction()

setInteraction

public abstract void setInteraction(InteractionProperties interaction)

getParties

public abstract KeyValueCollection getParties()
List of parties that are already participating in processing this interaction.


setParties

public abstract void setParties(KeyValueCollection parties)
List of parties that are already participating in processing this interaction.


getInQueues

public abstract KeyValueCollection getInQueues()
List of queues supplied by interaction workflow as suggested places for the agent to place the original interaction.


setInQueues

public abstract void setInQueues(KeyValueCollection inQueues)
List of queues supplied by interaction workflow as suggested places for the agent to place the original interaction.


getOutQueues

public abstract KeyValueCollection getOutQueues()
List of queues supplied by interaction workflow as suggested places for the agent to place the reply interaction.


setOutQueues

public abstract void setOutQueues(KeyValueCollection outQueues)
List of queues supplied by interaction workflow as suggested places for the agent to place the reply interaction.


getVisibilityMode

public abstract VisibilityMode getVisibilityMode()
Values:


setVisibilityMode

public abstract void setVisibilityMode(VisibilityMode visibilityMode)
Values:


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.