Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.requests.agentmanagement
Class RequestAddMedia

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

public abstract class RequestAddMedia
extends Message

The request is intended for agent application to indicate that new media capability has been added. The state for the newly added media is 'NOT READY'. Agent application should use RequestCancelNotReadyForMedia to make him ready to process interaction of the specified media.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestAddMedia create()
          Creates instance of RequestAddMedia with no parameters set.
static RequestAddMedia create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String mediaTypeName, ReasonInfo reason)
          Creates instance of RequestAddMedia with all parameters set.
static RequestAddMedia create(java.lang.String mediaTypeName, ReasonInfo reason)
          Creates instance of RequestAddMedia with required parameters set.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  java.lang.String getMediaTypeName()
          Media type name.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  ReasonInfo getReason()
          This property has been deprecated in all events.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setMediaTypeName(java.lang.String mediaTypeName)
          Media type name.
abstract  void setProxyClientId(int proxyClientId)
          Proxy client identifier.
abstract  void setProxyClientId(java.lang.Integer proxyClientId)
          Proxy client identifier.
abstract  void setReason(ReasonInfo reason)
          This property has been deprecated in all events.
abstract  void setReferenceId(int referenceId)
          Reference identifier of the request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference identifier of the request.
 
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 RequestAddMedia create()
Creates instance of RequestAddMedia with no parameters set.

Returns:
instance of RequestAddMedia

create

public static RequestAddMedia create(java.lang.Integer proxyClientId,
                                     KeyValueCollection extension,
                                     java.lang.String mediaTypeName,
                                     ReasonInfo reason)
Creates instance of RequestAddMedia with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
mediaTypeName - Name of the new media added.
reason - Reason.
Returns:
instance of RequestAddMedia

create

public static RequestAddMedia create(java.lang.String mediaTypeName,
                                     ReasonInfo reason)
Creates instance of RequestAddMedia with required parameters set.

Parameters:
mediaTypeName - Name of the new media added.
reason - Reason.
Returns:
instance of RequestAddMedia

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:


getMediaTypeName

public abstract java.lang.String getMediaTypeName()
Media type name.


setMediaTypeName

public abstract void setMediaTypeName(java.lang.String mediaTypeName)
Media type name.


getReason

public abstract ReasonInfo getReason()
This property has been deprecated in all events. In any messages sent to Interaction Server, this value must be left as 0 (the default value).


setReason

public abstract void setReason(ReasonInfo reason)
This property has been deprecated in all events. In any messages sent to Interaction Server, this value must be left as 0 (the default value).


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.