getPermitList

Description

Returns the list of users that the IM server has been told to send state information about the gateway.

Syntax

array = getPermitList()

See also

addDeny, addPermit, getDenyList, getPermitMode, removeDeny, removePermit, setPermitMode, Using the GatewayHelper object in Using the Instant Messaging Event Gateways of ColdFusion MX Developer’s Guide

Returns

An array of IDs (buddy names) of the users on the gateway’s permit list, the list of IDs to which the IM server sends presence status information if the permit mode is set to PERMIT_SOME.

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 MX 7 release do not support permission management. If the server does not support permission management, this function always returns False.

Example

See GatewayHelper example, in Using the Instant Messaging Event Gateways in ColdFusion MX Developer’s Guide, which uses all GatewayHelper class methods.