Update documentation for v10.0.10

PiperOrigin-RevId: 327416819
Change-Id: I371a55cb97a7b938589c332fffd64c5c2a57f755

README.md

@@ -18,6 +18,7 @@ The plugin provides support for the
 following features of the Google Play Games API:<br/>
 
 * sign in
+* friends
 * unlock/reveal/increment achievement
 * post score to leaderboard
 * cloud save read/write
@@ -355,6 +356,101 @@ PlayGamesPlatform.Instance.RequestPermission("email", result => {
  });
 ```
 
+## Friends
+
+Play Games Friends allows players to create and maintain a cross-games friends list. You can request access to this friends list to help your players play your game with their friends. See the [Friends concept page](https://developers.google.com/games/services/common/concepts/friends) for more details on the friends system.
+
+To enable Friends, use the following functions:
+
+*  [View friends](https://github.com/playgameservices/play-games-plugin-for-unity#view-friends): Request access to a player’s friends list, so you can add their play games friends to your in-game friends list
+*  [View a player profile](https://github.com/playgameservices/play-games-plugin-for-unity#view-a-player-profile): Let a player view the Play Games profile of another player. This is essential so a player knows who their friends are, and can connect to other Play Games players in your game. This will need to be tied to a UI element to trigger the popup. See the [friends guidelines](https://developers.google.com/games/services/checklist#friends) for details.
+
+See the [best practices guidelines](https://developers.google.com/games/services/checklist#friends) for instructions on how best to implement these APIs.
+
+Note: To use Friends, you need to update your PGS SDK to version 20.0.0
+
+
+### View friends
+
+There are two ways to load friends, either using the `ISocial` framework or directly with `PlayGamesPlatform`.
+
+#### Loading friends with the ISocial framework
+
+```csharp
+Social.localUser.LoadFriends((success) =>  {
+    Debug.Log("Friends loaded OK: " + ok));
+    foreach(IUserProfile p in Social.localUser.friends) {
+         Debug.Log(p.userName + " is a friend");
+    }
+```
+
+However, this call will fail if the current player has not yet granted permission to the game to access this information. Use `GetLastLoadFriendsStatus` to check if `LoadFriends` failed due to missing consent.
+
+```csharp
+ PlayGamesPlatform.Instance.GetLastLoadFriendsStatus((status) => {
+    // Check for consent
+    if (status == LoadFriendsStatus.ResolutionRequired) {
+        // Ask for resolution.
+    }
+});
+```
+
+A game can ask the current player to share the friends list by calling `AskForLoadFriendsResolution`.
+
+```csharp
+PlayGamesPlatform.Instance.AskForLoadFriendsResolution((result) => {
+    if (result == UIStatus.Valid) {
+        // User agreed to share friends with the game. Reload friends.
+    } else {
+        // User doesn’t agree to share the friends list.
+    }
+});
+```
+
+This function will show the appropriate platform-specific friends sharing UI. This UI asks the player if they want to share their friends with the game.
+
+#### Loading friends with PlayGamesPlatform
+
+Another way of loading friends is to use `LoadFriends` and `LoadMoreFriends`:
+
+```csharp
+PlayGamesPlatform.Instance.LoadFriends(pageSize, forceReload, (status) => {
+    // Check if the call is successful and if there are more friends to load.
+});
+
+PlayGamesPlatform.Instance.LoadMoreFriends(pageSize, (status) => {
+    // Check if there are more friends to load.
+});
+```
+
+The `pageSize` param represents the number of entries to request for this page. Note that if cached data already exists, the returned buffer may contain more than this size. The buffer is guaranteed to contain at least this many entries if the collection contains enough records. If `forceReload` is set to `true`, this call will clear any locally-cached data and attempt to fetch the latest data from the server. This would commonly be used for actions like a user-initiated refresh. Normally, this should be set to `false` to gain the advantages of data caching.
+
+If the callback returns `LoadFriendsStatus.LoadMore`, then there are more friends to load. `LoadFriendsStatus.ResolutionRequired` signals that the user has not shared the friends list and you can directly call `PlayGamesPlatform.Instance.AskForLoadFriendsResolution`.
+
+#### Determining friends list visibility
+
+Use `PlayGamesPlatform.Instance.GetFriendsListVisibility` to check if the user has shared the friends list with the game. Possible return statuses are:
+
+   * `FriendsListVisibilityStatus.RequestRequired` indicates you must ask for consent. 
+   * `FriendsListVisibilityStatus.Visible` indicates that loading the friends list should succeed.
+   * `FriendsListVisibilityStatus.Unknown` generally shouldn't happen. You can set `forceReload` to true to refresh the data.
+
+```csharp
+PlayGamesPlatform.Instance.GetFriendsListVisibility(forceReload, (friendsListVisibilityStatus) => {});
+```
+
+### View a player profile
+
+To add or remove a player as a friend, use the show and compare profile function. This function triggers a bottom sheet dialog showing the Play Games profile of the user; call the function with the player Id of the requested player. If the player and friend have in-game nicknames, use them in the call to add more context to the profile UI:
+
+```csharp
+PlayGamesPlatform.Instance.ShowCompareProfileWithAlternativeNameHintsUI(
+    mFirstFriendId, /* otherPlayerInGameName= */ null, /* currentPlayerInGameName= */ null,
+    (result) => {
+        // Profile comparison view has closed.
+});
+```
+
 ## Player Statistics
 
 The Player Stats API let you tailor game experiences to specific segments
@@ -491,6 +587,7 @@ To show the built-in UI for all achievements, call
     // show achievements UI
     Social.ShowAchievementsUI();
 ```
+
 ## Showing the Leaderboard UI
 
 To show the built-in UI for all leaderboards, call **Social.ShowLeaderboardUI**.
@@ -603,6 +700,8 @@ caller when loading scores.  The members are:
     }
 ```
 
+This call may fail when trying to load friends with `ResponseCode.ResolutionRequired` if the user has not shared their friends list with the game. In this case, use `AskForLoadFriendsResolution` to request access.
+
 ### Getting player names
 
 Each score has the userId of the player that made the score.  You can use
@@ -867,22 +966,6 @@ requesting the ID Token will cause a consent screen to be presented to the user
 during login.
 
 
-## Loading Friends
-
-To load the friends of the current player, you can use the ISocial framework.
-This call is asynchronous, so the friends need to be processed in the callback.
-
-```csharp
-Social.localUser.LoadFriends((ok) =>  {
-    Debug.Log("Friends loaded OK: " + ok));
-    foreach(IUserProfile p in Social.localUser.friends) {
-         Debug.Log(p.userName + " is a friend");
-    }
-});
-```
-
-
-
 ## Video Recording
 
 If you wish to integrate the Play Games video capture functionality into your game,
@@ -1016,13 +1099,15 @@ However, if for some reason you wish to keep the default implementation accessib
 3. Do not use `Social.Active` when interacting with Google Play Games. Instead, use `PlayGamesPlatform.Instance`.
 
 That way, you can even submit scores and achievements simultaneously to two or more social platforms:
+
 ```csharp
     // Submit achievement to original default social platform
     Social.ReportProgress("MyAchievementIdHere", 100.0f, callback);
 
     // Submit achievement to Google Play
     PlayGamesPlatform.Instance.ReportProgress("MyGooglePlayAchievementIdHere", 100.0f, callback);
 ```
+
 ## Special Thanks
 
 This section lists people who have contributed to this project by writing code, improving documentation or fixing bugs.