API C_FriendList.GetFriendInfo

From Wowpedia
Jump to: navigation, search

Retrieves information about a person on your friends list.

info = C_FriendList.GetFriendInfo("name")
     = C_FriendList.GetFriendInfoByIndex(index)

Arguments (GetFriendInfo)

name 
string - name of friend in the friend list.

Arguments (GetFriendInfoByIndex)

index 
number - index of the friend, up to C_FriendList.GetNumFriends (max 100). Note that status changes can re-order the friend list and indices.

Returns

info 
structure - FriendInfo
Key Type Description
connected boolean If the friend is online
name string Friend's name
className string (nilable) Friend's class, or "Unknown" (if offline)
area string (nilable) Friend's current location, or "Unknown" (if offline)
notes string (nilable) Friend's note
guid string Friend's GUID, example: "Player-1096-085DE703"
level number Friend's level, or 0 (if offline)
dnd boolean If the friend's current status flag is DND
afk boolean If the friend's current status flag is AFK
rafLinkType Enum.RafLinkType
mobile boolean
Enum.RafLinkType
Value Type Description
0
None
1
Recruit
2
Friend
3
Both

Details

  • Friend information isn't necessarily automatically kept up to date. You can use C_FriendList.ShowFriends to request an update from the server.

Example

local f = C_FriendList.GetFriendInfoByIndex(1)
print(format("Your friend %s (level %d %s) is in %s", f.name, f.level, f.className, f.area))
> Your friend Aërto (level 74 Warrior) is in Sholazar Basin

Patch changes

See also