WoW:API BNGetFriendInfo

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < BNGetFriendInfo

Returns information about the specified RealID friend

presenceID, givenName, surname, toonName, toonID, client, isOnline, lastOnline, isAFK, isDND, broadcastText, noteText, isFriend, broadcastTime  = BNGetFriendInfo(friendIndex)

Arguments

friendIndex

number - The index on the friends list for this RealID friend

Returns

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

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

​