setStatus

Description

Sets the online presence status of the gateway, including any custom away message.

Syntax

Boolean = setStatus(status, customAwayMsg)

See also

getCustomAwayMessage, getStatusAsString, getStatusTimeStamp, isOnline, Using the GatewayHelper object in the Developing ColdFusion Applications

Parameters

Parameter

Description

status

The gateway’s online presence status; one of the following:

  • ONLINE

  • AWAY

  • DND (Do Not Disturb)

  • NA (Not Available)

  • FREE_TO_CHAT

  • IDLE

XMPP only

  • NA (Not Available)

  • FREE_TO_CHAT

  • IDLE

Sametime only:

  • IDLE

customAwayMsg

A text string containing a custom message for the status. Can be the empty string if you do not need a custom away message.

Returns

True, if the operation was successful; False. otherwise. Passing an invalid status for the protocol causes this method to return False.

Usage

Do not use the setStatus method to go offline. Although the method accepts a parameter of OFFLINE, the gateway immediately resets itself to be online. To set the gateway offline, stop the gateway instance in the ColdFusion Administrator, or use the stopGatewayInstance method in the CFIDE.adminapi.eventgateway CFC.

Example

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