Description
Gets the online status of the gateway as a text string.
Syntax
string = getStatusAsString() |
See also
getCustomAwayMessage, getStatusTimeStamp, isOnline, setStatus, Using the GatewayHelper object in the Developing ColdFusion Applications
Returns
The gateway's online status; one of the following:
- ONLINE
- OFFLINE
- AWAY
- DO NOT DISTURB XMPP only
- NOT AVAILABLE
- FREE TO CHAT Sametime only
- IDLE
Usage
The DO NOT DISTURB, NOT AVAILABLE, and FREE TO CHAT strings differ from the status values that you use in the setStatus method, which does not allow spaces in the status names.
Example
See GatewayHelper example in Using the GatewayHelper object in the Developing ColdFusion Applications, which uses all GatewayHelper class methods.
