Query Channel Friend List (QueryFriends)

AndroidiOSWindows
If you are using the Unity engine, see Unity SDK's QueryFriends.

Get a list of a player's channel friends, or in-game play friends list.

info

The Player Network SDK currently supports fetching channel friend lists for Discord, Epic, Kakao, Switch, and Xbox Series X|S.
Third-party channel play friend lists can be obtained through the backend interface friend_list for channels like Facebook, Garena, QQ, Steam, WeChat, and VK.

Channel	Android	iOS	Windows	Console
Discord	Supported	Supported	Unsupported	Unsupported
Epic	Unsupported	Unsupported	Supported	Unsupported
Kakao	Supported	Supported	Unsupported	Unsupported
Switch	Unsupported	Unsupported	Unsupported	Supported
Xbox Series X|S	Unsupported	Unsupported	Unsupported	Supported
WinGDK	Not supported	Not supported	Not supported	Supported

Function Definition

UFUNCTION(BlueprintCallable, Category = "INTLSDKAPI")
static bool QueryFriends(
    const EINTLLoginChannel Channel,
    const int32 Page = 0,
    const int32 Count = 0,
    const bool IsInGame = true,
    const FString ExtraJson = "{}");

Parameter Details

Parameters	Type	Explanation
Channel	EINTLLoginChannel	Channel information e.g., "Epic".
Page	int32	Which page of friends to fetch
Count	int32	Number of friends per page
IsInGame	bool	Whether they are in-game friends true means play friends false means otherwise
ExtraJson	FString	Extended interface, passing data transparently

Callback processing

The callback handling interface is FriendResultObserver.The callback data structure is FriendResult.

The callback ID is kMethodIDFriendQueryFriends.

Code example

UINTLSDKAPI::QueryFriends(EINTLLoginChannel::kChannelEpic);