|
getBuddyInfo
DescriptionGets
information about the specified user from the buddy list, deny list,
and permit list.
Syntaxarray = getBuddyInfo(name)
Parameters
Parameter
|
Description
|
name
|
The unique instant messaging user name for
the person about whom you want to get information.
|
ReturnsAn 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 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)
NA (displays as NOT AVAILABLE)
FREE_TO_CHAT (displays as FREE TO CHAT)
IDLE
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 user’s status
most recently changed.
|
BUDDYCUSTOMAWAYMESSAGE
|
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:
BUDDY_LIST The list
of users whose presence status information the gateway can receive.
DENY_LIST The list of users who cannot get presence information
about the gateway ID.
PERMIT_LIST The list of users who can send presence information
messages to the gateway ID.
REVERSE_LIST The list of users who do not allow messages
to us.
|
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.
|
BUDDYWARNINGPERCENT
|
The user’s warning percentage value. Always
0 for XMPP or SameTime.
|
ExampleSee GatewayHelper
example , in the Developing ColdFusion Applications,
which uses all GatewayHelper class methods. For an example of using
this method to get the buddy custom away message, see onBuddyStatus.
|