Adobe ColdFusion 8

addPermit

Description

Tells the IM server to add the specified user to the permit list for the gateway's user ID. If the gateway's permit mode is PERMIT_SOME, the specified user receive messages on the gateway's presence state.

Syntax

Boolean = addPermit(name, nickname, group)

See also

addDeny, getDenyList, getPermitList, getPermitMode, removeDeny, removePermit, setPermitMode, "Using the GatewayHelper object" in the ColdFusion Developer's Guide

Parameters

Parameter

Description
name

The unique instant messaging user name for the person about whom you want to deny access to status messages.
nickname

The nickname that the application can use to refer to the user. Can be the empty string.
group

The name of the group you want to add the user to in your Buddy List. If the group specified does not exist, it is created. If the group parameter is the empty string, the gateway uses the General group.

Returns

True if the ID was added to the permit list; 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.

Example

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