Platform SDK Java 8.5 API Reference

com.genesyslab.platform.voice.protocol.tserver.requests.special
Class RequestSetInputMask

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

public abstract class RequestSetInputMask
extends Message

Directs T-Server to send applications only the subset of T-Server Events that are specified by an InputMask, and filter out the rest. When a client application establishes a connection with T-Server, a list of all events available from the media device is specified during the initialization procedure. Using this request narrows that list based on a configured EventMask.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestSetInputMask create()
          Creates instance of RequestSetInputMask with no parameters set.
static RequestSetInputMask create(EventMask inputMask)
          Creates instance of RequestSetInputMask with all parameters set.
abstract  EventMask getInputMask()
          An EventMask that specifies which T-Server Events are transmitted to the application.
abstract  java.lang.Integer getReferenceID()
          Reference ID of the related request.
abstract  void setInputMask(EventMask inputMask)
          An EventMask that specifies which T-Server Events are transmitted to the application.
abstract  void setReferenceID(int referenceID)
          Reference ID of the related request.
abstract  void setReferenceID(java.lang.Integer referenceID)
          Reference ID of the related request.
 
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 RequestSetInputMask create()
Creates instance of RequestSetInputMask with no parameters set.

Returns:
instance of RequestSetInputMask

create

public static RequestSetInputMask create(EventMask inputMask)
Creates instance of RequestSetInputMask with all parameters set.

Parameters:
inputMask - Specifies which T-Server events can be transmitted to the application.
Returns:
instance of RequestSetInputMask

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.


getInputMask

public abstract EventMask getInputMask()
An EventMask that specifies which T-Server Events are transmitted to the application.


setInputMask

public abstract void setInputMask(EventMask inputMask)
An EventMask that specifies which T-Server Events are transmitted to the application.


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.