Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestSendEvent
extends Message

Sends the T-Library event specified by the parameter event to T-Server. This makes the data from the event available to the clients registered to receive events about the telephony object specified by the attribute ThisDn in the event. As distinct from the function TSendEvent(), this function also allows for a client specified by the parameter client_id to receive the event in question. Warning: Improper use of this function may result in unpredictable behavior on the part of T-Server and the Genesys Framework. If you have any doubt on how to use it, please consult with Genesys.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestSendEvent create()
          Creates instance of RequestSendEvent with no parameters set.
static RequestSendEvent create(java.lang.Integer clientID)
          Creates instance of RequestSendEvent with required parameters set.
static RequestSendEvent create(java.lang.Integer clientID, CommonProperties userEvent)
          Creates instance of RequestSendEvent with all parameters set.
abstract  java.lang.Integer getClientID()
          Client identified for receipt of the data structure, including the reference ID, being sent.
abstract  java.lang.Integer getReferenceID()
          Reference ID of the related request.
abstract  CommonProperties getUserEvent()
          The user's event.
abstract  void setClientID(int clientID)
          Client identified for receipt of the data structure, including the reference ID, being sent.
abstract  void setClientID(java.lang.Integer clientID)
          Client identified for receipt of the data structure, including the reference ID, being sent.
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 RequestSendEvent create()
Creates instance of RequestSendEvent with no parameters set.

Returns:
instance of RequestSendEvent

create

public static RequestSendEvent create(java.lang.Integer clientID,
                                      CommonProperties userEvent)
Creates instance of RequestSendEvent with all parameters set.

Parameters:
clientID - Client identified for receipt of the data structure, including the reference ID, being sent.
userEvent - The user's event.
Returns:
instance of RequestSendEvent

create

public static RequestSendEvent create(java.lang.Integer clientID)
Creates instance of RequestSendEvent with required parameters set.

Parameters:
clientID - Client identified for receipt of the data structure, including the reference ID, being sent.
Returns:
instance of RequestSendEvent

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.


getClientID

public abstract java.lang.Integer getClientID()
Client identified for receipt of the data structure, including the reference ID, being sent.

Returns:
property value

setClientID

public abstract void setClientID(java.lang.Integer clientID)
Client identified for receipt of the data structure, including the reference ID, being sent.

Parameters:
clientID - new value of the property

setClientID

public abstract void setClientID(int clientID)
Client identified for receipt of the data structure, including the reference ID, being sent.

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