|
getHelper
DescriptionReturns
an instance of the gatewayHelper class, if any for the gateway type.
CategoryEvent
Gateway Development
Syntaxpublic GatewayHelper getHelper()
ReturnsA coldfusion.eventgateway.GatewayHelper
class instance, or null if the gateway does not have a GatewayHelper
class.
UsageColdFusion
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.
ExampleThe
following example is the ColdFusion SocketGateway class getHelper method:
public GatewayHelper getHelper()
{
// SocketHelper class implements the GatewayHelper interface
return new SocketHelper();
}
|