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 Using the Instant Messaging Event Gateways in ColdFusion MX Developer's Guide

Parameters

Parameter Description

status

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

  • ONLINE
  • AWAY
  • DND (Do Not Disturb)

XMPP only

  • NA (Not Available)
  • FREE_TO_CHAT

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 MX Administrator, or use the stopGatewayInstance method in the CFIDE.adminapi.eventgateway CFC.

Example

See GatewayHelper example, in Using the Instant Messaging Event Gateways in ColdFusion MX Developer's Guide, which uses all GatewayHelper class methods.

ColdFusion 9 | ColdFusion 8 | ColdFusion MX 7 | ColdFusion MX 6.1 | ColdFusion MX | Forums | Developer Center | KnowledgeBase | Bug Reporting

Version 7

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/coldfusion/7/htmldocs/00000776.htm