Sets the online presence status of the gateway, including any custom away message.
Boolean = setStatus(status, customAwayMsg)
getCustomAwayMessage, getStatusAsString, getStatusTimeStamp, isOnline, "Using the GatewayHelper object" in the ColdFusion Developer's Guide
Parameter |
Description |
---|---|
status |
The gateway's online presence status; one of the following:
XMPP only
Sametime only:
|
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. |
True, if the operation was successful; False. otherwise. Passing an invalid status for the protocol causes this method to return False.
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.
See "GatewayHelper example", in the ColdFusion Developer's Guide, which uses all GatewayHelper class methods.