Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestDistributeUserEvent
extends Message

Sends the application-defined data structure specified by the parameter event to T-Server, making this data available to the applications registered to receive events about the telephony object specified by the parameter dn.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestDistributeUserEvent create()
          Creates instance of RequestDistributeUserEvent with no parameters set.
static RequestDistributeUserEvent create(java.lang.String communicationDN, CommonProperties userEvent)
          Creates instance of RequestDistributeUserEvent with all parameters set.
abstract  java.lang.String getCommunicationDN()
          Directory number of the telephony object the user event relates to.
abstract  java.lang.Integer getReferenceID()
          Reference ID of the related request.
abstract  CommonProperties getUserEvent()
          The user's event.
abstract  void setCommunicationDN(java.lang.String communicationDN)
          Directory number of the telephony object the user event relates to.
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 setUserEvent(CommonProperties userEvent)
          The user's 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 RequestDistributeUserEvent create()
Creates instance of RequestDistributeUserEvent with no parameters set.

Returns:
instance of RequestDistributeUserEvent

create

public static RequestDistributeUserEvent create(java.lang.String communicationDN,
                                                CommonProperties userEvent)
Creates instance of RequestDistributeUserEvent with all parameters set.

Parameters:
communicationDN - Directory number of the telephony object the user event relates to.
userEvent - The user's event.
Returns:
instance of RequestDistributeUserEvent

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.


getCommunicationDN

public abstract java.lang.String getCommunicationDN()
Directory number of the telephony object the user event relates to.

Returns:
property value

setCommunicationDN

public abstract void setCommunicationDN(java.lang.String communicationDN)
Directory number of the telephony object the user event relates to.

Parameters:
communicationDN - new value of the property

getUserEvent

public abstract CommonProperties getUserEvent()
The user's event.

Returns:
property value

setUserEvent

public abstract void setUserEvent(CommonProperties userEvent)
The user's event.

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