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

addPermit

Last update:
May 18, 2026

Description

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

Syntax

Boolean = addPermit(name, nickname, group)

See also

Parameters

ParameterDescription
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 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 permit list; false, otherwise.
If the XMPP server does not support permission management, this function always returns False.

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