blob: ce504402c460179f99ec138eba1632b82257c111 [file] [log] [blame]
quddusc563daee2013-12-03 19:31:14 -08001<!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
76
77
Quddus Chong26ca3fa2014-05-06 17:02:49 -070078
79
80
81
82
83
84
Quddus Chong559c0062014-06-12 13:59:34 -070085
86
Quddus Chong2b4b3d22014-10-26 18:10:42 -070087
88
89
90
91
92
93
94
95
96
97
quddusc563daee2013-12-03 19:31:14 -080098<html>
99<head>
100
101
102<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
103<meta name="viewport" content="width=device-width" />
104
105<link rel="shortcut icon" type="image/x-icon" href="/favicon.ico" />
Quddus Chonge457fb62014-09-11 18:55:43 -0700106<title>ConfigApi | Android Developers</title>
quddusc563daee2013-12-03 19:31:14 -0800107
108<!-- STYLESHEETS -->
109<link rel="stylesheet"
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700110href="//fonts.googleapis.com/css?family=Roboto+Condensed">
111<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Roboto:light,regular,medium,thin,italic,mediumitalic,bold"
112 title="roboto">
Quddus Chong559c0062014-06-12 13:59:34 -0700113<link href="/assets/css/default.css?v=2" rel="stylesheet" type="text/css">
quddusc563daee2013-12-03 19:31:14 -0800114
115
116
117<!-- JAVASCRIPT -->
118<script src="//www.google.com/jsapi" type="text/javascript"></script>
119<script src="/assets/js/android_3p-bundle.js" type="text/javascript"></script>
120<script type="text/javascript">
121 var toRoot = "/";
122 var metaTags = [];
123 var devsite = false;
124</script>
Quddus Chong559c0062014-06-12 13:59:34 -0700125<script src="/assets/js/docs.js?v=2" type="text/javascript"></script>
quddusc563daee2013-12-03 19:31:14 -0800126
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700127
128
Quddus Chong559c0062014-06-12 13:59:34 -0700129<script>
130 (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
131 (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
132 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
133 })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
quddusc563daee2013-12-03 19:31:14 -0800134
Quddus Chong559c0062014-06-12 13:59:34 -0700135 ga('create', 'UA-5831155-1', 'android.com');
136 ga('create', 'UA-49880327-2', 'android.com', {'name': 'universal'}); // New tracker);
137 ga('send', 'pageview');
138 ga('universal.send', 'pageview'); // Send page view for new tracker.
quddusc563daee2013-12-03 19:31:14 -0800139</script>
Quddus Chong559c0062014-06-12 13:59:34 -0700140
quddusc563daee2013-12-03 19:31:14 -0800141</head>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700142
quddusc563daee2013-12-03 19:31:14 -0800143<body class="gc-documentation google
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700144 develop reference" itemscope itemtype="http://schema.org/Article">
quddusc563daee2013-12-03 19:31:14 -0800145 <div id="doc-api-level" class="" style="display:none"></div>
146 <a name="top"></a>
147
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700148
quddusc563daee2013-12-03 19:31:14 -0800149<a name="top"></a>
150
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700151 <!-- Header -->
152 <div id="header-wrapper">
quddusc563daee2013-12-03 19:31:14 -0800153 <div id="header">
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700154
155
156
157
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700158 <div class="wrap" id="header-wrap">
159 <div class="col-3 logo">
quddusc563daee2013-12-03 19:31:14 -0800160 <a href="/index.html">
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700161 <img src="/assets/images/dac_logo.png"
162 srcset="/assets/images/dac_logo@2x.png 2x"
163 width="123" height="25" alt="Android Developers" />
quddusc563daee2013-12-03 19:31:14 -0800164 </a>
165 <div class="btn-quicknav" id="btn-quicknav">
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700166 <a href="#" class="arrow-inactive">Quicknav</a>
167 <a href="#" class="arrow-active">Quicknav</a>
quddusc563daee2013-12-03 19:31:14 -0800168 </div>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700169 </div>
170 <ul class="nav-x col-9">
171 <li class="design">
172 <a href="/design/index.html"
173 zh-tw-lang="設計"
174 zh-cn-lang="设计"
175 ru-lang="Проектирование"
176 ko-lang="디자인"
177 ja-lang="設計"
178 es-lang="Diseñar"
179 >Design</a></li>
180 <li class="develop"><a href="/develop/index.html"
181 zh-tw-lang="開發"
182 zh-cn-lang="开发"
183 ru-lang="Разработка"
184 ko-lang="개발"
185 ja-lang="開発"
186 es-lang="Desarrollar"
187 >Develop</a></li>
188 <li class="distribute last"><a href="/distribute/index.html"
189 zh-tw-lang="發佈"
190 zh-cn-lang="分发"
191 ru-lang="Распространение"
192 ko-lang="배포"
193 ja-lang="配布"
194 es-lang="Distribuir"
195 >Distribute</a></li>
196 </ul>
197
198
199
200
201<div class="menu-container">
202 <div class="moremenu">
quddusc563daee2013-12-03 19:31:14 -0800203 <div id="more-btn"></div>
204 </div>
205 <div class="morehover" id="moremenu">
206 <div class="top"></div>
207 <div class="mid">
208 <div class="header">Links</div>
209 <ul>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700210 <li><a href="https://play.google.com/apps/publish/" target="_googleplay">Google Play Developer Console</a></li>
quddusc563daee2013-12-03 19:31:14 -0800211 <li><a href="http://android-developers.blogspot.com/">Android Developers Blog</a></li>
212 <li><a href="/about/index.html">About Android</a></li>
213 </ul>
214 <div class="header">Android Sites</div>
215 <ul>
216 <li><a href="http://www.android.com">Android.com</a></li>
217 <li class="active"><a>Android Developers</a></li>
218 <li><a href="http://source.android.com">Android Open Source Project</a></li>
219 </ul>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700220
Quddus Chong559c0062014-06-12 13:59:34 -0700221
222
quddusc563daee2013-12-03 19:31:14 -0800223 <div class="header">Language</div>
224 <div id="language" class="locales">
225 <select name="language" onChange="changeLangPref(this.value, true)">
226 <option value="en">English</option>
227 <option value="es">Español</option>
228 <option value="ja">日本語</option>
229 <option value="ko">한국어</option>
230 <option value="ru">Русский</option>
231 <option value="zh-cn">中文 (中国)</option>
232 <option value="zh-tw">中文 (台灣)</option>
233 </select>
234 </div>
235 <script type="text/javascript">
236 <!--
237 loadLangPref();
238 //-->
239 </script>
Quddus Chong559c0062014-06-12 13:59:34 -0700240
241
quddusc563daee2013-12-03 19:31:14 -0800242 <br class="clearfix" />
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700243 </div><!-- end 'mid' -->
quddusc563daee2013-12-03 19:31:14 -0800244 <div class="bottom"></div>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700245 </div><!-- end 'moremenu' -->
246
quddusc563daee2013-12-03 19:31:14 -0800247 <div class="search" id="search-container">
248 <div class="search-inner">
249 <div id="search-btn"></div>
250 <div class="left"></div>
251 <form onsubmit="return submit_search()">
252 <input id="search_autocomplete" type="text" value="" autocomplete="off" name="q"
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700253 onfocus="search_focus_changed(this, true)" onblur="search_focus_changed(this, false)"
254 onkeydown="return search_changed(event, true, '/')"
255 onkeyup="return search_changed(event, false, '/')" />
quddusc563daee2013-12-03 19:31:14 -0800256 </form>
257 <div class="right"></div>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700258 <a class="close hide">close</a>
259 <div class="left"></div>
260 <div class="right"></div>
261 </div><!-- end search-inner -->
262 </div><!-- end search-container -->
quddusc563daee2013-12-03 19:31:14 -0800263
264 <div class="search_filtered_wrapper reference">
265 <div class="suggest-card reference no-display">
266 <ul class="search_filtered">
267 </ul>
268 </div>
269 </div>
270
271 <div class="search_filtered_wrapper docs">
272 <div class="suggest-card dummy no-display">&nbsp;</div>
273 <div class="suggest-card develop no-display">
274 <ul class="search_filtered">
275 </ul>
276 <div class="child-card guides no-display">
277 </div>
278 <div class="child-card training no-display">
279 </div>
280 <div class="child-card samples no-display">
281 </div>
282 </div>
283 <div class="suggest-card design no-display">
284 <ul class="search_filtered">
285 </ul>
286 </div>
287 <div class="suggest-card distribute no-display">
288 <ul class="search_filtered">
289 </ul>
290 </div>
291 </div>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700292</div><!-- end menu-container (search and menu widget) -->
quddusc563daee2013-12-03 19:31:14 -0800293
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700294
295
296 <!-- Expanded quicknav -->
Quddus Chong559c0062014-06-12 13:59:34 -0700297 <div id="quicknav" class="col-13">
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700298 <ul>
Quddus Chong559c0062014-06-12 13:59:34 -0700299 <li class="about">
300 <ul>
301 <li><a href="/about/index.html">About</a></li>
302 <li><a href="/wear/index.html">Wear</a></li>
303 <li><a href="/tv/index.html">TV</a></li>
304 <li><a href="/auto/index.html">Auto</a></li>
305 </ul>
306 </li>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700307 <li class="design">
308 <ul>
309 <li><a href="/design/index.html">Get Started</a></li>
Quddus Chong559c0062014-06-12 13:59:34 -0700310 <li><a href="/design/devices.html">Devices</a></li>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700311 <li><a href="/design/style/index.html">Style</a></li>
312 <li><a href="/design/patterns/index.html">Patterns</a></li>
313 <li><a href="/design/building-blocks/index.html">Building Blocks</a></li>
314 <li><a href="/design/downloads/index.html">Downloads</a></li>
315 <li><a href="/design/videos/index.html">Videos</a></li>
316 </ul>
317 </li>
318 <li class="develop">
319 <ul>
320 <li><a href="/training/index.html"
321 zh-tw-lang="訓練課程"
322 zh-cn-lang="培训"
323 ru-lang="Курсы"
324 ko-lang="교육"
325 ja-lang="トレーニング"
326 es-lang="Capacitación"
327 >Training</a></li>
328 <li><a href="/guide/index.html"
329 zh-tw-lang="API 指南"
330 zh-cn-lang="API 指南"
331 ru-lang="Руководства по API"
332 ko-lang="API 가이드"
333 ja-lang="API ガイド"
334 es-lang="Guías de la API"
335 >API Guides</a></li>
336 <li><a href="/reference/packages.html"
337 zh-tw-lang="參考資源"
338 zh-cn-lang="参考"
339 ru-lang="Справочник"
340 ko-lang="참조문서"
341 ja-lang="リファレンス"
342 es-lang="Referencia"
343 >Reference</a></li>
Quddus Chong559c0062014-06-12 13:59:34 -0700344 <li><a href="/sdk/index.html"
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700345 zh-tw-lang="相關工具"
346 zh-cn-lang="工具"
347 ru-lang="Инструменты"
348 ko-lang="도구"
349 ja-lang="ツール"
350 es-lang="Herramientas"
351 >Tools</a>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700352 </li>
353 <li><a href="/google/index.html">Google Services</a>
354 </li>
355
356 <li><a href="/samples/index.html">Samples</a>
357 </li>
358
359 </ul>
360 </li>
361 <li class="distribute last">
362 <ul>
363 <li><a href="/distribute/googleplay/index.html">Google Play</a></li>
364 <li><a href="/distribute/essentials/index.html">Essentials</a></li>
365 <li><a href="/distribute/users/index.html">Get Users</a></li>
366 <li><a href="/distribute/engage/index.html">Engage &amp; Retain</a></li>
367 <li><a href="/distribute/monetize/index.html">Monetize</a></li>
368 <li><a href="/distribute/tools/index.html">Tools &amp; Reference</a></li>
369 <li><a href="/distribute/stories/index.html">Developer Stories</a></li>
370 </ul>
371 </li>
372 </ul>
373 </div><!-- /Expanded quicknav -->
374 </div><!-- end header-wrap.wrap -->
375 </div><!-- end header -->
376
Quddus Chong559c0062014-06-12 13:59:34 -0700377
quddusc563daee2013-12-03 19:31:14 -0800378 <!-- Secondary x-nav -->
379 <div id="nav-x">
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700380 <div class="wrap" style="position:relative;z-index:1">
381
382
383 <a id="helpoutsLink" class="resource resource-card resource-card-6x2x3 resource-card-6x2 helpouts-card"
384 href="http://helpouts.google.com/partner/landing/provider/googledevelopers" target="_blank">
385 <div class="card-bg helpouts-card-bg"></div>
386 <div class="card-info">
387 <div class="helpouts-description">
388 <div class="text">Help developers solve problems<br/>
389 <span id="helpoutsLinkText" class="link-color" style="display:block;padding-top:5px;text-align:right">Learn more</span>
390 </div>
391 </div>
392 </div>
393 </a>
394 <script>
395 var textA = "LEARN MORE";
396 var linkA = "http://helpouts.google.com/partner/landing/provider/googledevelopers?utm_source=android_banner1&utm_medium=banner&utm_campaign=android_provider_banner1";
397 var textB = "SIGN UP NOW";
398 var linkB = "http://helpouts.google.com/partner/landing/provider/googledevelopers?utm_source=android_banner2&utm_medium=banner&utm_campaign=android_provider_banner2";
399
400 if (Math.floor(1/Math.random()) > 1) {
401 $("a#helpoutsLink").attr('href', linkA);
402 $("span#helpoutsLinkText").text(textA);
403 } else {
404 $("a#helpoutsLink").attr('href', linkB);
405 $("span#helpoutsLinkText").text(textB);
406 }
407 </script>
408
409
quddusc563daee2013-12-03 19:31:14 -0800410 <ul class="nav-x col-9 develop" style="width:100%">
411 <li class="training"><a href="/training/index.html"
412 zh-tw-lang="訓練課程"
413 zh-cn-lang="培训"
414 ru-lang="Курсы"
415 ko-lang="교육"
416 ja-lang="トレーニング"
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700417 es-lang="Capacitación"
quddusc563daee2013-12-03 19:31:14 -0800418 >Training</a></li>
419 <li class="guide"><a href="/guide/index.html"
420 zh-tw-lang="API 指南"
421 zh-cn-lang="API 指南"
422 ru-lang="Руководства по API"
423 ko-lang="API 가이드"
424 ja-lang="API ガイド"
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700425 es-lang="Guías de la API"
quddusc563daee2013-12-03 19:31:14 -0800426 >API Guides</a></li>
427 <li class="reference"><a href="/reference/packages.html"
428 zh-tw-lang="參考資源"
429 zh-cn-lang="参考"
430 ru-lang="Справочник"
431 ko-lang="참조문서"
432 ja-lang="リファレンス"
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700433 es-lang="Referencia"
quddusc563daee2013-12-03 19:31:14 -0800434 >Reference</a></li>
Quddus Chong559c0062014-06-12 13:59:34 -0700435 <li class="tools"><a href="/sdk/index.html"
quddusc563daee2013-12-03 19:31:14 -0800436 zh-tw-lang="相關工具"
437 zh-cn-lang="工具"
438 ru-lang="Инструменты"
439 ko-lang="도구"
440 ja-lang="ツール"
441 es-lang="Herramientas"
442 >Tools</a></li>
443 <li class="google"><a href="/google/index.html"
444 >Google Services</a>
445 </li>
Quddus Chong559c0062014-06-12 13:59:34 -0700446
quddusc563daee2013-12-03 19:31:14 -0800447 <li class="samples"><a href="/samples/index.html"
448 >Samples</a>
449 </li>
Quddus Chong559c0062014-06-12 13:59:34 -0700450
quddusc563daee2013-12-03 19:31:14 -0800451 </ul>
452 </div>
quddusc563daee2013-12-03 19:31:14 -0800453 </div>
Quddus Chong559c0062014-06-12 13:59:34 -0700454 <!-- /Sendondary x-nav DEVELOP -->
quddusc563daee2013-12-03 19:31:14 -0800455
Quddus Chong559c0062014-06-12 13:59:34 -0700456
quddusc563daee2013-12-03 19:31:14 -0800457
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700458 <div id="searchResults" class="wrap" style="display:none;">
459 <h2 id="searchTitle">Results</h2>
460 <div id="leftSearchControl" class="search-control">Loading...</div>
461 </div>
462 </div> <!--end header-wrapper -->
463
464 <div id="sticky-header">
465 <div>
466 <a class="logo" href="#top"></a>
467 <a class="top" href="#top"></a>
468 <ul class="breadcrumb">
469
Quddus Chonge457fb62014-09-11 18:55:43 -0700470 <li class="current">ConfigApi</li>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700471 </ul>
472 </div>
473 </div>
474
475
476
477
quddusc563daee2013-12-03 19:31:14 -0800478
Quddus Chong559c0062014-06-12 13:59:34 -0700479
quddusc563daee2013-12-03 19:31:14 -0800480 <div class="wrap clearfix" id="body-content">
481 <div class="col-4" id="side-nav" itemscope itemtype="http://schema.org/SiteNavigationElement">
482 <div id="devdoc-nav" class="scroll-pane">
quddusc563daee2013-12-03 19:31:14 -0800483
484
485
486<ul id="nav">
487
488 <li class="nav-section">
489 <div class="nav-section-header empty"><a href="/google/index.html">
490 <span class="en">Overview</span>
491 </a></div>
492 </li>
493
494 <li class="nav-section">
495 <div class="nav-section-header empty"><a href="/google/play-services/games.html">
496 <span class="en">Games</span>
497 </a></div>
498 </li>
499 <li class="nav-section">
500 <div class="nav-section-header empty"><a href="/google/play-services/location.html">
501 <span class="en">Location</span>
502 </a></div>
503 </li>
504 <li class="nav-section">
505 <div class="nav-section-header empty"><a href="/google/play-services/plus.html">
506 <span class="en">Google+</span>
507 </a></div>
508 </li>
509 <li class="nav-section">
510 <div class="nav-section-header empty"><a href="/google/play-services/maps.html">
511 <span class="en">Maps</span>
512 </a></div>
513 </li>
514 <li class="nav-section">
Dirk Dougherty16542642014-02-07 19:58:28 -0800515 <div class="nav-section-header empty"><a href="/google/play-services/drive.html">
516 <span class="en">Drive</span>
517 </a></div>
518 </li>
519 <li class="nav-section">
520 <div class="nav-section-header empty"><a href="/google/play-services/cast.html">
521 <span class="en">Cast</span>
522 </a></div>
523 </li>
524 <li class="nav-section">
quddusc563daee2013-12-03 19:31:14 -0800525 <div class="nav-section-header"><a href="/google/play-services/ads.html">
526 <span class="en">Ads</span></a>
527 </div>
528 <ul>
529 <li><a href="/google/play-services/id.html">
530 <span class="en">Advertising ID</span></a>
531 </li>
532 </ul>
533 </li>
534 <li class="nav-section">
535 <div class="nav-section-header empty"><a href="/google/play-services/wallet.html">
536 <span class="en">Wallet</span>
537 </a></div>
538 </li>
quddusc563daee2013-12-03 19:31:14 -0800539
540
541 <li class="nav-section">
542 <div class="nav-section-header"><a href="/google/play-services/index.html">
543 <span class="en">Google Play Services</span></a>
544 </div>
545 <ul>
546 <li><a href="/google/play-services/setup.html">
Quddus Chonge457fb62014-09-11 18:55:43 -0700547 <span class="en">Setting Up Google Play Services</span></a>
quddusc563daee2013-12-03 19:31:14 -0800548 </li>
quddusc682d8e92014-03-13 11:55:32 -0700549 <li class="nav-section">
550 <div class="nav-section-header"><a href="/google/auth/api-client.html">
Quddus Chonge457fb62014-09-11 18:55:43 -0700551 <span class="en">Accessing Google APIs</span></a>
quddusc682d8e92014-03-13 11:55:32 -0700552 </div>
553 <ul>
554 <li>
555 <a href="/google/auth/http-auth.html">
556 <span class="en">Authorizing with Google for REST APIs</span>
557 </a>
558 </li>
559 </ul>
560 </li>
quddusc563daee2013-12-03 19:31:14 -0800561 <li id="gms-tree-list" class="nav-section">
562 <div class="nav-section-header">
563 <a href="/reference/gms-packages.html">
564 <span class="en">Reference</span>
565 </a>
566 <div>
567 </li>
568 </ul>
569 </li>
570
571
572 <li class="nav-section">
573 <div class="nav-section-header"><a href="/google/play/billing/index.html">
574 <span class="en">Google Play In-app Billing</span></a>
575 </div>
576 <ul>
577 <li><a href="/google/play/billing/billing_overview.html">
578 <span class="en">Overview</span></a>
579 </li>
580 <li class="nav-section"><div class="nav-section-header"><a href="/google/play/billing/api.html">
581 <span class="en">Version 3 API</span></a></div>
582 <ul>
583 <li><a href="/google/play/billing/billing_integrate.html">
584 <span class="en">Implementing the API</span></a></li>
585 <li><a href="/google/play/billing/billing_reference.html">
586 <span class="en">Reference</span></a></li>
587 </ul>
588 </li>
589 <li class="nav-section"><div class="nav-section-header"><a href="/google/play/billing/v2/api.html">
590 <span class="en">Version 2 API</span></a></div>
591 <ul>
592 <li><a href="/google/play/billing/v2/billing_integrate.html">
593 <span class="en">Implementing the API</span></a></li>
594 <li><a href="/google/play/billing/v2/billing_subscriptions.html">
595 <span class="en">Subscriptions</span></a></li>
596 <li><a href="/google/play/billing/v2/billing_reference.html">
597 <span class="en">Reference</span></a></li>
598 </ul>
599 </li>
600 <li><a href="/google/play/billing/billing_subscriptions.html">
601 <span class="en">Subscriptions</span></a>
602 </li>
603 <li><a href="/google/play/billing/billing_best_practices.html">
604 <span class="en">Security and Design</span></a>
605 </li>
606 <li><a href="/google/play/billing/billing_testing.html">
607 <span class="en">Testing In-app Billing</span></a>
608 </li>
609 <li><a href="/google/play/billing/billing_admin.html">
610 <span class="en">Administering In-app Billing</span></a>
611 </li>
quddusc563daee2013-12-03 19:31:14 -0800612 <li><a href="/google/play/billing/versions.html">
613 <span class="en">Version Notes</span></a>
614 </li>
615 </ul>
616 </li>
617
618
619
620 <li class="nav-section">
621 <div class="nav-section-header"><a href="/google/gcm/index.html">
622 <span class="en">Google Cloud Messaging</span></a>
623 </div>
624 <ul>
625 <li><a href="/google/gcm/gcm.html">
626 <span class="en">Overview</span></a>
627 </li>
628 <li><a href="/google/gcm/gs.html">
629 <span class="en">Getting Started</span></a>
630 </li>
631 <li><a href="/google/gcm/client.html">
632 <span class="en">Implementing GCM Client</span></a>
633 </li>
634 <li class="nav-section"><div class="nav-section-header"><a href="/google/gcm/server.html">
635 <span class="en">Implementing GCM Server</span></a></div>
636 <ul>
637 <li><a href="/google/gcm/ccs.html">
638 <span class="en">CCS (XMPP)</span></a></li>
639 <li><a href="/google/gcm/http.html">
640 <span class="en">HTTP</span></a></li>
641 </ul>
642 </li>
643 <li><a href="/google/gcm/notifications.html">
644 <span class="en">User Notifications</span></a>
645 </li>
646 <li><a href="/google/gcm/adv.html">
647 <span class="en">Advanced Topics</span></a>
648 </li>
649 <li><a href="/google/gcm/c2dm.html">
650 <span class="en">Migration</span></a>
651 </li>
652 <li id="gcm-tree-list" class="nav-section">
653 <div class="nav-section-header">
654 <a href="/reference/gcm-packages.html">
655 <span class="en">Reference</span>
656 </a>
657 <div>
658 </li>
659 </ul>
660 </li>
661
662 <li class="nav-section">
Quddus Chonge457fb62014-09-11 18:55:43 -0700663 <div class="nav-section-header empty"><a href="/google/gcs/index.html">
664 <span class="en">Google Cloud Save</span></a>
665 </div>
666 </li>
667
668 <li class="nav-section">
quddusc563daee2013-12-03 19:31:14 -0800669 <div class="nav-section-header"><a href="/google/play/dist.html">
670 <span class="en">Google Play Distribution</span></a>
671 </div>
672 <ul>
673 <li><a href="/google/play/filters.html">
674 <span class="en">Filters on Google Play</span></a>
675 </li>
Quddus Chonge457fb62014-09-11 18:55:43 -0700676 <li><a href="/google/play/billing/gp-purchase-status-api.html">
677 <span class="en">Google Play Developer API</span></a>
678 </li>
quddusc563daee2013-12-03 19:31:14 -0800679 <li><a href="/google/play/publishing/multiple-apks.html">
680 <span class="en">Multiple APK Support</span></a>
681 </li>
682 <li><a href="/google/play/expansion-files.html">
683 <span class="en">APK Expansion Files</span></a>
684 </li>
685 <li class="nav-section">
686 <div class="nav-section-header"><a href="/google/play/licensing/index.html">
687 <span class="en">Application Licensing</span></a>
688 </div>
689 <ul>
690 <li><a href="/google/play/licensing/overview.html">
691 <span class="en">Licensing Overview</span></a>
692 </li>
693 <li><a href="/google/play/licensing/setting-up.html">
694 <span class="en">Setting Up for Licensing</span></a>
695 </li>
696 <li><a href="/google/play/licensing/adding-licensing.html">
697 <span class="en">Adding Licensing to Your App</span></a>
698 </li>
699 <li><a href="/google/play/licensing/licensing-reference.html">
700 <span class="en">Licensing Reference</span></a>
701 </li>
702 </ul>
703 </li>
704
705 <li class="nav-section">
706 <div class="nav-section-header"><a href="/google/backup/index.html">
707 Android Backup Service</a>
708 </div>
709 <ul>
710 <li><a href="/google/backup/signup.html">
711 Register</a>
712 </li>
713 </ul>
714 </li>
715
716 </ul>
717
718</li>
719
720
721
722</ul>
723
724<script type="text/javascript">
725<!--
726 buildToggleLists();
727 changeNavLang(getLangPref());
728//-->
729</script>
730
731
Quddus Chong559c0062014-06-12 13:59:34 -0700732
quddusc563daee2013-12-03 19:31:14 -0800733
734 </div>
735 <script type="text/javascript">
736 showGoogleRefTree();
Quddus Chong559c0062014-06-12 13:59:34 -0700737
quddusc563daee2013-12-03 19:31:14 -0800738 </script>
739 </div> <!-- end side-nav -->
740 <script>
741 $(document).ready(function() {
742 scrollIntoView("devdoc-nav");
743 });
744 </script>
745
746
Quddus Chong559c0062014-06-12 13:59:34 -0700747
quddusc563daee2013-12-03 19:31:14 -0800748
749
750
751<div class="col-12" id="doc-col">
752
753<div id="api-info-block">
754
755
756
Quddus Chong559c0062014-06-12 13:59:34 -0700757
quddusc563daee2013-12-03 19:31:14 -0800758<div class="sum-details-links">
759
quddusc563daee2013-12-03 19:31:14 -0800760</div><!-- end sum-details-links -->
761<div class="api-level">
Quddus Chong559c0062014-06-12 13:59:34 -0700762
763
764
quddusc563daee2013-12-03 19:31:14 -0800765
766</div>
767</div><!-- end api-info-block -->
768
769
770<!-- ======== START OF CLASS DATA ======== -->
771
772<div id="jd-header">
773 public
Quddus Chong559c0062014-06-12 13:59:34 -0700774
775
776
quddusc563daee2013-12-03 19:31:14 -0800777 interface
Quddus Chonge457fb62014-09-11 18:55:43 -0700778<h1 itemprop="name">ConfigApi</h1>
quddusc563daee2013-12-03 19:31:14 -0800779
780
781
Quddus Chong559c0062014-06-12 13:59:34 -0700782
783
Quddus Chong559c0062014-06-12 13:59:34 -0700784
quddusc563daee2013-12-03 19:31:14 -0800785
786
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700787
788
789
quddusc563daee2013-12-03 19:31:14 -0800790</div><!-- end header -->
791
792<div id="naMessage"></div>
793
794<div id="jd-content" class="api apilevel-">
795<table class="jd-inheritance-table">
796
797
798 <tr>
Quddus Chong559c0062014-06-12 13:59:34 -0700799
Quddus Chonge457fb62014-09-11 18:55:43 -0700800 <td colspan="1" class="jd-inheritance-class-cell">com.google.android.gms.fitness.ConfigApi</td>
quddusc563daee2013-12-03 19:31:14 -0800801 </tr>
Quddus Chong559c0062014-06-12 13:59:34 -0700802
quddusc563daee2013-12-03 19:31:14 -0800803
804</table>
805
806
807
808
809
810
811
812<div class="jd-descr">
813
814
815<h2>Class Overview</h2>
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700816<p itemprop="articleBody">API for accessing custom data types and settings in Google Fit.
Quddus Chonge457fb62014-09-11 18:55:43 -0700817 <p>
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700818 Custom <code><a href="/reference/com/google/android/gms/fitness/data/DataType.html">data type</a></code> definitions can be added and then retrieved using
Quddus Chonge457fb62014-09-11 18:55:43 -0700819 <code><a href="/reference/com/google/android/gms/fitness/ConfigApi.html#createCustomDataType(com.google.android.gms.common.api.GoogleApiClient, com.google.android.gms.fitness.request.DataTypeCreateRequest)">createCustomDataType(GoogleApiClient, DataTypeCreateRequest)</a></code> and
820 <code><a href="/reference/com/google/android/gms/fitness/ConfigApi.html#readDataType(com.google.android.gms.common.api.GoogleApiClient, java.lang.String)">readDataType(GoogleApiClient, String)</a></code>.
821 <p>
822 <code><a href="/reference/com/google/android/gms/fitness/ConfigApi.html#disableFit(com.google.android.gms.common.api.GoogleApiClient)">disableFit(GoogleApiClient)</a></code> can be used to disconnect your app from Google Fit.
823 <p>
824 The Config API should be accessed via the <code><a href="/reference/com/google/android/gms/fitness/Fitness.html">Fitness</a></code> entry point. Example:
825 <pre>
826 GoogleApiClient client = new GoogleApiClient.Builder(context)
827 .addApi(Fitness.API)
828 ...
829 .build();
830 client.connect();
831
832 PendingResult&lt;DataTypeResult&gt; pendingResult = Fitness.ConfigApi.readDataType(
833 client, "com.example.my_custom_data_type");
834
835 DataTypeResult dataTypeResult = pendingResult.await();
836 DataType dataType = dataTypeResult.getDataType();
837 </pre>
838</p>
quddusc563daee2013-12-03 19:31:14 -0800839
840
841
842
843
844</div><!-- jd-descr -->
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861<div class="jd-descr">
862
863
864<h2>Summary</h2>
865
866
867
Quddus Chong559c0062014-06-12 13:59:34 -0700868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
quddusc563daee2013-12-03 19:31:14 -0800885
886
887
888
889
890
891
892<!-- ========== METHOD SUMMARY =========== -->
Quddus Chonge457fb62014-09-11 18:55:43 -0700893<table id="pubmethods" class="jd-sumtable"><tr><th colspan="12">Public Methods</th></tr>
quddusc563daee2013-12-03 19:31:14 -0800894
895
Quddus Chong559c0062014-06-12 13:59:34 -0700896
897
quddusc563daee2013-12-03 19:31:14 -0800898 <tr class="alt-color api apilevel-" >
899 <td class="jd-typecol"><nobr>
900 abstract
Quddus Chong559c0062014-06-12 13:59:34 -0700901
902
903
904
Quddus Chonge457fb62014-09-11 18:55:43 -0700905 <a href="/reference/com/google/android/gms/common/api/PendingResult.html">PendingResult</a>&lt;<a href="/reference/com/google/android/gms/fitness/result/DataTypeResult.html">DataTypeResult</a>&gt;</nobr>
quddusc563daee2013-12-03 19:31:14 -0800906 </td>
907 <td class="jd-linkcol" width="100%"><nobr>
Quddus Chonge457fb62014-09-11 18:55:43 -0700908 <span class="sympad"><a href="/reference/com/google/android/gms/fitness/ConfigApi.html#createCustomDataType(com.google.android.gms.common.api.GoogleApiClient, com.google.android.gms.fitness.request.DataTypeCreateRequest)">createCustomDataType</a></span>(<a href="/reference/com/google/android/gms/common/api/GoogleApiClient.html">GoogleApiClient</a> client, <a href="/reference/com/google/android/gms/fitness/request/DataTypeCreateRequest.html">DataTypeCreateRequest</a> request)</nobr>
909
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700910 <div class="jd-descrdiv">
911 Defines a new data type which is added to the Google Fit platform on behalf of the current
912 application.
913
914
915
916 </div>
Quddus Chong559c0062014-06-12 13:59:34 -0700917
quddusc563daee2013-12-03 19:31:14 -0800918 </td></tr>
919
920
Quddus Chonge457fb62014-09-11 18:55:43 -0700921
922 <tr class=" api apilevel-" >
923 <td class="jd-typecol"><nobr>
924 abstract
925
926
927
928
929 <a href="/reference/com/google/android/gms/common/api/PendingResult.html">PendingResult</a>&lt;<a href="/reference/com/google/android/gms/common/api/Status.html">Status</a>&gt;</nobr>
930 </td>
931 <td class="jd-linkcol" width="100%"><nobr>
932 <span class="sympad"><a href="/reference/com/google/android/gms/fitness/ConfigApi.html#disableFit(com.google.android.gms.common.api.GoogleApiClient)">disableFit</a></span>(<a href="/reference/com/google/android/gms/common/api/GoogleApiClient.html">GoogleApiClient</a> client)</nobr>
933
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700934 <div class="jd-descrdiv">
935 Disables Google Fit for an app.
936
937
938
939 </div>
Quddus Chonge457fb62014-09-11 18:55:43 -0700940
941 </td></tr>
942
943
944
945 <tr class="alt-color api apilevel-" >
946 <td class="jd-typecol"><nobr>
947 abstract
948
949
950
951
952 <a href="/reference/com/google/android/gms/common/api/PendingResult.html">PendingResult</a>&lt;<a href="/reference/com/google/android/gms/fitness/result/DataTypeResult.html">DataTypeResult</a>&gt;</nobr>
953 </td>
954 <td class="jd-linkcol" width="100%"><nobr>
955 <span class="sympad"><a href="/reference/com/google/android/gms/fitness/ConfigApi.html#readDataType(com.google.android.gms.common.api.GoogleApiClient, java.lang.String)">readDataType</a></span>(<a href="/reference/com/google/android/gms/common/api/GoogleApiClient.html">GoogleApiClient</a> client, String dataTypeName)</nobr>
956
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700957 <div class="jd-descrdiv">
958 Returns a data type with the specified <code>dataTypeName</code>.
959
960
961
962 </div>
Quddus Chonge457fb62014-09-11 18:55:43 -0700963
964 </td></tr>
965
quddusc563daee2013-12-03 19:31:14 -0800966
967
968</table>
969
970
Quddus Chonge457fb62014-09-11 18:55:43 -0700971
972
973
974
975
quddusc563daee2013-12-03 19:31:14 -0800976</div><!-- jd-descr (summary) -->
977
978<!-- Details -->
979
980
981
982
983
984
985
986
987<!-- XML Attributes -->
988
989
990<!-- Enum Values -->
991
992
993<!-- Constants -->
994
995
996<!-- Fields -->
997
998
999<!-- Public ctors -->
1000
1001
1002
1003<!-- ========= CONSTRUCTOR DETAIL ======== -->
1004<!-- Protected ctors -->
1005
1006
1007
1008<!-- ========= METHOD DETAIL ======== -->
1009<!-- Public methdos -->
1010
Quddus Chonge457fb62014-09-11 18:55:43 -07001011<h2>Public Methods</h2>
1012
1013
1014
1015<A NAME="createCustomDataType(com.google.android.gms.common.api.GoogleApiClient, com.google.android.gms.fitness.request.DataTypeCreateRequest)"></A>
1016
1017<div class="jd-details api apilevel-">
1018 <h4 class="jd-details-title">
1019 <span class="normal">
1020 public
1021
1022
1023 abstract
1024
1025 <a href="/reference/com/google/android/gms/common/api/PendingResult.html">PendingResult</a>&lt;<a href="/reference/com/google/android/gms/fitness/result/DataTypeResult.html">DataTypeResult</a>&gt;
1026 </span>
1027 <span class="sympad">createCustomDataType</span>
1028 <span class="normal">(<a href="/reference/com/google/android/gms/common/api/GoogleApiClient.html">GoogleApiClient</a> client, <a href="/reference/com/google/android/gms/fitness/request/DataTypeCreateRequest.html">DataTypeCreateRequest</a> request)</span>
1029 </h4>
1030 <div class="api-level">
1031 <div></div>
1032
1033
1034
1035 </div>
1036 <div class="jd-details-descr">
1037
Quddus Chong2b4b3d22014-10-26 18:10:42 -07001038
1039
1040
Quddus Chonge457fb62014-09-11 18:55:43 -07001041 <div class="jd-tagdata jd-tagdescr"><p>Defines a new data type which is added to the Google Fit platform on behalf of the current
1042 application. Useful for adding a private custom data type for recording app-specific data.
1043 Custom data created by one app will not be visible to other apps.
1044 <p>
1045 Example:
1046 <pre>
1047 PendingResult<DataTypeResult> pendingResult = ConfigApi.createCustomDataType(client
1048 new DataTypeCreateRequest.Builder()
1049 .setName(DATA_TYPE_NAME)
1050 .addField(MY_FIELD1)
1051 .addField(MY_FIELD2)
1052 .build());
1053 DataTypeResult result = pendingResult.await();
1054 </pre></p></div>
1055 <div class="jd-tagdata">
1056 <h5 class="jd-tagtitle">Parameters</h5>
1057 <table class="jd-tagtable">
1058 <tr>
1059 <th>client</td>
1060 <td>an existing GoogleApiClient. Must be connected at the time of this call.</td>
1061 </tr>
1062 <tr>
1063 <th>request</td>
1064 <td>the new data type name and fields that need to be added</td>
1065 </tr>
1066 </table>
1067 </div>
1068 <div class="jd-tagdata">
1069 <h5 class="jd-tagtitle">Returns</h5>
1070 <ul class="nolist"><li>a pending result containing the status of the request. If an existing DataType has
1071 the same name but different fields, the operation will fail with
1072 <code><a href="/reference/com/google/android/gms/fitness/FitnessStatusCodes.html#CONFLICTING_DATA_TYPE">CONFLICTING_DATA_TYPE</a></code>.
Quddus Chong2b4b3d22014-10-26 18:10:42 -07001073 If application package name does not match <code><a href="/reference/com/google/android/gms/fitness/data/DataType.html">DataType</a></code>'s name, the operation
1074 will fail with <code><a href="/reference/com/google/android/gms/fitness/FitnessStatusCodes.html#INCONSISTENT_DATA_TYPE">INCONSISTENT_DATA_TYPE</a></code> status code.
Quddus Chonge457fb62014-09-11 18:55:43 -07001075</li></ul>
1076 </div>
1077
1078 </div>
1079</div>
1080
1081
1082<A NAME="disableFit(com.google.android.gms.common.api.GoogleApiClient)"></A>
1083
1084<div class="jd-details api apilevel-">
1085 <h4 class="jd-details-title">
1086 <span class="normal">
1087 public
1088
1089
1090 abstract
1091
1092 <a href="/reference/com/google/android/gms/common/api/PendingResult.html">PendingResult</a>&lt;<a href="/reference/com/google/android/gms/common/api/Status.html">Status</a>&gt;
1093 </span>
1094 <span class="sympad">disableFit</span>
1095 <span class="normal">(<a href="/reference/com/google/android/gms/common/api/GoogleApiClient.html">GoogleApiClient</a> client)</span>
1096 </h4>
1097 <div class="api-level">
1098 <div></div>
1099
1100
1101
1102 </div>
1103 <div class="jd-details-descr">
1104
Quddus Chong2b4b3d22014-10-26 18:10:42 -07001105
1106
1107
Quddus Chonge457fb62014-09-11 18:55:43 -07001108 <div class="jd-tagdata jd-tagdescr"><p>Disables Google Fit for an app. Can be used to revoke all granted OAuth access permissions
1109 from an app and consequently remove all existing subscriptions and registrations of the app.</p></div>
1110 <div class="jd-tagdata">
1111 <h5 class="jd-tagtitle">Parameters</h5>
1112 <table class="jd-tagtable">
1113 <tr>
1114 <th>client</td>
1115 <td>an existing GoogleApiClient. Must be connected at the time of this call.</td>
1116 </tr>
1117 </table>
1118 </div>
1119 <div class="jd-tagdata">
1120 <h5 class="jd-tagtitle">Returns</h5>
1121 <ul class="nolist"><li>result containing the status of the request
1122</li></ul>
1123 </div>
1124
1125 </div>
1126</div>
1127
1128
1129<A NAME="readDataType(com.google.android.gms.common.api.GoogleApiClient, java.lang.String)"></A>
1130
1131<div class="jd-details api apilevel-">
1132 <h4 class="jd-details-title">
1133 <span class="normal">
1134 public
1135
1136
1137 abstract
1138
1139 <a href="/reference/com/google/android/gms/common/api/PendingResult.html">PendingResult</a>&lt;<a href="/reference/com/google/android/gms/fitness/result/DataTypeResult.html">DataTypeResult</a>&gt;
1140 </span>
1141 <span class="sympad">readDataType</span>
1142 <span class="normal">(<a href="/reference/com/google/android/gms/common/api/GoogleApiClient.html">GoogleApiClient</a> client, String dataTypeName)</span>
1143 </h4>
1144 <div class="api-level">
1145 <div></div>
1146
1147
1148
1149 </div>
1150 <div class="jd-details-descr">
1151
Quddus Chong2b4b3d22014-10-26 18:10:42 -07001152
1153
1154
Quddus Chonge457fb62014-09-11 18:55:43 -07001155 <div class="jd-tagdata jd-tagdescr"><p>Returns a data type with the specified <code>dataTypeName</code>. Useful to retrieve
1156 shareable data types added by other apps or custom data types added by your app.
1157 Custom data types created by other apps will not be returned.</p></div>
1158 <div class="jd-tagdata">
1159 <h5 class="jd-tagtitle">Parameters</h5>
1160 <table class="jd-tagtable">
1161 <tr>
1162 <th>client</td>
1163 <td>an existing GoogleApiClient. It does not need to be connected at the time of
1164 this call, but the read result will be delayed until the connection is complete.</td>
1165 </tr>
1166 <tr>
1167 <th>dataTypeName</td>
1168 <td>name of the data type we want to read</td>
1169 </tr>
1170 </table>
1171 </div>
1172 <div class="jd-tagdata">
1173 <h5 class="jd-tagtitle">Returns</h5>
1174 <ul class="nolist"><li>result containing the status of the request
1175</li></ul>
1176 </div>
1177
1178 </div>
1179</div>
1180
1181
1182
quddusc563daee2013-12-03 19:31:14 -08001183
1184
1185<!-- ========= METHOD DETAIL ======== -->
1186
1187
1188
1189<!-- ========= END OF CLASS DATA ========= -->
1190<A NAME="navbar_top"></A>
1191
1192<div id="footer" class="wrap" >
Quddus Chong559c0062014-06-12 13:59:34 -07001193
quddusc563daee2013-12-03 19:31:14 -08001194
1195 <div id="copyright">
Quddus Chong559c0062014-06-12 13:59:34 -07001196
quddusc563daee2013-12-03 19:31:14 -08001197 Except as noted, this content is licensed under <a
Quddus Chong559c0062014-06-12 13:59:34 -07001198 href="http://www.apache.org/licenses/LICENSE-2.0">Apache 2.0</a>.
quddusc563daee2013-12-03 19:31:14 -08001199 For details and restrictions, see the <a href="/license.html">
1200 Content License</a>.
1201 </div>
1202 <div id="build_info">
Quddus Chong559c0062014-06-12 13:59:34 -07001203
quddusc563daee2013-12-03 19:31:14 -08001204<script src="/timestamp.js" type="text/javascript"></script>
1205<script>document.write(BUILD_TIMESTAMP)</script>
1206
1207 </div>
1208
1209
1210 <div id="footerlinks">
Quddus Chong559c0062014-06-12 13:59:34 -07001211
quddusc563daee2013-12-03 19:31:14 -08001212 <p>
1213 <a href="/about/index.html">About Android</a>&nbsp;&nbsp;|&nbsp;
1214 <a href="/legal.html">Legal</a>&nbsp;&nbsp;|&nbsp;
1215 <a href="/support.html">Support</a>
1216 </p>
1217 </div>
1218
1219</div> <!-- end footer -->
1220</div> <!-- jd-content -->
1221
1222</div><!-- end doc-content -->
1223
Quddus Chong559c0062014-06-12 13:59:34 -07001224</div> <!-- end body-content -->
quddusc563daee2013-12-03 19:31:14 -08001225
1226
1227
1228
1229
1230
1231</body>
1232</html>