diff options
author | Dirk Dougherty <ddougherty@google.com> | 2013-06-28 14:04:39 -0700 |
---|---|---|
committer | Dirk Dougherty <ddougherty@google.com> | 2013-07-10 18:38:36 -0700 |
commit | 8f1a75972735032fdab859f053d6f1b2cad3d937 (patch) | |
tree | 96e76b265bb58a654e6d7613aebd8fd65d331b54 /docs/html/reference/com/google/android/gms/games/multiplayer/realtime | |
parent | 8451fc4f8660842b21e4ed3bddaedb0eb9490855 (diff) | |
download | frameworks_base-8f1a75972735032fdab859f053d6f1b2cad3d937.zip frameworks_base-8f1a75972735032fdab859f053d6f1b2cad3d937.tar.gz frameworks_base-8f1a75972735032fdab859f053d6f1b2cad3d937.tar.bz2 |
Doc change: Update gcore reference docs.
Change-Id: I9064969741598663ba7a732054ee378d3a14da7e
Diffstat (limited to 'docs/html/reference/com/google/android/gms/games/multiplayer/realtime')
5 files changed, 18 insertions, 19 deletions
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 64c6398..1b12a08 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 @@ -1547,7 +1547,7 @@ From interface room has no automatch properties.</p></div> <div class="jd-tagdata"> <h5 class="jd-tagtitle">Returns</h5> - <ul class="nolist"><li>bundle containing the automatch criteria for this room. + <ul class="nolist"><li>A bundle containing the automatch criteria for this room. </li></ul> </div> @@ -1928,8 +1928,8 @@ From interface <div class="jd-tagdata"> <h5 class="jd-tagtitle">Returns</h5> <ul class="nolist"><li>Variant specified for this room, if any. A variant is an optional - developer-controlled parameter describing the type of game to play, ranging from - 1-1023 (inclusive). If this room had no variant specified, returns + developer-controlled parameter describing the type of game to play. If specified, + this value will be a positive integer. If this room had no variant specified, returns <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#ROOM_VARIANT_ANY">ROOM_VARIANT_ANY</a></code>. </li></ul> </div> 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 373578b..df6fb49 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 @@ -1398,7 +1398,7 @@ From class <table class="jd-tagtable"> <tr> <th>invitationId</td> - <td>the ID of the invitation to accept. + <td>The ID of the invitation to accept. </td> </tr> </table> @@ -1440,7 +1440,7 @@ From class <table class="jd-tagtable"> <tr> <th>listener</td> - <td>the message received listener that is called to notify the client when it + <td>The message received listener that is called to notify the client when it receives a message in a room. The listener is called on the main thread. </td> </tr> @@ -1480,7 +1480,7 @@ From class <table class="jd-tagtable"> <tr> <th>listener</td> - <td>the listener that is called to notify the client when the status of the + <td>The listener that is called to notify the client when the status of the room has changed. The listener is called on the main thread. </td> </tr> @@ -1566,8 +1566,8 @@ From class <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 value from 1 to 1023 (inclusive), or + 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 93da6bb..926eeda 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 @@ -1317,15 +1317,15 @@ From class <table class="jd-tagtable"> <tr> <th>minAutoMatchPlayers</td> - <td>min number of auto-matched players.</td> + <td>Minimum number of auto-matched players.</td> </tr> <tr> <th>maxAutoMatchPlayers</td> - <td>max number of auto-matched players.</td> + <td>Maximum number of auto-matched players.</td> </tr> <tr> <th>exclusiveBitMask</td> - <td>exclusive bitmasks for the automatching request. The logical AND of + <td>Exclusive bitmasks for the automatching request. The logical AND of each pairing of automatching requests must equal zero for auto-match. If there are no exclusivity requirements for the game, this value should just be set to 0.</td> </tr> @@ -1333,7 +1333,7 @@ From class </div> <div class="jd-tagdata"> <h5 class="jd-tagtitle">Returns</h5> - <ul class="nolist"><li>bundle of auto-match criteria data. + <ul class="nolist"><li>A bundle of auto-match criteria data. </li></ul> </div> @@ -1470,7 +1470,7 @@ From class <div class="jd-tagdata jd-tagdescr"><p>Retrieves the listener for message received from a peer.</p></div> <div class="jd-tagdata"> <h5 class="jd-tagtitle">Returns</h5> - <ul class="nolist"><li>the <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessageReceivedListener.html">RealTimeMessageReceivedListener</a></code> that is called when the client has + <ul class="nolist"><li>The <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessageReceivedListener.html">RealTimeMessageReceivedListener</a></code> that is called when the client has received a message from a peer. </li></ul> </div> @@ -1571,8 +1571,7 @@ From class <div class="jd-details-descr"> <div class="jd-tagdata jd-tagdescr"><p>Retrieves the (optional) developer-controlled parameter describing the type of game to play. - Must be either a value from 1 to 1023 (inclusive), or <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#ROOM_VARIANT_ANY">ROOM_VARIANT_ANY</a></code> if not - desired.</p></div> + 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> if not desired.</p></div> <div class="jd-tagdata"> <h5 class="jd-tagtitle">Returns</h5> <ul class="nolist"><li>The developer-specified game variant. 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 e3772e2..7e6861b 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 @@ -2044,7 +2044,7 @@ From interface room has no automatch properties.</p></div> <div class="jd-tagdata"> <h5 class="jd-tagtitle">Returns</h5> - <ul class="nolist"><li>bundle containing the automatch criteria for this room. + <ul class="nolist"><li>A bundle containing the automatch criteria for this room. </li></ul> </div> @@ -2324,7 +2324,7 @@ From interface applicable to the given object.</p></div> <div class="jd-tagdata"> <h5 class="jd-tagtitle">Returns</h5> - <ul class="nolist"><li>a list of <code><a href="/reference/com/google/android/gms/games/multiplayer/Participant.html">Participant</a></code>s for this object. + <ul class="nolist"><li>A list of <code><a href="/reference/com/google/android/gms/games/multiplayer/Participant.html">Participant</a></code>s for this object. </li></ul> </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 45fd518..988cc0c 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 @@ -1059,7 +1059,7 @@ onkeyup="return search_changed(event, false, '/')" /> <table class="jd-tagtable"> <tr> <th>participantIds</td> - <td>ID of the peers invited to a room. + <td>IDs of the peers invited to a room. </td> </tr> </table> @@ -1098,7 +1098,7 @@ onkeyup="return search_changed(event, false, '/')" /> <table class="jd-tagtable"> <tr> <th>participantIds</td> - <td>ID of the peers invited to a room. + <td>IDs of the peers invited to a room. </td> </tr> </table> |