![]() ![]() ![]() |
||
|
Gets information about the specified user from the buddy list, deny list, and permit list.
array = getBuddyInfo(name)
addBuddy, getBuddyList, removeBuddy, Using the GatewayHelper object in Using the Instant Messaging Event Gateways of ColdFusion MX Developers Guide
Parameter |
Description |
---|---|
name |
The unique instant messaging user name for the person about whom you want to get information. |
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.
Field |
Description |
---|---|
BUDDYNAME |
The users 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 users presence state, can by any of the following:
XMPP only
Sametime only
|
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 users status most recently changed. |
BUDDYCUSTOM |
The custom away message that the user has set to explain the current status, if any. |
BUDDYOWNER |
A string representing the client and protocol associated with this ID, in the format client@protocol. |
BUDDYLISTTIYPE |
The type of list that this buddy record is in; one of the following:
|
BUDDYIDLETIME |
If the buddy status is IDLE, how long the buddy has been idle. Always 0 for XMPP or SameTime. |
BUDDYISMOBILE |
True or False, indicating whether the user is on a mobile device. Always False for XMPP or SameTime. |
BUDDYWARNING |
The users warning percentage value. Always 0 for XMPP or SameTime. |
See GatewayHelper example, in Using the Instant Messaging Event Gateways in ColdFusion MX Developers Guide, which uses all GatewayHelper class methods. For an example of using this method to get the buddy custom away message, see onBuddyStatus.
|
||
![]() ![]() ![]() |