summaryrefslogtreecommitdiff
path: root/docs/html/reference/com/google/android/gms/games/GamesClient.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/html/reference/com/google/android/gms/games/GamesClient.html')
-rw-r--r--docs/html/reference/com/google/android/gms/games/GamesClient.html342
1 files changed, 199 insertions, 143 deletions
diff --git a/docs/html/reference/com/google/android/gms/games/GamesClient.html b/docs/html/reference/com/google/android/gms/games/GamesClient.html
index 1a107bc80b80..63c4d3ae5885 100644
--- a/docs/html/reference/com/google/android/gms/games/GamesClient.html
+++ b/docs/html/reference/com/google/android/gms/games/GamesClient.html
@@ -852,7 +852,7 @@ Summary:
<td class="jd-typecol">int</td>
<td class="jd-linkcol"><a href="/reference/com/google/android/gms/games/GamesClient.html#MAX_RELIABLE_MESSAGE_LEN">MAX_RELIABLE_MESSAGE_LEN</a></td>
<td class="jd-descrcol" width="100%">This gives the maximum message size supported via the <code><a href="/reference/com/google/android/gms/games/GamesClient.html#sendReliableRealTimeMessage(com.google.android.gms.games.multiplayer.realtime.RealTimeReliableMessageSentListener, byte[], java.lang.String, java.lang.String)">sendReliableRealTimeMessage(RealTimeReliableMessageSentListener, byte[], String, String)</a></code>
- APIs (excluding protocol headers).</td>
+ methods (excluding protocol headers).</td>
</tr>
@@ -860,7 +860,7 @@ Summary:
<td class="jd-typecol">int</td>
<td class="jd-linkcol"><a href="/reference/com/google/android/gms/games/GamesClient.html#MAX_UNRELIABLE_MESSAGE_LEN">MAX_UNRELIABLE_MESSAGE_LEN</a></td>
<td class="jd-descrcol" width="100%">This gives the maximum (unfragmented) message size supported via the
- <code><a href="/reference/com/google/android/gms/games/GamesClient.html#sendUnreliableRealTimeMessage(byte[], java.lang.String, java.lang.String)">sendUnreliableRealTimeMessage(byte[], String, String)</a></code> APIs (excluding protocol headers).</td>
+ <code><a href="/reference/com/google/android/gms/games/GamesClient.html#sendUnreliableRealTimeMessage(byte[], java.lang.String, java.lang.String)">sendUnreliableRealTimeMessage(byte[], String, String)</a></code> methods (excluding protocol headers).</td>
</tr>
@@ -934,8 +934,8 @@ Summary:
<tr class=" api apilevel-" >
<td class="jd-typecol">int</td>
<td class="jd-linkcol"><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_INVALID_REAL_TIME_ROOM_ID">STATUS_INVALID_REAL_TIME_ROOM_ID</a></td>
- <td class="jd-descrcol" width="100%">Constant indicating that real-time room ID provided by the user is not a valid or it is
- not currently active real-time room.</td>
+ <td class="jd-descrcol" width="100%">Constant indicating that the real-time room ID provided to the operation was not valid, or
+ does not correspond to the currently active real-time room.</td>
</tr>
@@ -1025,8 +1025,8 @@ Summary:
<tr class=" api apilevel-" >
<td class="jd-typecol">int</td>
<td class="jd-linkcol"><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_REAL_TIME_MESSAGE_FAILED">STATUS_REAL_TIME_MESSAGE_FAILED</a></td>
- <td class="jd-descrcol" width="100%">Status code returned from <code><a href="/reference/com/google/android/gms/games/GamesClient.html#sendUnreliableRealTimeMessage(byte[], java.lang.String, java.lang.String)">sendUnreliableRealTimeMessage(byte[], String, String)</a></code> and the
- <code><a href="/reference/com/google/android/gms/games/GamesClient.html#sendReliableRealTimeMessage(com.google.android.gms.games.multiplayer.realtime.RealTimeReliableMessageSentListener, byte[], java.lang.String, java.lang.String)">sendReliableRealTimeMessage(RealTimeReliableMessageSentListener, byte[], String, String)</a></code> APIs when the message send operation failed due to an
+ <td class="jd-descrcol" width="100%">Status code returned from the <code><a href="/reference/com/google/android/gms/games/GamesClient.html#sendUnreliableRealTimeMessage(byte[], java.lang.String, java.lang.String)">sendUnreliableRealTimeMessage(byte[], String, String)</a></code> and
+ <code><a href="/reference/com/google/android/gms/games/GamesClient.html#sendReliableRealTimeMessage(com.google.android.gms.games.multiplayer.realtime.RealTimeReliableMessageSentListener, byte[], java.lang.String, java.lang.String)">sendReliableRealTimeMessage(RealTimeReliableMessageSentListener, byte[], String, String)</a></code> methods when the message send operation failed due to an
immediate error.</td>
</tr>
@@ -1275,6 +1275,22 @@ Summary:
+ <a href="/reference/com/google/android/gms/games/Game.html">Game</a></nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad"><a href="/reference/com/google/android/gms/games/GamesClient.html#getCurrentGame()">getCurrentGame</a></span>()</nobr>
+
+ </td></tr>
+
+
+
+ <tr class="alt-color api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+
+
+
<a href="/reference/com/google/android/gms/games/Player.html">Player</a></nobr>
</td>
<td class="jd-linkcol" width="100%"><nobr>
@@ -1284,7 +1300,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1300,7 +1316,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1318,7 +1334,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1336,7 +1352,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1354,7 +1370,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1373,7 +1389,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1391,7 +1407,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1410,7 +1426,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1428,7 +1444,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1446,7 +1462,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1465,7 +1481,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1483,7 +1499,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1502,7 +1518,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1521,7 +1537,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1539,7 +1555,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1557,7 +1573,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1575,7 +1591,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1593,7 +1609,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1612,7 +1628,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1630,7 +1646,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1648,7 +1664,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1666,7 +1682,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1684,7 +1700,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1702,7 +1718,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1720,7 +1736,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1738,7 +1754,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1756,7 +1772,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1774,7 +1790,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1792,7 +1808,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1810,7 +1826,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1828,7 +1844,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1847,7 +1863,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1865,7 +1881,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1883,7 +1899,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1901,7 +1917,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1919,7 +1935,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1937,7 +1953,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1955,7 +1971,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1973,7 +1989,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -1992,7 +2008,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -2011,7 +2027,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -2029,7 +2045,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -2047,7 +2063,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -2065,7 +2081,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -2083,7 +2099,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -2101,7 +2117,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -2119,7 +2135,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -2137,7 +2153,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -2155,7 +2171,7 @@ Summary:
- <tr class="alt-color api apilevel-" >
+ <tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -2173,7 +2189,7 @@ Summary:
- <tr class=" api apilevel-" >
+ <tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -2910,7 +2926,7 @@ From interface
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>This gives the maximum message size supported via the <code><a href="/reference/com/google/android/gms/games/GamesClient.html#sendReliableRealTimeMessage(com.google.android.gms.games.multiplayer.realtime.RealTimeReliableMessageSentListener, byte[], java.lang.String, java.lang.String)">sendReliableRealTimeMessage(RealTimeReliableMessageSentListener, byte[], String, String)</a></code>
- APIs (excluding protocol headers).
+ methods (excluding protocol headers).
</p></div>
@@ -2950,7 +2966,7 @@ From interface
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>This gives the maximum (unfragmented) message size supported via the
- <code><a href="/reference/com/google/android/gms/games/GamesClient.html#sendUnreliableRealTimeMessage(byte[], java.lang.String, java.lang.String)">sendUnreliableRealTimeMessage(byte[], String, String)</a></code> APIs (excluding protocol headers).
+ <code><a href="/reference/com/google/android/gms/games/GamesClient.html#sendUnreliableRealTimeMessage(byte[], java.lang.String, java.lang.String)">sendUnreliableRealTimeMessage(byte[], String, String)</a></code> methods (excluding protocol headers).
</p></div>
@@ -3342,8 +3358,8 @@ From interface
</div>
<div class="jd-details-descr">
- <div class="jd-tagdata jd-tagdescr"><p>Constant indicating that real-time room ID provided by the user is not a valid or it is
- not currently active real-time room.
+ <div class="jd-tagdata jd-tagdescr"><p>Constant indicating that the real-time room ID provided to the operation was not valid, or
+ does not correspond to the currently active real-time room.
</p></div>
@@ -3820,8 +3836,8 @@ From interface
</div>
<div class="jd-details-descr">
- <div class="jd-tagdata jd-tagdescr"><p>Status code returned from <code><a href="/reference/com/google/android/gms/games/GamesClient.html#sendUnreliableRealTimeMessage(byte[], java.lang.String, java.lang.String)">sendUnreliableRealTimeMessage(byte[], String, String)</a></code> and the
- <code><a href="/reference/com/google/android/gms/games/GamesClient.html#sendReliableRealTimeMessage(com.google.android.gms.games.multiplayer.realtime.RealTimeReliableMessageSentListener, byte[], java.lang.String, java.lang.String)">sendReliableRealTimeMessage(RealTimeReliableMessageSentListener, byte[], String, String)</a></code> APIs when the message send operation failed due to an
+ <div class="jd-tagdata jd-tagdescr"><p>Status code returned from the <code><a href="/reference/com/google/android/gms/games/GamesClient.html#sendUnreliableRealTimeMessage(byte[], java.lang.String, java.lang.String)">sendUnreliableRealTimeMessage(byte[], String, String)</a></code> and
+ <code><a href="/reference/com/google/android/gms/games/GamesClient.html#sendReliableRealTimeMessage(com.google.android.gms.games.multiplayer.realtime.RealTimeReliableMessageSentListener, byte[], java.lang.String, java.lang.String)">sendReliableRealTimeMessage(RealTimeReliableMessageSentListener, byte[], String, String)</a></code> methods when the message send operation failed due to an
immediate error.
</p></div>
@@ -4095,7 +4111,7 @@ From interface
<table class="jd-tagtable">
<tr>
<th>config</td>
- <td>the real-time room configuration.
+ <td>The real-time room configuration.
</td>
</tr>
</table>
@@ -4134,7 +4150,7 @@ From interface
<table class="jd-tagtable">
<tr>
<th>invitationId</td>
- <td>the ID of the invitation to decline.
+ <td>The ID of the invitation to decline.
</td>
</tr>
</table>
@@ -4204,7 +4220,7 @@ From interface
<table class="jd-tagtable">
<tr>
<th>invitationId</td>
- <td>the ID of the invitation to dismiss.
+ <td>The ID of the invitation to dismiss.
</td>
</tr>
</table>
@@ -4246,7 +4262,7 @@ From interface
state.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
- <ul class="nolist"><li>an <code><a href="/reference/android/content/Intent.html">Intent</a></code> that can be started to view the currently signed in player's
+ <ul class="nolist"><li>An <code><a href="/reference/android/content/Intent.html">Intent</a></code> that can be started to view the currently signed in player's
achievements.
</li></ul>
</div>
@@ -4287,7 +4303,7 @@ From interface
state.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
- <ul class="nolist"><li>an <code><a href="/reference/android/content/Intent.html">Intent</a></code> that can be started to view the list of leaderboards for a game.
+ <ul class="nolist"><li>An <code><a href="/reference/android/content/Intent.html">Intent</a></code> that can be started to view the list of leaderboards for a game.
</li></ul>
</div>
@@ -4378,6 +4394,41 @@ From interface
</div>
+<A NAME="getCurrentGame()"></A>
+
+<div class="jd-details api apilevel-">
+ <h4 class="jd-details-title">
+ <span class="normal">
+ public
+
+
+
+
+ <a href="/reference/com/google/android/gms/games/Game.html">Game</a>
+ </span>
+ <span class="sympad">getCurrentGame</span>
+ <span class="normal">()</span>
+ </h4>
+ <div class="api-level">
+ <div></div>
+
+
+
+ </div>
+ <div class="jd-details-descr">
+
+ <div class="jd-tagdata jd-tagdescr"><p></p></div>
+ <div class="jd-tagdata">
+ <h5 class="jd-tagtitle">Returns</h5>
+ <ul class="nolist"><li><code><a href="/reference/com/google/android/gms/games/Game.html">Game</a></code> metadata for the current game. May be null if the metadata is not
+ available locally.
+</li></ul>
+ </div>
+
+ </div>
+</div>
+
+
<A NAME="getCurrentPlayer()"></A>
<div class="jd-details api apilevel-">
@@ -4438,7 +4489,7 @@ From interface
<div class="jd-tagdata jd-tagdescr"><p></p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
- <ul class="nolist"><li>the player ID for the currently signed in player.
+ <ul class="nolist"><li>The player ID for the currently signed in player.
</li></ul>
</div>
@@ -4473,13 +4524,13 @@ From interface
that this must be invoked using <code><a href="/reference/android/app/Activity.html#startActivityForResult(android.content.Intent, int)">startActivityForResult(Intent, int)</a></code> so that
the identity of the calling package can be established.
<p>
- If the user canceled the result will be <code><a href="/reference/android/app/Activity.html#RESULT_CANCELED">RESULT_CANCELED</a></code>. If the user
+ If the user canceled, the result will be <code><a href="/reference/android/app/Activity.html#RESULT_CANCELED">RESULT_CANCELED</a></code>. If the user
selected an invitation to accept, the result will be <code><a href="/reference/android/app/Activity.html#RESULT_OK">RESULT_OK</a></code> and the data
intent will contain the selected invitation as a parcelable extra in
<code><a href="/reference/com/google/android/gms/games/GamesClient.html#EXTRA_INVITATION">EXTRA_INVITATION</a></code>.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
- <ul class="nolist"><li>an <code><a href="/reference/android/content/Intent.html">Intent</a></code> that can be started to view the invitation inbox UI.
+ <ul class="nolist"><li>An <code><a href="/reference/android/content/Intent.html">Intent</a></code> that can be started to view the invitation inbox UI.
</li></ul>
</div>
@@ -4528,7 +4579,7 @@ From interface
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
- <ul class="nolist"><li>an <code><a href="/reference/android/content/Intent.html">Intent</a></code> that can be started to view the specified leaderboard.
+ <ul class="nolist"><li>An <code><a href="/reference/android/content/Intent.html">Intent</a></code> that can be started to view the specified leaderboard.
</li></ul>
</div>
@@ -4573,13 +4624,13 @@ From interface
</tr>
<tr>
<th>participantId</td>
- <td>the ID of the participant to whom this socket is bound</td>
+ <td>The ID of the participant to whom this socket is bound</td>
</tr>
</table>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
- <ul class="nolist"><li>instance of a LocalSocket, or null on error.
+ <ul class="nolist"><li>An instance of a LocalSocket, or null on error.
</li></ul>
</div>
@@ -4626,8 +4677,18 @@ From interface
data intent containing a <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html">Room</a></code> object in <code><a href="/reference/com/google/android/gms/games/GamesClient.html#EXTRA_ROOM">EXTRA_ROOM</a></code> that represents
the current state of the Room that you originally passed as a parameter here.
<p>
- Note that the waiting room itself will never explicitly take any action to change
- the state of the room or its participants. So if the activity result is
+ If desired, the waiting room can allow the user to start playing the game even before
+ the room is fully connected. This is controlled by the <code>minParticipantsToStart</code>
+ parameter: if at least that many participants (including the current player) are
+ connected to the room, a "Start playing" menu item will become enabled in the waiting
+ room UI. Setting <code>minParticipantsToStart</code> to 0 means that "Start playing" will
+ always be available, and a value of <code><a href="/reference/java/lang/Integer.html#MAX_VALUE">MAX_VALUE</a></code> will disable the item
+ completely. Note: if you do allow the user to start early, you'll need to handle that
+ situation by explicitly telling the other connected peers that the game is now starting;
+ see the developer documentation for more details.
+ <p>
+ Finally, note that the waiting room itself will never explicitly take any action to
+ change the state of the room or its participants. So if the activity result is
<code><a href="/reference/com/google/android/gms/games/GamesActivityResultCodes.html#RESULT_LEFT_ROOM">RESULT_LEFT_ROOM</a></code>, it's the caller's responsibility
to actually leave the room. Or if the result is <code><a href="/reference/android/app/Activity.html#RESULT_CANCELED">RESULT_CANCELED</a></code>,
it's the responsibility of the caller to double-check the current state of the Room
@@ -4644,21 +4705,15 @@ From interface
</tr>
<tr>
<th>minParticipantsToStart</td>
- <td>the minimum number of participants that must
- be connected to the room (including the current player) before the
- "Start playing" option becomes enabled.
- <p>
- If this is 0, that means that "Start playing" will always be enabled.
- If it's equal to the maximum possible number of participants (including
- the current player <i>and</i> any auto-match participants) then the
- 'Start playing' option will never be enabled; instead the waiting room
- will exit automatically as soon as all participants are fully connected.</td>
+ <td>the minimum number of participants that must be
+ connected to the room (including the current player) for the "Start
+ playing" menu item to become enabled.</td>
</tr>
</table>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
- <ul class="nolist"><li>an <code><a href="/reference/android/content/Intent.html">Intent</a></code> that can be started to display the waiting room screen.</li></ul>
+ <ul class="nolist"><li>An <code><a href="/reference/android/content/Intent.html">Intent</a></code> that can be started to display the waiting room screen.</li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">See Also</h5>
@@ -4722,7 +4777,7 @@ From interface
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
- <ul class="nolist"><li>an <code><a href="/reference/android/content/Intent.html">Intent</a></code> that can be started to display the player selector.</li></ul>
+ <ul class="nolist"><li>An <code><a href="/reference/android/content/Intent.html">Intent</a></code> that can be started to display the player selector.</li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">See Also</h5>
@@ -4771,7 +4826,7 @@ From interface
menu item.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
- <ul class="nolist"><li>an <code><a href="/reference/android/content/Intent.html">Intent</a></code> that can be started to view the GamesClient Settings UI.
+ <ul class="nolist"><li>An <code><a href="/reference/android/content/Intent.html">Intent</a></code> that can be started to view the GamesClient Settings UI.
</li></ul>
</div>
@@ -4817,11 +4872,11 @@ From interface
<table class="jd-tagtable">
<tr>
<th>id</td>
- <td>the achievement ID to increment.</td>
+ <td>The achievement ID to increment.</td>
</tr>
<tr>
<th>numSteps</td>
- <td>the number of steps to increment by. Must be greater than 0.
+ <td>The number of steps to increment by. Must be greater than 0.
</td>
</tr>
</table>
@@ -4869,16 +4924,16 @@ From interface
<table class="jd-tagtable">
<tr>
<th>listener</td>
- <td>the listener that is called when the increment achievement is complete. The
+ <td>The listener that is called when the increment achievement is complete. The
listener is called on the main thread.</td>
</tr>
<tr>
<th>id</td>
- <td>the ID of the achievement to increment.</td>
+ <td>The ID of the achievement to increment.</td>
</tr>
<tr>
<th>numSteps</td>
- <td>the number of steps to increment by. Must be greater than 0.
+ <td>The number of steps to increment by. Must be greater than 0.
</td>
</tr>
</table>
@@ -4916,7 +4971,7 @@ From interface
client actions caused by the user with a call to this method.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
- <ul class="nolist"><li>true If the client is connected to the service.
+ <ul class="nolist"><li>true if the client is connected to the service.
</li></ul>
</div>
@@ -4950,7 +5005,7 @@ From interface
<div class="jd-tagdata jd-tagdescr"><p>Checks if the client is attempting to connect to the service.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
- <ul class="nolist"><li>true If the client is attempting to connect to the service.
+ <ul class="nolist"><li>true if the client is attempting to connect to the service.
</li></ul>
</div>
@@ -4994,7 +5049,7 @@ From interface
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
- <ul class="nolist"><li>true If the specified listener is currently registered to receive connection
+ <ul class="nolist"><li>true if the specified listener is currently registered to receive connection
events.</li></ul>
</div>
@@ -5038,7 +5093,7 @@ From interface
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
- <ul class="nolist"><li>true If the specified listener is currently registered to receive connection
+ <ul class="nolist"><li>true if the specified listener is currently registered to receive connection
failed events.</li></ul>
</div>
@@ -5080,7 +5135,7 @@ From interface
<table class="jd-tagtable">
<tr>
<th>config</td>
- <td>the real-time room configuration.
+ <td>The real-time room configuration.
</td>
</tr>
</table>
@@ -5121,7 +5176,7 @@ From interface
<table class="jd-tagtable">
<tr>
<th>listener</td>
- <td>the listener that is notified after the room has been left. The listener is
+ <td>The listener that is notified after the room has been left. The listener is
called on the main thread.</td>
</tr>
<tr>
@@ -5168,7 +5223,7 @@ From interface
<table class="jd-tagtable">
<tr>
<th>listener</td>
- <td>the listener that is called when the load is complete. The listener is called
+ <td>The listener that is called when the load is complete. The listener is called
on the main thread.
</td>
</tr>
@@ -5208,7 +5263,7 @@ From interface
<table class="jd-tagtable">
<tr>
<th>listener</td>
- <td>the listener that is called when the load is complete. The listener is called
+ <td>The listener that is called when the load is complete. The listener is called
on the main thread.
</td>
</tr>
@@ -5252,12 +5307,12 @@ From interface
<table class="jd-tagtable">
<tr>
<th>listener</td>
- <td>the listener that is called when the load is complete. The listener is called
+ <td>The listener that is called when the load is complete. The listener is called
on the main thread.</td>
</tr>
<tr>
<th>pageSize</td>
- <td>the number of entries to request for this initial page. Note that if cached
+ <td>The number of entries to request for this initial page. Note that if cached
data already exists, the returned buffer may contain more than this size, but it
is guaranteed to contain at least this many if the collection contains enough
records. This must be a value between 1 and 25.</td>
@@ -5309,7 +5364,7 @@ From interface
<table class="jd-tagtable">
<tr>
<th>listener</td>
- <td>the listener that is called when the load is complete. The listener is called
+ <td>The listener that is called when the load is complete. The listener is called
on the main thread.
</td>
</tr>
@@ -5352,7 +5407,7 @@ From interface
<table class="jd-tagtable">
<tr>
<th>listener</td>
- <td>the listener that is called when the load is complete. The listener is called
+ <td>The listener that is called when the load is complete. The listener is called
on the main thread.</td>
</tr>
<tr>
@@ -5399,7 +5454,7 @@ From interface
<table class="jd-tagtable">
<tr>
<th>listener</td>
- <td>the listener that is called when the load is complete. The listener is called
+ <td>The listener that is called when the load is complete. The listener is called
on the main thread.
</td>
</tr>
@@ -5443,12 +5498,12 @@ From interface
<table class="jd-tagtable">
<tr>
<th>listener</td>
- <td>the listener that is called when the load is complete. The listener is called
+ <td>The listener that is called when the load is complete. The listener is called
on the main thread.</td>
</tr>
<tr>
<th>pageSize</td>
- <td>the number of additional entries to request. This must be a value between 1
+ <td>The number of additional entries to request. This must be a value between 1
and 25.
</td>
</tr>
@@ -5492,12 +5547,12 @@ From interface
<table class="jd-tagtable">
<tr>
<th>listener</td>
- <td>the listener that is called when the load is complete. The listener is called
+ <td>The listener that is called when the load is complete. The listener is called
on the main thread.</td>
</tr>
<tr>
<th>buffer</td>
- <td>the existing buffer that will be expanded.</td>
+ <td>The existing buffer that will be expanded.</td>
</tr>
<tr>
<th>maxResults</td>
@@ -5505,8 +5560,8 @@ From interface
</tr>
<tr>
<th>pageDirection</td>
- <td>the direction to expand the buffer. Values are defined in
- <code><a href="/reference/com/google/android/gms/games/PageDirection.html">PageDirection</a></code>
+ <td>The direction to expand the buffer. Values are defined in
+ <code><a href="/reference/com/google/android/gms/games/PageDirection.html">PageDirection</a></code>.
</td>
</tr>
</table>
@@ -5548,12 +5603,12 @@ From interface
<table class="jd-tagtable">
<tr>
<th>listener</td>
- <td>the listener that is called when the load is complete. The listener is called
+ <td>The listener that is called when the load is complete. The listener is called
on the main thread.</td>
</tr>
<tr>
<th>playerId</td>
- <td>the player ID to get full profile data for.
+ <td>The player ID to get full profile data for.
</td>
</tr>
</table>
@@ -5596,7 +5651,7 @@ From interface
<table class="jd-tagtable">
<tr>
<th>listener</td>
- <td>the listener that is called when the load is complete. The listener is called
+ <td>The listener that is called when the load is complete. The listener is called
on the main thread.</td>
</tr>
<tr>
@@ -5668,7 +5723,7 @@ From interface
<table class="jd-tagtable">
<tr>
<th>listener</td>
- <td>the listener that is called when the load is complete. The listener is called
+ <td>The listener that is called when the load is complete. The listener is called
on the main thread.</td>
</tr>
<tr>
@@ -5732,7 +5787,7 @@ From interface
<table class="jd-tagtable">
<tr>
<th>listener</td>
- <td>the listener that is called when the load is complete. The listener is called
+ <td>The listener that is called when the load is complete. The listener is called
on the main thread.</td>
</tr>
<tr>
@@ -5901,9 +5956,10 @@ From interface
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Registers a listener to receive connection events from this <code>GooglePlayServicesClient</code>.
- If we are already connected, the listener's <code><a href="/reference/com/google/android/gms/common/GooglePlayServicesClient.ConnectionCallbacks.html#onConnected(android.os.Bundle)">onConnected(Bundle)</a></code> method
- will be called immediately. Applications should balance calls to this method with calls to
- <code><a href="/reference/com/google/android/gms/common/GooglePlayServicesClient.html#unregisterConnectionCallbacks(com.google.android.gms.common.GooglePlayServicesClient.ConnectionCallbacks)">unregisterConnectionCallbacks(ConnectionCallbacks)</a></code> to avoid leaking resources.
+ If the service is already connected, the listener's <code><a href="/reference/com/google/android/gms/common/GooglePlayServicesClient.ConnectionCallbacks.html#onConnected(android.os.Bundle)">onConnected(Bundle)</a></code>
+ method will be called immediately. Applications should balance calls to this method with
+ calls to <code><a href="/reference/com/google/android/gms/common/GooglePlayServicesClient.html#unregisterConnectionCallbacks(com.google.android.gms.common.GooglePlayServicesClient.ConnectionCallbacks)">unregisterConnectionCallbacks(ConnectionCallbacks)</a></code> to avoid leaking
+ resources.
<p>
If the specified listener is already registered to receive connection events, this
method will not add a duplicate entry for the same listener, but <strong>will</strong>
@@ -5952,11 +6008,12 @@ From interface
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Registers a listener to receive connection failed events from this
- <code>GooglePlayServicesClient</code>. Unlike <code><a href="/reference/com/google/android/gms/common/GooglePlayServicesClient.html#registerConnectionCallbacks(com.google.android.gms.common.GooglePlayServicesClient.ConnectionCallbacks)">registerConnectionCallbacks(GooglePlayServicesClient.ConnectionCallbacks)</a></code>, if we are not
- already connected, the listener's <code><a href="/reference/com/google/android/gms/common/GooglePlayServicesClient.OnConnectionFailedListener.html#onConnectionFailed(com.google.android.gms.common.ConnectionResult)">onConnectionFailed(ConnectionResult)</a></code>
- method will not be called immediately. Applications should balance calls to this method with
- calls to <code><a href="/reference/com/google/android/gms/common/GooglePlayServicesClient.html#unregisterConnectionFailedListener(com.google.android.gms.common.GooglePlayServicesClient.OnConnectionFailedListener)">unregisterConnectionFailedListener(OnConnectionFailedListener)</a></code> to avoid
- leaking resources.
+ <code>GooglePlayServicesClient</code>. Unlike <code><a href="/reference/com/google/android/gms/common/GooglePlayServicesClient.html#registerConnectionCallbacks(com.google.android.gms.common.GooglePlayServicesClient.ConnectionCallbacks)">registerConnectionCallbacks(GooglePlayServicesClient.ConnectionCallbacks)</a></code>, if the service
+ is not already connected, the listener's
+ <code><a href="/reference/com/google/android/gms/common/GooglePlayServicesClient.OnConnectionFailedListener.html#onConnectionFailed(com.google.android.gms.common.ConnectionResult)">onConnectionFailed(ConnectionResult)</a></code> method will not be called immediately.
+ Applications should balance calls to this method with calls to
+ <code><a href="/reference/com/google/android/gms/common/GooglePlayServicesClient.html#unregisterConnectionFailedListener(com.google.android.gms.common.GooglePlayServicesClient.OnConnectionFailedListener)">unregisterConnectionFailedListener(OnConnectionFailedListener)</a></code> to avoid leaking
+ resources.
<p>
If the specified listener is already registered to receive connection failed events, this
method will not add a duplicate entry for the same listener.
@@ -6013,7 +6070,7 @@ From interface
<table class="jd-tagtable">
<tr>
<th>listener</td>
- <td>the listener that is called when a new invitation is received. The listener
+ <td>The listener that is called when a new invitation is received. The listener
is called on the main thread.
</td>
</tr>
@@ -6061,7 +6118,7 @@ From interface
<table class="jd-tagtable">
<tr>
<th>id</td>
- <td>the achievement ID to reveal</td>
+ <td>The achievement ID to reveal</td>
</tr>
</table>
</div>
@@ -6112,12 +6169,12 @@ From interface
<table class="jd-tagtable">
<tr>
<th>listener</td>
- <td>the listener that is called when the reveal achievement is complete.
+ <td>The listener that is called when the reveal achievement is complete.
The listener is called on the main thread.</td>
</tr>
<tr>
<th>id</td>
- <td>the ID of the achievement to reveal</td>
+ <td>The ID of the achievement to reveal</td>
</tr>
</table>
</div>
@@ -6164,11 +6221,11 @@ From interface
<table class="jd-tagtable">
<tr>
<th>listener</td>
- <td>the listener that is notified when the message has been sent.</td>
+ <td>The listener that is notified when the message has been sent.</td>
</tr>
<tr>
<th>messageData</td>
- <td>the message to be sent. Should be at most
+ <td>The message to be sent. Should be at most
<code><a href="/reference/com/google/android/gms/games/GamesClient.html#MAX_RELIABLE_MESSAGE_LEN">MAX_RELIABLE_MESSAGE_LEN</a></code> bytes.</td>
</tr>
<tr>
@@ -6177,16 +6234,15 @@ From interface
</tr>
<tr>
<th>recipientParticipantId</td>
- <td>the participant ID to send the message to.</td>
+ <td>The participant ID to send the message to.</td>
</tr>
</table>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
- <ul class="nolist"><li>token for the message sent, which is returned in callback
+ <ul class="nolist"><li>The token for the message sent, which is returned in callback
<code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeReliableMessageSentListener.html#onRealTimeMessageSent(int, int, java.lang.String)">onRealTimeMessageSent(int, int, String)</a></code> or
<code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_REAL_TIME_MESSAGE_FAILED">STATUS_REAL_TIME_MESSAGE_FAILED</a></code> if the message failed to send.
-
</li></ul>
</div>
@@ -6227,7 +6283,7 @@ From interface
<table class="jd-tagtable">
<tr>
<th>messageData</td>
- <td>the message to be sent. Should be at most
+ <td>The message to be sent. Should be at most
<code><a href="/reference/com/google/android/gms/games/GamesClient.html#MAX_UNRELIABLE_MESSAGE_LEN">MAX_UNRELIABLE_MESSAGE_LEN</a></code> bytes.</td>
</tr>
<tr>
@@ -6284,7 +6340,7 @@ From interface
<table class="jd-tagtable">
<tr>
<th>messageData</td>
- <td>the message to be sent. Should be at most
+ <td>The message to be sent. Should be at most
<code><a href="/reference/com/google/android/gms/games/GamesClient.html#MAX_UNRELIABLE_MESSAGE_LEN">MAX_UNRELIABLE_MESSAGE_LEN</a></code> bytes.</td>
</tr>
<tr>
@@ -6293,7 +6349,7 @@ From interface
</tr>
<tr>
<th>recipientParticipantId</td>
- <td>the participant ID to send the message to.</td>
+ <td>The participant ID to send the message to.</td>
</tr>
</table>
</div>
@@ -6339,7 +6395,7 @@ From interface
<table class="jd-tagtable">
<tr>
<th>messageData</td>
- <td>the message to be sent. Should be at most
+ <td>The message to be sent. Should be at most
<code><a href="/reference/com/google/android/gms/games/GamesClient.html#MAX_UNRELIABLE_MESSAGE_LEN">MAX_UNRELIABLE_MESSAGE_LEN</a></code> bytes.</td>
</tr>
<tr>
@@ -6512,7 +6568,7 @@ From interface
<table class="jd-tagtable">
<tr>
<th>listener</td>
- <td>the listener that is called when sign-out is complete. The listener is called
+ <td>The listener that is called when sign-out is complete. The listener is called
on the main thread.
</td>
</tr>
@@ -6597,8 +6653,8 @@ From interface
</ul>
<p>
For more details, please see <a
- href="https://developers.google.com/games/services/common/concepts/leaderboards">this
- page</a>.</p></div>
+ href="https://developers.google.com/games/services/common/concepts/leaderboards">Leaderboard
+ Concepts</a>.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Parameters</h5>
<table class="jd-tagtable">
@@ -6731,7 +6787,7 @@ From interface
<table class="jd-tagtable">
<tr>
<th>id</td>
- <td>the achievement ID to unlock</td>
+ <td>The achievement ID to unlock</td>
</tr>
</table>
</div>
@@ -6782,12 +6838,12 @@ From interface
<table class="jd-tagtable">
<tr>
<th>listener</td>
- <td>the listener that is called when the unlock achievement is complete. The
+ <td>The listener that is called when the unlock achievement is complete. The
listener is called on the main thread.</td>
</tr>
<tr>
<th>id</td>
- <td>the ID of the achievement to unlock.</td>
+ <td>The ID of the achievement to unlock.</td>
</tr>
</table>
</div>