• ColdFusion Event Gateway reference

    CFML functions to develop gateway applications.

  • addEvent

    Sends a CFEvent instance to ColdFusion for dispatching to a listener CFC.

  • CFEvent

    CFEvent constructor.

  • CFEventclass

    CFEvent instances to communicate with the ColdFusion listener CFC or application.

  • Constructor

    Instantiates a gateway.

  • Gateway development interfaces and classes

    Gateway development interfaces and classes.

  • getStatus

    Returns the gateway status.

  • setCFCPath

    Specifies the listener CFC that processes this event.

  • setCFCMethod

    Sets the name of the CFC method that processes an incoming message.

  • getOriginatorID

    Identifies the originator of an incoming message.

  • getLogger

    Returns a ColdFusion Logger object that the event gateway can use to log information in a file.

  • getBuddyList

    Gets information about the specified user from the buddy list, deny list, and permit list.

  • getBuddyInfo

    Gets the buddy list for the gateway's user ID.

  • IM gateway message sending commands

    Send outgoing messages using SendGatewayMessage CFML function or the return value of a CFC listener method.

  • IM Gateway GatewayHelper class methods

    IM Gateway GatewayHelper class methods.

  • onIncomingMessage

    Handles incoming instant messages from other users.

  • onIMServerMessage

    Handles incoming error and status messages from the IM server.

  • onBuddyStatus

    Handles incoming messages indicating online status (presence) changes of users on the gateway's buddy list.

  • onAddBuddyResponse

    Handles incoming responses from other users to requests from the gateway to be added to their buddy lists.

  • onAddBuddyRequest

    Handles incoming requests for users to add the gateway user name as one of their buddies.

  • IM Gateway CFC incoming message methods

    IM Gateway CFC incoming message methods.

  • IM gateway methods and commands

    XMPP and IBM Sametime gateway methods.

  • CFML CFEvent structure

    CFML listener CFC methods.

  • warn

    Writes a log entry with a warning severity to the ColdFusion logger.

  • info

    Writes a log entry with an information severity to the ColdFusion logger.

  • setOriginatorID

    Identifies the originator of an incoming message.

  • data command

    Send binary data to a single destination.

  • submit Multi command

    Send a single text message to multiple recipients.

  • submit command

    Send a message to a single address.

  • setGatewayType

    Identifies the type of event gateway.

  • setGatewayID

    Sets the gateway ID that uniquely identifies the Gateway instance.

  • setData

    Adds the gateway-specific data, including any message contents.

  • setCFCListeners

    Sets the array of listener CFCs that the gateway sends messages to.

  • outgoingMessage

    Sends a message from ColdFusion to a message receiver.

  • getStatusTimeStamp

    Gets the date and time that the gateway changed its online status.

  • numberOfMessagesReceived

    Gets the number of messages received by the gateway since it was started.

  • numberOfMessagesSent

    Gets the number of messages sent by the gateway since it was started.

  • removeBuddy

    Removes an ID from a group in the buddy list for the gateway.

  • removeDeny

    Removes an ID from a group in the deny list for the gateway.

  • removePermit

    Removes an ID from a group in the permit list for the gateway.

  • setNickName

    Sets the gateway's nickname (display name).

  • setPermitMode

    Sets the gateway's permit mode on the IM server.

  • setStatus

    Sets the online presence status of the gateway, including any custom away message.

  • SMS Gateway CFEvent structure and commands

    SMS Gateway CFEvent structure and commands.

  • SMS Gateway incoming message CFEvent structure

    The SMS gateway puts the following information in a CFEvent instance that it sends to the CFC listener method.

  • getStatusAsString

    Gets the online status of the gateway as a text string.

  • getProtocolName

    Gets the name of the gateway's instant messaging protocol.

  • getPermitMode

    Gets the gateway's permit mode from the IM server.

  • getPermitList

    Returns the list of users that the IM server has been told to send state information about the gateway.

  • getNickName

    Returns the gateway's nickname (display name).

  • getName

    Returns the gateway's user name.

  • getDenyList

    Returns the list of users that the IM server has been told not to send state information about the gateway.

  • getCustomAwayMessage

    Returns the gateway's custom away message if it has been set by the gatewayHelper object setStatus method.

  • getQueueSize

    Returns the current size of the ColdFusion event queue that handles all messages for all gateways.

  • getMaxQueueSize

    Returns the maximum size of the ColdFusion event queue, as set in the ColdFusion Administrator.

  • getHelper

    Returns an instance of the gatewayHelper class, if any for the gateway type.

  • getGatewayType

    Returns the gateway type field of the CFEvent object.

  • getGatewayServices

    Static method that returns the GatewayServices object. Gateway code can call this method at any time, if necessary.

  • getGatewayID_1

    Returns the gateway ID field of the CFEvent object.

  • getGatewayID

    Returns the gateway ID that identifies the Gateway instance.

  • getData

    Returns the data Map that contains the message contents and other gateway-specific information.

  • getCFCTimeout

    Gets the time-out, in seconds, for the listener CFC to process the event request.

  • setCFCTimeout

    Sets the time-out, in seconds, during which the listener CFC must process the event request and return before ColdFusion gateway services terminates the request.

  • getCFCPath

    Get the path to the listener CFC that processes this message.

  • getCFCMethod

    Get the name of the CFC method that processes the message.

  • GatewayServices class

    ColdFusion GatewayService class.

  • Gateway interface

    Interface for implementing ColdFusion event gateways.

  • GatewayHelper interface

    ColdFusion Gateway Helper Java interface.

  • addPermit

    Tell the IM server to add the specified user to the permit list for the gateway's user ID.

  • addDeny

    Tell the IM server to add the specified user to the deny list for the gateway's user ID.

  • addBuddy

    Add a buddy to the buddy list for the gateway user ID and ask to have the IM server send messages with the buddy's online presence state to the gateway.

  • error

    Writes a log entry with an error severity to the ColdFusion logger.

  • debug

    Writes a log entry with a debugging severity to the ColdFusion logger.

  • Logger class

    The Logger class logs messages to a file in the ColdFusion logs directory.

  • stop

    Stops a gateway if it is running.

  • start

    Start a gateway.

  • CFML event gateway SendGatewayMessage data parameter

    The ColdFusion CFML gateway type enables you to invoke CFC methods asynchronously.

  • restart

    Stop a gateway if it is running and starts it up.

  • fatal

    Write a log entry with a fatal severity to the ColdFusion logger.

  • SMS gateway message sending commands

    SMS gateway message sending commands.

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy