User Guide

IM Gateway GatewayHelper class methods 1029
getPermitMode
Description
Gets the gateway’s permit mode from the IM server. The permit mode determines whether all
users can get the gateway’s online state information, or whether the server uses a permit list or a
deny list to control which users get state information.
Syntax
string = getPermitMode()
See also
addDeny
, addPermit, getDenyList, getPermitList, removeDeny, removePermit,
setPermitMode, “Using the GatewayHelper object” in Chapter 43, “Using the Instant Messaging
Event Gateways” in ColdFusion MX Developer’s Guide
Returns
The gateway’s permit mode; one of the following values:
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 PERMIT_ALL.
Example
See “GatewayHelper example”, in Chapter 43, “Using the Instant Messaging Event Gateways” in
ColdFusion MX Developer’s Guide, which uses all GatewayHelper class methods.
Mode Description
PERMIT_ALL (Default) Permits all users to be aware of the gateway’s online presence and
state.
PERMIT_SOME Permits only users in the permit list to be aware of the gateway’s online
presence and state.
DENY_SOME Prevents the users in the deny list from being aware of the gateway’s online
presence and state.