public interface GatewayHelper

Marker interface for gateway helper classes.

This interface (Marker class) is used to mark a helper class that can be returned by a gateway (see Gateway.getHelper() and the getGatewayHelper CFML function). The CFC author can use the helper class to invoke gateway-specific utility functions, such as buddy management functions for an instant messaging gateway.

This class is returned by the CFML function getGatewayCFCHelper(gatewayID). The CFC cannot get a direct reference to the Gateway object itself to protect the gateway's key operations, such as start, stop, restart.

Interface GatewayHelper