getHelper

Description

Returns an instance of the gatewayHelper class, if any for the gateway type.

Category

Event Gateway Development

Syntax

public GatewayHelper getHelper()

See also

GatewayHelper interface; Providing Gateway class service and information routines in the Developing ColdFusion Applications.

Returns

A coldfusion.eventgateway.GatewayHelper class instance, or null if the gateway does not have a GatewayHelper class.

Usage

ColdFusion calls this method when a ColdFusion application calls the CFML GetGatewayHelper function. The application then uses the gatewayHelper object methods to call gateway-specific utility methods, such as instant message buddy management methods.

Example

The following example is the ColdFusion SocketGateway class getHelper method:

public GatewayHelper getHelper() 
    { 
        // SocketHelper class implements the GatewayHelper interface 
        return new SocketHelper(); 
    }