diff options
Diffstat (limited to 'docs/html/reference/com/google/android/gms/games/multiplayer/realtime')
11 files changed, 289 insertions, 98 deletions
diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessage.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessage.html index a5821f5..5a6d25c 100644 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessage.html +++ b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessage.html @@ -242,6 +242,8 @@ onkeyup="return search_changed(event, false, '/')" /> </div> <div class="child-card training no-display"> </div> + <div class="child-card samples no-display"> + </div> </div> <div class="suggest-card design no-display"> <ul class="search_filtered"> @@ -280,7 +282,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li><a href="/guide/components/index.html" + <li><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" @@ -351,7 +353,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li class="guide"><a href="/guide/components/index.html" + <li class="guide"><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessageReceivedListener.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessageReceivedListener.html index f1fb99d..9cf77f8 100644 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessageReceivedListener.html +++ b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessageReceivedListener.html @@ -242,6 +242,8 @@ onkeyup="return search_changed(event, false, '/')" /> </div> <div class="child-card training no-display"> </div> + <div class="child-card samples no-display"> + </div> </div> <div class="suggest-card design no-display"> <ul class="search_filtered"> @@ -280,7 +282,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li><a href="/guide/components/index.html" + <li><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" @@ -351,7 +353,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li class="guide"><a href="/guide/components/index.html" + <li class="guide"><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeReliableMessageSentListener.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeReliableMessageSentListener.html index 82b27ef..3f21050 100644 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeReliableMessageSentListener.html +++ b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeReliableMessageSentListener.html @@ -242,6 +242,8 @@ onkeyup="return search_changed(event, false, '/')" /> </div> <div class="child-card training no-display"> </div> + <div class="child-card samples no-display"> + </div> </div> <div class="suggest-card design no-display"> <ul class="search_filtered"> @@ -280,7 +282,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li><a href="/guide/components/index.html" + <li><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" @@ -351,7 +353,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li class="guide"><a href="/guide/components/index.html" + <li class="guide"><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeSocket.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeSocket.html index 86d51c5..b4878f0 100644 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeSocket.html +++ b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeSocket.html @@ -242,6 +242,8 @@ onkeyup="return search_changed(event, false, '/')" /> </div> <div class="child-card training no-display"> </div> + <div class="child-card samples no-display"> + </div> </div> <div class="suggest-card design no-display"> <ul class="search_filtered"> @@ -280,7 +282,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li><a href="/guide/components/index.html" + <li><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" @@ -351,7 +353,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li class="guide"><a href="/guide/components/index.html" + <li class="guide"><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" @@ -711,7 +713,7 @@ onkeyup="return search_changed(event, false, '/')" /> <h2>Class Overview</h2> <p itemprop="articleBody">Provides a Socket-like interface for a real-time data connection to a participant in a real-time - room. Use <code><a href="/reference/com/google/android/gms/games/GamesClient.html#getRealTimeSocketForParticipant(java.lang.String, java.lang.String)">getRealTimeSocketForParticipant(String, String)</a></code> to get an instance. + room. Use getSocketForParticipant(GoogleApiClient, String, String) to get an instance. <p> Use <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeSocket.html#getParcelFileDescriptor()">getParcelFileDescriptor()</a></code> to get a file descriptor for read/write, or use <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeSocket.html#getInputStream()">getInputStream()</a></code> / <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeSocket.html#getOutputStream()">getOutputStream()</a></code> to get @@ -724,7 +726,7 @@ onkeyup="return search_changed(event, false, '/')" /> The Socket-like interface provided is currently modeled on connection-based byte streams, rather than preserving packet semantics. That is, multiple writes may be coalesced or individual writes divided. Clients should avoid calling <code><a href="/reference/java/io/OutputStream.html#write(byte[])">write(byte[])</a></code> with more than - <code><a href="/reference/com/google/android/gms/games/GamesClient.html#MAX_UNRELIABLE_MESSAGE_LEN">MAX_UNRELIABLE_MESSAGE_LEN</a></code> bytes at a time. + MAX_UNRELIABLE_MESSAGE_LEN bytes at a time. </p> @@ -1028,18 +1030,18 @@ onkeyup="return search_changed(event, false, '/')" /> </div> <div class="jd-details-descr"> - <div class="jd-tagdata jd-tagdescr"><p>Instance of <code><a href="/reference/java/io/OutputStream.html">OutputStream</a></code> to write data to. - Calling close() on the OutputStream will close the socket. + <div class="jd-tagdata jd-tagdescr"><p>Instance of <code><a href="/reference/java/io/OutputStream.html">OutputStream</a></code> to write data to. Calling + <code><a href="/reference/java/io/OutputStream.html#close()">close()</a></code> on the OutputStream will close the socket. <p> Note: The maximum (unfragmented) packet size supported through this API is - <code><a href="/reference/com/google/android/gms/games/GamesClient.html#MAX_UNRELIABLE_MESSAGE_LEN">MAX_UNRELIABLE_MESSAGE_LEN</a></code> bytes (excluding internal protocol headers). - Thus, the byte[] data passed to <code><a href="/reference/java/io/OutputStream.html#write(byte[])">write(byte[])</a></code> should honor this limit or the - packet will be dropped and an error message will be sent to the log. + MAX_UNRELIABLE_MESSAGE_LEN bytes (excluding internal protocol headers). + Make sure that the byte[] data passed to <code><a href="/reference/java/io/OutputStream.html#write(byte[])">write(byte[])</a></code> honors this limit - + otherwise the packet will be dropped and an error message will be sent to the log. <p> - Do not call <code>flush()</code> on the <code>OutputStream</code> instance that you - obtained from this routine. To send each message as a single datagram, implement your own - message parsing logic to distinguish message boundaries. This allows partial messages and - a non-integral number of messages to be delivered using <code>RealTimeSocket</code>.</p></div> + Do not call <code>flush()</code> on the <code>OutputStream</code> instance that you obtained + from this routine. To send each message as a single datagram, implement your own message + parsing logic to distinguish message boundaries. This allows partial messages and a + non-integral number of messages to be delivered using <code>RealTimeSocket</code>.</p></div> <div class="jd-tagdata"> <h5 class="jd-tagtitle">Returns</h5> <ul class="nolist"><li>An instance of <code><a href="/reference/java/io/OutputStream.html">OutputStream</a></code>.</li></ul> diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/Room.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/Room.html index 5daba7f..5dbb533 100644 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/Room.html +++ b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/Room.html @@ -242,6 +242,8 @@ onkeyup="return search_changed(event, false, '/')" /> </div> <div class="child-card training no-display"> </div> + <div class="child-card samples no-display"> + </div> </div> <div class="suggest-card design no-display"> <ul class="search_filtered"> @@ -280,7 +282,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li><a href="/guide/components/index.html" + <li><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" @@ -351,7 +353,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li class="guide"><a href="/guide/components/index.html" + <li class="guide"><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" @@ -1070,6 +1072,24 @@ android.os.Parcelable + <a href="/reference/com/google/android/gms/games/multiplayer/Participant.html">Participant</a></nobr> + </td> + <td class="jd-linkcol" width="100%"><nobr> + <span class="sympad"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getParticipant(java.lang.String)">getParticipant</a></span>(String participantId)</nobr> + + <div class="jd-descrdiv">Get a participant in a room by its ID.</div> + + </td></tr> + + + + <tr class=" api apilevel-" > + <td class="jd-typecol"><nobr> + abstract + + + + String</nobr> </td> <td class="jd-linkcol" width="100%"><nobr> @@ -1081,7 +1101,7 @@ android.os.Parcelable - <tr class=" api apilevel-" > + <tr class="alt-color api apilevel-" > <td class="jd-typecol"><nobr> abstract @@ -1093,11 +1113,13 @@ android.os.Parcelable <td class="jd-linkcol" width="100%"><nobr> <span class="sympad"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getParticipantIds()">getParticipantIds</a></span>()</nobr> + <div class="jd-descrdiv">Get the IDs of the participants of the given room.</div> + </td></tr> - <tr class="alt-color api apilevel-" > + <tr class=" api apilevel-" > <td class="jd-typecol"><nobr> abstract @@ -1115,7 +1137,7 @@ android.os.Parcelable - <tr class=" api apilevel-" > + <tr class="alt-color api apilevel-" > <td class="jd-typecol"><nobr> abstract @@ -1131,7 +1153,7 @@ android.os.Parcelable - <tr class="alt-color api apilevel-" > + <tr class=" api apilevel-" > <td class="jd-typecol"><nobr> abstract @@ -1147,7 +1169,7 @@ android.os.Parcelable - <tr class=" api apilevel-" > + <tr class="alt-color api apilevel-" > <td class="jd-typecol"><nobr> abstract @@ -1720,7 +1742,9 @@ 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 ID of the participant who created this Room. + <ul class="nolist"><li>The ID of the participant who created this Room. Note that not all participants will + see the same value for the creator. In the case of an automatch, this value may + differ for each participant. </li></ul> </div> @@ -1801,6 +1825,59 @@ From interface </div> +<A NAME="getParticipant(java.lang.String)"></A> + +<div class="jd-details api apilevel-"> + <h4 class="jd-details-title"> + <span class="normal"> + public + + + abstract + + <a href="/reference/com/google/android/gms/games/multiplayer/Participant.html">Participant</a> + </span> + <span class="sympad">getParticipant</span> + <span class="normal">(String participantId)</span> + </h4> + <div class="api-level"> + <div></div> + + + + </div> + <div class="jd-details-descr"> + + <div class="jd-tagdata jd-tagdescr"><p>Get a participant in a room by its ID. Note that the participant ID must correspond to a + participant in this match, or this method will throw an exception.</p></div> + <div class="jd-tagdata"> + <h5 class="jd-tagtitle">Parameters</h5> + <table class="jd-tagtable"> + <tr> + <th>participantId</td> + <td>Match-local ID of the participant to retrieve status for.</td> + </tr> + </table> + </div> + <div class="jd-tagdata"> + <h5 class="jd-tagtitle">Returns</h5> + <ul class="nolist"><li>The participant corresponding to the given ID.</li></ul> + </div> + <div class="jd-tagdata"> + <h5 class="jd-tagtitle">Throws</h5> + <table class="jd-tagtable"> + <tr> + <th></td> + <td>IllegalStateException} if the participant is not a participant in this match. +</td> + </tr> + </table> + </div> + + </div> +</div> + + <A NAME="getParticipantId(java.lang.String)"></A> <div class="jd-details api apilevel-"> @@ -1869,7 +1946,7 @@ From interface </div> <div class="jd-details-descr"> - <div class="jd-tagdata jd-tagdescr"><p></p></div> + <div class="jd-tagdata jd-tagdescr"><p>Get the IDs of the participants of the given room.</p></div> <div class="jd-tagdata"> <h5 class="jd-tagtitle">Returns</h5> <ul class="nolist"><li>The IDs of the participants in this room. These are returned in the participant diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomConfig.Builder.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomConfig.Builder.html index f422aef..339f9d5 100644 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomConfig.Builder.html +++ b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomConfig.Builder.html @@ -242,6 +242,8 @@ onkeyup="return search_changed(event, false, '/')" /> </div> <div class="child-card training no-display"> </div> + <div class="child-card samples no-display"> + </div> </div> <div class="suggest-card design no-display"> <ul class="search_filtered"> @@ -280,7 +282,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li><a href="/guide/components/index.html" + <li><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" @@ -351,7 +353,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li class="guide"><a href="/guide/components/index.html" + <li class="guide"><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" @@ -969,7 +971,8 @@ Summary: <td class="jd-linkcol" width="100%"><nobr> <span class="sympad"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/RoomConfig.Builder.html#setVariant(int)">setVariant</a></span>(int variant)</nobr> - <div class="jd-descrdiv">Sets the variant for the room when calling <code><a href="/reference/com/google/android/gms/games/GamesClient.html#createRoom(com.google.android.gms.games.multiplayer.realtime.RoomConfig)">createRoom(RoomConfig)</a></code>.</div> + <div class="jd-descrdiv">Sets the variant for the room when calling + create(GoogleApiClient, RoomConfig).</div> </td></tr> @@ -1256,7 +1259,7 @@ From class <div class="jd-details-descr"> <div class="jd-tagdata jd-tagdescr"><p>Add one or more player IDs to invite to the room. This should be set only when calling - <code><a href="/reference/com/google/android/gms/games/GamesClient.html#createRoom(com.google.android.gms.games.multiplayer.realtime.RoomConfig)">createRoom(RoomConfig)</a></code></p></div> + create(GoogleApiClient, RoomConfig)</p></div> <div class="jd-tagdata"> <h5 class="jd-tagtitle">Parameters</h5> <table class="jd-tagtable"> @@ -1300,7 +1303,7 @@ From class <div class="jd-details-descr"> <div class="jd-tagdata jd-tagdescr"><p>Add a list of player IDs to invite to the room. This should be set only when calling - <code><a href="/reference/com/google/android/gms/games/GamesClient.html#createRoom(com.google.android.gms.games.multiplayer.realtime.RoomConfig)">createRoom(RoomConfig)</a></code></p></div> + create(GoogleApiClient, RoomConfig)</p></div> <div class="jd-tagdata"> <h5 class="jd-tagtitle">Parameters</h5> <table class="jd-tagtable"> @@ -1423,7 +1426,7 @@ From class <div class="jd-details-descr"> <div class="jd-tagdata jd-tagdescr"><p>Set the ID of the invitation to accept. This is required and should be set only when - calling <code><a href="/reference/com/google/android/gms/games/GamesClient.html#joinRoom(com.google.android.gms.games.multiplayer.realtime.RoomConfig)">joinRoom(RoomConfig)</a></code>.</p></div> + calling join(GoogleApiClient, RoomConfig).</p></div> <div class="jd-tagdata"> <h5 class="jd-tagtitle">Parameters</h5> <table class="jd-tagtable"> @@ -1546,12 +1549,15 @@ From class <div class="jd-details-descr"> <div class="jd-tagdata jd-tagdescr"><p>Sets whether to enable sockets for sending and receiving data. The socket for each - participant can be obtained using <code><a href="/reference/com/google/android/gms/games/GamesClient.html#getRealTimeSocketForParticipant(java.lang.String, java.lang.String)">getRealTimeSocketForParticipant(String, String)</a></code>. If - false 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> API should be used to send - messages. + participant can be obtained using + getSocketForParticipant(GoogleApiClient, String, String). If + false the + sendUnreliableMessage(GoogleApiClient, byte[], String, String) + API should be used to send messages. <p> - Note that for reliable messages, 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> API - should still be used. Reliable messages will be delivered via the + Note that for reliable messages, the + sendReliableMessage(GoogleApiClient, ReliableMessageSentCallback, byte[], String, String) + API should still be used. Reliable messages will be delivered via the <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessageReceivedListener.html">RealTimeMessageReceivedListener</a></code> registered with <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/RoomConfig.Builder.html#setMessageReceivedListener(com.google.android.gms.games.multiplayer.realtime.RealTimeMessageReceivedListener)">setMessageReceivedListener(RealTimeMessageReceivedListener)</a></code>.</p></div> <div class="jd-tagdata"> @@ -1596,9 +1602,10 @@ From class </div> <div class="jd-details-descr"> - <div class="jd-tagdata jd-tagdescr"><p>Sets the variant for the room when calling <code><a href="/reference/com/google/android/gms/games/GamesClient.html#createRoom(com.google.android.gms.games.multiplayer.realtime.RoomConfig)">createRoom(RoomConfig)</a></code>. This is an - optional, developer-controlled parameter describing the type of game to play, and is used - for auto-matching criteria. Must be either a positive integer or + <div class="jd-tagdata jd-tagdescr"><p>Sets the variant for the room when calling + create(GoogleApiClient, RoomConfig). This is an optional, + developer-controlled parameter describing the type of game to play, and is used for + auto-matching criteria. Must be either a positive integer or <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#ROOM_VARIANT_ANY">ROOM_VARIANT_ANY</a></code> (the default) if not desired.</p></div> <div class="jd-tagdata"> <h5 class="jd-tagtitle">Parameters</h5> diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomConfig.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomConfig.html index 305bf58..304fbb3 100644 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomConfig.html +++ b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomConfig.html @@ -242,6 +242,8 @@ onkeyup="return search_changed(event, false, '/')" /> </div> <div class="child-card training no-display"> </div> + <div class="child-card samples no-display"> + </div> </div> <div class="suggest-card design no-display"> <ul class="search_filtered"> @@ -280,7 +282,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li><a href="/guide/components/index.html" + <li><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" @@ -351,7 +353,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li class="guide"><a href="/guide/components/index.html" + <li class="guide"><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" @@ -1429,7 +1431,7 @@ From class <div class="jd-details-descr"> <div class="jd-tagdata jd-tagdescr"><p>Retrieves the ID of the invitation to accept, if any. This is necessary when calling - <code><a href="/reference/com/google/android/gms/games/GamesClient.html#joinRoom(com.google.android.gms.games.multiplayer.realtime.RoomConfig)">joinRoom(RoomConfig)</a></code>.</p></div> + join(GoogleApiClient, RoomConfig).</p></div> <div class="jd-tagdata"> <h5 class="jd-tagtitle">Returns</h5> <ul class="nolist"><li>The ID of the invitation to accept. diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomEntity.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomEntity.html index 5457464..4855bba 100644 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomEntity.html +++ b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomEntity.html @@ -242,6 +242,8 @@ onkeyup="return search_changed(event, false, '/')" /> </div> <div class="child-card training no-display"> </div> + <div class="child-card samples no-display"> + </div> </div> <div class="suggest-card design no-display"> <ul class="search_filtered"> @@ -280,7 +282,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li><a href="/guide/components/index.html" + <li><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" @@ -351,7 +353,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li class="guide"><a href="/guide/components/index.html" + <li class="guide"><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" @@ -1157,6 +1159,24 @@ android.os.Parcelable + <a href="/reference/com/google/android/gms/games/multiplayer/Participant.html">Participant</a></nobr> + </td> + <td class="jd-linkcol" width="100%"><nobr> + <span class="sympad"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/RoomEntity.html#getParticipant(java.lang.String)">getParticipant</a></span>(String participantId)</nobr> + + <div class="jd-descrdiv">Get a participant in a room by its ID.</div> + + </td></tr> + + + + <tr class="alt-color api apilevel-" > + <td class="jd-typecol"><nobr> + + + + + String</nobr> </td> <td class="jd-linkcol" width="100%"><nobr> @@ -1168,7 +1188,7 @@ android.os.Parcelable - <tr class="alt-color api apilevel-" > + <tr class=" api apilevel-" > <td class="jd-typecol"><nobr> @@ -1180,11 +1200,13 @@ android.os.Parcelable <td class="jd-linkcol" width="100%"><nobr> <span class="sympad"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/RoomEntity.html#getParticipantIds()">getParticipantIds</a></span>()</nobr> + <div class="jd-descrdiv">Get the IDs of the participants of the given room.</div> + </td></tr> - <tr class=" api apilevel-" > + <tr class="alt-color api apilevel-" > <td class="jd-typecol"><nobr> @@ -1202,7 +1224,7 @@ android.os.Parcelable - <tr class="alt-color api apilevel-" > + <tr class=" api apilevel-" > <td class="jd-typecol"><nobr> @@ -1220,7 +1242,7 @@ android.os.Parcelable - <tr class=" api apilevel-" > + <tr class="alt-color api apilevel-" > <td class="jd-typecol"><nobr> @@ -1236,7 +1258,7 @@ android.os.Parcelable - <tr class="alt-color api apilevel-" > + <tr class=" api apilevel-" > <td class="jd-typecol"><nobr> @@ -1252,7 +1274,7 @@ android.os.Parcelable - <tr class=" api apilevel-" > + <tr class="alt-color api apilevel-" > <td class="jd-typecol"><nobr> @@ -1268,7 +1290,7 @@ android.os.Parcelable - <tr class="alt-color api apilevel-" > + <tr class=" api apilevel-" > <td class="jd-typecol"><nobr> @@ -1284,7 +1306,7 @@ android.os.Parcelable - <tr class=" api apilevel-" > + <tr class="alt-color api apilevel-" > <td class="jd-typecol"><nobr> @@ -1302,7 +1324,7 @@ android.os.Parcelable - <tr class="alt-color api apilevel-" > + <tr class=" api apilevel-" > <td class="jd-typecol"><nobr> @@ -1318,7 +1340,7 @@ android.os.Parcelable - <tr class=" api apilevel-" > + <tr class="alt-color api apilevel-" > <td class="jd-typecol"><nobr> @@ -1845,6 +1867,24 @@ From interface + <a href="/reference/com/google/android/gms/games/multiplayer/Participant.html">Participant</a></nobr> + </td> + <td class="jd-linkcol" width="100%"><nobr> + <span class="sympad"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getParticipant(java.lang.String)">getParticipant</a></span>(String participantId)</nobr> + + <div class="jd-descrdiv">Get a participant in a room by its ID.</div> + + </td></tr> + + + + <tr class=" api apilevel-" > + <td class="jd-typecol"><nobr> + abstract + + + + String</nobr> </td> <td class="jd-linkcol" width="100%"><nobr> @@ -1856,7 +1896,7 @@ From interface - <tr class=" api apilevel-" > + <tr class="alt-color api apilevel-" > <td class="jd-typecol"><nobr> abstract @@ -1868,11 +1908,13 @@ From interface <td class="jd-linkcol" width="100%"><nobr> <span class="sympad"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getParticipantIds()">getParticipantIds</a></span>()</nobr> + <div class="jd-descrdiv">Get the IDs of the participants of the given room.</div> + </td></tr> - <tr class="alt-color api apilevel-" > + <tr class=" api apilevel-" > <td class="jd-typecol"><nobr> abstract @@ -1890,7 +1932,7 @@ From interface - <tr class=" api apilevel-" > + <tr class="alt-color api apilevel-" > <td class="jd-typecol"><nobr> abstract @@ -1906,7 +1948,7 @@ From interface - <tr class="alt-color api apilevel-" > + <tr class=" api apilevel-" > <td class="jd-typecol"><nobr> abstract @@ -1922,7 +1964,7 @@ From interface - <tr class=" api apilevel-" > + <tr class="alt-color api apilevel-" > <td class="jd-typecol"><nobr> abstract @@ -2323,6 +2365,49 @@ From interface </div> +<A NAME="getParticipant(java.lang.String)"></A> + +<div class="jd-details api apilevel-"> + <h4 class="jd-details-title"> + <span class="normal"> + public + + + + + <a href="/reference/com/google/android/gms/games/multiplayer/Participant.html">Participant</a> + </span> + <span class="sympad">getParticipant</span> + <span class="normal">(String participantId)</span> + </h4> + <div class="api-level"> + <div></div> + + + + </div> + <div class="jd-details-descr"> + + <div class="jd-tagdata jd-tagdescr"><p>Get a participant in a room by its ID. Note that the participant ID must correspond to a + participant in this match, or this method will throw an exception.</p></div> + <div class="jd-tagdata"> + <h5 class="jd-tagtitle">Parameters</h5> + <table class="jd-tagtable"> + <tr> + <th>participantId</td> + <td>Match-local ID of the participant to retrieve status for.</td> + </tr> + </table> + </div> + <div class="jd-tagdata"> + <h5 class="jd-tagtitle">Returns</h5> + <ul class="nolist"><li>The participant corresponding to the given ID.</li></ul> + </div> + + </div> +</div> + + <A NAME="getParticipantId(java.lang.String)"></A> <div class="jd-details api apilevel-"> @@ -2391,7 +2476,13 @@ From interface </div> <div class="jd-details-descr"> - <div class="jd-tagdata jd-tagdescr"><p></p></div> + <div class="jd-tagdata jd-tagdescr"><p>Get the IDs of the participants of the given room.</p></div> + <div class="jd-tagdata"> + <h5 class="jd-tagtitle">Returns</h5> + <ul class="nolist"><li>The IDs of the participants in this room. These are returned in the participant + order of the room. Note that these are not stable across rooms. +</li></ul> + </div> </div> </div> diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomStatusUpdateListener.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomStatusUpdateListener.html index bc4b593..90492db 100644 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomStatusUpdateListener.html +++ b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomStatusUpdateListener.html @@ -242,6 +242,8 @@ onkeyup="return search_changed(event, false, '/')" /> </div> <div class="child-card training no-display"> </div> + <div class="child-card samples no-display"> + </div> </div> <div class="suggest-card design no-display"> <ul class="search_filtered"> @@ -280,7 +282,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li><a href="/guide/components/index.html" + <li><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" @@ -351,7 +353,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li class="guide"><a href="/guide/components/index.html" + <li class="guide"><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomUpdateListener.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomUpdateListener.html index 8836837..b2d518a 100644 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomUpdateListener.html +++ b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomUpdateListener.html @@ -242,6 +242,8 @@ onkeyup="return search_changed(event, false, '/')" /> </div> <div class="child-card training no-display"> </div> + <div class="child-card samples no-display"> + </div> </div> <div class="suggest-card design no-display"> <ul class="search_filtered"> @@ -280,7 +282,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li><a href="/guide/components/index.html" + <li><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" @@ -351,7 +353,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li class="guide"><a href="/guide/components/index.html" + <li class="guide"><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" @@ -913,17 +915,18 @@ onkeyup="return search_changed(event, false, '/')" /> </div> <div class="jd-details-descr"> - <div class="jd-tagdata jd-tagdescr"><p>Called when the client attempts to join a real-time room. The real-time room can be joined - by calling the <code><a href="/reference/com/google/android/gms/games/GamesClient.html#joinRoom(com.google.android.gms.games.multiplayer.realtime.RoomConfig)">joinRoom(RoomConfig)</a></code> operation. - Possible status codes include: + <div class="jd-tagdata jd-tagdescr"><p>Called when the client attempts to join a real-time room. The real-time room can be joined by + calling the join(GoogleApiClient, RoomConfig) operation. Possible status codes include: <ul> <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_OK">STATUS_OK</a></code> if data was successfully loaded and is up-to-date.</li> - <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_CLIENT_RECONNECT_REQUIRED">STATUS_CLIENT_RECONNECT_REQUIRED</a></code> if the <code><a href="/reference/com/google/android/gms/games/GamesClient.html">GamesClient</a></code> needs to - reconnect to the service to access this data.</li> - <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_REAL_TIME_CONNECTION_FAILED">STATUS_REAL_TIME_CONNECTION_FAILED</a></code> if the client failed - to connect to the network</li> - <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_INTERNAL_ERROR">STATUS_INTERNAL_ERROR</a></code> if an unexpected error occurred in the - service.</li> + <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_CLIENT_RECONNECT_REQUIRED">STATUS_CLIENT_RECONNECT_REQUIRED</a></code> if the client needs to reconnect to + the service to access this data.</li> + <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_REAL_TIME_CONNECTION_FAILED">STATUS_REAL_TIME_CONNECTION_FAILED</a></code> if the client failed to connect to + the network</li> + <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_MULTIPLAYER_DISABLED">STATUS_MULTIPLAYER_DISABLED</a></code> if the game does not support multiplayer. + </li> + <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_INTERNAL_ERROR">STATUS_INTERNAL_ERROR</a></code> if an unexpected error occurred in the service. + </li> </ul></p></div> <div class="jd-tagdata"> <h5 class="jd-tagtitle">Parameters</h5> @@ -935,7 +938,7 @@ onkeyup="return search_changed(event, false, '/')" /> <tr> <th>room</td> <td>The data of the room that was joined. The room can be <code>null</code> if the - <code><a href="/reference/com/google/android/gms/games/GamesClient.html#joinRoom(com.google.android.gms.games.multiplayer.realtime.RoomConfig)">joinRoom(RoomConfig)</a></code> operation failed. + join(GoogleApiClient, RoomConfig) operation failed. </td> </tr> </table> @@ -968,12 +971,11 @@ onkeyup="return search_changed(event, false, '/')" /> </div> <div class="jd-details-descr"> - <div class="jd-tagdata jd-tagdescr"><p>Called when the client attempts to leaves the real-time room. - Possible status codes include: + <div class="jd-tagdata jd-tagdescr"><p>Called when the client attempts to leaves the real-time room. Possible status codes include: <ul> <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_OK">STATUS_OK</a></code> if operation was successfully completed.</li> - <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_INTERNAL_ERROR">STATUS_INTERNAL_ERROR</a></code> if an unexpected error occurred in the - service.</li> + <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_INTERNAL_ERROR">STATUS_INTERNAL_ERROR</a></code> if an unexpected error occurred in the service. + </li> </ul></p></div> <div class="jd-tagdata"> <h5 class="jd-tagtitle">Parameters</h5> @@ -1018,14 +1020,14 @@ onkeyup="return search_changed(event, false, '/')" /> <div class="jd-details-descr"> <div class="jd-tagdata jd-tagdescr"><p>Called when all the participants in a real-time room are fully connected. This gets called - once all invitations are accepted and any necessary automatching has been completed - Possible status codes include: + once all invitations are accepted and any necessary automatching has been completed. Possible + status codes include: <ul> <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_OK">STATUS_OK</a></code> if data was successfully loaded and is up-to-date.</li> - <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_CLIENT_RECONNECT_REQUIRED">STATUS_CLIENT_RECONNECT_REQUIRED</a></code> if the <code><a href="/reference/com/google/android/gms/games/GamesClient.html">GamesClient</a></code> needs to - reconnect to the service to access this data.</li> - <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_INTERNAL_ERROR">STATUS_INTERNAL_ERROR</a></code> if an unexpected error occurred in the - service.</li> + <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_CLIENT_RECONNECT_REQUIRED">STATUS_CLIENT_RECONNECT_REQUIRED</a></code> if the client needs to reconnect to + the service to access this data.</li> + <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_INTERNAL_ERROR">STATUS_INTERNAL_ERROR</a></code> if an unexpected error occurred in the service. + </li> </ul></p></div> <div class="jd-tagdata"> <h5 class="jd-tagtitle">Parameters</h5> @@ -1033,7 +1035,7 @@ onkeyup="return search_changed(event, false, '/')" /> <tr> <th>room</td> <td>The fully connected room object. The room can be <code>null</code> if it could not be - loaded successfully. + loaded successfully. </td> </tr> </table> @@ -1067,16 +1069,17 @@ onkeyup="return search_changed(event, false, '/')" /> <div class="jd-details-descr"> <div class="jd-tagdata jd-tagdescr"><p>Called when the client attempts to create a real-time room. The real-time room can be created - by calling the <code><a href="/reference/com/google/android/gms/games/GamesClient.html#createRoom(com.google.android.gms.games.multiplayer.realtime.RoomConfig)">createRoom(RoomConfig)</a></code> operation. - Possible status codes include: + by calling the create(GoogleApiClient, RoomConfig) operation. Possible status codes include: <ul> <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_OK">STATUS_OK</a></code> if data was successfully loaded and is up-to-date.</li> - <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_CLIENT_RECONNECT_REQUIRED">STATUS_CLIENT_RECONNECT_REQUIRED</a></code> if the <code><a href="/reference/com/google/android/gms/games/GamesClient.html">GamesClient</a></code> needs to - reconnect to the service to access this data.</li> + <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_CLIENT_RECONNECT_REQUIRED">STATUS_CLIENT_RECONNECT_REQUIRED</a></code> if the client needs to reconnect to + the service to access this data.</li> <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_REAL_TIME_CONNECTION_FAILED">STATUS_REAL_TIME_CONNECTION_FAILED</a></code> if the client failed to connect to the network</li> - <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_INTERNAL_ERROR">STATUS_INTERNAL_ERROR</a></code> if an unexpected error occurred in the - service.</li> + <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_MULTIPLAYER_DISABLED">STATUS_MULTIPLAYER_DISABLED</a></code> if the game does not support multiplayer. + </li> + <li><code><a href="/reference/com/google/android/gms/games/GamesClient.html#STATUS_INTERNAL_ERROR">STATUS_INTERNAL_ERROR</a></code> if an unexpected error occurred in the service. + </li> </ul></p></div> <div class="jd-tagdata"> <h5 class="jd-tagtitle">Parameters</h5> @@ -1088,8 +1091,7 @@ onkeyup="return search_changed(event, false, '/')" /> <tr> <th>room</td> <td>The room data that was created if successful. The room can be <code>null</code> if the - <code><a href="/reference/com/google/android/gms/games/GamesClient.html#createRoom(com.google.android.gms.games.multiplayer.realtime.RoomConfig)">createRoom(RoomConfig)</a></code> operation failed. - + create(GoogleApiClient, RoomConfig) operation failed. </td> </tr> </table> diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/package-summary.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/package-summary.html index 20da1fe..b6548ab 100644 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/package-summary.html +++ b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/package-summary.html @@ -243,6 +243,8 @@ onkeyup="return search_changed(event, false, '/')" /> </div> <div class="child-card training no-display"> </div> + <div class="child-card samples no-display"> + </div> </div> <div class="suggest-card design no-display"> <ul class="search_filtered"> @@ -281,7 +283,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li><a href="/guide/components/index.html" + <li><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" @@ -352,7 +354,7 @@ onkeyup="return search_changed(event, false, '/')" /> ja-lang="トレーニング" es-lang="Capacitación" >Training</a></li> - <li class="guide"><a href="/guide/components/index.html" + <li class="guide"><a href="/guide/index.html" zh-tw-lang="API 指南" zh-cn-lang="API 指南" ru-lang="Руководства по API" |