MACROMEDIA COLFUSION MX 7 - INSTALLING AND USING COLDFUSION MX, Reference

Page: 1011 / 1108

IM Gateway CFC incoming message methods 1011
onBuddyStatus
Description
Handles incoming messages indicating online status (presence) changes of users on the gateway’s
buddy list.
Syntax
onBuddyStatus(CFEvent)
See also
onIncomingMessage
,
onAddBuddyRequest
,
onAddBuddyResponse
,
onIMServerMessage
Parameters
The method must take one parameter, a CFEvent structure with the following fields:
Note: You configure the buddy’s nickname and group when you use the gatewayHelper object
addBuddy
method to add a buddy.
Returns
The function does not return a value.
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 (buddy name) of the message originator.
cfcMethod This CFC method; by default, onIMServerMessage.
data.BUDDYNAME The sender’s buddy name, or ID; identical to the originatorID.
data.BUDDYNICK
NAME
The buddy’s display name or nickname.
data.BUDDYSTATUS The buddy’s status; one of the following:
•
ONLINE
•
OFFLINE
•
AWAY
•
DO NOT DISTURB
XMPP only
•
NOT AVAILABLE
•
FREE TO CHAT
Sametime only
•
IDLE
Use the IMGatewayHelper getCustomAwayMessage method to get any
custom message that the buddy sent when changing status.
data.BUDDYGROUP The group that the buddy belongs to.
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.