WoW:API BNGetFriendInfo: Difference between revisions
Jump to navigation
Jump to search
(Created page with '{{wowapi}} __NOTOC__ Returns information about the specified RealID friend presenceID, givenName, surname, toonName, toonID, client, isOnline, lastOnline, isAFK, isDND, broadcas…') |
m (Move page script moved page API BNGetFriendInfo to API BNGetFriendInfo without leaving a redirect) |
||
| (4 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{ood}} | |||
{{wowapi}} __NOTOC__ | {{wowapi}} __NOTOC__ | ||
Returns information about the specified RealID friend | Returns information about the specified RealID friend | ||
| Line 4: | Line 5: | ||
== Arguments == | == Arguments == | ||
;friendIndex : number - The index on the friends list for this RealID friend | ;friendIndex | ||
: number - The index on the friends list for this RealID friend | |||
== Returns == | == Returns == | ||
:presenceID, givenName, surname, toonName, toonID, client, isOnline, lastOnline, isAFK, isDND, broadcastText, noteText, isFriend, broadcastTime | :presenceID, givenName, surname, toonName, toonID, client, isOnline, lastOnline, isAFK, isDND, broadcastText, noteText, isFriend, broadcastTime | ||
;presenceID : Number - a unique numeric identifier for this friend for this session | ;presenceID | ||
;givenName : String - the friend's first name | : Number - a unique numeric identifier for this friend for this session | ||
;surname : String - the friend's family name | ;givenName | ||
;toonName : String - the name of the friend's currently logged in character | : String - a |K [[UI_escape_sequences|Escape Sequence]] representing the friend's first/given name (As of 4.0) | ||
;toonID : Number - a unique numeric identifier for this friend's character for this session | ;surname | ||
;client : String - Either "WoW" or "S2", for World of Warcraft or Starcraft2 | : String - a |K [[UI_escape_sequences|Escape Sequence]] representing the friend's Surname/family name (As of 4.0) | ||
;isOnline : Boolean - true if the friend is online | ;toonName | ||
;lastOnline : Number - the number of seconds since this friend was last online, nil if currently online | : String - the name of the friend's currently logged in character | ||
;isAFK : Boolean - true if the friend is flagged as Away | ;toonID | ||
;isDND : Boolean - true if the friend is flagged as Busy | : Number - a unique numeric identifier for this friend's character for this session | ||
;broadcastText : String - the contents of the friend's broadcast message | ;client | ||
;noteText : String - the contents of the player's note about this friend | : String - Either "WoW" or "S2", for World of Warcraft or Starcraft2 | ||
;isFriend : Boolean - unknown | ;isOnline | ||
;broadcastTime : Number - the number of seconds since the friend send the current broadcast | : Boolean - true if the friend is online | ||
;lastOnline | |||
: Number - the number of seconds since this friend was last online since last Epoch, January 1, 1970, nil if currently online | |||
;isAFK | |||
: Boolean - true if the friend is flagged as Away | |||
;isDND | |||
: Boolean - true if the friend is flagged as Busy | |||
;broadcastText | |||
: String - the contents of the friend's broadcast message | |||
;noteText | |||
: String - the contents of the player's note about this friend | |||
;isFriend | |||
: Boolean - unknown | |||
;broadcastTime | |||
: Number - the number of seconds since the friend send the current broadcast | |||
== Details == | == Details == | ||
The client names can be accessed via the globals BNET_CLIENT_WOW and | The client names can be accessed via the globals BNET_CLIENT_WOW, BNET_CLIENT_D3, BNET_CLIENT_SC2 and BNET_CLIENT_WTCG. | ||
==Useful Events== | |||
*BN_CONNECTED | |||
*BN_DISCONNECTED | |||
*BN_FRIEND_ACCOUNT_ONLINE | |||
*BN_FRIEND_ACCOUNT_OFFLINE | |||
*BN_CUSTOM_MESSAGE_CHANGED | |||
*BN_FRIEND_INVITE_ADDED | |||
*BN_FRIEND_INVITE_LIST_INITIALIZED | |||
*BN_CHAT_CHANNEL_JOINED | |||
<span style="line-height:21px;"></span> | |||
Latest revision as of 04:45, 15 August 2023
|
This article or section contains information that is out-of-date.
|
Returns information about the specified RealID friend
presenceID, givenName, surname, toonName, toonID, client, isOnline, lastOnline, isAFK, isDND, broadcastText, noteText, isFriend, broadcastTime = BNGetFriendInfo(friendIndex)
Arguments[edit]
- friendIndex
- number - The index on the friends list for this RealID friend
Returns[edit]
- presenceID, givenName, surname, toonName, toonID, client, isOnline, lastOnline, isAFK, isDND, broadcastText, noteText, isFriend, broadcastTime
- presenceID
- Number - a unique numeric identifier for this friend for this session
- givenName
- String - a |K Escape Sequence representing the friend's first/given name (As of 4.0)
- surname
- String - a |K Escape Sequence representing the friend's Surname/family name (As of 4.0)
- toonName
- String - the name of the friend's currently logged in character
- toonID
- Number - a unique numeric identifier for this friend's character for this session
- client
- String - Either "WoW" or "S2", for World of Warcraft or Starcraft2
- isOnline
- Boolean - true if the friend is online
- lastOnline
- Number - the number of seconds since this friend was last online since last Epoch, January 1, 1970, nil if currently online
- isAFK
- Boolean - true if the friend is flagged as Away
- isDND
- Boolean - true if the friend is flagged as Busy
- broadcastText
- String - the contents of the friend's broadcast message
- noteText
- String - the contents of the player's note about this friend
- isFriend
- Boolean - unknown
- broadcastTime
- Number - the number of seconds since the friend send the current broadcast
Details[edit]
The client names can be accessed via the globals BNET_CLIENT_WOW, BNET_CLIENT_D3, BNET_CLIENT_SC2 and BNET_CLIENT_WTCG.
Useful Events[edit]
- BN_CONNECTED
- BN_DISCONNECTED
- BN_FRIEND_ACCOUNT_ONLINE
- BN_FRIEND_ACCOUNT_OFFLINE
- BN_CUSTOM_MESSAGE_CHANGED
- BN_FRIEND_INVITE_ADDED
- BN_FRIEND_INVITE_LIST_INITIALIZED
- BN_CHAT_CHANNEL_JOINED