|
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.dn.RequestUnregisterAddress
public abstract class RequestUnregisterAddress
Unregisters for a DN.
If the request is successful, your application receives the event EventUnregistered
.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestUnregisterAddress |
create()
Creates instance of RequestUnregisterAddress with no parameters set. |
static RequestUnregisterAddress |
create(java.lang.String thisDN,
ControlMode controlMode)
Creates instance of RequestUnregisterAddress with required parameters set. |
static RequestUnregisterAddress |
create(java.lang.String thisDN,
ControlMode controlMode,
KeyValueCollection extensions)
Creates instance of RequestUnregisterAddress with all parameters set. |
abstract ControlMode |
getControlMode()
Control mode specifying whether the fact of registration is to be relayed to the switch. |
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 |
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 void |
setControlMode(ControlMode controlMode)
Control mode specifying whether the fact of registration is to be relayed to the switch. |
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 |
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. |
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 RequestUnregisterAddress create()
public static RequestUnregisterAddress create(java.lang.String thisDN, ControlMode controlMode, KeyValueCollection extensions)
thisDN
- DN of the controlling agent or Route Point.controlMode
- Control mode specifying whether the fact of registration is to be relayed to the switch.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 RequestUnregisterAddress create(java.lang.String thisDN, ControlMode controlMode)
thisDN
- DN of the controlling agent or Route Point.controlMode
- Control mode specifying whether the fact of registration is to be relayed to the switch.
public abstract java.lang.Integer getReferenceID()
public abstract void setReferenceID(java.lang.Integer referenceID)
public abstract void setReferenceID(int referenceID)
public abstract java.lang.String getThisDN()
public abstract void setThisDN(java.lang.String thisDN)
public abstract ControlMode getControlMode()
public abstract void setControlMode(ControlMode controlMode)
controlMode
- 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 |