The IM event gateway handles five types of messages, and your CFC must implement a listener method for each message type. The following table describes the message-handling CFC methods and the messages they handle. It lists the default CFC method names; however, you can change the names in the gateway configuration file.

CFC method

Description

onIncomingMessage

Standard message from an IM user. The application processes the message body appropriately; for example, it could display the message in an interface window. This method can return a response message to the sender.

onAddBuddyRequest

Request from another IM user to add your application's IM ID to their buddy list. The CFC must determine whether to accept or reject the request, or to take no action. An action is not always appropriate in cases where the request must be reviewed offline for approval and responses are sent at a later time.The CFC returns a message with the decision as a command value and optionally a text message specifying the reason. If you accept the request, the requestor automatically gets added to the list of IDs that can get status information for the gateway. If you specify no action, ColdFusion does not respond.

onAddBuddyResponse

Response from another IM user to a request from the gatewaybeing added to their buddy list. The response message is accept or decline. Your application can handle this response as appropriate; for example, to add or remove the ID from a list of message recipients. This method does not return a value.

onBuddyStatus

Message indicating a gateway buddy's status. Received when a buddy's status changes; for example, from OFFLINE to ONLINE. This method does not return a value.

onIMServerMessage

Status messages from the IM server, such as warning or error messages. The messages you can receive depend on the IM server that sends them. For information on the server messages, see the documentation for the IM server that your gateway instance uses. This method does not return a value.

For detailed information on each method, including examples of their use, see IM Gateway CFC incoming message methods in the CFML Reference. For an example that uses these functions, see Sample IM message handling application.

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy