PFFriendsClientAddFriendAsync - XBOX Game Development Documentation

Adds the PlayFab user, based upon a match against a supplied unique identifier, to the friend list of the local user. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.

Syntax

HRESULT PFFriendsClientAddFriendAsync(  
    PFEntityHandle entityHandle,  
    const PFFriendsClientAddFriendRequest* request,  
    XAsyncBlock* async  
)  

Parameters

entityHandle PFEntityHandle PFEntityHandle to use for authentication. request PFFriendsClientAddFriendRequest* Populated request object. async XAsyncBlock*
Inout XAsyncBlock for the async operation.

Return value

Type: HRESULT Result code for this API operation.

Remarks

This API is available on all platforms. See also ClientGetFriendsListAsync, ClientSetFriendTagsAsync. When the asynchronous task is complete, call PFFriendsClientAddFriendGetResult to get the result.

Requirements

Header: PFFriends.h

See also

PFFriends members

Last modified on August 3, 2026

⌘I