Whatever message this page gives is out now! Go check it out!

setPermitMode

Last update:
May 18, 2026

Description

Sets the gateway's permit mode on 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

Boolean = setPermitMode(permitMode)

See also

Parameters

ParameterDescription
permitMode
The permission mode, one of the following:
  • PERMIT_ALL-Permits all users to be aware of the gateway's online presence and state. This is the default mode if you do not call this function.
  • PERMIT_SOME-Permits only users in the permit list to be aware of the gateway's online presence and state.
  • DENY_SOME-Prevents all users in the deny list from being aware of the gateway's online presence and state.

Returns

True if the permit mode was set; False otherwise.
Note: If the XMPP server does not support permission management, this function returns False to all values except PERMIT_ALL.

Example

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

Share this page

Was this page helpful?
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Thank you for your feedback. Your response will help improve this page.

On this page