Platform SDK Java 8.5 API Reference

com.genesyslab.platform.voice.protocol.tserver.requests.party
Class RequestMakeCall

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

public abstract class RequestMakeCall
extends Message

Makes a regular call from the thisDN DN to the otherDN called party.

 RequestMakeCall requestMakeCall = RequestMakeCall.create(thisDn, singleTargetTextField.getText(), MakeCallType.DirectAgent);
 

If the call is successful, your application first receives the EventDialing event, and then the EventEstablished event once connected to the other DN.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestMakeCall create()
          Creates instance of RequestMakeCall with no parameters set.
static RequestMakeCall create(java.lang.String thisDN, java.lang.String otherDN, MakeCallType makeCallType)
          Creates instance of RequestMakeCall with required parameters set.
static RequestMakeCall create(java.lang.String thisDN, java.lang.String otherDN, MakeCallType makeCallType, java.lang.String location, KeyValueCollection userData, KeyValueCollection reasons, KeyValueCollection extensions)
          Creates instance of RequestMakeCall with all parameters set.
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.String getLocation()
          Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`.
abstract  MakeCallType getMakeCallType()
          Refer to the type TMakeCallType.
abstract  java.lang.String getOtherDN()
          The other main Directory Number (which your application did not register) involved in this request or event.
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 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 setLocation(java.lang.String location)
          Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`.
abstract  void setMakeCallType(MakeCallType makeCallType)
          Refer to the type TMakeCallType.
abstract  void setOtherDN(java.lang.String otherDN)
          The other main Directory Number (which your application did not register) involved in this request or event.
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

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

Returns:
instance of RequestMakeCall

create

public static RequestMakeCall create(java.lang.String thisDN,
                                     java.lang.String otherDN,
                                     MakeCallType makeCallType,
                                     java.lang.String location,
                                     KeyValueCollection userData,
                                     KeyValueCollection reasons,
                                     KeyValueCollection extensions)
Creates instance of RequestMakeCall with all parameters set.

Parameters:
thisDN - DN of the controlling agent or Route Point.
otherDN - The directory number of the second most significant telephony object (except an ACD group or trunk group) with respect to the event in question. The application does not have to be registered to this directory number to receive the event in question.
makeCallType - Refer to the type TMakeCallType.
location - Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`.
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.
Returns:
instance of RequestMakeCall

create

public static RequestMakeCall create(java.lang.String thisDN,
                                     java.lang.String otherDN,
                                     MakeCallType makeCallType)
Creates instance of RequestMakeCall with required parameters set.

Parameters:
thisDN - DN of the controlling agent or Route Point.
otherDN - The directory number of the second most significant telephony object (except an ACD group or trunk group) with respect to the event in question. The application does not have to be registered to this directory number to receive the event in question.
makeCallType - Refer to the type TMakeCallType.
Returns:
instance of RequestMakeCall

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.


getOtherDN

public abstract java.lang.String getOtherDN()
The other main Directory Number (which your application did not register) involved in this request or event. For instance, the DN of the main party of the call.


setOtherDN

public abstract void setOtherDN(java.lang.String otherDN)
The other main Directory Number (which your application did not register) involved in this request or event. For instance, the DN of the main party of the call.


getMakeCallType

public abstract MakeCallType getMakeCallType()
Refer to the type TMakeCallType.

Returns:
property value

setMakeCallType

public abstract void setMakeCallType(MakeCallType makeCallType)
Refer to the type TMakeCallType.

Parameters:
makeCallType - new value of the property

getLocation

public abstract java.lang.String getLocation()
Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`.

Returns:
property value

setLocation

public abstract void setLocation(java.lang.String location)
Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`.

Parameters:
location - new value of the property

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

getReasons

public abstract KeyValueCollection getReasons()
Additional data intended to specify reasons for and results of actions taken by the user.

Returns:
property value

setReasons

public abstract void setReasons(KeyValueCollection reasons)
Additional data intended to specify reasons for and results of actions taken by the user.

Parameters:
reasons - new value of the property

getExtensions

public 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.

Returns:
property value

setExtensions

public 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.

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