Adobe ColdFusion 8

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 the ColdFusion Developer's Guide

Parameters

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.

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 the ColdFusion Developer's Guide, which uses all GatewayHelper class methods.