getNickName

Description

Returns the gateway’s nickname (display name), if it has been set using the gatewayHelper object setNickName method.

Syntax

string = getNickName()

See also

getName, getProtocolName, numberOfMessagesReceived, numberOfMessagesSent, setNickName, Using the GatewayHelper object in the Developing ColdFusion Applications

Returns

The gateway’s nickname, if any; empty string, otherwise.

Example

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