User Guide

1014 Chapter 6: ColdFusion MX Event Gateway Reference
onIncomingMessage
Description
Handles incoming instant messages from other users. Optionally returns a response to the
message sender.
Syntax
onIncomingMessage(CFEvent)
See also
onAddBuddyRequest
, onAddBuddyResponse, onBuddyStatus, onIMServerMessage, “Handling
incoming messages” and “Sample IM message handling application”
in Chapter 43, “Using the
Instant Messaging Event Gateways” in ColdFusion MX Developer’s Guide
Parameters
The method must take one parameter, a CFEvent structure with the following fields:
Returns
The function can optionally return a value to send a response message. The return structure must
contain the following fields:
Example
The following example shows a simple onIncomingMessage method that echoes a message back
to the sender.
<cffunction name="onIncomingMessage">
<cfargument name="CFEvent" type="struct" required="YES">
<cfset input_mesg = CFEvent.data.MESSAGE>
Field Description
gatewayType Gateway type, either XMPP or SAMETIME.
gatewayID The ID of the Gateway instance as configured in ColdFusion MX Administrator.
originatorID The IM ID of the message originator.
cfcMethod This CFC method; by default, onIncomingMessage.
data.MESSAGE The message that was received.
data.SENDER The sender’s ID; identical to the originatorID
data.RECIPIENT The recipient’s ID, as specified in the gateway’s configuration file
data.TIMESTAMP The date and time when the message was sent
Field Description
command Normally omitted. You can also specify submit.
buddyID ID to which to send the message. Normally, the value of the input parameter’s
Data.SENDER field.
message The message contents.