Platform SDK Java 8.5 API Reference

com.genesyslab.platform.voice.protocol.tserver.requests.userdata
Class RequestDeletePair

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.voice.protocol.tserver.requests.userdata.RequestDeletePair
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestDeletePair
extends Message

On behalf of the telephony object specified by the parameter dn, deletes the key-value pair specified by the parameter key from the user data attached to the call specified by the parameter conn_id.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestDeletePair create()
          Creates instance of RequestDeletePair with no parameters set.
static RequestDeletePair create(java.lang.String thisDN, ConnectionId connID, java.lang.String dataKey)
          Creates instance of RequestDeletePair with all parameters set.
abstract  ConnectionId getConnID()
          Connection identifier of the current call handled by the DN.
abstract  java.lang.String getDataKey()
          The key of the pair that should be deleted from UserData.
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 setConnID(ConnectionId connID)
          Connection identifier of the current call handled by the DN.
abstract  void setDataKey(java.lang.String dataKey)
          The key of the pair that should be deleted from UserData.
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

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 RequestDeletePair create()
Creates instance of RequestDeletePair with no parameters set.

Returns:
instance of RequestDeletePair

create

public static RequestDeletePair create(java.lang.String thisDN,
                                       ConnectionId connID,
                                       java.lang.String dataKey)
Creates instance of RequestDeletePair with all parameters set.

Parameters:
thisDN - DN of the controlling agent or Route Point.
connID - Connection identifier of the current call handled by the DN.
dataKey - The key of the pair that should be deleted from UserData.
Returns:
instance of RequestDeletePair

getReferenceID

public abstract java.lang.Integer getReferenceID()
Reference ID of the related request. In event objects, this reference ID indicates to which request the event refers to.


setReferenceID

public abstract void setReferenceID(java.lang.Integer referenceID)
Reference ID of the related request. In event objects, this reference ID indicates to which request the event refers to.


setReferenceID

public abstract void setReferenceID(int referenceID)
Reference ID of the related request. In event objects, this reference ID indicates to which request the event refers to.


getThisDN

public abstract java.lang.String getThisDN()
The Directory Number (which your application registered) involved in this request or event.


setThisDN

public abstract void setThisDN(java.lang.String thisDN)
The Directory Number (which your application registered) involved in this request or event.


getConnID

public abstract ConnectionId getConnID()
Connection identifier of the current call handled by the DN.


setConnID

public abstract void setConnID(ConnectionId connID)
Connection identifier of the current call handled by the DN.


getDataKey

public abstract java.lang.String getDataKey()
The key of the pair that should be deleted from UserData.

Returns:
property value

setDataKey

public abstract void setDataKey(java.lang.String dataKey)
The key of the pair that should be deleted from UserData.

Parameters:
dataKey - new value of the property

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.