Platform SDK Java 8.5 API Reference

com.genesyslab.platform.voice.protocol.tserver.requests.dn
Class RequestMonitorNextCall

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

public abstract class RequestMonitorNextCall
extends Message

A request by a supervisor to monitor (be automatically conferenced in as a party on) the next call delivered to an agent. Supervisors can request to monitor one subsequent call or all calls until the request is explicitly canceled. If a request is successful, EventMonitoringNextCall is distributed to all clients registered on the supervisor’s and agent’s DNs. Supervisors start monitoring each call in Mute mode. To speak, they must execute the function TSetMuteOff(). Supervisors can request to monitor only one agent at a time. If they make a request to monitor another agent, the first request is automatically canceled. Only one supervisor can monitor the next call of a particular agent—if another supervisor places a request to monitor the same agent, the request is rejected. The monitoring is automatically canceled when either the supervisor or the agent logs out.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestMonitorNextCall create()
          Creates instance of RequestMonitorNextCall with no parameters set.
static RequestMonitorNextCall create(java.lang.String thisDN, java.lang.String otherDN, MonitorNextCallType monitorNextCallType)
          Creates instance of RequestMonitorNextCall with required parameters set.
static RequestMonitorNextCall create(java.lang.String thisDN, java.lang.String otherDN, MonitorNextCallType monitorNextCallType, KeyValueCollection reasons, KeyValueCollection extensions)
          Creates instance of RequestMonitorNextCall 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  MonitorNextCallType getMonitorNextCallType()
          Supervisor will monitor one call to the agent or Supervisor will monitor all subsequent calls to the agent until monitoring is canceled..
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  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 setMonitorNextCallType(MonitorNextCallType monitorNextCallType)
          Supervisor will monitor one call to the agent or Supervisor will monitor all subsequent calls to the agent until monitoring is canceled..
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.
 
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 RequestMonitorNextCall create()
Creates instance of RequestMonitorNextCall with no parameters set.

Returns:
instance of RequestMonitorNextCall

create

public static RequestMonitorNextCall create(java.lang.String thisDN,
                                            java.lang.String otherDN,
                                            MonitorNextCallType monitorNextCallType,
                                            KeyValueCollection reasons,
                                            KeyValueCollection extensions)
Creates instance of RequestMonitorNextCall 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.
monitorNextCallType - Supervisor will monitor one call to the agent or Supervisor will monitor all subsequent calls to the agent until monitoring is canceled..
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 RequestMonitorNextCall

create

public static RequestMonitorNextCall create(java.lang.String thisDN,
                                            java.lang.String otherDN,
                                            MonitorNextCallType monitorNextCallType)
Creates instance of RequestMonitorNextCall 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.
monitorNextCallType - Supervisor will monitor one call to the agent or Supervisor will monitor all subsequent calls to the agent until monitoring is canceled..
Returns:
instance of RequestMonitorNextCall

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.


getMonitorNextCallType

public abstract MonitorNextCallType getMonitorNextCallType()
Supervisor will monitor one call to the agent or Supervisor will monitor all subsequent calls to the agent until monitoring is canceled..

Returns:
property value

setMonitorNextCallType

public abstract void setMonitorNextCallType(MonitorNextCallType monitorNextCallType)
Supervisor will monitor one call to the agent or Supervisor will monitor all subsequent calls to the agent until monitoring is canceled..

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