|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.voice.protocol.tserver.requests.special.RequestSendEvent
public abstract class RequestSendEvent
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static RequestSendEvent create()
public static RequestSendEvent create(java.lang.Integer clientID, CommonProperties userEvent)
clientID
- Client identified for receipt of the data structure, including the reference ID, being sent.userEvent
- The user's event.
public static RequestSendEvent create(java.lang.Integer clientID)
clientID
- Client identified for receipt of the data structure, including the reference ID, being sent.
public abstract java.lang.Integer getReferenceID()
public abstract void setReferenceID(java.lang.Integer referenceID)
public abstract void setReferenceID(int referenceID)
public abstract java.lang.Integer getClientID()
public abstract void setClientID(java.lang.Integer clientID)
clientID
- new value of the propertypublic abstract void setClientID(int clientID)
clientID
- new value of the propertypublic abstract CommonProperties getUserEvent()
public abstract void setUserEvent(CommonProperties userEvent)
userEvent
- new value of the property
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |