Adobe COLDFUSION 9 Manual page 1292

DEVELOPING COLDFUSION 9 APPLICATIONS
Using External Resources
Using the GatewayHelper object
The CFML
GetGatewayHelper
gateway and buddy list. The GatewayHelper methods let you do the following:
• Get and set gateway configuration information and get gateway statistics.
• Get and set the gateway online status.
• Manage the gateway's buddy list
• Manage permissions for others to get information about the gateway status.
The following sections briefly describe the class methods. For detailed information about each method, see IM
Gateway GatewayHelper class methods in the CFML Reference.
Gateway configuration information and statistics methods
The following table describes the methods that you can use to get and set configuration information and get gateway
statistics:
Method
getName
getNickName
getProtocolName
numberOfMessagesReceived
numberOfMessagesSent
setNickName
Gateway online status methods
The following table describes the methods that you can use to get and set the gateway's online availability status
(presence information):
Method
getCustomAwayMessage
getStatusAsString
getStatusTimeStamp
isOnline
setStatus
Gateway buddy management methods
The following table describes the methods that you can use to manage the gateway's buddy list:
Method
addBuddy
function returns a GatewayHelper object with several methods that manage your
Description
Returns the gateway's user name.
Returns the gateway's display name (nickname).
Returns the name of the instant messaging protocol (JABBER for XMPP, or SAMETIME).
Returns the number of messages received by the gateway since it was started.
Returns the number of messages sent by the gateway since it was started.
Sets the gateway's display name (nickname).
Description
Returns the gateway's custom away message if the
Returns the online status of the gateway.
Returns the date/time that the gateway changed its online status.
Returns True if the gateway is connected to the IM server; otherwise, returns false.
Changes the gateway's online status; for example, to away or idle.
Description
Adds a buddy to the gateway's buddy list and tells the IM server to send the gateway messages with
the buddy's online state.
Last updated 8/5/2010
method set it.
setStatus
1287