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.
Содержание COLFUSION MX 7 - INSTALLING AND USING COLDFUSION MX
Страница 1: ...COLDFUSION MX7 CFML Reference...
Страница 20: ...20 Chapter 1 Reserved Words and Variables...
Страница 50: ...50 Chapter 2 ColdFusion Tags cfelse br Searching cfif cfloop cfif...
Страница 101: ...cfdefaultcase 101 cfdefaultcase cfswitch cfoutput Your grade is grade cfoutput...
Страница 115: ...cfdocumentsection 115 cfdocumentsection cfoutput cfdocument...
Страница 311: ...cfNTauthenticate 311 Please Try again H2 cfif cfoutput cfinclude template loginform cfm cfabort cfif cfif cflogin...
Страница 411: ...cftable 411 cftable body html...
Страница 515: ...Chr 515 maxlength 5 p input type Submit name input type RESET cfform...
Страница 605: ...GetEncoding 605 WriteOutput The encoding is theEncoding cfscript cfif...
Страница 629: ...GetProfileString 629 tr td input type Submit name Submit value Submit td td td tr table form...
Страница 655: ...IIf 655 cfoutput IIf Hour Now GTE 12 DE It is afternoon or evening DE It is morning cfoutput b...
Страница 664: ...664 Chapter 3 ColdFusion Functions cfelse h3 Conversion error h3 cfif...
Страница 687: ...IsStruct 687 cfoutput cfquery cfif cfoutput hr Employee Add Complete cfoutput cfcase cfswitch...
Страница 693: ...IsWDDX 693 struct data wddxPacket hr xmp cfoutput packet xmp IsWDDX returns IsWDDX packet br cfoutput...
Страница 751: ...LSDateFormat 751 hr noshade cfoutput cfloop...
Страница 861: ...StructFind 861 cfquery cfif cfoutput hr Employee Add Complete cfoutput cfcase cfswitch...
Страница 869: ...StructIsEmpty 869 cfoutput cfquery cfif cfoutput hr Employee Add Complete cfoutput cfcase cfswitch...
Страница 903: ...Val 903 value Is the beginning numeric name form...
Страница 932: ...932 Chapter 3 ColdFusion Functions...
Страница 944: ...944 Chapter 4 ColdFusion MX Flash Form Style Reference...
Страница 962: ...962 Chapter 5 Application CFC Reference...
Страница 1008: ...1008 Chapter 6 ColdFusion MX Event Gateway Reference cfset retValue Reason reason cfreturn retValue cffunction...
Страница 1054: ...1054 Chapter 6 ColdFusion MX Event Gateway Reference...