Adobe ColdFusion 8

removePermit

Description

Removes an ID from a group in the permit list for the gateway. If the gateway's permit mode is PERMIT_SOME, the specified user cannot receive messages on the gateway's presence state.

Syntax

Boolean = removePermit(name, group)

See also

addDeny, addPermit, getDenyList, getPermitList, getPermitMode, removeBuddy, removeDeny, setPermitMode, "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 permit 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.

Note: XMPP permission management is included in the XMPP 1.0 draft specification, but several XMPP servers that were available at the time of the ColdFusion 8 release do not support permission management. If the server does not support permission management, this function always returns False.

Usage

If the user is in multiple groups in your permit list, you remove the user separately from each group. However, the IM server stops sending status updates when you remove the user from the first group.

Example

See "GatewayHelper example", in the ColdFusion Developer's Guide, which uses all GatewayHelper class methods.