Whatever message this page gives is out now! Go check it out!

getHelper

Last update:
May 18, 2026

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 interfaceProviding Gateway class service and information routines in  Building an event gateway  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(); }

Share this page

Was this page helpful?
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Thank you for your feedback. Your response will help improve this page.

On this page