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 the Developing ColdFusion Applications

Returns

The gateway's permit mode; one of the following values:

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.

Note: If the XMPP server does not support permission management, this function always returns PERMIT_ALL.

Example

See  GatewayHelper example in Using the GatewayHelper object in the Developing ColdFusion Applications, which uses all GatewayHelper class methods.

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy