Changes: API C FriendList.GetFriendInfo

Revision as of 12:17, 24 September 2021

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	Field	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 (2019-09-24): Added rafLinkType field.
Patch 8.2.0 (2019-06-25): Added mobile field.
Patch 8.1.0 (2018-12-11): Moved to C_FriendList.GetFriendInfo()^[1]
Patch 2.4.0 (2008-03-25): Added note return.^[2]
Patch 1.1.0 (2004-11-07): Added as GetFriendInfo()

@@ Line 1: / Line 1: @@
+{{wowapi|t=a|namespace=C_FriendList|system=FriendList}}
-{{wowapi}}
 Retrieves information about a person on your friends list.
  info = C_FriendList.GetFriendInfo(name)
       = C_FriendList.GetFriendInfoByIndex(index)
-==Arguments (GetFriendInfo)==
+==Arguments==
+===<font color="#4ec9b0">GetFriendInfo</font>===
-;name : String - name of friend in the friend list.
+;name : <span class="apitype">string</span> - name of friend in the friend list.
-==Arguments (GetFriendInfoByIndex)==
+===<font color="#4ec9b0">GetFriendInfoByIndex</font>===
-;index : number - index of the friend, up to {{api|C_FriendList.GetNumFriends}} (max 100). Note that status changes can re-order the friend list and indices.
+;index : <span class="apitype">number</span> - index of the friend, up to {{api|C_FriendList.GetNumFriends}}() limited to max 100.
 ==Returns==
-;info : structure - FriendInfo
+;info : <span class="apitype">FriendInfo</span>
+{| class="sortable darktable zebra" style="margin-left: 2em"
-{| class="sortable darktable zebra"
-|-
 ! Key !! Type !! Description
 |-
-| connected || boolean || If the friend is online
+| connected || <span class="apitype">boolean</span> || If the friend is online
 |-
-| name || string || Friend's name
+| name || <span class="apitype">string</span> ||
 |-
-| className || string (nilable) || Friend's class, or "Unknown" (if offline)
+| className || <span title="nilable"><span class="apitype">string</span>?</span> || Friend's class, or "Unknown" (if offline)
 |-
-| area || string (nilable) || Friend's current location, or "Unknown" (if offline)
+| area || <span title="nilable"><span class="apitype">string</span>?</span> || Current location, or "Unknown" (if offline)
 |-
-| notes || string (nilable) || Friend's note
+| notes || <span title="nilable"><span class="apitype">string</span>?</span> ||
 |-
-| guid || string || Friend's [[GUID]], example: "Player-1096-085DE703"
+| guid || <span class="apitype">string</span> || [[GUID]], example: "Player-1096-085DE703"
 |-
-| level || number || Friend's level, or 0 (if offline)
+| level || <span class="apitype">number</span> || Friend's level, or 0 (if offline)
 |-
-| dnd || boolean || If the friend's current status flag is DND
+| dnd || <span class="apitype">boolean</span> || If the friend's current status flag is DND
 |-
-| afk || boolean || If the friend's current status flag is AFK
+| afk || <span class="apitype">boolean</span> || If the friend's current status flag is AFK
 |-
+| rafLinkType || <span class="apitype">Enum.RafLinkType</span> ||
-| referAFriend || boolean || If your friend was recruited through [[Recruit-A-Friend]]
+|-
+| mobile || <span class="apitype">boolean</span> ||
 |}
+{{:Enum_RecruitAFriendShared.RafLinkType}}
 ==Details==
-* Friend information isn't necessarily automatically kept up to date. You can use {{api|C_FriendList.ShowFriends}} to request an update from the server.
+* Friend information isn't necessarily automatically kept up to date. You can use {{api|C_FriendList.ShowFriends}}() to request an update from the server.
 ==Example==
+<syntaxhighlight lang="lua">
- local f = C_FriendList.GetFriendInfoByIndex(1)
+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))
+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
+-- Your friend Aërto (level 74 Warrior) is in Sholazar Basin
+</syntaxhighlight>
 ==Patch changes==
+* {{Patch 8.2.5|note=Added <code>rafLinkType</code> field.}}
-* {{Patch 8.1.0|note=Changed and moved to ''C_FriendList''. The previous alias {{api|GetFriendInfo}} is deprecated and will be removed in the next expansion. [https://www.townlong-yak.com/framexml/8.1.5/Blizzard_Deprecated/Deprecated_8_1_0.lua#70]}}
+* {{Patch 8.2.0|note=Added <code>mobile</code> field.}}
+* {{Patch 8.1.0|note=Moved to <code>C_FriendList.GetFriendInfo()</code><sup>[https://www.townlong-yak.com/framexml/8.1.5/Blizzard_Deprecated/Deprecated_8_1_0.lua#70]</sup>}}
-==See also==
-* [https://www.townlong-yak.com/framexml/live/Blizzard_APIDocumentation#C_FriendList.GetFriendInfo Blizzard API Documentation]
+* {{Patch 2.4.0|note=Added <code>note</code> return.<sup>[https://www.townlong-yak.com/framexml/2.4.0/FriendsFrame.lua/diff#201]</sup>}}
+* {{Patch 1.1.0|note=Added as <code>GetFriendInfo()</code>}}