Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / frameworks / base / dc5e02bdccbbc60ede21ae706f06c696b6983812 / . / docs / html / reference / com / google / android / gms / games / multiplayer / realtime / Room.html
blob: a317f76bbedd9bc903fc5461cad125f2fbf26fe6 [file] [log] [blame]
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1<!DOCTYPE html>
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]76
77
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]78<html>
79<head>
80
81
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]82<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
83<meta name="viewport" content="width=device-width" />
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]84
85<link rel="shortcut icon" type="image/x-icon" href="/favicon.ico" />
86<title>Room | Android Developers</title>
87
88<!-- STYLESHEETS -->
89<link rel="stylesheet"
90href="//fonts.googleapis.com/css?family=Roboto:regular,medium,thin,italic,mediumitalic,bold" title="roboto">
91<link href="/assets/css/default.css" rel="stylesheet" type="text/css">
92
93
94
95<!-- JAVASCRIPT -->
96<script src="//www.google.com/jsapi" type="text/javascript"></script>
97<script src="/assets/js/android_3p-bundle.js" type="text/javascript"></script>
98<script type="text/javascript">
99 var toRoot = "/";
100 var devsite = false;
101</script>
102<script src="/assets/js/docs.js" type="text/javascript"></script>
103
104<script type="text/javascript">
105 var _gaq = _gaq || [];
106 _gaq.push(['_setAccount', 'UA-5831155-1']);
107 _gaq.push(['_trackPageview']);
108
109 (function() {
110 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
111 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
112 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
113 })();
114</script>
115</head>
116<body class="gc-documentation google
117 develop" itemscope itemtype="http://schema.org/Article">
118 <div id="doc-api-level" class="" style="display:none"></div>
119 <a name="top"></a>
120
121<a name="top"></a>
122
123 <!-- Header -->
124 <div id="header">
125 <div class="wrap" id="header-wrap">
126 <div class="col-3 logo">
127 <a href="/index.html">
128 <img src="/assets/images/dac_logo.png" width="123" height="25" alt="Android Developers" />
129 </a>
130 <div class="btn-quicknav" id="btn-quicknav">
131 <a href="#" class="arrow-inactive">Quicknav</a>
132 <a href="#" class="arrow-active">Quicknav</a>
133 </div>
134 </div>
135 <ul class="nav-x col-9">
136 <li class="design">
137 <a href="/design/index.html"
138 zh-tw-lang="設計"
139 zh-cn-lang="设计"
140 ru-lang="Проектирование"
141 ko-lang="디자인"
142 ja-lang="設計"
143 es-lang="Diseñar"
144 >Design</a></li>
145 <li class="develop"><a href="/develop/index.html"
146 zh-tw-lang="開發"
147 zh-cn-lang="开发"
148 ru-lang="Разработка"
149 ko-lang="개발"
150 ja-lang="開発"
151 es-lang="Desarrollar"
152 >Develop</a></li>
153 <li class="distribute last"><a href="/distribute/index.html"
154 zh-tw-lang="發佈"
155 zh-cn-lang="分发"
156 ru-lang="Распространение"
157 ko-lang="배포"
158 ja-lang="配布"
159 es-lang="Distribuir"
160 >Distribute</a></li>
161 </ul>
162
163 <!-- New Search -->
164 <div class="menu-container">
165 <div class="moremenu">
166 <div id="more-btn"></div>
167 </div>
168 <div class="morehover" id="moremenu">
169 <div class="top"></div>
170 <div class="mid">
171 <div class="header">Links</div>
172 <ul>
173 <li><a href="https://play.google.com/apps/publish/">Google Play Developer Console</a></li>
174 <li><a href="http://android-developers.blogspot.com/">Android Developers Blog</a></li>
175 <li><a href="/about/index.html">About Android</a></li>
176 </ul>
177 <div class="header">Android Sites</div>
178 <ul>
179 <li><a href="http://www.android.com">Android.com</a></li>
180 <li class="active"><a>Android Developers</a></li>
181 <li><a href="http://source.android.com">Android Open Source Project</a></li>
182 </ul>
183
184
185
186 <div class="header">Language</div>
187 <div id="language" class="locales">
188 <select name="language" onChange="changeLangPref(this.value, true)">
189 <option value="en">English</option>
190 <option value="es">Español</option>
191 <option value="ja">日本語</option>
192 <option value="ko">한국어</option>
193 <option value="ru">Русский</option>
194 <option value="zh-cn">中文 (中国)</option>
195 <option value="zh-tw">中文 (台灣)</option>
196 </select>
197 </div>
198 <script type="text/javascript">
199 <!--
200 loadLangPref();
201 //-->
202 </script>
203
204
205
206
207 <br class="clearfix" />
208 </div>
209 <div class="bottom"></div>
210 </div>
211 <div class="search" id="search-container">
212 <div class="search-inner">
213 <div id="search-btn"></div>
214 <div class="left"></div>
215 <form onsubmit="return submit_search()">
216 <input id="search_autocomplete" type="text" value="" autocomplete="off" name="q"
217onfocus="search_focus_changed(this, true)" onblur="search_focus_changed(this, false)"
218onkeydown="return search_changed(event, true, '/')"
219onkeyup="return search_changed(event, false, '/')" />
220 </form>
221 <div class="right"></div>
222 <a class="close hide">close</a>
223 <div class="left"></div>
224 <div class="right"></div>
225 </div>
226 </div>
227
228 <div class="search_filtered_wrapper reference">
229 <div class="suggest-card reference no-display">
230 <ul class="search_filtered">
231 </ul>
232 </div>
233 </div>
234
235 <div class="search_filtered_wrapper docs">
236 <div class="suggest-card dummy no-display">&nbsp;</div>
237 <div class="suggest-card develop no-display">
238 <ul class="search_filtered">
239 </ul>
240 <div class="child-card guides no-display">
241 </div>
242 <div class="child-card training no-display">
243 </div>
244 </div>
245 <div class="suggest-card design no-display">
246 <ul class="search_filtered">
247 </ul>
248 </div>
249 <div class="suggest-card distribute no-display">
250 <ul class="search_filtered">
251 </ul>
252 </div>
253 </div>
254
255 </div>
256 <!-- /New Search>
257
258
259 <!-- Expanded quicknav -->
260 <div id="quicknav" class="col-9">
261 <ul>
262 <li class="design">
263 <ul>
264 <li><a href="/design/index.html">Get Started</a></li>
265 <li><a href="/design/style/index.html">Style</a></li>
266 <li><a href="/design/patterns/index.html">Patterns</a></li>
267 <li><a href="/design/building-blocks/index.html">Building Blocks</a></li>
268 <li><a href="/design/downloads/index.html">Downloads</a></li>
269 <li><a href="/design/videos/index.html">Videos</a></li>
270 </ul>
271 </li>
272 <li class="develop">
273 <ul>
274 <li><a href="/training/index.html"
275 zh-tw-lang="訓練課程"
276 zh-cn-lang="培训"
277 ru-lang="Курсы"
278 ko-lang="교육"
279 ja-lang="トレーニング"
280 es-lang="Capacitación"
281 >Training</a></li>
282 <li><a href="/guide/components/index.html"
283 zh-tw-lang="API 指南"
284 zh-cn-lang="API 指南"
285 ru-lang="Руководства по API"
286 ko-lang="API 가이드"
287 ja-lang="API ガイド"
288 es-lang="Guías de la API"
289 >API Guides</a></li>
290 <li><a href="/reference/packages.html"
291 zh-tw-lang="參考資源"
292 zh-cn-lang="参考"
293 ru-lang="Справочник"
294 ko-lang="참조문서"
295 ja-lang="リファレンス"
296 es-lang="Referencia"
297 >Reference</a></li>
298 <li><a href="/tools/index.html"
299 zh-tw-lang="相關工具"
300 zh-cn-lang="工具"
301 ru-lang="Инструменты"
302 ko-lang="도구"
303 ja-lang="ツール"
304 es-lang="Herramientas"
305 >Tools</a>
306 <ul><li><a href="/sdk/index.html">Get the SDK</a></li></ul>
307 </li>
308 <li><a href="/google/index.html">Google Services</a>
309 </li>
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]310
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]311 </ul>
312 </li>
313 <li class="distribute last">
314 <ul>
315 <li><a href="/distribute/index.html">Google Play</a></li>
316 <li><a href="/distribute/googleplay/publish/index.html">Publishing</a></li>
317 <li><a href="/distribute/googleplay/promote/index.html">Promoting</a></li>
318 <li><a href="/distribute/googleplay/quality/index.html">App Quality</a></li>
319 <li><a href="/distribute/googleplay/spotlight/index.html">Spotlight</a></li>
320 <li><a href="/distribute/open.html">Open Distribution</a></li>
321 </ul>
322 </li>
323 </ul>
324 </div>
325 <!-- /Expanded quicknav -->
326 </div>
327 </div>
328 <!-- /Header -->
329
330
331 <div id="searchResults" class="wrap" style="display:none;">
332 <h2 id="searchTitle">Results</h2>
333 <div id="leftSearchControl" class="search-control">Loading...</div>
334 </div>
335
336
337
338 <!-- Secondary x-nav -->
339 <div id="nav-x">
340 <div class="wrap">
341 <ul class="nav-x col-9 develop" style="width:100%">
342 <li class="training"><a href="/training/index.html"
343 zh-tw-lang="訓練課程"
344 zh-cn-lang="培训"
345 ru-lang="Курсы"
346 ko-lang="교육"
347 ja-lang="トレーニング"
348 es-lang="Capacitación"
349 >Training</a></li>
350 <li class="guide"><a href="/guide/components/index.html"
351 zh-tw-lang="API 指南"
352 zh-cn-lang="API 指南"
353 ru-lang="Руководства по API"
354 ko-lang="API 가이드"
355 ja-lang="API ガイド"
356 es-lang="Guías de la API"
357 >API Guides</a></li>
358 <li class="reference"><a href="/reference/packages.html"
359 zh-tw-lang="參考資源"
360 zh-cn-lang="参考"
361 ru-lang="Справочник"
362 ko-lang="참조문서"
363 ja-lang="リファレンス"
364 es-lang="Referencia"
365 >Reference</a></li>
366 <li class="tools"><a href="/tools/index.html"
367 zh-tw-lang="相關工具"
368 zh-cn-lang="工具"
369 ru-lang="Инструменты"
370 ko-lang="도구"
371 ja-lang="ツール"
372 es-lang="Herramientas"
373 >Tools</a></li>
374 <li class="google"><a href="/google/index.html"
375 >Google Services</a>
376 </li>
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]377
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]378 </ul>
379 </div>
380
381 </div>
382 <!-- /Sendondary x-nav -->
383
384
385
386
387
388
389
390
391
392 <div class="wrap clearfix" id="body-content">
393 <div class="col-4" id="side-nav" itemscope itemtype="http://schema.org/SiteNavigationElement">
394 <div id="devdoc-nav" class="scroll-pane">
395<a class="totop" href="#top" data-g-event="left-nav-top">to top</a>
396
397
398
399<ul id="nav">
Dirk Doughertya38ca332013-05-15 02:36:33 -0700[diff] [blame]400
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]401 <li class="nav-section">
402 <div class="nav-section-header empty"><a href="/google/index.html">
Dirk Doughertya38ca332013-05-15 02:36:33 -0700[diff] [blame]403 <span class="en">Overview</span>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]404 </a></div>
405 </li>
406
407 <li class="nav-section">
Dirk Doughertya38ca332013-05-15 02:36:33 -0700[diff] [blame]408 <div class="nav-section-header empty"><a href="/google/play-services/games.html">
409 <span class="en">Games</span>
410 </a></div>
411 </li>
412 <li class="nav-section">
413 <div class="nav-section-header empty"><a href="/google/play-services/location.html">
414 <span class="en">Location</span>
415 </a></div>
416 </li>
417 <li class="nav-section">
418 <div class="nav-section-header empty"><a href="/google/play-services/plus.html">
419 <span class="en">Google+</span>
420 </a></div>
421 </li>
422 <li class="nav-section">
423 <div class="nav-section-header empty"><a href="/google/play-services/maps.html">
Dirk Dougherty28167892013-10-29 22:25:12 -0700[diff] [blame]424 <span class="en">Maps</span>
425 </a></div>
426 </li>
427 <li class="nav-section">
428 <div class="nav-section-header"><a href="/google/play-services/ads.html">
429 <span class="en">Ads</span></a>
430 </div>
431 <ul>
432 <li><a href="/google/play-services/id.html">
433 <span class="en">Advertising ID</span></a>
434 </li>
435 </ul>
436 </li>
437 <li class="nav-section">
438 <div class="nav-section-header empty"><a href="/google/play-services/wallet.html">
439 <span class="en">Wallet</span>
Dirk Doughertya38ca332013-05-15 02:36:33 -0700[diff] [blame]440 </a></div>
441 </li>
442 <li class="nav-section">
443 <div class="nav-section-header empty"><a href="/google/play-services/auth.html">
444 <span class="en">Authorization</span>
445 </a></div>
446 </li>
447
448
449
450 <li class="nav-section">
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]451 <div class="nav-section-header"><a href="/google/play-services/index.html">
452 <span class="en">Google Play Services</span></a>
453 </div>
454 <ul>
455 <li><a href="/google/play-services/setup.html">
456 <span class="en">Setup</span></a>
457 </li>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]458 <li id="gms-tree-list" class="nav-section">
459 <div class="nav-section-header">
460 <a href="/reference/gms-packages.html">
461 <span class="en">Reference</span>
462 </a>
463 <div>
464 </li>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]465 </ul>
466 </li>
467
468
469 <li class="nav-section">
470 <div class="nav-section-header"><a href="/google/play/billing/index.html">
471 <span class="en">Google Play In-app Billing</span></a>
472 </div>
473 <ul>
474 <li><a href="/google/play/billing/billing_overview.html">
475 <span class="en">Overview</span></a>
476 </li>
477 <li class="nav-section"><div class="nav-section-header"><a href="/google/play/billing/api.html">
478 <span class="en">Version 3 API</span></a></div>
479 <ul>
480 <li><a href="/google/play/billing/billing_integrate.html">
481 <span class="en">Implementing the API</span></a></li>
482 <li><a href="/google/play/billing/billing_reference.html">
483 <span class="en">Reference</span></a></li>
484 </ul>
485 </li>
486 <li class="nav-section"><div class="nav-section-header"><a href="/google/play/billing/v2/api.html">
487 <span class="en">Version 2 API</span></a></div>
488 <ul>
489 <li><a href="/google/play/billing/v2/billing_integrate.html">
490 <span class="en">Implementing the API</span></a></li>
491 <li><a href="/google/play/billing/v2/billing_subscriptions.html">
492 <span class="en">Subscriptions</span></a></li>
493 <li><a href="/google/play/billing/v2/billing_reference.html">
494 <span class="en">Reference</span></a></li>
495 </ul>
496 </li>
497 <li><a href="/google/play/billing/billing_subscriptions.html">
498 <span class="en">Subscriptions</span></a>
499 </li>
500 <li><a href="/google/play/billing/billing_best_practices.html">
501 <span class="en">Security and Design</span></a>
502 </li>
503 <li><a href="/google/play/billing/billing_testing.html">
504 <span class="en">Testing In-app Billing</span></a>
505 </li>
506 <li><a href="/google/play/billing/billing_admin.html">
507 <span class="en">Administering In-app Billing</span></a>
508 </li>
Dirk Doughertyfe3da792013-06-12 18:06:08 -0700[diff] [blame]509 <li><a href="/google/play/billing/gp-purchase-status-api.html">
510 <span class="en">Purchase Status API</span></a>
511 </li>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]512 <li><a href="/google/play/billing/versions.html">
513 <span class="en">Version Notes</span></a>
514 </li>
515 </ul>
516 </li>
517
Dirk Doughertya38ca332013-05-15 02:36:33 -0700[diff] [blame]518
519
520 <li class="nav-section">
521 <div class="nav-section-header"><a href="/google/gcm/index.html">
522 <span class="en">Google Cloud Messaging</span></a>
523 </div>
524 <ul>
525 <li><a href="/google/gcm/gs.html">
526 <span class="en">Getting Started</span></a>
527 </li>
Dirk Dougherty28167892013-10-29 22:25:12 -0700[diff] [blame]528 <li><a href="/google/gcm/gcm.html">
529 <span class="en">Architectural Overview</span></a>
Dirk Doughertya38ca332013-05-15 02:36:33 -0700[diff] [blame]530 </li>
Dirk Dougherty28167892013-10-29 22:25:12 -0700[diff] [blame]531 <li><a href="/google/gcm/ccs.html">
532 <span class="en">Cloud Connection Server</span></a>
Dirk Doughertyfe3da792013-06-12 18:06:08 -0700[diff] [blame]533 </li>
534 <li><a href="/google/gcm/notifications.html">
535 <span class="en">User Notifications</span></a>
536 </li>
Dirk Dougherty28167892013-10-29 22:25:12 -0700[diff] [blame]537 <li><a href="/google/gcm/client.html">
538 <span class="en">GCM Client</span></a>
539 </li>
540 <li><a href="/google/gcm/server.html">
541 <span class="en">GCM Server</span></a>
542 </li>
Dirk Doughertya38ca332013-05-15 02:36:33 -0700[diff] [blame]543 <li><a href="/google/gcm/adv.html">
544 <span class="en">Advanced Topics</span></a>
545 </li>
546 <li><a href="/google/gcm/c2dm.html">
547 <span class="en">Migration</span></a>
548 </li>
549 <li id="gcm-tree-list" class="nav-section">
550 <div class="nav-section-header">
551 <a href="/reference/gcm-packages.html">
552 <span class="en">Reference</span>
553 </a>
554 <div>
555 </li>
556 </ul>
557 </li>
558
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]559 <li class="nav-section">
560 <div class="nav-section-header"><a href="/google/play/dist.html">
561 <span class="en">Google Play Distribution</span></a>
562 </div>
563 <ul>
564 <li><a href="/google/play/filters.html">
565 <span class="en">Filters on Google Play</span></a>
566 </li>
567
568 <li><a href="/google/play/publishing/multiple-apks.html">
569 <span class="en">Multiple APK Support</span></a>
570 </li>
571 <li><a href="/google/play/expansion-files.html">
572 <span class="en">APK Expansion Files</span></a>
573 </li>
574 <li class="nav-section">
575 <div class="nav-section-header"><a href="/google/play/licensing/index.html">
576 <span class="en">Application Licensing</span></a>
577 </div>
578 <ul>
579 <li><a href="/google/play/licensing/overview.html">
580 <span class="en">Licensing Overview</span></a>
581 </li>
582 <li><a href="/google/play/licensing/setting-up.html">
583 <span class="en">Setting Up for Licensing</span></a>
584 </li>
585 <li><a href="/google/play/licensing/adding-licensing.html">
586 <span class="en">Adding Licensing to Your App</span></a>
587 </li>
588 <li><a href="/google/play/licensing/licensing-reference.html">
589 <span class="en">Licensing Reference</span></a>
590 </li>
591 </ul>
592 </li>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]593
594 <li class="nav-section">
595 <div class="nav-section-header"><a href="/google/backup/index.html">
596 Android Backup Service</a>
597 </div>
598 <ul>
599 <li><a href="/google/backup/signup.html">
600 Register</a>
601 </li>
602 </ul>
603 </li>
604
Dirk Doughertya38ca332013-05-15 02:36:33 -0700[diff] [blame]605 </ul>
606
607</li>
608
609
610
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]611</ul>
612
613<script type="text/javascript">
614<!--
615 buildToggleLists();
616 changeNavLang(getLangPref());
617//-->
618</script>
619
620
621
622
623 </div>
624 <script type="text/javascript">
625 showGoogleRefTree();
626
627 </script>
628 </div> <!-- end side-nav -->
629 <script>
630 $(document).ready(function() {
631 scrollIntoView("devdoc-nav");
632 });
633 </script>
634
635
636
637
638
639
640<div class="col-12" id="doc-col">
641
642<div id="api-info-block">
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670<div class="sum-details-links">
671
672Summary:
673
674
675
676
677
678 <a href="#constants">Constants</a>
679
680
681
682 &#124; <a href="#inhconstants">Inherited Constants</a>
683
684
685
686
687
688
689
690 &#124; <a href="#pubmethods">Methods</a>
691
692
693
694
695 &#124; <a href="#inhmethods">Inherited Methods</a>
696
697&#124; <a href="#" onclick="return toggleAllClassInherited()" id="toggleAllClassInherited">[Expand All]</a>
698
699</div><!-- end sum-details-links -->
700<div class="api-level">
701
702
703
704
705</div>
706</div><!-- end api-info-block -->
707
708
709<!-- ======== START OF CLASS DATA ======== -->
710
711<div id="jd-header">
712 public
713
714
715
716 interface
717<h1 itemprop="name">Room</h1>
718
719
720
721
722
723 implements
724
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]725 Parcelable
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]726
727 <a href="/reference/com/google/android/gms/common/data/Freezable.html">Freezable</a>&lt;T&gt;
728
729 <a href="/reference/com/google/android/gms/games/multiplayer/Participatable.html">Participatable</a>
730
731
732
733
734
735</div><!-- end header -->
736
737<div id="naMessage"></div>
738
739<div id="jd-content" class="api apilevel-">
740<table class="jd-inheritance-table">
741
742
743 <tr>
744
745 <td colspan="1" class="jd-inheritance-class-cell">com.google.android.gms.games.multiplayer.realtime.Room</td>
746 </tr>
747
748
749</table>
750
751
752
753
754
755
756<table class="jd-sumtable jd-sumtable-subclasses"><tr><td colspan="12" style="border:none;margin:0;padding:0;">
757
758 <a href="#" onclick="return toggleInherited(this, null)" id="subclasses-indirect" class="jd-expando-trigger closed"
759 ><img id="subclasses-indirect-trigger"
760 src="/assets/images/triangle-closed.png"
761 class="jd-expando-trigger-img" /></a>Known Indirect Subclasses
762
763 <div id="subclasses-indirect">
764 <div id="subclasses-indirect-list"
765 class="jd-inheritedlinks"
766
767 >
768
769
770 <a href="/reference/com/google/android/gms/games/multiplayer/realtime/RoomEntity.html">RoomEntity</a>
771
772
773 </div>
774 <div id="subclasses-indirect-summary"
775 style="display: none;"
776 >
777 <table class="jd-sumtable-expando">
778 <tr class="alt-color api apilevel-" >
779 <td class="jd-linkcol"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/RoomEntity.html">RoomEntity</a></td>
780 <td class="jd-descrcol" width="100%">Data object representing the data for a room.&nbsp;</td>
781 </tr>
782 </table>
783 </div>
784 </div>
785</td></tr></table>
786
787
788<div class="jd-descr">
789
790
791<h2>Class Overview</h2>
792<p itemprop="articleBody">Data interface for room functionality.
793</p>
794
795
796
797
798
799</div><!-- jd-descr -->
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816<div class="jd-descr">
817
818
819<h2>Summary</h2>
820
821
822
823
824
825
826
827
828
829
830
831
832
833<!-- =========== ENUM CONSTANT SUMMARY =========== -->
834<table id="constants" class="jd-sumtable"><tr><th colspan="12">Constants</th></tr>
835
836
837
838 <tr class="alt-color api apilevel-" >
839 <td class="jd-typecol">int</td>
840 <td class="jd-linkcol"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#ROOM_STATUS_ACTIVE">ROOM_STATUS_ACTIVE</a></td>
841 <td class="jd-descrcol" width="100%">Constant returned by <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getStatus()">getStatus()</a></code> indicating that the room is active and connections
842 are established.</td>
843 </tr>
844
845
846 <tr class=" api apilevel-" >
847 <td class="jd-typecol">int</td>
848 <td class="jd-linkcol"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#ROOM_STATUS_AUTO_MATCHING">ROOM_STATUS_AUTO_MATCHING</a></td>
849 <td class="jd-descrcol" width="100%">Constant returned by <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getStatus()">getStatus()</a></code> indicating that one or more slots are waiting to be
850 filled by auto-matching.</td>
851 </tr>
852
853
854 <tr class="alt-color api apilevel-" >
855 <td class="jd-typecol">int</td>
856 <td class="jd-linkcol"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#ROOM_STATUS_CONNECTING">ROOM_STATUS_CONNECTING</a></td>
857 <td class="jd-descrcol" width="100%">Constant returned by <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getStatus()">getStatus()</a></code> indicating that this room is waiting for clients to
858 connect to each other.</td>
859 </tr>
860
861
862 <tr class=" api apilevel-" >
863 <td class="jd-typecol">int</td>
864 <td class="jd-linkcol"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#ROOM_STATUS_INVITING">ROOM_STATUS_INVITING</a></td>
865 <td class="jd-descrcol" width="100%">Constant returned by <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getStatus()">getStatus()</a></code> indicating that the room has one or more players
866 that have been invited and have not responded yet.</td>
867 </tr>
868
869
870 <tr class="alt-color api apilevel-" >
871 <td class="jd-typecol">int</td>
872 <td class="jd-linkcol"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#ROOM_VARIANT_ANY">ROOM_VARIANT_ANY</a></td>
873 <td class="jd-descrcol" width="100%">Constant used to indicate that the variant for a room is unspecified.</td>
874 </tr>
875
876
877
878</table>
879
880
881
882
883
884<!-- =========== ENUM CONSTANT SUMMARY =========== -->
885<table id="inhconstants" class="jd-sumtable"><tr><th>
886 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
887 <div style="clear:left;">Inherited Constants</div></th></tr>
888
889
890<tr class="api apilevel-" >
891<td colspan="12">
892
893 <a href="#" onclick="return toggleInherited(this, null)" id="inherited-constants-android.os.Parcelable" class="jd-expando-trigger closed"
894 ><img id="inherited-constants-android.os.Parcelable-trigger"
895 src="/assets/images/triangle-closed.png"
896 class="jd-expando-trigger-img" /></a>From interface
897android.os.Parcelable
898<div id="inherited-constants-android.os.Parcelable">
899 <div id="inherited-constants-android.os.Parcelable-list"
900 class="jd-inheritedlinks">
901 </div>
902 <div id="inherited-constants-android.os.Parcelable-summary" style="display: none;">
903 <table class="jd-sumtable-expando">
904
905
906
907 <tr class="alt-color api apilevel-" >
908 <td class="jd-typecol">int</td>
909 <td class="jd-linkcol">CONTENTS_FILE_DESCRIPTOR</td>
910 <td class="jd-descrcol" width="100%"></td>
911 </tr>
912
913
914 <tr class=" api apilevel-" >
915 <td class="jd-typecol">int</td>
916 <td class="jd-linkcol">PARCELABLE_WRITE_RETURN_VALUE</td>
917 <td class="jd-descrcol" width="100%"></td>
918 </tr>
919
920
921</table>
922 </div>
923</div>
924</td></tr>
925
926
927
928
929
930
931</table>
932
933
934
935
936
937
938
939
940
941
942
943
944
945<!-- ========== METHOD SUMMARY =========== -->
946<table id="pubmethods" class="jd-sumtable"><tr><th colspan="12">Public Methods</th></tr>
947
948
949
950
951 <tr class="alt-color api apilevel-" >
952 <td class="jd-typecol"><nobr>
953 abstract
954
955
956
957
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]958 Bundle</nobr>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]959 </td>
960 <td class="jd-linkcol" width="100%"><nobr>
961 <span class="sympad"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getAutoMatchCriteria()">getAutoMatchCriteria</a></span>()</nobr>
962
963 <div class="jd-descrdiv">Retrieves the automatch criteria used to create or join this room, if any.</div>
964
965 </td></tr>
966
967
968
969 <tr class=" api apilevel-" >
970 <td class="jd-typecol"><nobr>
971 abstract
972
973
974
975
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]976 int</nobr>
977 </td>
978 <td class="jd-linkcol" width="100%"><nobr>
979 <span class="sympad"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getAutoMatchWaitEstimateSeconds()">getAutoMatchWaitEstimateSeconds</a></span>()</nobr>
980
981 <div class="jd-descrdiv">Retrieves the estimated wait time for automatching to finish for players who are not
982 automatched immediately, as measured from the time that the room entered the
983 automatching pool.</div>
984
985 </td></tr>
986
987
988
989 <tr class="alt-color api apilevel-" >
990 <td class="jd-typecol"><nobr>
991 abstract
992
993
994
995
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]996 long</nobr>
997 </td>
998 <td class="jd-linkcol" width="100%"><nobr>
999 <span class="sympad"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getCreationTimestamp()">getCreationTimestamp</a></span>()</nobr>
1000
1001 </td></tr>
1002
1003
1004
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1005 <tr class=" api apilevel-" >
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1006 <td class="jd-typecol"><nobr>
1007 abstract
1008
1009
1010
1011
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1012 String</nobr>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1013 </td>
1014 <td class="jd-linkcol" width="100%"><nobr>
1015 <span class="sympad"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getCreatorId()">getCreatorId</a></span>()</nobr>
1016
1017 </td></tr>
1018
1019
1020
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1021 <tr class="alt-color api apilevel-" >
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1022 <td class="jd-typecol"><nobr>
1023 abstract
1024
1025
1026
1027
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1028 String</nobr>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1029 </td>
1030 <td class="jd-linkcol" width="100%"><nobr>
1031 <span class="sympad"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getDescription()">getDescription</a></span>()</nobr>
1032
1033 </td></tr>
1034
1035
1036
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1037 <tr class=" api apilevel-" >
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1038 <td class="jd-typecol"><nobr>
1039 abstract
1040
1041
1042
1043
1044 void</nobr>
1045 </td>
1046 <td class="jd-linkcol" width="100%"><nobr>
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1047 <span class="sympad"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getDescription(android.database.CharArrayBuffer)">getDescription</a></span>(CharArrayBuffer dataOut)</nobr>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1048
Dirk Dougherty4e847bd2013-08-06 09:59:51 -0700[diff] [blame]1049 <div class="jd-descrdiv">Loads the room description into the given <code><a href="/reference/android/database/CharArrayBuffer.html">CharArrayBuffer</a></code>.</div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1050
1051 </td></tr>
1052
1053
1054
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1055 <tr class="alt-color api apilevel-" >
1056 <td class="jd-typecol"><nobr>
1057 abstract
1058
1059
1060
1061
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1062 String</nobr>
1063 </td>
1064 <td class="jd-linkcol" width="100%"><nobr>
1065 <span class="sympad"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getParticipantId(java.lang.String)">getParticipantId</a></span>(String playerId)</nobr>
1066
1067 <div class="jd-descrdiv">Get the participant ID for a given player.</div>
1068
1069 </td></tr>
1070
1071
1072
1073 <tr class=" api apilevel-" >
1074 <td class="jd-typecol"><nobr>
1075 abstract
1076
1077
1078
1079
1080 ArrayList&lt;String&gt;</nobr>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1081 </td>
1082 <td class="jd-linkcol" width="100%"><nobr>
1083 <span class="sympad"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getParticipantIds()">getParticipantIds</a></span>()</nobr>
1084
1085 </td></tr>
1086
1087
1088
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1089 <tr class="alt-color api apilevel-" >
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1090 <td class="jd-typecol"><nobr>
1091 abstract
1092
1093
1094
1095
1096 int</nobr>
1097 </td>
1098 <td class="jd-linkcol" width="100%"><nobr>
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1099 <span class="sympad"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getParticipantStatus(java.lang.String)">getParticipantStatus</a></span>(String participantId)</nobr>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1100
1101 <div class="jd-descrdiv">Get the status of a participant in a room.</div>
1102
1103 </td></tr>
1104
1105
1106
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1107 <tr class=" api apilevel-" >
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1108 <td class="jd-typecol"><nobr>
1109 abstract
1110
1111
1112
1113
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1114 String</nobr>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1115 </td>
1116 <td class="jd-linkcol" width="100%"><nobr>
1117 <span class="sympad"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getRoomId()">getRoomId</a></span>()</nobr>
1118
1119 </td></tr>
1120
1121
1122
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1123 <tr class="alt-color api apilevel-" >
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1124 <td class="jd-typecol"><nobr>
1125 abstract
1126
1127
1128
1129
1130 int</nobr>
1131 </td>
1132 <td class="jd-linkcol" width="100%"><nobr>
1133 <span class="sympad"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getStatus()">getStatus</a></span>()</nobr>
1134
1135 </td></tr>
1136
1137
1138
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1139 <tr class=" api apilevel-" >
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1140 <td class="jd-typecol"><nobr>
1141 abstract
1142
1143
1144
1145
1146 int</nobr>
1147 </td>
1148 <td class="jd-linkcol" width="100%"><nobr>
1149 <span class="sympad"><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getVariant()">getVariant</a></span>()</nobr>
1150
1151 </td></tr>
1152
1153
1154
1155</table>
1156
1157
1158
1159
1160
1161
1162
1163<!-- ========== METHOD SUMMARY =========== -->
1164<table id="inhmethods" class="jd-sumtable"><tr><th>
1165 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
1166 <div style="clear:left;">Inherited Methods</div></th></tr>
1167
1168
1169<tr class="api apilevel-" >
1170<td colspan="12">
1171 <a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-android.os.Parcelable" class="jd-expando-trigger closed"
1172 ><img id="inherited-methods-android.os.Parcelable-trigger"
1173 src="/assets/images/triangle-closed.png"
1174 class="jd-expando-trigger-img" /></a>
1175From interface
1176
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1177 android.os.Parcelable
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1178
1179<div id="inherited-methods-android.os.Parcelable">
1180 <div id="inherited-methods-android.os.Parcelable-list"
1181 class="jd-inheritedlinks">
1182 </div>
1183 <div id="inherited-methods-android.os.Parcelable-summary" style="display: none;">
1184 <table class="jd-sumtable-expando">
1185
1186
1187
1188
1189 <tr class="alt-color api apilevel-" >
1190 <td class="jd-typecol"><nobr>
1191 abstract
1192
1193
1194
1195
1196 int</nobr>
1197 </td>
1198 <td class="jd-linkcol" width="100%"><nobr>
1199 <span class="sympad">describeContents</span>()</nobr>
1200
1201 </td></tr>
1202
1203
1204
1205 <tr class=" api apilevel-" >
1206 <td class="jd-typecol"><nobr>
1207 abstract
1208
1209
1210
1211
1212 void</nobr>
1213 </td>
1214 <td class="jd-linkcol" width="100%"><nobr>
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1215 <span class="sympad">writeToParcel</span>(Parcel arg0, int arg1)</nobr>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1216
1217 </td></tr>
1218
1219
1220</table>
1221 </div>
1222</div>
1223</td></tr>
1224
1225
1226
1227<tr class="api apilevel-" >
1228<td colspan="12">
1229 <a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-com.google.android.gms.common.data.Freezable" class="jd-expando-trigger closed"
1230 ><img id="inherited-methods-com.google.android.gms.common.data.Freezable-trigger"
1231 src="/assets/images/triangle-closed.png"
1232 class="jd-expando-trigger-img" /></a>
1233From interface
1234
1235 <a href="/reference/com/google/android/gms/common/data/Freezable.html">com.google.android.gms.common.data.Freezable</a>
1236
1237<div id="inherited-methods-com.google.android.gms.common.data.Freezable">
1238 <div id="inherited-methods-com.google.android.gms.common.data.Freezable-list"
1239 class="jd-inheritedlinks">
1240 </div>
1241 <div id="inherited-methods-com.google.android.gms.common.data.Freezable-summary" style="display: none;">
1242 <table class="jd-sumtable-expando">
1243
1244
1245
1246
1247 <tr class="alt-color api apilevel-" >
1248 <td class="jd-typecol"><nobr>
1249 abstract
1250
1251
1252
1253
1254 T</nobr>
1255 </td>
1256 <td class="jd-linkcol" width="100%"><nobr>
1257 <span class="sympad"><a href="/reference/com/google/android/gms/common/data/Freezable.html#freeze()">freeze</a></span>()</nobr>
1258
1259 <div class="jd-descrdiv">Freeze a volatile representation into an immutable representation.</div>
1260
1261 </td></tr>
1262
1263
Dirk Doughertyc1609c42013-08-01 15:30:06 -0700[diff] [blame]1264
1265 <tr class=" api apilevel-" >
1266 <td class="jd-typecol"><nobr>
1267 abstract
1268
1269
1270
1271
1272 boolean</nobr>
1273 </td>
1274 <td class="jd-linkcol" width="100%"><nobr>
1275 <span class="sympad"><a href="/reference/com/google/android/gms/common/data/Freezable.html#isDataValid()">isDataValid</a></span>()</nobr>
1276
1277 <div class="jd-descrdiv">Check to see if this object is valid for use.</div>
1278
1279 </td></tr>
1280
1281
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1282</table>
1283 </div>
1284</div>
1285</td></tr>
1286
1287
1288
1289<tr class="api apilevel-" >
1290<td colspan="12">
1291 <a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-com.google.android.gms.games.multiplayer.Participatable" class="jd-expando-trigger closed"
1292 ><img id="inherited-methods-com.google.android.gms.games.multiplayer.Participatable-trigger"
1293 src="/assets/images/triangle-closed.png"
1294 class="jd-expando-trigger-img" /></a>
1295From interface
1296
1297 <a href="/reference/com/google/android/gms/games/multiplayer/Participatable.html">com.google.android.gms.games.multiplayer.Participatable</a>
1298
1299<div id="inherited-methods-com.google.android.gms.games.multiplayer.Participatable">
1300 <div id="inherited-methods-com.google.android.gms.games.multiplayer.Participatable-list"
1301 class="jd-inheritedlinks">
1302 </div>
1303 <div id="inherited-methods-com.google.android.gms.games.multiplayer.Participatable-summary" style="display: none;">
1304 <table class="jd-sumtable-expando">
1305
1306
1307
1308
1309 <tr class="alt-color api apilevel-" >
1310 <td class="jd-typecol"><nobr>
1311 abstract
1312
1313
1314
1315
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1316 ArrayList&lt;<a href="/reference/com/google/android/gms/games/multiplayer/Participant.html">Participant</a>&gt;</nobr>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1317 </td>
1318 <td class="jd-linkcol" width="100%"><nobr>
1319 <span class="sympad"><a href="/reference/com/google/android/gms/games/multiplayer/Participatable.html#getParticipants()">getParticipants</a></span>()</nobr>
1320
1321 <div class="jd-descrdiv">Retrieve the <code><a href="/reference/com/google/android/gms/games/multiplayer/Participant.html">Participant</a></code>s for this object.</div>
1322
1323 </td></tr>
1324
1325
1326</table>
1327 </div>
1328</div>
1329</td></tr>
1330
1331
1332</table>
1333
1334
1335</div><!-- jd-descr (summary) -->
1336
1337<!-- Details -->
1338
1339
1340
1341
1342
1343
1344
1345
1346<!-- XML Attributes -->
1347
1348
1349<!-- Enum Values -->
1350
1351
1352<!-- Constants -->
1353
1354
1355<!-- ========= ENUM CONSTANTS DETAIL ======== -->
1356<h2>Constants</h2>
1357
1358
1359
1360
1361<A NAME="ROOM_STATUS_ACTIVE"></A>
1362
1363<div class="jd-details api apilevel-">
1364 <h4 class="jd-details-title">
1365 <span class="normal">
1366 public
1367 static
1368 final
1369 int
1370 </span>
1371 ROOM_STATUS_ACTIVE
1372 </h4>
1373 <div class="api-level">
1374
1375
1376
1377
1378 </div>
1379 <div class="jd-details-descr">
1380
1381 <div class="jd-tagdata jd-tagdescr"><p>Constant returned by <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getStatus()">getStatus()</a></code> indicating that the room is active and connections
1382 are established.
1383</p></div>
1384
1385
1386 <div class="jd-tagdata">
1387 <span class="jd-tagtitle">Constant Value: </span>
1388 <span>
1389
1390 3
1391 (0x00000003)
1392
1393 </span>
1394 </div>
1395
1396 </div>
1397</div>
1398
1399
1400
1401<A NAME="ROOM_STATUS_AUTO_MATCHING"></A>
1402
1403<div class="jd-details api apilevel-">
1404 <h4 class="jd-details-title">
1405 <span class="normal">
1406 public
1407 static
1408 final
1409 int
1410 </span>
1411 ROOM_STATUS_AUTO_MATCHING
1412 </h4>
1413 <div class="api-level">
1414
1415
1416
1417
1418 </div>
1419 <div class="jd-details-descr">
1420
1421 <div class="jd-tagdata jd-tagdescr"><p>Constant returned by <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getStatus()">getStatus()</a></code> indicating that one or more slots are waiting to be
1422 filled by auto-matching.
1423</p></div>
1424
1425
1426 <div class="jd-tagdata">
1427 <span class="jd-tagtitle">Constant Value: </span>
1428 <span>
1429
1430 1
1431 (0x00000001)
1432
1433 </span>
1434 </div>
1435
1436 </div>
1437</div>
1438
1439
1440
1441<A NAME="ROOM_STATUS_CONNECTING"></A>
1442
1443<div class="jd-details api apilevel-">
1444 <h4 class="jd-details-title">
1445 <span class="normal">
1446 public
1447 static
1448 final
1449 int
1450 </span>
1451 ROOM_STATUS_CONNECTING
1452 </h4>
1453 <div class="api-level">
1454
1455
1456
1457
1458 </div>
1459 <div class="jd-details-descr">
1460
1461 <div class="jd-tagdata jd-tagdescr"><p>Constant returned by <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getStatus()">getStatus()</a></code> indicating that this room is waiting for clients to
1462 connect to each other.
1463</p></div>
1464
1465
1466 <div class="jd-tagdata">
1467 <span class="jd-tagtitle">Constant Value: </span>
1468 <span>
1469
1470 2
1471 (0x00000002)
1472
1473 </span>
1474 </div>
1475
1476 </div>
1477</div>
1478
1479
1480
1481<A NAME="ROOM_STATUS_INVITING"></A>
1482
1483<div class="jd-details api apilevel-">
1484 <h4 class="jd-details-title">
1485 <span class="normal">
1486 public
1487 static
1488 final
1489 int
1490 </span>
1491 ROOM_STATUS_INVITING
1492 </h4>
1493 <div class="api-level">
1494
1495
1496
1497
1498 </div>
1499 <div class="jd-details-descr">
1500
1501 <div class="jd-tagdata jd-tagdescr"><p>Constant returned by <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#getStatus()">getStatus()</a></code> indicating that the room has one or more players
1502 that have been invited and have not responded yet.
1503</p></div>
1504
1505
1506 <div class="jd-tagdata">
1507 <span class="jd-tagtitle">Constant Value: </span>
1508 <span>
1509
1510 0
1511 (0x00000000)
1512
1513 </span>
1514 </div>
1515
1516 </div>
1517</div>
1518
1519
1520
1521<A NAME="ROOM_VARIANT_ANY"></A>
1522
1523<div class="jd-details api apilevel-">
1524 <h4 class="jd-details-title">
1525 <span class="normal">
1526 public
1527 static
1528 final
1529 int
1530 </span>
1531 ROOM_VARIANT_ANY
1532 </h4>
1533 <div class="api-level">
1534
1535
1536
1537
1538 </div>
1539 <div class="jd-details-descr">
1540
1541 <div class="jd-tagdata jd-tagdescr"><p>Constant used to indicate that the variant for a room is unspecified.
1542</p></div>
1543
1544
1545 <div class="jd-tagdata">
1546 <span class="jd-tagtitle">Constant Value: </span>
1547 <span>
1548
1549 -1
1550 (0xffffffff)
1551
1552 </span>
1553 </div>
1554
1555 </div>
1556</div>
1557
1558
1559
1560
1561<!-- Fields -->
1562
1563
1564<!-- Public ctors -->
1565
1566
1567
1568<!-- ========= CONSTRUCTOR DETAIL ======== -->
1569<!-- Protected ctors -->
1570
1571
1572
1573<!-- ========= METHOD DETAIL ======== -->
1574<!-- Public methdos -->
1575
1576<h2>Public Methods</h2>
1577
1578
1579
1580<A NAME="getAutoMatchCriteria()"></A>
1581
1582<div class="jd-details api apilevel-">
1583 <h4 class="jd-details-title">
1584 <span class="normal">
1585 public
1586
1587
1588 abstract
1589
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1590 Bundle
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1591 </span>
1592 <span class="sympad">getAutoMatchCriteria</span>
1593 <span class="normal">()</span>
1594 </h4>
1595 <div class="api-level">
1596 <div></div>
1597
1598
1599
1600 </div>
1601 <div class="jd-details-descr">
1602
1603 <div class="jd-tagdata jd-tagdescr"><p>Retrieves the automatch criteria used to create or join this room, if any. May be null if the
1604 room has no automatch properties.</p></div>
1605 <div class="jd-tagdata">
1606 <h5 class="jd-tagtitle">Returns</h5>
Dirk Dougherty8f1a7592013-06-28 14:04:39 -0700[diff] [blame]1607 <ul class="nolist"><li>A bundle containing the automatch criteria for this room.
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1608</li></ul>
1609 </div>
1610
1611 </div>
1612</div>
1613
1614
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1615<A NAME="getAutoMatchWaitEstimateSeconds()"></A>
1616
1617<div class="jd-details api apilevel-">
1618 <h4 class="jd-details-title">
1619 <span class="normal">
1620 public
1621
1622
1623 abstract
1624
1625 int
1626 </span>
1627 <span class="sympad">getAutoMatchWaitEstimateSeconds</span>
1628 <span class="normal">()</span>
1629 </h4>
1630 <div class="api-level">
1631 <div></div>
1632
1633
1634
1635 </div>
1636 <div class="jd-details-descr">
1637
1638 <div class="jd-tagdata jd-tagdescr"><p>Retrieves the estimated wait time for automatching to finish for players who are not
1639 automatched immediately, as measured from the time that the room entered the
1640 automatching pool.</p></div>
1641 <div class="jd-tagdata">
1642 <h5 class="jd-tagtitle">Returns</h5>
1643 <ul class="nolist"><li>The estimated wait time in seconds, or -1 if the room is not
1644 automatching or no estimate could be provided.
1645</li></ul>
1646 </div>
1647
1648 </div>
1649</div>
1650
1651
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1652<A NAME="getCreationTimestamp()"></A>
1653
1654<div class="jd-details api apilevel-">
1655 <h4 class="jd-details-title">
1656 <span class="normal">
1657 public
1658
1659
1660 abstract
1661
1662 long
1663 </span>
1664 <span class="sympad">getCreationTimestamp</span>
1665 <span class="normal">()</span>
1666 </h4>
1667 <div class="api-level">
1668 <div></div>
1669
1670
1671
1672 </div>
1673 <div class="jd-details-descr">
1674
1675 <div class="jd-tagdata jd-tagdescr"><p></p></div>
1676 <div class="jd-tagdata">
1677 <h5 class="jd-tagtitle">Returns</h5>
1678 <ul class="nolist"><li>The server timestamp at which the room was created.
1679</li></ul>
1680 </div>
1681
1682 </div>
1683</div>
1684
1685
1686<A NAME="getCreatorId()"></A>
1687
1688<div class="jd-details api apilevel-">
1689 <h4 class="jd-details-title">
1690 <span class="normal">
1691 public
1692
1693
1694 abstract
1695
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1696 String
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1697 </span>
1698 <span class="sympad">getCreatorId</span>
1699 <span class="normal">()</span>
1700 </h4>
1701 <div class="api-level">
1702 <div></div>
1703
1704
1705
1706 </div>
1707 <div class="jd-details-descr">
1708
1709 <div class="jd-tagdata jd-tagdescr"><p></p></div>
1710 <div class="jd-tagdata">
1711 <h5 class="jd-tagtitle">Returns</h5>
1712 <ul class="nolist"><li>The ID of the participant who created this Room.
1713</li></ul>
1714 </div>
1715
1716 </div>
1717</div>
1718
1719
1720<A NAME="getDescription()"></A>
1721
1722<div class="jd-details api apilevel-">
1723 <h4 class="jd-details-title">
1724 <span class="normal">
1725 public
1726
1727
1728 abstract
1729
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1730 String
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1731 </span>
1732 <span class="sympad">getDescription</span>
1733 <span class="normal">()</span>
1734 </h4>
1735 <div class="api-level">
1736 <div></div>
1737
1738
1739
1740 </div>
1741 <div class="jd-details-descr">
1742
1743 <div class="jd-tagdata jd-tagdescr"><p></p></div>
1744 <div class="jd-tagdata">
1745 <h5 class="jd-tagtitle">Returns</h5>
1746 <ul class="nolist"><li>Description of this room.
1747</li></ul>
1748 </div>
1749
1750 </div>
1751</div>
1752
1753
1754<A NAME="getDescription(android.database.CharArrayBuffer)"></A>
1755
1756<div class="jd-details api apilevel-">
1757 <h4 class="jd-details-title">
1758 <span class="normal">
1759 public
1760
1761
1762 abstract
1763
1764 void
1765 </span>
1766 <span class="sympad">getDescription</span>
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1767 <span class="normal">(CharArrayBuffer dataOut)</span>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1768 </h4>
1769 <div class="api-level">
1770 <div></div>
1771
1772
1773
1774 </div>
1775 <div class="jd-details-descr">
1776
Dirk Dougherty4e847bd2013-08-06 09:59:51 -0700[diff] [blame]1777 <div class="jd-tagdata jd-tagdescr"><p>Loads the room description into the given <code><a href="/reference/android/database/CharArrayBuffer.html">CharArrayBuffer</a></code>.</p></div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1778 <div class="jd-tagdata">
1779 <h5 class="jd-tagtitle">Parameters</h5>
1780 <table class="jd-tagtable">
1781 <tr>
1782 <th>dataOut</td>
1783 <td>The buffer to load the data into.
1784</td>
1785 </tr>
1786 </table>
1787 </div>
1788
1789 </div>
1790</div>
1791
1792
1793<A NAME="getParticipantId(java.lang.String)"></A>
1794
1795<div class="jd-details api apilevel-">
1796 <h4 class="jd-details-title">
1797 <span class="normal">
1798 public
1799
1800
1801 abstract
1802
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1803 String
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1804 </span>
1805 <span class="sympad">getParticipantId</span>
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1806 <span class="normal">(String playerId)</span>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1807 </h4>
1808 <div class="api-level">
1809 <div></div>
1810
1811
1812
1813 </div>
1814 <div class="jd-details-descr">
1815
1816 <div class="jd-tagdata jd-tagdescr"><p>Get the participant ID for a given player. This will only return a non-null ID if the player
1817 is actually a participant in the room and that player's identity is visible to the current
1818 player. Note that this will always return non-null for the current player.</p></div>
1819 <div class="jd-tagdata">
1820 <h5 class="jd-tagtitle">Parameters</h5>
1821 <table class="jd-tagtable">
1822 <tr>
1823 <th>playerId</td>
1824 <td>Player ID to find participant ID for.</td>
1825 </tr>
1826 </table>
1827 </div>
1828 <div class="jd-tagdata">
1829 <h5 class="jd-tagtitle">Returns</h5>
1830 <ul class="nolist"><li>The participant ID corresponding to given player, or null if none found.
1831</li></ul>
1832 </div>
1833
1834 </div>
1835</div>
1836
1837
1838<A NAME="getParticipantIds()"></A>
1839
1840<div class="jd-details api apilevel-">
1841 <h4 class="jd-details-title">
1842 <span class="normal">
1843 public
1844
1845
1846 abstract
1847
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1848 ArrayList&lt;String&gt;
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1849 </span>
1850 <span class="sympad">getParticipantIds</span>
1851 <span class="normal">()</span>
1852 </h4>
1853 <div class="api-level">
1854 <div></div>
1855
1856
1857
1858 </div>
1859 <div class="jd-details-descr">
1860
1861 <div class="jd-tagdata jd-tagdescr"><p></p></div>
1862 <div class="jd-tagdata">
1863 <h5 class="jd-tagtitle">Returns</h5>
1864 <ul class="nolist"><li>The IDs of the participants in this room. These are returned in the participant
1865 order of the room. Note that these are not stable across rooms.
1866</li></ul>
1867 </div>
1868
1869 </div>
1870</div>
1871
1872
1873<A NAME="getParticipantStatus(java.lang.String)"></A>
1874
1875<div class="jd-details api apilevel-">
1876 <h4 class="jd-details-title">
1877 <span class="normal">
1878 public
1879
1880
1881 abstract
1882
1883 int
1884 </span>
1885 <span class="sympad">getParticipantStatus</span>
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1886 <span class="normal">(String participantId)</span>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1887 </h4>
1888 <div class="api-level">
1889 <div></div>
1890
1891
1892
1893 </div>
1894 <div class="jd-details-descr">
1895
1896 <div class="jd-tagdata jd-tagdescr"><p>Get the status of a participant in a room. Note that the participant ID must correspond to a
1897 participant in this room, or this method will throw an exception.</p></div>
1898 <div class="jd-tagdata">
1899 <h5 class="jd-tagtitle">Parameters</h5>
1900 <table class="jd-tagtable">
1901 <tr>
1902 <th>participantId</td>
1903 <td>Room-local ID of the participant to retrieve status for.</td>
1904 </tr>
1905 </table>
1906 </div>
1907 <div class="jd-tagdata">
1908 <h5 class="jd-tagtitle">Returns</h5>
1909 <ul class="nolist"><li>The current status of the participant in this room. One of
1910 <code><a href="/reference/com/google/android/gms/games/multiplayer/Participant.html#STATUS_INVITED">STATUS_INVITED</a></code>, <code><a href="/reference/com/google/android/gms/games/multiplayer/Participant.html#STATUS_JOINED">STATUS_JOINED</a></code>,
1911 <code><a href="/reference/com/google/android/gms/games/multiplayer/Participant.html#STATUS_DECLINED">STATUS_DECLINED</a></code>, or <code><a href="/reference/com/google/android/gms/games/multiplayer/Participant.html#STATUS_LEFT">STATUS_LEFT</a></code>.</li></ul>
1912 </div>
1913 <div class="jd-tagdata">
1914 <h5 class="jd-tagtitle">Throws</h5>
1915 <table class="jd-tagtable">
1916 <tr>
1917 <th></td>
1918 <td>IllegalStateException} if the participant is not a participant in this room.
1919</td>
1920 </tr>
1921 </table>
1922 </div>
1923
1924 </div>
1925</div>
1926
1927
1928<A NAME="getRoomId()"></A>
1929
1930<div class="jd-details api apilevel-">
1931 <h4 class="jd-details-title">
1932 <span class="normal">
1933 public
1934
1935
1936 abstract
1937
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1938 String
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1939 </span>
1940 <span class="sympad">getRoomId</span>
1941 <span class="normal">()</span>
1942 </h4>
1943 <div class="api-level">
1944 <div></div>
1945
1946
1947
1948 </div>
1949 <div class="jd-details-descr">
1950
1951 <div class="jd-tagdata jd-tagdescr"><p></p></div>
1952 <div class="jd-tagdata">
1953 <h5 class="jd-tagtitle">Returns</h5>
1954 <ul class="nolist"><li>The ID of this Room.
1955</li></ul>
1956 </div>
1957
1958 </div>
1959</div>
1960
1961
1962<A NAME="getStatus()"></A>
1963
1964<div class="jd-details api apilevel-">
1965 <h4 class="jd-details-title">
1966 <span class="normal">
1967 public
1968
1969
1970 abstract
1971
1972 int
1973 </span>
1974 <span class="sympad">getStatus</span>
1975 <span class="normal">()</span>
1976 </h4>
1977 <div class="api-level">
1978 <div></div>
1979
1980
1981
1982 </div>
1983 <div class="jd-details-descr">
1984
1985 <div class="jd-tagdata jd-tagdescr"><p></p></div>
1986 <div class="jd-tagdata">
1987 <h5 class="jd-tagtitle">Returns</h5>
1988 <ul class="nolist"><li>The current status of the room. One of <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#ROOM_STATUS_INVITING">ROOM_STATUS_INVITING</a></code>,
1989 <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#ROOM_STATUS_ACTIVE">ROOM_STATUS_ACTIVE</a></code>, <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#ROOM_STATUS_AUTO_MATCHING">ROOM_STATUS_AUTO_MATCHING</a></code>,
1990 <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#ROOM_STATUS_CONNECTING">ROOM_STATUS_CONNECTING</a></code>.
1991</li></ul>
1992 </div>
1993
1994 </div>
1995</div>
1996
1997
1998<A NAME="getVariant()"></A>
1999
2000<div class="jd-details api apilevel-">
2001 <h4 class="jd-details-title">
2002 <span class="normal">
2003 public
2004
2005
2006 abstract
2007
2008 int
2009 </span>
2010 <span class="sympad">getVariant</span>
2011 <span class="normal">()</span>
2012 </h4>
2013 <div class="api-level">
2014 <div></div>
2015
2016
2017
2018 </div>
2019 <div class="jd-details-descr">
2020
2021 <div class="jd-tagdata jd-tagdescr"><p></p></div>
2022 <div class="jd-tagdata">
2023 <h5 class="jd-tagtitle">Returns</h5>
2024 <ul class="nolist"><li>Variant specified for this room, if any. A variant is an optional
Dirk Dougherty8f1a7592013-06-28 14:04:39 -0700[diff] [blame]2025 developer-controlled parameter describing the type of game to play. If specified,
2026 this value will be a positive integer. If this room had no variant specified, returns
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2027 <code><a href="/reference/com/google/android/gms/games/multiplayer/realtime/Room.html#ROOM_VARIANT_ANY">ROOM_VARIANT_ANY</a></code>.
2028</li></ul>
2029 </div>
2030
2031 </div>
2032</div>
2033
2034
2035
2036
2037
2038<!-- ========= METHOD DETAIL ======== -->
2039
2040
2041
2042<!-- ========= END OF CLASS DATA ========= -->
2043<A NAME="navbar_top"></A>
2044
2045<div id="footer" class="wrap" >
2046
2047
2048 <div id="copyright">
2049
2050 Except as noted, this content is licensed under <a
2051 href="http://www.apache.org/licenses/LICENSE-2.0">Apache 2.0</a>.
2052 For details and restrictions, see the <a href="/license.html">
2053 Content License</a>.
2054 </div>
2055 <div id="build_info">
2056
2057<script src="/timestamp.js" type="text/javascript"></script>
2058<script>document.write(BUILD_TIMESTAMP)</script>
2059
2060 </div>
2061
2062
2063 <div id="footerlinks">
2064
2065 <p>
2066 <a href="/about/index.html">About Android</a>&nbsp;&nbsp;|&nbsp;
2067 <a href="/legal.html">Legal</a>&nbsp;&nbsp;|&nbsp;
2068 <a href="/support.html">Support</a>
2069 </p>
2070 </div>
2071
2072</div> <!-- end footer -->
2073</div> <!-- jd-content -->
2074
2075</div><!-- end doc-content -->
2076
2077</div> <!-- end body-content -->
2078
2079
2080
2081
2082
2083
2084</body>
2085</html>