C_FriendList.GetFriendInfo

Main Menu
WoW API Widget API Widget scripts Lua API Events CVars XML schema Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs

	C_FriendList.GetFriendInfo + 8.1.0 / 1.13.2
	C_FriendList.GetFriendInfoByIndex + 8.1.0 / 1.13.2

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.

GetFriendInfoByIndex

index 

number - index of the friend, up to C_FriendList.GetNumFriends() limited to max 100.

Returns

info 

FriendInfo

Key	Type	Description
connected	boolean	If the friend is online
name	string
className	string?	Friend's class, or "Unknown" (if offline)
area	string?	Current location, or "Unknown" (if offline)
notes	string?
guid	string	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	Key	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

• Patch 8.2.5 / API (2019-09-24): Added rafLinkType field.
  
• Patch 8.2.0 / API (2019-06-25): Added mobile field.
  
• Patch 8.1.0 / API (2018-12-11): Moved to C_FriendList.GetFriendInfo()^[1]
  
• Patch 2.4.0 / API (2008-03-25): Added note return.^[2]
  
• Patch 1.1.0 / API (2004-11-07): Added as GetFriendInfo()