Adobe ColdFusion 8

addDeny

Description

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

Syntax

Boolean = addDeny(name, nickname, group)

See also

addPermit, 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 that 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 deny 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.