|
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.requests.agentmanagement.RequestAddMedia
public abstract class RequestAddMedia
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static RequestAddMedia create()
public static RequestAddMedia create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String mediaTypeName, ReasonInfo reason)
proxyClientId
- The identifier of the client of proxy.extension
- Extensions.mediaTypeName
- Name of the new media added.reason
- Reason.
public static RequestAddMedia create(java.lang.String mediaTypeName, ReasonInfo reason)
mediaTypeName
- Name of the new media added.reason
- Reason.
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 KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
public abstract java.lang.String getMediaTypeName()
public abstract void setMediaTypeName(java.lang.String mediaTypeName)
public abstract ReasonInfo getReason()
public abstract void setReason(ReasonInfo reason)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |