Server Friend API Reference

The Friends service allows developers to manage the player's friend list. The player can invite friends to join a party for matchmaking or to chat.

API List

API	Description
BatchSetPlayerFriendsLimit	Batch set the maximum limit of friends players can have. (max 100 players, max 500 friends per player)
BatchGetPlayerFriendsLimit	Batch query the maximum limit of friends players can have. (max 100 players)
GetFriendList	Retrieve the specified player's friends list (including friends' player info, player presence, and remark).

API Details

BatchSetPlayerFriendsLimit

Batch set the maximum limit of friends players can have. (max 100 players, max 500 friends per player)

/**
 * Batch set the maximum limit of friends players can have.  (max 100 players, max 500 friends per player)
 * 
 * @param params Request struct for set friend remark.
 * @param result_callback The result callback after the API execution ends, and it will be called in an ASYNCHRONOUS CHILD THREAD.
 */
void BatchSetPlayerFriendsLimit(
    const BatchSetPlayerFriendsLimitParams& params,
    PgosCallback result_callback);

Parameters:

Param	Type	Description
params	const BatchSetPlayerFriendsLimitParams&	Request struct for set friend remark.
result_callback	PgosCallback	The result callback after the API execution ends, and it will be called in an ASYNCHRONOUS CHILD THREAD.

Return: void

BatchGetPlayerFriendsLimit

Batch query the maximum limit of friends players can have. (max 100 players)

/**
 * Batch query the maximum limit of friends players can have. (max 100 players)
 * 
 * @param params Request struct for set friend remark.
 * @param result_callback The result callback after the API execution ends, and it will be called in an ASYNCHRONOUS CHILD THREAD.
 */
void BatchGetPlayerFriendsLimit(
    const BatchGetPlayerFriendsLimitParams& params,
    PgosDataCallback<BatchGetPlayerFriendsLimitResult> result_callback);

Parameters:

Param	Type	Description
params	const BatchGetPlayerFriendsLimitParams&	Request struct for set friend remark.
result_callback	PgosDataCallback<BatchGetPlayerFriendsLimitResult>	The result callback after the API execution ends, and it will be called in an ASYNCHRONOUS CHILD THREAD.

Return: void

GetFriendList

Retrieve the specified player's friends list (including friends' player info, player presence, and remark).

/**
 * Retrieve the specified player's friends list (including friends' player info, player presence, and remark).
 * 
 * @param params Request struct for get friend list.
 * @param result_callback The result callback after the API execution ends, and it will be called in an ASYNCHRONOUS CHILD THREAD.
 */
void GetFriendList(
    const GetFriendListParams& params,
    PgosDataCallback<FriendListInfo> result_callback);

Parameters:

Param	Type	Description
params	const GetFriendListParams&	Request struct for get friend list.
result_callback	PgosDataCallback<FriendListInfo>	The result callback after the API execution ends, and it will be called in an ASYNCHRONOUS CHILD THREAD.

Return: void