|
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.interactionmanagement.RequestConference
public abstract class RequestConference
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static 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)
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.
public static RequestConference create(java.lang.String interactionId)
interactionId
- Interaction identifier.
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 getInteractionId()
public abstract void setInteractionId(java.lang.String interactionId)
public abstract java.lang.String getAgentId()
public abstract void setAgentId(java.lang.String agentId)
public abstract java.lang.String getPlaceId()
public abstract void setPlaceId(java.lang.String placeId)
public abstract VisibilityMode getVisibilityMode()
public abstract void setVisibilityMode(VisibilityMode visibilityMode)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |