setNickName

Description

Sets the gateway’s nickname (display name).

Syntax

Boolean = setNickName(name)

See also

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

Parameters

Parameter

Description

name

The display name that you want to associate with this gateway. This name is not guaranteed to be unique for the protocol.

Returns

True if the nickname got set; false, otherwise.

Example

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