User Guide

IM Gateway GatewayHelper class methods 1021
getBuddyInfo
Description
Gets information about the specified user from the buddy list, deny list, and permit list.
Syntax
array = getBuddyInfo(name)
See also
addBuddy
, getBuddyList, removeBuddy, “Using the GatewayHelper object” in Chapter 43,
“Using the Instant Messaging Event Gateways” of ColdFusion MX Developer’s Guide
Parameters
Returns
An array of structures, with one structure for each information record found. The method finds
one record for each group that the user belongs to in each of the lists (buddy, permit, deny) that
contains the specified name. Each structure has the following fields. Some fields might not be
meaningful for some IM protocols. If there is no information for a field, it is blank.
Parameter Description
name The unique instant messaging user name for the person about whom you want to
get information.
Field Description
BUDDYNAME The user’s unique ID.
BUDDYGROUP The group to which the user belongs.
BUDDYNICKNAME The nickname that you have assigned to the user.
BUDDYPROTOCOL The instant messaging protocol. JABBER (for XMPP) or SAMETIME, or
an empty string (if the server did not return a value).
BUDDYSTATUS The user’s presence state, can by any of the following:
• ONLINE
• OFFLINE
• AWAY
• DND (displays as DO NOT DISTURB)
XMPP only
• NA (displays as NOT AVAILABLE)
• FREE_TO_CHAT (displays as FREE TO CHAT)
Sametime only
• IDLE
BUDDYSIGNONTIME The date and time when the user signed onto the IM server. Empty if the
user is not currently signed on. Always an empty string for XMPP and
Sametime.
BUDDYSTATUSTIME The date and time when the user’s status most recently changed.