CFEvent class
coldfusion.gateway.CFEvent
The Gateway class sends and receives CFEvent instances to communicate with the ColdFusion listener CFC or application. The CFEvent instances correspond to CFML CFEvent structures that ColdFusion application listener CFC methods receive and contain the message structures that ColdFusion application code sends to the gateway.
- The Gateway notifies ColdFusion of a message by sending a CFEvent instance in GatewayServices.addEvent method.
- The Gateway receives a CFEvent instance when ColdFusion calls the gateway's outgoingMessage method.
The CFEvent Class extends the java.util.Hashtable class and has the following methods:
|
Methods |
Description |
|---|---|
| CFEvent(String gatewayID) |
CFEvent constructor. |
| String <ct code_in_table>getGatewayID() |
Returns the gateway ID (set in the CFEvent constructor). |
| void <ct code_in_table>setCFCMethod(String method) String <ct code_in_table>getCFCMethod() |
Sets or gets the name of the CFC method that receives an incoming message. |
| void <ct code_in_table>setCFCPath(String path) String <ct code_in_table>getCFCPath() |
Sets or gets the path to the application listener CFC that processes the event. |
| void <ct code_in_table>setCFCTimeout(Strin g seconds) String <ct code_in_table>getCFCTimeout() |
Sets or gets the time-out, in seconds, for the listener CFC to process the event request. |
| void setData(Map data) Map getData() |
Sets or gets the event data structure, which contains the message contents and any other gateway-specific information. |
| void <ct code_in_table>setGatewayType(Stri ng type) String <ct code_in_table>getGatewayType() |
Sets or gets the event gateway type identifier, such as SMS. |
| void <ct code_in_table>setOriginatorID(Str ing id) String <ct code_in_table>getOriginatorID() |
Sets or gets the gateway- or protocol-specific Identity of the originator of a message. |