Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.requests.interactiondelivery
Class RequestAccept

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.requests.interactiondelivery.RequestAccept
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestAccept
extends Message

With this request, an agent application indicates that the agent accepts an invitation to take part in processing an interaction.

Direction: From agent application to Interaction Server.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestAccept create()
          Creates instance of RequestAccept with no parameters set.
static RequestAccept create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.Integer ticketId, java.lang.String interactionId, java.lang.Boolean initialInFocusState)
          Creates instance of RequestAccept with all parameters set.
static RequestAccept create(java.lang.Integer ticketId, java.lang.String interactionId)
          Creates instance of RequestAccept with required parameters set.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  java.lang.Boolean getInitialInFocusState()
          Attribute specifies the initial state (In/out of focus) of the interaction right after it has been accepted or pulled by agent.
abstract  java.lang.String getInteractionId()
          Identifier of the interaction being accepted.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  java.lang.Integer getTicketId()
          Invitation ticket identifier (received with EventInvite).
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setInitialInFocusState(java.lang.Boolean initialInFocusState)
          Attribute specifies the initial state (In/out of focus) of the interaction right after it has been accepted or pulled by agent.
abstract  void setInteractionId(java.lang.String interactionId)
          Identifier of the interaction being accepted.
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 setTicketId(int ticketId)
          Invitation ticket identifier (received with EventInvite).
abstract  void setTicketId(java.lang.Integer ticketId)
          Invitation ticket identifier (received with EventInvite).
 
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 RequestAccept create()
Creates instance of RequestAccept with no parameters set.

Returns:
instance of RequestAccept

create

public static RequestAccept create(java.lang.Integer proxyClientId,
                                   KeyValueCollection extension,
                                   java.lang.Integer ticketId,
                                   java.lang.String interactionId,
                                   java.lang.Boolean initialInFocusState)
Creates instance of RequestAccept with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
ticketId - An invitation identifier generated by Interaction Server and provided in EventInvite.
interactionId - Interaction identifier.
initialInFocusState - Attribute specifies the initial state (In/out of focus) of the interaction right after it has been accepted or pulled by agent.
Returns:
instance of RequestAccept

create

public static RequestAccept create(java.lang.Integer ticketId,
                                   java.lang.String interactionId)
Creates instance of RequestAccept with required parameters set.

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

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:


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).


getInteractionId

public abstract java.lang.String getInteractionId()
Identifier of the interaction being accepted.


setInteractionId

public abstract void setInteractionId(java.lang.String interactionId)
Identifier of the interaction being accepted.


getInitialInFocusState

public abstract java.lang.Boolean getInitialInFocusState()
Attribute specifies the initial state (In/out of focus) of the interaction right after it has been accepted or pulled by agent.

Returns:
property value

setInitialInFocusState

public abstract void setInitialInFocusState(java.lang.Boolean initialInFocusState)
Attribute specifies the initial state (In/out of focus) of the interaction right after it has been accepted or pulled by agent.

Parameters:
initialInFocusState - new value of the property

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.