Platform SDK Java 8.5 API Reference

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

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.RequestAttachUserData
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestAttachUserData
extends Message

On behalf of the telephony object specified by the parameter dn, attaches the User Data structure specified by the parameter user_data to the T-Server information that is related to the call specified by the parameter conn_id.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestAttachUserData create()
          Creates instance of RequestAttachUserData with no parameters set.
static RequestAttachUserData create(java.lang.String thisDN, ConnectionId connID)
          Deprecated. use other create methods
static RequestAttachUserData create(java.lang.String thisDN, ConnectionId connID, KeyValueCollection userData)
          Creates instance of RequestAttachUserData.
abstract  ConnectionId getConnID()
          Connection identifier of the current call handled by the DN.
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 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

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

Returns:
instance of RequestAttachUserData

create

public static RequestAttachUserData create(java.lang.String thisDN,
                                           ConnectionId connID)
Deprecated. use other create methods

Creates instance of RequestAttachUserData.

Parameters:
thisDN - DN of the controlling agent or Route Point.
connID - Connection identifier of the current call handled by the DN.
Returns:
instance of RequestAttachUserData

create

public static RequestAttachUserData create(java.lang.String thisDN,
                                           ConnectionId connID,
                                           KeyValueCollection userData)
Creates instance of RequestAttachUserData.

Parameters:
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.
Returns:
instance of RequestAttachUserData

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.


getUserData

public abstract KeyValueCollection getUserData()
Call-related user data.

Returns:
property value

setUserData

public abstract void setUserData(KeyValueCollection userData)
Call-related user data.

Parameters:
userData - 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.