|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.openmedia.protocol.interactionserver.events.EventInvite
public abstract class EventInvite
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static 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)
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
- Interactionparties
- 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.
public static EventInvite create(java.lang.Integer ticketId, InteractionProperties interaction)
ticketId
- An invitation identifier generated by Interaction Server and provided in EventInvite.interaction
- Interaction
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.Integer getProxyClientId()
public abstract void setProxyClientId(java.lang.Integer proxyClientId)
public abstract void setProxyClientId(int proxyClientId)
public abstract java.lang.Integer getTicketId()
public abstract void setTicketId(java.lang.Integer ticketId)
public abstract void setTicketId(int ticketId)
public abstract java.util.Date getSubmittedToRouterAt()
public abstract void setSubmittedToRouterAt(java.util.Date submittedToRouterAt)
public abstract InteractionProperties getInteraction()
public abstract void setInteraction(InteractionProperties interaction)
public abstract KeyValueCollection getParties()
public abstract void setParties(KeyValueCollection parties)
public abstract KeyValueCollection getInQueues()
public abstract void setInQueues(KeyValueCollection inQueues)
public abstract KeyValueCollection getOutQueues()
public abstract void setOutQueues(KeyValueCollection outQueues)
public abstract VisibilityMode getVisibilityMode()
public abstract void setVisibilityMode(VisibilityMode visibilityMode)
public abstract KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |