MACROMEDIA COLFUSION MX 7-CFML, Reference

Page: 609 / 1108

GetGatewayHelper 609
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
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
Chapter 42, “Using Event Gateways,” in
ColdFusion MX Developer’s Guide .
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 MX Administrator Event Gateways section’s Gateways page.