Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.requests.interactionmanagement
Class RequestConference

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

public abstract class RequestConference
extends Message

With this request, an agent asks to initiate a conference with another agent.

Direction: From client to Interaction Server


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestConference create()
          Creates instance of RequestConference with no parameters set.
static RequestConference create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String interactionId, java.lang.String agentId, java.lang.String placeId, VisibilityMode visibilityMode)
          Creates instance of RequestConference with all parameters set.
static RequestConference create(java.lang.String interactionId)
          Creates instance of RequestConference with required parameters set.
abstract  java.lang.String getAgentId()
          Agent identifier of the resource, if the Party is a resource and if the resource logged in with its agent identifier specified.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  java.lang.String getInteractionId()
          Identifier of the interaction being accepted.
abstract  java.lang.String getPlaceId()
          Place identifier of the resource, if the Party is a resource.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  VisibilityMode getVisibilityMode()
          Values: 0-unknown 1-conference 2-monitor 3-coach
abstract  void setAgentId(java.lang.String agentId)
          Agent identifier of the resource, if the Party is a resource and if the resource logged in with its agent identifier specified.
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setInteractionId(java.lang.String interactionId)
          Identifier of the interaction being accepted.
abstract  void setPlaceId(java.lang.String placeId)
          Place identifier of the resource, if the Party is a resource.
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 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 RequestConference create()
Creates instance of RequestConference with no parameters set.

Returns:
instance of RequestConference

create

public static RequestConference create(java.lang.Integer proxyClientId,
                                       KeyValueCollection extension,
                                       java.lang.String interactionId,
                                       java.lang.String agentId,
                                       java.lang.String placeId,
                                       VisibilityMode visibilityMode)
Creates instance of RequestConference with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
interactionId - Interaction identifier.
agentId - Agent identifier of the resource, if party is a resource and if resource logged in with agent identifier specified.
placeId - Place identifier of the resource, if party is a resource.
visibilityMode - The following values are possible: 1 - conference, 2 - monitor, 3 - coach. Default value is 1 - conference.
Returns:
instance of RequestConference

create

public static RequestConference create(java.lang.String interactionId)
Creates instance of RequestConference with required parameters set.

Parameters:
interactionId - Interaction identifier.
Returns:
instance of RequestConference

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:


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.


getAgentId

public abstract java.lang.String getAgentId()
Agent identifier of the resource, if the Party is a resource and if the resource logged in with its agent identifier specified.


setAgentId

public abstract void setAgentId(java.lang.String agentId)
Agent identifier of the resource, if the Party is a resource and if the resource logged in with its agent identifier specified.


getPlaceId

public abstract java.lang.String getPlaceId()
Place identifier of the resource, if the Party is a resource.


setPlaceId

public abstract void setPlaceId(java.lang.String placeId)
Place identifier of the resource, if the Party is a resource.


getVisibilityMode

public abstract VisibilityMode getVisibilityMode()
Values:


setVisibilityMode

public abstract void setVisibilityMode(VisibilityMode visibilityMode)
Values:


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.