User Guide

1018 Chapter 6: ColdFusion MX Event Gateway Reference
addBuddy
Description
Adds a buddy to the buddy list for the gateway user ID and asks to have the IM server send
messages with the buddy’s online presence state to the gateway.
Syntax
Boolean = addBuddy(name, nickname, group)
See also
getBuddyInfo
, getBuddyList, removeBuddy, “Using the GatewayHelper object” in Chapter 43,
“Using the Instant Messaging Event Gateways” in ColdFusion MX Developer’s Guide
Parameters
Returns
True if the ID was added to the gateway’s buddy list; False, otherwise.
Usage
This method adds the buddy to the buddy list for the gateway’s ID and sends a subscription
request (to automatically get presence information about the buddy’s online status) to the remote
buddy. It does not wait for a response from the buddy, so it returns True (and the gateway adds
the buddy to the list) even if the buddy denies the subscription request. Use the listener CFC
onAddBuddyResponse method to monitor the buddy’s response. If the CFEvent.data.MESSAGE
field value is decline, the listener method can call the gatewayHelper object
removeBuddy method
to remove the buddy from the buddy list.
Example
See “GatewayHelper example”, in Chapter 43, “Using the Instant Messaging Event Gateways” in
ColdFusion MX Developer’s Guide, which uses all GatewayHelper class methods.
Parameter Description
name The unique instant messaging user name for the person about whom you want to
receive periodic status messages.
nickname The nickname that the application can use to refer to the user.
group The name of the group you wish to add the user to in your Buddy List. If the group
specified does not exist, it will be created. If the group parameter is the empty string,
the gateway uses the General group.