Gateway permission management methods

The IM gateways can manage the information that other users can get about the gateway’s online status.

Note: XMPP permission management is included in the XMPP 1.0 specification, but several XMPP servers that were available at the time of the ColdFusion MX 7 release do not support permission management.

The following table describes the gateway permission management methods:

Method

Description

addDeny

Tells the IM server to add the specified user to the gateway’s deny list. If the permitMode is DENY_SOME, these users cannot receive messages on the gateway’s state.

addPermit

Tells the IM server to add the specified user to the server’s permit list. If the permitMode is PERMIT_SOME, these users receive messages on the gateway’s state.

getDenyList

Returns the list of users that the server has been told not to send state information to.

getPermitList

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

getPermitMode

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.

removeDeny

Removes the user from the gateway’s deny list.

removePermit

Removes the user from the gateway’s permit list.

setPermitMode

Sets the gateway’s permit mode on the IM server.