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)
/// <summary>Batch set the maximum limit of friends players can have. (max 100 players, max 500 friends per player)</summary>
/// <param name="pgos_params">Request struct for set friend remark.</param>
public void BatchSetPlayerFriendsLimit(BatchSetPlayerFriendsLimitParams pgos_params, FriendDelegate0 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | BatchSetPlayerFriendsLimitParams | Request struct for set friend remark. |
| callback | FriendDelegate0 |
Return: void
BatchGetPlayerFriendsLimit
Batch query the maximum limit of friends players can have. (max 100 players)
/// <summary>Batch query the maximum limit of friends players can have. (max 100 players)</summary>
/// <param name="pgos_params">Request struct for set friend remark.</param>
public void BatchGetPlayerFriendsLimit(BatchGetPlayerFriendsLimitParams pgos_params, FriendDelegate1 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | BatchGetPlayerFriendsLimitParams | Request struct for set friend remark. |
| callback | FriendDelegate1 |
Return: void
GetFriendList
Retrieve the specified player's friends list (including friends' player info, player presence, and remark).
/// <summary>Retrieve the specified player's friends list (including friends' player info, player presence, and remark).</summary>
/// <param name="pgos_params">Request struct for get friend list.</param>
public void GetFriendList(GetFriendListParams pgos_params, FriendDelegate2 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | GetFriendListParams | Request struct for get friend list. |
| callback | FriendDelegate2 |
Return: void
All Delegates
public delegate void FriendDelegate0(PgosResult a0);
public delegate void FriendDelegate1(PgosResult a0, BatchGetPlayerFriendsLimitResult a1);
public delegate void FriendDelegate2(PgosResult a0, FriendListInfo a1);
Type Reference: