GetGatewayHelper

Description

Gets a Java GatewayHelper object that provides methods and properties for use with a ColdFusion event gateway.

Returns

A Java GatewayHelper object.

Category

Extensibility functions

Function syntax

GetGatewayHelper(gatewayID)

See also

SendGatewayMessage

History

ColdFusion MX 7: Added the function.

Parameters

Parameter

Description

gatewayID

Identifier of the gateway that provides the GatewayHelper object. Must be the Gateway ID of one of the ColdFusion event gateway instances configured on the ColdFusion Administrator Event Gateways section’s Gateways page.

Usage

The ColdFusion GetGatewayHelper function returns a Java GatewayHelper object that provides event gateway-specific helper methods and properties. To use this function, the event gateway must provide access to a class that implements the GatewayHelper class. For example, an instant messaging event gateway might make buddy-list management functions available in a GatewayHelper object.

An event gateway listener CFC can get the gatewayID value from the CFEvent structure of the incoming message.

You access the GatewayHelper object’s methods and properties using standard ColdFusion Java object access techniques. For more information, see The role of the GatewayHelper object in the Developing ColdFusion Applications.

Example

If an event gateway’s helper class includes an addBuddy method that takes a single String parameter, you could use the following code to get the GatewayHelper object and add a buddy to the buddies list:

<h3>GetGatewayHelper Example</h3> 
<cfscript> 
    myHelper = getGatewayHelper(myGatewayID); 
    status = myHelper.addBuddy("jsmith"); 
</cfscript>