MACROMEDIA COLFUSION MX 7-CFML, Reference

Page: 1036 / 1108

1036 Chapter 6: ColdFusion MX Event Gateway Reference
removeBuddy
Description
Removes an ID from a group in the buddy list for the gateway and tells the IM server not to send
the gateway messages with the buddy’s online presence state.
Syntax
Boolean = removeBuddy( name , group )
See also
addBuddy
,
getBuddyInfo
,
getBuddyList
,
removeDeny
,
removePermit
, “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 removed from the group; False, otherwise.
Usage
If the user is in multiple groups in your buddy list, you remove the buddy separately from each
group. The IM server does not stop sending status updates until you remove the name from all
groups.
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 to remove from the buddy
list.
group The name of the group from which you want to remove the user. If the parameter is
the empty string, the gateway uses the General group.