|
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.voice.protocol.tserver.requests.special.RequestPrivateService
public abstract class RequestPrivateService
Passes information and request services (such as Split Call, Set Feature, change T-Server behavior, and so on) that are supported only by certain T-Servers, and which are not covered by general feature requests.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestPrivateService |
create()
Creates instance of RequestPrivateService with no parameters set. |
static RequestPrivateService |
create(java.lang.Integer privateMsgID,
java.lang.String thisDN)
Creates instance of RequestPrivateService with required parameters set. |
static RequestPrivateService |
create(java.lang.Integer privateMsgID,
java.lang.String thisDN,
ConnectionId connID,
KeyValueCollection userData,
KeyValueCollection reasons,
KeyValueCollection extensions)
Creates instance of RequestPrivateService with all parameters set. |
abstract ConnectionId |
getConnID()
Connection identifier of the current call handled by the DN. |
abstract KeyValueCollection |
getExtensions()
An additional data structure intended to take account of switch-specific features that cannot be described by other parameters or in the original structure of user data. |
abstract java.lang.Integer |
getPrivateMsgID()
Service identifier for the information being passed. |
abstract KeyValueCollection |
getReasons()
Additional data intended to specify reasons for and results of actions taken by the user. |
abstract java.lang.Integer |
getReferenceID()
Reference ID of the related request. |
abstract java.lang.String |
getThisDN()
The Directory Number (which your application registered) involved in this request or event. |
abstract KeyValueCollection |
getUserData()
Call-related user data. |
abstract void |
setConnID(ConnectionId connID)
Connection identifier of the current call handled by the DN. |
abstract void |
setExtensions(KeyValueCollection extensions)
An additional data structure intended to take account of switch-specific features that cannot be described by other parameters or in the original structure of user data. |
abstract void |
setPrivateMsgID(int privateMsgID)
Service identifier for the information being passed. |
abstract void |
setPrivateMsgID(java.lang.Integer privateMsgID)
Service identifier for the information being passed. |
abstract void |
setReasons(KeyValueCollection reasons)
Additional data intended to specify reasons for and results of actions taken by the user. |
abstract void |
setReferenceID(int referenceID)
Reference ID of the related request. |
abstract void |
setReferenceID(java.lang.Integer referenceID)
Reference ID of the related request. |
abstract void |
setThisDN(java.lang.String thisDN)
The Directory Number (which your application registered) involved in this request or event. |
abstract void |
setUserData(KeyValueCollection userData)
Call-related user data. |
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 RequestPrivateService create()
public static RequestPrivateService create(java.lang.Integer privateMsgID, java.lang.String thisDN, ConnectionId connID, KeyValueCollection userData, KeyValueCollection reasons, KeyValueCollection extensions)
privateMsgID
- Service identifier for the information being passed.thisDN
- DN of the controlling agent or Route Point.connID
- Connection identifier of the current call handled by the DN.userData
- Call-related user data.reasons
- Additional data intended to specify reasons for and results of actions taken by the user.extensions
- An additional data structure intended to take account of switch-specific features that cannot be described by other parameters or in the original structure of user data.
public static RequestPrivateService create(java.lang.Integer privateMsgID, java.lang.String thisDN)
privateMsgID
- Service identifier for the information being passed.thisDN
- DN of the controlling agent or Route Point.
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 getPrivateMsgID()
public abstract void setPrivateMsgID(java.lang.Integer privateMsgID)
privateMsgID
- new value of the propertypublic abstract void setPrivateMsgID(int privateMsgID)
privateMsgID
- new value of the propertypublic abstract java.lang.String getThisDN()
public abstract void setThisDN(java.lang.String thisDN)
public abstract ConnectionId getConnID()
public abstract void setConnID(ConnectionId connID)
public abstract KeyValueCollection getUserData()
public abstract void setUserData(KeyValueCollection userData)
userData
- new value of the propertypublic abstract KeyValueCollection getReasons()
public abstract void setReasons(KeyValueCollection reasons)
reasons
- new value of the propertypublic abstract KeyValueCollection getExtensions()
public abstract void setExtensions(KeyValueCollection extensions)
extensions
- new value of the property
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |