Adobe ColdFusion 8

getCustomAwayMessage

Description

Returns the gateway's custom away message if it has been set by the gatewayHelper object setStatus method.

Syntax

string = getCustomAwayMessage()

See also

getStatusAsString, getStatusTimeStamp, isOnline, setStatus, "Using the GatewayHelper object" in the ColdFusion Developer's Guide

Returns

The gateway's custom away message if it has been set by the GatewayHelper object setStatus method.

Example

See "GatewayHelper example", in the ColdFusion Developer's Guide, which uses all GatewayHelper class methods.