Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / frameworks / base / a9f628662c348c5926caf5e2df0fd2f245a715bf / . / docs / html / reference / com / google / android / gms / location / LocationRequest.html
blob: 6145607ae524b7400f6f3b3c98ded30b95ec0a3e [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
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]78
79
80
81
82
83
84
Quddus Chong559c0062014-06-12 13:59:34 -0700[diff] [blame]85
86
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]87
88
89
90
91
92
93
94
95
96
97
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]98
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]99<html>
100<head>
101
102
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]103<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
104<meta name="viewport" content="width=device-width" />
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]105
106<link rel="shortcut icon" type="image/x-icon" href="/favicon.ico" />
107<title>LocationRequest | Android Developers</title>
108
109<!-- STYLESHEETS -->
110<link rel="stylesheet"
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]111href="//fonts.googleapis.com/css?family=Roboto+Condensed">
112<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Roboto:light,regular,medium,thin,italic,mediumitalic,bold"
113 title="roboto">
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]114<link href="/assets/css/default.css?v=4" rel="stylesheet" type="text/css">
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]115
116
117
118<!-- JAVASCRIPT -->
119<script src="//www.google.com/jsapi" type="text/javascript"></script>
120<script src="/assets/js/android_3p-bundle.js" type="text/javascript"></script>
121<script type="text/javascript">
122 var toRoot = "/";
Dirk Doughertyd1898452013-12-02 11:34:20 -0800[diff] [blame]123 var metaTags = [];
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]124 var devsite = false;
125</script>
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]126<script src="/assets/js/docs.js?v=3" type="text/javascript"></script>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]127
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]128
129
Quddus Chong559c0062014-06-12 13:59:34 -0700[diff] [blame]130<script>
131 (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
132 (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
133 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
134 })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]135
Quddus Chong559c0062014-06-12 13:59:34 -0700[diff] [blame]136 ga('create', 'UA-5831155-1', 'android.com');
137 ga('create', 'UA-49880327-2', 'android.com', {'name': 'universal'}); // New tracker);
138 ga('send', 'pageview');
139 ga('universal.send', 'pageview'); // Send page view for new tracker.
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]140</script>
Quddus Chong559c0062014-06-12 13:59:34 -0700[diff] [blame]141
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]142</head>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]143
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]144<body class="gc-documentation google
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]145 develop reference" itemscope itemtype="http://schema.org/Article">
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]146 <div id="doc-api-level" class="" style="display:none"></div>
147 <a name="top"></a>
148
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]149
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]150<a name="top"></a>
151
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]152<!-- dialog to prompt lang pref change when loaded from hardcoded URL
153<div id="langMessage" style="display:none">
154 <div>
155 <div class="lang en">
156 <p>You requested a page in English, would you like to proceed with this language setting?</p>
157 </div>
158 <div class="lang es">
159 <p>You requested a page in Spanish (Español), would you like to proceed with this language setting?</p>
160 </div>
161 <div class="lang ja">
162 <p>You requested a page in Japanese (日本語), would you like to proceed with this language setting?</p>
163 </div>
164 <div class="lang ko">
165 <p>You requested a page in Korean (한국어), would you like to proceed with this language setting?</p>
166 </div>
167 <div class="lang ru">
168 <p>You requested a page in Russian (Русский), would you like to proceed with this language setting?</p>
169 </div>
170 <div class="lang zh-cn">
171 <p>You requested a page in Simplified Chinese (简体中文), would you like to proceed with this language setting?</p>
172 </div>
173 <div class="lang zh-tw">
174 <p>You requested a page in Traditional Chinese (繁體中文), would you like to proceed with this language setting?</p>
175 </div>
176 <a href="#" class="button yes" onclick="return false;">
177 <span class="lang en">Yes</span>
178 <span class="lang es">Sí</span>
179 <span class="lang ja">Yes</span>
180 <span class="lang ko">Yes</span>
181 <span class="lang ru">Yes</span>
182 <span class="lang zh-cn">是的</span>
183 <span class="lang zh-tw">没有</span>
184 </a>
185 <a href="#" class="button" onclick="$('#langMessage').hide();return false;">
186 <span class="lang en">No</span>
187 <span class="lang es">No</span>
188 <span class="lang ja">No</span>
189 <span class="lang ko">No</span>
190 <span class="lang ru">No</span>
191 <span class="lang zh-cn">没有</span>
192 <span class="lang zh-tw">没有</span>
193 </a>
194 </div>
195</div> -->
196
197
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]198 <!-- Header -->
199 <div id="header-wrapper">
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]200 <div id="header">
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]201
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]202
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]203
204
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]205 <div class="wrap" id="header-wrap">
206 <div class="col-3 logo">
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]207 <a href="/index.html">
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]208 <img src="/assets/images/dac_logo.png"
209 srcset="/assets/images/dac_logo@2x.png 2x"
210 width="123" height="25" alt="Android Developers" />
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]211 </a>
212 <div class="btn-quicknav" id="btn-quicknav">
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]213 <a href="#" class="arrow-inactive">Quicknav</a>
214 <a href="#" class="arrow-active">Quicknav</a>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]215 </div>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]216 </div>
217 <ul class="nav-x col-9">
218 <li class="design">
219 <a href="/design/index.html"
220 zh-tw-lang="設計"
221 zh-cn-lang="设计"
222 ru-lang="Проектирование"
223 ko-lang="디자인"
224 ja-lang="設計"
225 es-lang="Diseñar"
226 >Design</a></li>
227 <li class="develop"><a href="/develop/index.html"
228 zh-tw-lang="開發"
229 zh-cn-lang="开发"
230 ru-lang="Разработка"
231 ko-lang="개발"
232 ja-lang="開発"
233 es-lang="Desarrollar"
234 >Develop</a></li>
235 <li class="distribute last"><a href="/distribute/index.html"
236 zh-tw-lang="發佈"
237 zh-cn-lang="分发"
238 ru-lang="Распространение"
239 ko-lang="배포"
240 ja-lang="配布"
241 es-lang="Distribuir"
242 >Distribute</a></li>
243 </ul>
244
245
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]246
247
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]248<div class="menu-container">
249 <div class="moremenu">
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]250 <div id="more-btn"></div>
251 </div>
252 <div class="morehover" id="moremenu">
253 <div class="top"></div>
254 <div class="mid">
255 <div class="header">Links</div>
256 <ul>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]257 <li><a href="https://play.google.com/apps/publish/" target="_googleplay">Google Play Developer Console</a></li>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]258 <li><a href="http://android-developers.blogspot.com/">Android Developers Blog</a></li>
259 <li><a href="/about/index.html">About Android</a></li>
260 </ul>
261 <div class="header">Android Sites</div>
262 <ul>
263 <li><a href="http://www.android.com">Android.com</a></li>
264 <li class="active"><a>Android Developers</a></li>
265 <li><a href="http://source.android.com">Android Open Source Project</a></li>
266 </ul>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]267
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]268
269
270 <div class="header">Language</div>
271 <div id="language" class="locales">
272 <select name="language" onChange="changeLangPref(this.value, true)">
273 <option value="en">English</option>
274 <option value="es">Español</option>
275 <option value="ja">日本語</option>
276 <option value="ko">한국어</option>
277 <option value="ru">Русский</option>
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]278 <option value="zh-cn">中文（简体)</option>
279 <option value="zh-tw">中文（繁體)</option>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]280 </select>
281 </div>
282 <script type="text/javascript">
283 <!--
284 loadLangPref();
285 //-->
286 </script>
287
288
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]289 <br class="clearfix" />
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]290 </div><!-- end 'mid' -->
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]291 <div class="bottom"></div>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]292 </div><!-- end 'moremenu' -->
293
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]294 <div class="search" id="search-container">
295 <div class="search-inner">
296 <div id="search-btn"></div>
297 <div class="left"></div>
298 <form onsubmit="return submit_search()">
299 <input id="search_autocomplete" type="text" value="" autocomplete="off" name="q"
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]300 onfocus="search_focus_changed(this, true)" onblur="search_focus_changed(this, false)"
301 onkeydown="return search_changed(event, true, '/')"
302 onkeyup="return search_changed(event, false, '/')" />
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]303 </form>
304 <div class="right"></div>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]305 <a class="close hide">close</a>
306 <div class="left"></div>
307 <div class="right"></div>
308 </div><!-- end search-inner -->
309 </div><!-- end search-container -->
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]310
311 <div class="search_filtered_wrapper reference">
312 <div class="suggest-card reference no-display">
313 <ul class="search_filtered">
314 </ul>
315 </div>
316 </div>
317
318 <div class="search_filtered_wrapper docs">
319 <div class="suggest-card dummy no-display">&nbsp;</div>
320 <div class="suggest-card develop no-display">
321 <ul class="search_filtered">
322 </ul>
323 <div class="child-card guides no-display">
324 </div>
325 <div class="child-card training no-display">
326 </div>
quddusc563daee2013-12-03 19:31:14 -0800[diff] [blame]327 <div class="child-card samples no-display">
328 </div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]329 </div>
330 <div class="suggest-card design no-display">
331 <ul class="search_filtered">
332 </ul>
333 </div>
334 <div class="suggest-card distribute no-display">
335 <ul class="search_filtered">
336 </ul>
337 </div>
338 </div>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]339</div><!-- end menu-container (search and menu widget) -->
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]340
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]341
342
343 <!-- Expanded quicknav -->
Quddus Chong559c0062014-06-12 13:59:34 -0700[diff] [blame]344 <div id="quicknav" class="col-13">
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]345 <ul>
Quddus Chong559c0062014-06-12 13:59:34 -0700[diff] [blame]346 <li class="about">
347 <ul>
348 <li><a href="/about/index.html">About</a></li>
349 <li><a href="/wear/index.html">Wear</a></li>
350 <li><a href="/tv/index.html">TV</a></li>
351 <li><a href="/auto/index.html">Auto</a></li>
352 </ul>
353 </li>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]354 <li class="design">
355 <ul>
356 <li><a href="/design/index.html">Get Started</a></li>
Quddus Chong559c0062014-06-12 13:59:34 -0700[diff] [blame]357 <li><a href="/design/devices.html">Devices</a></li>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]358 <li><a href="/design/style/index.html">Style</a></li>
359 <li><a href="/design/patterns/index.html">Patterns</a></li>
360 <li><a href="/design/building-blocks/index.html">Building Blocks</a></li>
361 <li><a href="/design/downloads/index.html">Downloads</a></li>
362 <li><a href="/design/videos/index.html">Videos</a></li>
363 </ul>
364 </li>
365 <li class="develop">
366 <ul>
367 <li><a href="/training/index.html"
368 zh-tw-lang="訓練課程"
369 zh-cn-lang="培训"
370 ru-lang="Курсы"
371 ko-lang="교육"
372 ja-lang="トレーニング"
373 es-lang="Capacitación"
374 >Training</a></li>
375 <li><a href="/guide/index.html"
376 zh-tw-lang="API 指南"
377 zh-cn-lang="API 指南"
378 ru-lang="Руководства по API"
379 ko-lang="API 가이드"
380 ja-lang="API ガイド"
381 es-lang="Guías de la API"
382 >API Guides</a></li>
383 <li><a href="/reference/packages.html"
384 zh-tw-lang="參考資源"
385 zh-cn-lang="参考"
386 ru-lang="Справочник"
387 ko-lang="참조문서"
388 ja-lang="リファレンス"
389 es-lang="Referencia"
390 >Reference</a></li>
Quddus Chong559c0062014-06-12 13:59:34 -0700[diff] [blame]391 <li><a href="/sdk/index.html"
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]392 zh-tw-lang="相關工具"
393 zh-cn-lang="工具"
394 ru-lang="Инструменты"
395 ko-lang="도구"
396 ja-lang="ツール"
397 es-lang="Herramientas"
398 >Tools</a>
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]399 </li>
400 <li><a href="/google/index.html">Google Services</a>
401 </li>
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]402
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]403 <li><a href="/samples/index.html">Samples</a>
404 </li>
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]405
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]406 </ul>
407 </li>
408 <li class="distribute last">
409 <ul>
410 <li><a href="/distribute/googleplay/index.html">Google Play</a></li>
411 <li><a href="/distribute/essentials/index.html">Essentials</a></li>
412 <li><a href="/distribute/users/index.html">Get Users</a></li>
413 <li><a href="/distribute/engage/index.html">Engage &amp; Retain</a></li>
414 <li><a href="/distribute/monetize/index.html">Monetize</a></li>
415 <li><a href="/distribute/tools/index.html">Tools &amp; Reference</a></li>
416 <li><a href="/distribute/stories/index.html">Developer Stories</a></li>
417 </ul>
418 </li>
419 </ul>
420 </div><!-- /Expanded quicknav -->
421 </div><!-- end header-wrap.wrap -->
422 </div><!-- end header -->
423
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]424
425 <!-- Secondary x-nav -->
426 <div id="nav-x">
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]427 <div class="wrap" style="position:relative;z-index:1">
428
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]429
430
431
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]432
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]433 <ul class="nav-x col-9 develop" style="width:100%">
434 <li class="training"><a href="/training/index.html"
435 zh-tw-lang="訓練課程"
436 zh-cn-lang="培训"
437 ru-lang="Курсы"
438 ko-lang="교육"
439 ja-lang="トレーニング"
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]440 es-lang="Capacitación"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]441 >Training</a></li>
quddusc563daee2013-12-03 19:31:14 -0800[diff] [blame]442 <li class="guide"><a href="/guide/index.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]443 zh-tw-lang="API 指南"
444 zh-cn-lang="API 指南"
445 ru-lang="Руководства по API"
446 ko-lang="API 가이드"
447 ja-lang="API ガイド"
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]448 es-lang="Guías de la API"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]449 >API Guides</a></li>
450 <li class="reference"><a href="/reference/packages.html"
451 zh-tw-lang="參考資源"
452 zh-cn-lang="参考"
453 ru-lang="Справочник"
454 ko-lang="참조문서"
455 ja-lang="リファレンス"
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]456 es-lang="Referencia"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]457 >Reference</a></li>
Quddus Chong559c0062014-06-12 13:59:34 -0700[diff] [blame]458 <li class="tools"><a href="/sdk/index.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]459 zh-tw-lang="相關工具"
460 zh-cn-lang="工具"
461 ru-lang="Инструменты"
462 ko-lang="도구"
463 ja-lang="ツール"
464 es-lang="Herramientas"
465 >Tools</a></li>
466 <li class="google"><a href="/google/index.html"
467 >Google Services</a>
468 </li>
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]469
Dirk Doughertyd1898452013-12-02 11:34:20 -0800[diff] [blame]470 <li class="samples"><a href="/samples/index.html"
471 >Samples</a>
472 </li>
473
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]474 </ul>
475 </div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]476 </div>
Quddus Chong559c0062014-06-12 13:59:34 -0700[diff] [blame]477 <!-- /Sendondary x-nav DEVELOP -->
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]478
479
480
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]481 <div id="searchResults" class="wrap" style="display:none;">
482 <h2 id="searchTitle">Results</h2>
483 <div id="leftSearchControl" class="search-control">Loading...</div>
484 </div>
485 </div> <!--end header-wrapper -->
486
487 <div id="sticky-header">
488 <div>
489 <a class="logo" href="#top"></a>
490 <a class="top" href="#top"></a>
491 <ul class="breadcrumb">
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]492
Quddus Chong26ca3fa2014-05-06 17:02:49 -0700[diff] [blame]493 <li class="current">LocationRequest</li>
494 </ul>
495 </div>
496 </div>
497
498
499
500
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]501
502
503 <div class="wrap clearfix" id="body-content">
504 <div class="col-4" id="side-nav" itemscope itemtype="http://schema.org/SiteNavigationElement">
505 <div id="devdoc-nav" class="scroll-pane">
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]506
507
508
509<ul id="nav">
Dirk Doughertya38ca332013-05-15 02:36:33 -0700[diff] [blame]510
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]511 <li class="nav-section">
512 <div class="nav-section-header empty"><a href="/google/index.html">
Dirk Doughertya38ca332013-05-15 02:36:33 -0700[diff] [blame]513 <span class="en">Overview</span>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]514 </a></div>
515 </li>
516
517 <li class="nav-section">
Dirk Doughertya38ca332013-05-15 02:36:33 -0700[diff] [blame]518 <div class="nav-section-header empty"><a href="/google/play-services/games.html">
519 <span class="en">Games</span>
520 </a></div>
521 </li>
522 <li class="nav-section">
523 <div class="nav-section-header empty"><a href="/google/play-services/location.html">
524 <span class="en">Location</span>
525 </a></div>
526 </li>
527 <li class="nav-section">
528 <div class="nav-section-header empty"><a href="/google/play-services/plus.html">
529 <span class="en">Google+</span>
530 </a></div>
531 </li>
532 <li class="nav-section">
533 <div class="nav-section-header empty"><a href="/google/play-services/maps.html">
Dirk Doughertyeb768482013-10-29 22:25:12 -0700[diff] [blame]534 <span class="en">Maps</span>
535 </a></div>
536 </li>
537 <li class="nav-section">
Dirk Dougherty16542642014-02-07 19:58:28 -0800[diff] [blame]538 <div class="nav-section-header empty"><a href="/google/play-services/drive.html">
539 <span class="en">Drive</span>
540 </a></div>
541 </li>
542 <li class="nav-section">
543 <div class="nav-section-header empty"><a href="/google/play-services/cast.html">
544 <span class="en">Cast</span>
545 </a></div>
546 </li>
547 <li class="nav-section">
Dirk Doughertyeb768482013-10-29 22:25:12 -0700[diff] [blame]548 <div class="nav-section-header"><a href="/google/play-services/ads.html">
549 <span class="en">Ads</span></a>
550 </div>
551 <ul>
552 <li><a href="/google/play-services/id.html">
553 <span class="en">Advertising ID</span></a>
554 </li>
555 </ul>
556 </li>
557 <li class="nav-section">
558 <div class="nav-section-header empty"><a href="/google/play-services/wallet.html">
559 <span class="en">Wallet</span>
Dirk Doughertya38ca332013-05-15 02:36:33 -0700[diff] [blame]560 </a></div>
561 </li>
Dirk Doughertya38ca332013-05-15 02:36:33 -0700[diff] [blame]562
563
564 <li class="nav-section">
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]565 <div class="nav-section-header"><a href="/google/play-services/index.html">
566 <span class="en">Google Play Services</span></a>
567 </div>
568 <ul>
569 <li><a href="/google/play-services/setup.html">
Quddus Chonge457fb62014-09-11 18:55:43 -0700[diff] [blame]570 <span class="en">Setting Up Google Play Services</span></a>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]571 </li>
quddusc682d8e92014-03-13 11:55:32 -0700[diff] [blame]572 <li class="nav-section">
573 <div class="nav-section-header"><a href="/google/auth/api-client.html">
Quddus Chonge457fb62014-09-11 18:55:43 -0700[diff] [blame]574 <span class="en">Accessing Google APIs</span></a>
quddusc682d8e92014-03-13 11:55:32 -0700[diff] [blame]575 </div>
576 <ul>
577 <li>
578 <a href="/google/auth/http-auth.html">
579 <span class="en">Authorizing with Google for REST APIs</span>
580 </a>
581 </li>
582 </ul>
583 </li>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]584 <li id="gms-tree-list" class="nav-section">
585 <div class="nav-section-header">
586 <a href="/reference/gms-packages.html">
587 <span class="en">Reference</span>
588 </a>
589 <div>
590 </li>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]591 </ul>
592 </li>
593
594
595 <li class="nav-section">
596 <div class="nav-section-header"><a href="/google/play/billing/index.html">
597 <span class="en">Google Play In-app Billing</span></a>
598 </div>
599 <ul>
600 <li><a href="/google/play/billing/billing_overview.html">
601 <span class="en">Overview</span></a>
602 </li>
603 <li class="nav-section"><div class="nav-section-header"><a href="/google/play/billing/api.html">
604 <span class="en">Version 3 API</span></a></div>
605 <ul>
606 <li><a href="/google/play/billing/billing_integrate.html">
607 <span class="en">Implementing the API</span></a></li>
608 <li><a href="/google/play/billing/billing_reference.html">
609 <span class="en">Reference</span></a></li>
610 </ul>
611 </li>
612 <li class="nav-section"><div class="nav-section-header"><a href="/google/play/billing/v2/api.html">
613 <span class="en">Version 2 API</span></a></div>
614 <ul>
615 <li><a href="/google/play/billing/v2/billing_integrate.html">
616 <span class="en">Implementing the API</span></a></li>
617 <li><a href="/google/play/billing/v2/billing_subscriptions.html">
618 <span class="en">Subscriptions</span></a></li>
619 <li><a href="/google/play/billing/v2/billing_reference.html">
620 <span class="en">Reference</span></a></li>
621 </ul>
622 </li>
623 <li><a href="/google/play/billing/billing_subscriptions.html">
624 <span class="en">Subscriptions</span></a>
625 </li>
626 <li><a href="/google/play/billing/billing_best_practices.html">
627 <span class="en">Security and Design</span></a>
628 </li>
629 <li><a href="/google/play/billing/billing_testing.html">
630 <span class="en">Testing In-app Billing</span></a>
631 </li>
632 <li><a href="/google/play/billing/billing_admin.html">
633 <span class="en">Administering In-app Billing</span></a>
634 </li>
635 <li><a href="/google/play/billing/versions.html">
636 <span class="en">Version Notes</span></a>
637 </li>
638 </ul>
639 </li>
640
Dirk Doughertya38ca332013-05-15 02:36:33 -0700[diff] [blame]641
642
Dirk Doughertyd1898452013-12-02 11:34:20 -0800[diff] [blame]643 <li class="nav-section">
Dirk Doughertya38ca332013-05-15 02:36:33 -0700[diff] [blame]644 <div class="nav-section-header"><a href="/google/gcm/index.html">
645 <span class="en">Google Cloud Messaging</span></a>
646 </div>
647 <ul>
Dirk Doughertyd1898452013-12-02 11:34:20 -0800[diff] [blame]648 <li><a href="/google/gcm/gcm.html">
649 <span class="en">Overview</span></a>
650 </li>
Dirk Doughertya38ca332013-05-15 02:36:33 -0700[diff] [blame]651 <li><a href="/google/gcm/gs.html">
652 <span class="en">Getting Started</span></a>
653 </li>
Dirk Doughertyd1898452013-12-02 11:34:20 -0800[diff] [blame]654 <li><a href="/google/gcm/client.html">
655 <span class="en">Implementing GCM Client</span></a>
Dirk Doughertya38ca332013-05-15 02:36:33 -0700[diff] [blame]656 </li>
Dirk Doughertyd1898452013-12-02 11:34:20 -0800[diff] [blame]657 <li class="nav-section"><div class="nav-section-header"><a href="/google/gcm/server.html">
658 <span class="en">Implementing GCM Server</span></a></div>
659 <ul>
660 <li><a href="/google/gcm/ccs.html">
661 <span class="en">CCS (XMPP)</span></a></li>
662 <li><a href="/google/gcm/http.html">
663 <span class="en">HTTP</span></a></li>
664 </ul>
Dirk Doughertyfe3da792013-06-12 18:06:08 -0700[diff] [blame]665 </li>
666 <li><a href="/google/gcm/notifications.html">
667 <span class="en">User Notifications</span></a>
668 </li>
Dirk Doughertya38ca332013-05-15 02:36:33 -0700[diff] [blame]669 <li><a href="/google/gcm/adv.html">
670 <span class="en">Advanced Topics</span></a>
671 </li>
672 <li><a href="/google/gcm/c2dm.html">
673 <span class="en">Migration</span></a>
674 </li>
675 <li id="gcm-tree-list" class="nav-section">
676 <div class="nav-section-header">
677 <a href="/reference/gcm-packages.html">
678 <span class="en">Reference</span>
679 </a>
680 <div>
681 </li>
682 </ul>
683 </li>
684
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]685 <li class="nav-section">
Quddus Chonge457fb62014-09-11 18:55:43 -0700[diff] [blame]686 <div class="nav-section-header empty"><a href="/google/gcs/index.html">
687 <span class="en">Google Cloud Save</span></a>
688 </div>
689 </li>
690
691 <li class="nav-section">
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]692 <div class="nav-section-header"><a href="/google/play/dist.html">
693 <span class="en">Google Play Distribution</span></a>
694 </div>
695 <ul>
696 <li><a href="/google/play/filters.html">
697 <span class="en">Filters on Google Play</span></a>
698 </li>
Quddus Chonge457fb62014-09-11 18:55:43 -0700[diff] [blame]699 <li><a href="/google/play/billing/gp-purchase-status-api.html">
700 <span class="en">Google Play Developer API</span></a>
701 </li>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]702 <li><a href="/google/play/publishing/multiple-apks.html">
703 <span class="en">Multiple APK Support</span></a>
704 </li>
705 <li><a href="/google/play/expansion-files.html">
706 <span class="en">APK Expansion Files</span></a>
707 </li>
708 <li class="nav-section">
709 <div class="nav-section-header"><a href="/google/play/licensing/index.html">
710 <span class="en">Application Licensing</span></a>
711 </div>
712 <ul>
713 <li><a href="/google/play/licensing/overview.html">
714 <span class="en">Licensing Overview</span></a>
715 </li>
716 <li><a href="/google/play/licensing/setting-up.html">
717 <span class="en">Setting Up for Licensing</span></a>
718 </li>
719 <li><a href="/google/play/licensing/adding-licensing.html">
720 <span class="en">Adding Licensing to Your App</span></a>
721 </li>
722 <li><a href="/google/play/licensing/licensing-reference.html">
723 <span class="en">Licensing Reference</span></a>
724 </li>
725 </ul>
726 </li>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]727
728 <li class="nav-section">
729 <div class="nav-section-header"><a href="/google/backup/index.html">
730 Android Backup Service</a>
731 </div>
732 <ul>
733 <li><a href="/google/backup/signup.html">
734 Register</a>
735 </li>
736 </ul>
737 </li>
738
Dirk Doughertya38ca332013-05-15 02:36:33 -0700[diff] [blame]739 </ul>
740
741</li>
742
743
744
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]745</ul>
746
747<script type="text/javascript">
748<!--
749 buildToggleLists();
750 changeNavLang(getLangPref());
751//-->
752</script>
753
754
755
756
757 </div>
758 <script type="text/javascript">
759 showGoogleRefTree();
760
761 </script>
762 </div> <!-- end side-nav -->
763 <script>
764 $(document).ready(function() {
765 scrollIntoView("devdoc-nav");
766 });
767 </script>
768
769
770
771
772
773
774<div class="col-12" id="doc-col">
775
776<div id="api-info-block">
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797<div class="sum-details-links">
798
799Summary:
800
801
802
803
804
805 <a href="#constants">Constants</a>
806
807
808
809 &#124; <a href="#inhconstants">Inherited Constants</a>
810
811
812
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]813
814
815
816
817 &#124; <a href="#pubmethods">Methods</a>
818
819
820
821
822 &#124; <a href="#inhmethods">Inherited Methods</a>
823
824&#124; <a href="#" onclick="return toggleAllClassInherited()" id="toggleAllClassInherited">[Expand All]</a>
825
826</div><!-- end sum-details-links -->
827<div class="api-level">
828
829
830
831
832</div>
833</div><!-- end api-info-block -->
834
835
836<!-- ======== START OF CLASS DATA ======== -->
837
838<div id="jd-header">
839 public
840
841 final
842
843 class
844<h1 itemprop="name">LocationRequest</h1>
845
846
847
848
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]849 extends Object<br/>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]850
851
852
853
854
855
856 implements
857
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]858 Parcelable
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]859
860
861
862
863
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]864
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]865
866
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]867</div><!-- end header -->
868
869<div id="naMessage"></div>
870
871<div id="jd-content" class="api apilevel-">
872<table class="jd-inheritance-table">
873
874
875 <tr>
876
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]877 <td colspan="2" class="jd-inheritance-class-cell">java.lang.Object</td>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]878 </tr>
879
880
881 <tr>
882
883 <td class="jd-inheritance-space">&nbsp;&nbsp;&nbsp;&#x21b3;</td>
884
885 <td colspan="1" class="jd-inheritance-class-cell">com.google.android.gms.location.LocationRequest</td>
886 </tr>
887
888
889</table>
890
891
892
893
894
895
896
897<div class="jd-descr">
898
899
900<h2>Class Overview</h2>
901<p itemprop="articleBody">A data object that contains quality of service parameters for requests to
Quddus Chonge457fb62014-09-11 18:55:43 -0700[diff] [blame]902 the <code><a href="/reference/com/google/android/gms/location/FusedLocationProviderApi.html">FusedLocationProviderApi</a></code>.
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]903
904 <p>LocationRequest objects are used to request a quality of service for location updates from
Quddus Chonge457fb62014-09-11 18:55:43 -0700[diff] [blame]905 the <code><a href="/reference/com/google/android/gms/location/FusedLocationProviderApi.html">FusedLocationProviderApi</a></code>.
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]906
907 <p>For example, if your application wants high accuracy location it should create a location
908 request with <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setPriority(int)">setPriority(int)</a></code> set to <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#PRIORITY_HIGH_ACCURACY">PRIORITY_HIGH_ACCURACY</a></code> and
909 <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setInterval(long)">setInterval(long)</a></code> to 5 seconds. This would be appropriate for mapping applications that are
910 showing your location in real-time.
911
912 <p>At the other extreme, if you want negligible power impact, but to still receive location
913 updates when available, then create a location request with <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setPriority(int)">setPriority(int)</a></code> set to
914 <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#PRIORITY_NO_POWER">PRIORITY_NO_POWER</a></code>. With this request your application will not trigger (and therefore
915 will not receive any power blame) any location updates, but will receive locations triggered by
916 other applications. This would be appropriate for applications that have no firm requirement
917 for location, but can take advantage when available.
918
919 <p>In between these two extremes is a very common use-case, where applications definitely want
920 to receive updates at a specified interval, and can receive them faster when available, but
921 still want a low power impact. These applications should consider
922 <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#PRIORITY_BALANCED_POWER_ACCURACY">PRIORITY_BALANCED_POWER_ACCURACY</a></code> combined with a faster
923 <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setFastestInterval(long)">setFastestInterval(long)</a></code> (such as 1 minute) and a slower <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setInterval(long)">setInterval(long)</a></code>
924 (such as 60 minutes). They will only be assigned power blame for the interval set by
925 <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setInterval(long)">setInterval(long)</a></code>, but can still receive locations triggered by other applications at a rate
926 up to <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setFastestInterval(long)">setFastestInterval(long)</a></code>. This style of request is appropriate for many location aware
927 applications, including background usage. Do be careful to also throttle
928 <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setFastestInterval(long)">setFastestInterval(long)</a></code> if you perform heavy-weight work after receiving an update - such
929 as using the network.
930
931 <p>Activities should strongly consider removing all location request when entering
Dirk Dougherty4e847bd2013-08-06 09:59:51 -0700[diff] [blame]932 the background (for example at <code><a href="/reference/android/app/Activity.html#onPause()">onPause()</a></code>), or at least swap the
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]933 request to a larger interval and lower quality.
934
935 <p>Applications cannot specify the exact location sources, such as GPS, that are used by the
936 LocationClient. In fact, the system may have multiple location sources (providers) running and
937 may fuse the results from several sources into a single Location object.
938
939 <p>Location requests from applications with
Dirk Dougherty4e847bd2013-08-06 09:59:51 -0700[diff] [blame]940 <code><a href="/reference/android/Manifest.permission.html#ACCESS_COARSE_LOCATION">ACCESS_COARSE_LOCATION</a></code> and not
941 <code><a href="/reference/android/Manifest.permission.html#ACCESS_FINE_LOCATION">ACCESS_FINE_LOCATION</a></code> will be automatically throttled to a
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]942 slower interval, and the location object will be obfuscated to only show a coarse level of
943 accuracy.
944
Dirk Dougherty8f1a7592013-06-28 14:04:39 -0700[diff] [blame]945 <p>All location requests are considered hints, and you may receive locations that are
946 more/less accurate, and faster/slower than requested.
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]947</p>
948
949
950
951
952
953</div><!-- jd-descr -->
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970<div class="jd-descr">
971
972
973<h2>Summary</h2>
974
975
976
977
978
979
980
981
982
983
984
985
986
987<!-- =========== ENUM CONSTANT SUMMARY =========== -->
988<table id="constants" class="jd-sumtable"><tr><th colspan="12">Constants</th></tr>
989
990
991
992 <tr class="alt-color api apilevel-" >
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]993 <td class="jd-typecol">int</td>
994 <td class="jd-linkcol"><a href="/reference/com/google/android/gms/location/LocationRequest.html#PRIORITY_BALANCED_POWER_ACCURACY">PRIORITY_BALANCED_POWER_ACCURACY</a></td>
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]995 <td class="jd-descrcol" width="100%">
996 Used with <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setPriority(int)">setPriority(int)</a></code> to request "block" level accuracy.
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]997
998
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]999
1000 </td>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1001 </tr>
1002
1003
Dirk Doughertyc1609c42013-08-01 15:30:06 -0700[diff] [blame]1004 <tr class=" api apilevel-" >
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1005 <td class="jd-typecol">int</td>
1006 <td class="jd-linkcol"><a href="/reference/com/google/android/gms/location/LocationRequest.html#PRIORITY_HIGH_ACCURACY">PRIORITY_HIGH_ACCURACY</a></td>
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1007 <td class="jd-descrcol" width="100%">
1008 Used with <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setPriority(int)">setPriority(int)</a></code> to request the most accurate locations available.
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1009
1010
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1011
1012 </td>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1013 </tr>
1014
1015
Dirk Doughertyc1609c42013-08-01 15:30:06 -0700[diff] [blame]1016 <tr class="alt-color api apilevel-" >
1017 <td class="jd-typecol">int</td>
1018 <td class="jd-linkcol"><a href="/reference/com/google/android/gms/location/LocationRequest.html#PRIORITY_LOW_POWER">PRIORITY_LOW_POWER</a></td>
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1019 <td class="jd-descrcol" width="100%">
1020 Used with <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setPriority(int)">setPriority(int)</a></code> to request "city" level accuracy.
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1021
1022
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1023
1024 </td>
Dirk Doughertyc1609c42013-08-01 15:30:06 -0700[diff] [blame]1025 </tr>
1026
1027
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1028 <tr class=" api apilevel-" >
1029 <td class="jd-typecol">int</td>
1030 <td class="jd-linkcol"><a href="/reference/com/google/android/gms/location/LocationRequest.html#PRIORITY_NO_POWER">PRIORITY_NO_POWER</a></td>
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1031 <td class="jd-descrcol" width="100%">
1032 Used with <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setPriority(int)">setPriority(int)</a></code> to request the best accuracy possible with zero additional
1033 power consumption.
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1034
1035
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1036
1037 </td>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1038 </tr>
1039
1040
1041
1042</table>
1043
1044
1045
1046
1047
1048<!-- =========== ENUM CONSTANT SUMMARY =========== -->
1049<table id="inhconstants" class="jd-sumtable"><tr><th>
1050 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
1051 <div style="clear:left;">Inherited Constants</div></th></tr>
1052
1053
1054
1055
1056<tr class="api apilevel-" >
1057<td colspan="12">
1058
1059 <a href="#" onclick="return toggleInherited(this, null)" id="inherited-constants-android.os.Parcelable" class="jd-expando-trigger closed"
1060 ><img id="inherited-constants-android.os.Parcelable-trigger"
1061 src="/assets/images/triangle-closed.png"
1062 class="jd-expando-trigger-img" /></a>From interface
1063android.os.Parcelable
1064<div id="inherited-constants-android.os.Parcelable">
1065 <div id="inherited-constants-android.os.Parcelable-list"
1066 class="jd-inheritedlinks">
1067 </div>
1068 <div id="inherited-constants-android.os.Parcelable-summary" style="display: none;">
1069 <table class="jd-sumtable-expando">
1070
1071
1072
1073 <tr class="alt-color api apilevel-" >
1074 <td class="jd-typecol">int</td>
1075 <td class="jd-linkcol">CONTENTS_FILE_DESCRIPTOR</td>
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1076 <td class="jd-descrcol" width="100%">
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1077
1078
1079
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1080
1081 </td>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1082 </tr>
1083
1084
1085 <tr class=" api apilevel-" >
1086 <td class="jd-typecol">int</td>
1087 <td class="jd-linkcol">PARCELABLE_WRITE_RETURN_VALUE</td>
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1088 <td class="jd-descrcol" width="100%">
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1089
1090
1091
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1092
1093 </td>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1094 </tr>
1095
1096
1097</table>
1098 </div>
1099</div>
1100</td></tr>
1101
1102
1103</table>
1104
1105
1106
1107
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1108
1109
1110
1111
1112
1113
1114
1115
1116
1117<!-- ========== METHOD SUMMARY =========== -->
1118<table id="pubmethods" class="jd-sumtable"><tr><th colspan="12">Public Methods</th></tr>
1119
1120
1121
1122
1123 <tr class="alt-color api apilevel-" >
1124 <td class="jd-typecol"><nobr>
1125
1126
1127
1128 static
1129
1130 <a href="/reference/com/google/android/gms/location/LocationRequest.html">LocationRequest</a></nobr>
1131 </td>
1132 <td class="jd-linkcol" width="100%"><nobr>
1133 <span class="sympad"><a href="/reference/com/google/android/gms/location/LocationRequest.html#create()">create</a></span>()</nobr>
1134
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1135 <div class="jd-descrdiv">
1136 Create a location request with default parameters.
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1137
1138
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1139
1140 </div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1141
1142 </td></tr>
1143
1144
1145
1146 <tr class=" api apilevel-" >
1147 <td class="jd-typecol"><nobr>
1148
1149
1150
1151
1152
1153 int</nobr>
1154 </td>
1155 <td class="jd-linkcol" width="100%"><nobr>
1156 <span class="sympad"><a href="/reference/com/google/android/gms/location/LocationRequest.html#describeContents()">describeContents</a></span>()</nobr>
1157
1158 </td></tr>
1159
1160
1161
1162 <tr class="alt-color api apilevel-" >
1163 <td class="jd-typecol"><nobr>
1164
1165
1166
1167
1168
Dirk Dougherty8f1a7592013-06-28 14:04:39 -0700[diff] [blame]1169 boolean</nobr>
1170 </td>
1171 <td class="jd-linkcol" width="100%"><nobr>
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1172 <span class="sympad"><a href="/reference/com/google/android/gms/location/LocationRequest.html#equals(java.lang.Object)">equals</a></span>(Object object)</nobr>
Dirk Dougherty8f1a7592013-06-28 14:04:39 -0700[diff] [blame]1173
1174 </td></tr>
1175
1176
1177
1178 <tr class=" api apilevel-" >
1179 <td class="jd-typecol"><nobr>
1180
1181
1182
1183
1184
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1185 long</nobr>
1186 </td>
1187 <td class="jd-linkcol" width="100%"><nobr>
1188 <span class="sympad"><a href="/reference/com/google/android/gms/location/LocationRequest.html#getExpirationTime()">getExpirationTime</a></span>()</nobr>
1189
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1190 <div class="jd-descrdiv">
1191 Get the request expiration time, in milliseconds since boot.
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1192
1193
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1194
1195 </div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1196
1197 </td></tr>
1198
1199
1200
Dirk Dougherty8f1a7592013-06-28 14:04:39 -0700[diff] [blame]1201 <tr class="alt-color api apilevel-" >
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1202 <td class="jd-typecol"><nobr>
1203
1204
1205
1206
1207
1208 long</nobr>
1209 </td>
1210 <td class="jd-linkcol" width="100%"><nobr>
1211 <span class="sympad"><a href="/reference/com/google/android/gms/location/LocationRequest.html#getFastestInterval()">getFastestInterval</a></span>()</nobr>
1212
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1213 <div class="jd-descrdiv">
1214 Get the fastest interval of this request, in milliseconds.
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1215
1216
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1217
1218 </div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1219
1220 </td></tr>
1221
1222
1223
Dirk Dougherty8f1a7592013-06-28 14:04:39 -0700[diff] [blame]1224 <tr class=" api apilevel-" >
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1225 <td class="jd-typecol"><nobr>
1226
1227
1228
1229
1230
1231 long</nobr>
1232 </td>
1233 <td class="jd-linkcol" width="100%"><nobr>
1234 <span class="sympad"><a href="/reference/com/google/android/gms/location/LocationRequest.html#getInterval()">getInterval</a></span>()</nobr>
1235
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1236 <div class="jd-descrdiv">
1237 Get the desired interval of this request, in milliseconds.
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1238
1239
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1240
1241 </div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1242
1243 </td></tr>
1244
1245
1246
Dirk Dougherty8f1a7592013-06-28 14:04:39 -0700[diff] [blame]1247 <tr class="alt-color api apilevel-" >
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1248 <td class="jd-typecol"><nobr>
1249
1250
1251
1252
1253
1254 int</nobr>
1255 </td>
1256 <td class="jd-linkcol" width="100%"><nobr>
1257 <span class="sympad"><a href="/reference/com/google/android/gms/location/LocationRequest.html#getNumUpdates()">getNumUpdates</a></span>()</nobr>
1258
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1259 <div class="jd-descrdiv">
1260 Get the number of updates requested.
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1261
1262
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1263
1264 </div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1265
1266 </td></tr>
1267
1268
1269
Dirk Dougherty8f1a7592013-06-28 14:04:39 -0700[diff] [blame]1270 <tr class=" api apilevel-" >
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1271 <td class="jd-typecol"><nobr>
1272
1273
1274
1275
1276
1277 int</nobr>
1278 </td>
1279 <td class="jd-linkcol" width="100%"><nobr>
1280 <span class="sympad"><a href="/reference/com/google/android/gms/location/LocationRequest.html#getPriority()">getPriority</a></span>()</nobr>
1281
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1282 <div class="jd-descrdiv">
1283 Get the quality of the request.
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1284
1285
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1286
1287 </div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1288
1289 </td></tr>
1290
1291
1292
Dirk Dougherty8f1a7592013-06-28 14:04:39 -0700[diff] [blame]1293 <tr class="alt-color api apilevel-" >
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1294 <td class="jd-typecol"><nobr>
1295
1296
1297
1298
1299
1300 float</nobr>
1301 </td>
1302 <td class="jd-linkcol" width="100%"><nobr>
1303 <span class="sympad"><a href="/reference/com/google/android/gms/location/LocationRequest.html#getSmallestDisplacement()">getSmallestDisplacement</a></span>()</nobr>
1304
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1305 <div class="jd-descrdiv">
1306 Get the minimum displacement between location updates in meters
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1307
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1308 <p>By default this is 0.
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1309
1310
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1311
1312 </div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1313
1314 </td></tr>
1315
1316
1317
Dirk Dougherty8f1a7592013-06-28 14:04:39 -0700[diff] [blame]1318 <tr class=" api apilevel-" >
1319 <td class="jd-typecol"><nobr>
1320
1321
1322
1323
1324
1325 int</nobr>
1326 </td>
1327 <td class="jd-linkcol" width="100%"><nobr>
1328 <span class="sympad"><a href="/reference/com/google/android/gms/location/LocationRequest.html#hashCode()">hashCode</a></span>()</nobr>
1329
1330 </td></tr>
1331
1332
1333
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1334 <tr class="alt-color api apilevel-" >
1335 <td class="jd-typecol"><nobr>
1336
1337
1338
1339
1340
1341 <a href="/reference/com/google/android/gms/location/LocationRequest.html">LocationRequest</a></nobr>
1342 </td>
1343 <td class="jd-linkcol" width="100%"><nobr>
1344 <span class="sympad"><a href="/reference/com/google/android/gms/location/LocationRequest.html#setExpirationDuration(long)">setExpirationDuration</a></span>(long millis)</nobr>
1345
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1346 <div class="jd-descrdiv">
1347 Set the duration of this request, in milliseconds.
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1348
1349
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1350
1351 </div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1352
1353 </td></tr>
1354
1355
1356
1357 <tr class=" api apilevel-" >
1358 <td class="jd-typecol"><nobr>
1359
1360
1361
1362
1363
1364 <a href="/reference/com/google/android/gms/location/LocationRequest.html">LocationRequest</a></nobr>
1365 </td>
1366 <td class="jd-linkcol" width="100%"><nobr>
1367 <span class="sympad"><a href="/reference/com/google/android/gms/location/LocationRequest.html#setExpirationTime(long)">setExpirationTime</a></span>(long millis)</nobr>
1368
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1369 <div class="jd-descrdiv">
1370 Set the request expiration time, in millisecond since boot.
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1371
1372
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1373
1374 </div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1375
1376 </td></tr>
1377
1378
1379
1380 <tr class="alt-color api apilevel-" >
1381 <td class="jd-typecol"><nobr>
1382
1383
1384
1385
1386
1387 <a href="/reference/com/google/android/gms/location/LocationRequest.html">LocationRequest</a></nobr>
1388 </td>
1389 <td class="jd-linkcol" width="100%"><nobr>
1390 <span class="sympad"><a href="/reference/com/google/android/gms/location/LocationRequest.html#setFastestInterval(long)">setFastestInterval</a></span>(long millis)</nobr>
1391
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1392 <div class="jd-descrdiv">
1393 Explicitly set the fastest interval for location updates, in milliseconds.
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1394
1395
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1396
1397 </div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1398
1399 </td></tr>
1400
1401
1402
1403 <tr class=" api apilevel-" >
1404 <td class="jd-typecol"><nobr>
1405
1406
1407
1408
1409
1410 <a href="/reference/com/google/android/gms/location/LocationRequest.html">LocationRequest</a></nobr>
1411 </td>
1412 <td class="jd-linkcol" width="100%"><nobr>
1413 <span class="sympad"><a href="/reference/com/google/android/gms/location/LocationRequest.html#setInterval(long)">setInterval</a></span>(long millis)</nobr>
1414
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1415 <div class="jd-descrdiv">
1416 Set the desired interval for active location updates, in milliseconds.
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1417
1418
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1419
1420 </div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1421
1422 </td></tr>
1423
1424
1425
1426 <tr class="alt-color api apilevel-" >
1427 <td class="jd-typecol"><nobr>
1428
1429
1430
1431
1432
1433 <a href="/reference/com/google/android/gms/location/LocationRequest.html">LocationRequest</a></nobr>
1434 </td>
1435 <td class="jd-linkcol" width="100%"><nobr>
1436 <span class="sympad"><a href="/reference/com/google/android/gms/location/LocationRequest.html#setNumUpdates(int)">setNumUpdates</a></span>(int numUpdates)</nobr>
1437
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1438 <div class="jd-descrdiv">
1439 Set the number of location updates.
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1440
1441
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1442
1443 </div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1444
1445 </td></tr>
1446
1447
1448
1449 <tr class=" api apilevel-" >
1450 <td class="jd-typecol"><nobr>
1451
1452
1453
1454
1455
1456 <a href="/reference/com/google/android/gms/location/LocationRequest.html">LocationRequest</a></nobr>
1457 </td>
1458 <td class="jd-linkcol" width="100%"><nobr>
1459 <span class="sympad"><a href="/reference/com/google/android/gms/location/LocationRequest.html#setPriority(int)">setPriority</a></span>(int priority)</nobr>
1460
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1461 <div class="jd-descrdiv">
1462 Set the priority of the request.
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1463
1464
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1465
1466 </div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1467
1468 </td></tr>
1469
1470
1471
1472 <tr class="alt-color api apilevel-" >
1473 <td class="jd-typecol"><nobr>
1474
1475
1476
1477
1478
1479 <a href="/reference/com/google/android/gms/location/LocationRequest.html">LocationRequest</a></nobr>
1480 </td>
1481 <td class="jd-linkcol" width="100%"><nobr>
1482 <span class="sympad"><a href="/reference/com/google/android/gms/location/LocationRequest.html#setSmallestDisplacement(float)">setSmallestDisplacement</a></span>(float smallestDisplacementMeters)</nobr>
1483
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1484 <div class="jd-descrdiv">
1485 Set the minimum displacement between location updates in meters
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1486
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1487 <p>By default this is 0.
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1488
1489
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1490
1491 </div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1492
1493 </td></tr>
1494
1495
1496
1497 <tr class=" api apilevel-" >
1498 <td class="jd-typecol"><nobr>
1499
1500
1501
1502
1503
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1504 String</nobr>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1505 </td>
1506 <td class="jd-linkcol" width="100%"><nobr>
1507 <span class="sympad"><a href="/reference/com/google/android/gms/location/LocationRequest.html#toString()">toString</a></span>()</nobr>
1508
1509 </td></tr>
1510
1511
1512
1513 <tr class="alt-color api apilevel-" >
1514 <td class="jd-typecol"><nobr>
1515
1516
1517
1518
1519
1520 void</nobr>
1521 </td>
1522 <td class="jd-linkcol" width="100%"><nobr>
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1523 <span class="sympad"><a href="/reference/com/google/android/gms/location/LocationRequest.html#writeToParcel(android.os.Parcel, int)">writeToParcel</a></span>(Parcel parcel, int flags)</nobr>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1524
1525 </td></tr>
1526
1527
1528
1529</table>
1530
1531
1532
1533
1534
1535
1536
1537<!-- ========== METHOD SUMMARY =========== -->
1538<table id="inhmethods" class="jd-sumtable"><tr><th>
1539 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
1540 <div style="clear:left;">Inherited Methods</div></th></tr>
1541
1542
1543<tr class="api apilevel-" >
1544<td colspan="12">
1545 <a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-java.lang.Object" class="jd-expando-trigger closed"
1546 ><img id="inherited-methods-java.lang.Object-trigger"
1547 src="/assets/images/triangle-closed.png"
1548 class="jd-expando-trigger-img" /></a>
1549From class
1550
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1551 java.lang.Object
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1552
1553<div id="inherited-methods-java.lang.Object">
1554 <div id="inherited-methods-java.lang.Object-list"
1555 class="jd-inheritedlinks">
1556 </div>
1557 <div id="inherited-methods-java.lang.Object-summary" style="display: none;">
1558 <table class="jd-sumtable-expando">
1559
1560
1561
1562
1563 <tr class="alt-color api apilevel-" >
1564 <td class="jd-typecol"><nobr>
1565
1566
1567
1568
1569
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1570 Object</nobr>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1571 </td>
1572 <td class="jd-linkcol" width="100%"><nobr>
1573 <span class="sympad">clone</span>()</nobr>
1574
1575 </td></tr>
1576
1577
1578
1579 <tr class=" api apilevel-" >
1580 <td class="jd-typecol"><nobr>
1581
1582
1583
1584
1585
1586 boolean</nobr>
1587 </td>
1588 <td class="jd-linkcol" width="100%"><nobr>
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1589 <span class="sympad">equals</span>(Object arg0)</nobr>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1590
1591 </td></tr>
1592
1593
1594
1595 <tr class="alt-color api apilevel-" >
1596 <td class="jd-typecol"><nobr>
1597
1598
1599
1600
1601
1602 void</nobr>
1603 </td>
1604 <td class="jd-linkcol" width="100%"><nobr>
1605 <span class="sympad">finalize</span>()</nobr>
1606
1607 </td></tr>
1608
1609
1610
1611 <tr class=" api apilevel-" >
1612 <td class="jd-typecol"><nobr>
1613
1614
1615 final
1616
1617
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1618 Class&lt;?&gt;</nobr>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1619 </td>
1620 <td class="jd-linkcol" width="100%"><nobr>
1621 <span class="sympad">getClass</span>()</nobr>
1622
1623 </td></tr>
1624
1625
1626
1627 <tr class="alt-color api apilevel-" >
1628 <td class="jd-typecol"><nobr>
1629
1630
1631
1632
1633
1634 int</nobr>
1635 </td>
1636 <td class="jd-linkcol" width="100%"><nobr>
1637 <span class="sympad">hashCode</span>()</nobr>
1638
1639 </td></tr>
1640
1641
1642
1643 <tr class=" api apilevel-" >
1644 <td class="jd-typecol"><nobr>
1645
1646
1647 final
1648
1649
1650 void</nobr>
1651 </td>
1652 <td class="jd-linkcol" width="100%"><nobr>
1653 <span class="sympad">notify</span>()</nobr>
1654
1655 </td></tr>
1656
1657
1658
1659 <tr class="alt-color api apilevel-" >
1660 <td class="jd-typecol"><nobr>
1661
1662
1663 final
1664
1665
1666 void</nobr>
1667 </td>
1668 <td class="jd-linkcol" width="100%"><nobr>
1669 <span class="sympad">notifyAll</span>()</nobr>
1670
1671 </td></tr>
1672
1673
1674
1675 <tr class=" api apilevel-" >
1676 <td class="jd-typecol"><nobr>
1677
1678
1679
1680
1681
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1682 String</nobr>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1683 </td>
1684 <td class="jd-linkcol" width="100%"><nobr>
1685 <span class="sympad">toString</span>()</nobr>
1686
1687 </td></tr>
1688
1689
1690
1691 <tr class="alt-color api apilevel-" >
1692 <td class="jd-typecol"><nobr>
1693
1694
1695 final
1696
1697
1698 void</nobr>
1699 </td>
1700 <td class="jd-linkcol" width="100%"><nobr>
1701 <span class="sympad">wait</span>()</nobr>
1702
1703 </td></tr>
1704
1705
1706
1707 <tr class=" api apilevel-" >
1708 <td class="jd-typecol"><nobr>
1709
1710
1711 final
1712
1713
1714 void</nobr>
1715 </td>
1716 <td class="jd-linkcol" width="100%"><nobr>
1717 <span class="sympad">wait</span>(long arg0, int arg1)</nobr>
1718
1719 </td></tr>
1720
1721
1722
1723 <tr class="alt-color api apilevel-" >
1724 <td class="jd-typecol"><nobr>
1725
1726
1727 final
1728
1729
1730 void</nobr>
1731 </td>
1732 <td class="jd-linkcol" width="100%"><nobr>
1733 <span class="sympad">wait</span>(long arg0)</nobr>
1734
1735 </td></tr>
1736
1737
1738</table>
1739 </div>
1740</div>
1741</td></tr>
1742
1743
1744
1745<tr class="api apilevel-" >
1746<td colspan="12">
1747 <a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-android.os.Parcelable" class="jd-expando-trigger closed"
1748 ><img id="inherited-methods-android.os.Parcelable-trigger"
1749 src="/assets/images/triangle-closed.png"
1750 class="jd-expando-trigger-img" /></a>
1751From interface
1752
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1753 android.os.Parcelable
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1754
1755<div id="inherited-methods-android.os.Parcelable">
1756 <div id="inherited-methods-android.os.Parcelable-list"
1757 class="jd-inheritedlinks">
1758 </div>
1759 <div id="inherited-methods-android.os.Parcelable-summary" style="display: none;">
1760 <table class="jd-sumtable-expando">
1761
1762
1763
1764
1765 <tr class="alt-color api apilevel-" >
1766 <td class="jd-typecol"><nobr>
1767 abstract
1768
1769
1770
1771
1772 int</nobr>
1773 </td>
1774 <td class="jd-linkcol" width="100%"><nobr>
1775 <span class="sympad">describeContents</span>()</nobr>
1776
1777 </td></tr>
1778
1779
1780
1781 <tr class=" api apilevel-" >
1782 <td class="jd-typecol"><nobr>
1783 abstract
1784
1785
1786
1787
1788 void</nobr>
1789 </td>
1790 <td class="jd-linkcol" width="100%"><nobr>
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]1791 <span class="sympad">writeToParcel</span>(Parcel arg0, int arg1)</nobr>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1792
1793 </td></tr>
1794
1795
1796</table>
1797 </div>
1798</div>
1799</td></tr>
1800
1801
1802</table>
1803
1804
1805</div><!-- jd-descr (summary) -->
1806
1807<!-- Details -->
1808
1809
1810
1811
1812
1813
1814
1815
1816<!-- XML Attributes -->
1817
1818
1819<!-- Enum Values -->
1820
1821
1822<!-- Constants -->
1823
1824
1825<!-- ========= ENUM CONSTANTS DETAIL ======== -->
1826<h2>Constants</h2>
1827
1828
1829
1830
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1831<A NAME="PRIORITY_BALANCED_POWER_ACCURACY"></A>
1832
1833<div class="jd-details api apilevel-">
1834 <h4 class="jd-details-title">
1835 <span class="normal">
1836 public
1837 static
1838 final
1839 int
1840 </span>
1841 PRIORITY_BALANCED_POWER_ACCURACY
1842 </h4>
1843 <div class="api-level">
1844
1845
1846
1847
1848 </div>
1849 <div class="jd-details-descr">
1850
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1851
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1852
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1853
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1854 <div class="jd-tagdata jd-tagdescr"><p>Used with <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setPriority(int)">setPriority(int)</a></code> to request "block" level accuracy.
1855
1856 <p>Block level accuracy is considered to be about 100 meter accuracy. Using a coarse
1857 accuracy such as this often consumes less power.
1858</p></div>
1859
1860
1861 <div class="jd-tagdata">
1862 <span class="jd-tagtitle">Constant Value: </span>
1863 <span>
1864
1865 102
1866 (0x00000066)
1867
1868 </span>
1869 </div>
1870
1871 </div>
1872</div>
1873
1874
1875
1876<A NAME="PRIORITY_HIGH_ACCURACY"></A>
1877
1878<div class="jd-details api apilevel-">
1879 <h4 class="jd-details-title">
1880 <span class="normal">
1881 public
1882 static
1883 final
1884 int
1885 </span>
1886 PRIORITY_HIGH_ACCURACY
1887 </h4>
1888 <div class="api-level">
1889
1890
1891
1892
1893 </div>
1894 <div class="jd-details-descr">
1895
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1896
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1897
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1898
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1899 <div class="jd-tagdata jd-tagdescr"><p>Used with <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setPriority(int)">setPriority(int)</a></code> to request the most accurate locations available.
1900
1901 <p>This will return the finest location available.
1902</p></div>
1903
1904
1905 <div class="jd-tagdata">
1906 <span class="jd-tagtitle">Constant Value: </span>
1907 <span>
1908
1909 100
1910 (0x00000064)
1911
1912 </span>
1913 </div>
1914
1915 </div>
1916</div>
1917
1918
1919
Dirk Doughertyc1609c42013-08-01 15:30:06 -0700[diff] [blame]1920<A NAME="PRIORITY_LOW_POWER"></A>
1921
1922<div class="jd-details api apilevel-">
1923 <h4 class="jd-details-title">
1924 <span class="normal">
1925 public
1926 static
1927 final
1928 int
1929 </span>
1930 PRIORITY_LOW_POWER
1931 </h4>
1932 <div class="api-level">
1933
1934
1935
1936
1937 </div>
1938 <div class="jd-details-descr">
1939
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1940
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1941
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1942
Dirk Doughertyc1609c42013-08-01 15:30:06 -0700[diff] [blame]1943 <div class="jd-tagdata jd-tagdescr"><p>Used with <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setPriority(int)">setPriority(int)</a></code> to request "city" level accuracy.
1944
1945 <p>City level accuracy is considered to be about 10km accuracy. Using a coarse accuracy
1946 such as this often consumes less power.
1947</p></div>
1948
1949
1950 <div class="jd-tagdata">
1951 <span class="jd-tagtitle">Constant Value: </span>
1952 <span>
1953
1954 104
1955 (0x00000068)
1956
1957 </span>
1958 </div>
1959
1960 </div>
1961</div>
1962
1963
1964
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1965<A NAME="PRIORITY_NO_POWER"></A>
1966
1967<div class="jd-details api apilevel-">
1968 <h4 class="jd-details-title">
1969 <span class="normal">
1970 public
1971 static
1972 final
1973 int
1974 </span>
1975 PRIORITY_NO_POWER
1976 </h4>
1977 <div class="api-level">
1978
1979
1980
1981
1982 </div>
1983 <div class="jd-details-descr">
1984
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1985
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]1986
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]1987
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]1988 <div class="jd-tagdata jd-tagdescr"><p>Used with <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setPriority(int)">setPriority(int)</a></code> to request the best accuracy possible with zero additional
1989 power consumption.
1990
1991 <p>No locations will be returned unless a different client has requested location updates
1992 in which case this request will act as a passive listener to those locations.
1993</p></div>
1994
1995
1996 <div class="jd-tagdata">
1997 <span class="jd-tagtitle">Constant Value: </span>
1998 <span>
1999
2000 105
2001 (0x00000069)
2002
2003 </span>
2004 </div>
2005
2006 </div>
2007</div>
2008
2009
2010
2011
2012<!-- Fields -->
2013
2014
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2015<!-- Public ctors -->
2016
2017
2018
2019<!-- ========= CONSTRUCTOR DETAIL ======== -->
2020<!-- Protected ctors -->
2021
2022
2023
2024<!-- ========= METHOD DETAIL ======== -->
2025<!-- Public methdos -->
2026
2027<h2>Public Methods</h2>
2028
2029
2030
2031<A NAME="create()"></A>
2032
2033<div class="jd-details api apilevel-">
2034 <h4 class="jd-details-title">
2035 <span class="normal">
2036 public
2037 static
2038
2039
2040
2041 <a href="/reference/com/google/android/gms/location/LocationRequest.html">LocationRequest</a>
2042 </span>
2043 <span class="sympad">create</span>
2044 <span class="normal">()</span>
2045 </h4>
2046 <div class="api-level">
2047 <div></div>
2048
2049
2050
2051 </div>
2052 <div class="jd-details-descr">
2053
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2054
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]2055
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2056
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2057 <div class="jd-tagdata jd-tagdescr"><p>Create a location request with default parameters.
2058
2059 <p>Default parameters are for a block accuracy, slowly updated location. It can then be
Quddus Chonge457fb62014-09-11 18:55:43 -0700[diff] [blame]2060 adjusted as required by the applications before passing to the
2061 <code><a href="/reference/com/google/android/gms/location/FusedLocationProviderApi.html">FusedLocationProviderApi</a></code>.</p></div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2062 <div class="jd-tagdata">
2063 <h5 class="jd-tagtitle">Returns</h5>
2064 <ul class="nolist"><li>a new location request
2065</li></ul>
2066 </div>
2067
2068 </div>
2069</div>
2070
2071
2072<A NAME="describeContents()"></A>
2073
2074<div class="jd-details api apilevel-">
2075 <h4 class="jd-details-title">
2076 <span class="normal">
2077 public
2078
2079
2080
2081
2082 int
2083 </span>
2084 <span class="sympad">describeContents</span>
2085 <span class="normal">()</span>
2086 </h4>
2087 <div class="api-level">
2088 <div></div>
2089
2090
2091
2092 </div>
2093 <div class="jd-details-descr">
2094
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2095
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]2096
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2097
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2098 <div class="jd-tagdata jd-tagdescr"><p></p></div>
2099
2100 </div>
2101</div>
2102
2103
Dirk Dougherty8f1a7592013-06-28 14:04:39 -0700[diff] [blame]2104<A NAME="equals(java.lang.Object)"></A>
2105
2106<div class="jd-details api apilevel-">
2107 <h4 class="jd-details-title">
2108 <span class="normal">
2109 public
2110
2111
2112
2113
2114 boolean
2115 </span>
2116 <span class="sympad">equals</span>
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]2117 <span class="normal">(Object object)</span>
Dirk Dougherty8f1a7592013-06-28 14:04:39 -0700[diff] [blame]2118 </h4>
2119 <div class="api-level">
2120 <div></div>
2121
2122
2123
2124 </div>
2125 <div class="jd-details-descr">
2126
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2127
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]2128
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2129
Dirk Dougherty8f1a7592013-06-28 14:04:39 -0700[diff] [blame]2130 <div class="jd-tagdata jd-tagdescr"><p></p></div>
2131
2132 </div>
2133</div>
2134
2135
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2136<A NAME="getExpirationTime()"></A>
2137
2138<div class="jd-details api apilevel-">
2139 <h4 class="jd-details-title">
2140 <span class="normal">
2141 public
2142
2143
2144
2145
2146 long
2147 </span>
2148 <span class="sympad">getExpirationTime</span>
2149 <span class="normal">()</span>
2150 </h4>
2151 <div class="api-level">
2152 <div></div>
2153
2154
2155
2156 </div>
2157 <div class="jd-details-descr">
2158
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2159
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]2160
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2161
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2162 <div class="jd-tagdata jd-tagdescr"><p>Get the request expiration time, in milliseconds since boot.
2163
Dirk Dougherty4e847bd2013-08-06 09:59:51 -0700[diff] [blame]2164 <p>This value can be compared to <code><a href="/reference/android/os/SystemClock.html#elapsedRealtime()">elapsedRealtime()</a></code> to determine the time
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2165 until expiration.</p></div>
2166 <div class="jd-tagdata">
2167 <h5 class="jd-tagtitle">Returns</h5>
2168 <ul class="nolist"><li>expiration time of request, in milliseconds since boot including suspend
2169</li></ul>
2170 </div>
2171
2172 </div>
2173</div>
2174
2175
2176<A NAME="getFastestInterval()"></A>
2177
2178<div class="jd-details api apilevel-">
2179 <h4 class="jd-details-title">
2180 <span class="normal">
2181 public
2182
2183
2184
2185
2186 long
2187 </span>
2188 <span class="sympad">getFastestInterval</span>
2189 <span class="normal">()</span>
2190 </h4>
2191 <div class="api-level">
2192 <div></div>
2193
2194
2195
2196 </div>
2197 <div class="jd-details-descr">
2198
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2199
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]2200
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2201
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2202 <div class="jd-tagdata jd-tagdescr"><p>Get the fastest interval of this request, in milliseconds.
2203
2204 <p>The system will never provide location updates faster than the minimum of
2205 <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#getFastestInterval()">getFastestInterval()</a></code> and <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#getInterval()">getInterval()</a></code>.</p></div>
2206 <div class="jd-tagdata">
2207 <h5 class="jd-tagtitle">Returns</h5>
2208 <ul class="nolist"><li>fastest interval in milliseconds, exact
2209</li></ul>
2210 </div>
2211
2212 </div>
2213</div>
2214
2215
2216<A NAME="getInterval()"></A>
2217
2218<div class="jd-details api apilevel-">
2219 <h4 class="jd-details-title">
2220 <span class="normal">
2221 public
2222
2223
2224
2225
2226 long
2227 </span>
2228 <span class="sympad">getInterval</span>
2229 <span class="normal">()</span>
2230 </h4>
2231 <div class="api-level">
2232 <div></div>
2233
2234
2235
2236 </div>
2237 <div class="jd-details-descr">
2238
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2239
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]2240
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2241
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2242 <div class="jd-tagdata jd-tagdescr"><p>Get the desired interval of this request, in milliseconds.</p></div>
2243 <div class="jd-tagdata">
2244 <h5 class="jd-tagtitle">Returns</h5>
2245 <ul class="nolist"><li>desired interval in milliseconds, inexact
2246</li></ul>
2247 </div>
2248
2249 </div>
2250</div>
2251
2252
2253<A NAME="getNumUpdates()"></A>
2254
2255<div class="jd-details api apilevel-">
2256 <h4 class="jd-details-title">
2257 <span class="normal">
2258 public
2259
2260
2261
2262
2263 int
2264 </span>
2265 <span class="sympad">getNumUpdates</span>
2266 <span class="normal">()</span>
2267 </h4>
2268 <div class="api-level">
2269 <div></div>
2270
2271
2272
2273 </div>
2274 <div class="jd-details-descr">
2275
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2276
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]2277
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2278
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2279 <div class="jd-tagdata jd-tagdescr"><p>Get the number of updates requested.
2280
Dirk Dougherty4e847bd2013-08-06 09:59:51 -0700[diff] [blame]2281 <p>By default this is <code><a href="/reference/java/lang/Integer.html#MAX_VALUE">MAX_VALUE</a></code>, which indicates that locations are updated
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2282 until the request is explicitly removed.</p></div>
2283 <div class="jd-tagdata">
2284 <h5 class="jd-tagtitle">Returns</h5>
2285 <ul class="nolist"><li>number of updates
2286</li></ul>
2287 </div>
2288
2289 </div>
2290</div>
2291
2292
2293<A NAME="getPriority()"></A>
2294
2295<div class="jd-details api apilevel-">
2296 <h4 class="jd-details-title">
2297 <span class="normal">
2298 public
2299
2300
2301
2302
2303 int
2304 </span>
2305 <span class="sympad">getPriority</span>
2306 <span class="normal">()</span>
2307 </h4>
2308 <div class="api-level">
2309 <div></div>
2310
2311
2312
2313 </div>
2314 <div class="jd-details-descr">
2315
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2316
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]2317
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2318
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2319 <div class="jd-tagdata jd-tagdescr"><p>Get the quality of the request.</p></div>
2320 <div class="jd-tagdata">
2321 <h5 class="jd-tagtitle">Returns</h5>
2322 <ul class="nolist"><li>an accuracy constant
2323</li></ul>
2324 </div>
2325
2326 </div>
2327</div>
2328
2329
2330<A NAME="getSmallestDisplacement()"></A>
2331
2332<div class="jd-details api apilevel-">
2333 <h4 class="jd-details-title">
2334 <span class="normal">
2335 public
2336
2337
2338
2339
2340 float
2341 </span>
2342 <span class="sympad">getSmallestDisplacement</span>
2343 <span class="normal">()</span>
2344 </h4>
2345 <div class="api-level">
2346 <div></div>
2347
2348
2349
2350 </div>
2351 <div class="jd-details-descr">
2352
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2353
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]2354
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2355
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2356 <div class="jd-tagdata jd-tagdescr"><p>Get the minimum displacement between location updates in meters
2357
2358 <p>By default this is 0.</p></div>
2359 <div class="jd-tagdata">
2360 <h5 class="jd-tagtitle">Returns</h5>
2361 <ul class="nolist"><li>minimum displacement between location updates in meters
2362</li></ul>
2363 </div>
2364
2365 </div>
2366</div>
2367
2368
Dirk Dougherty8f1a7592013-06-28 14:04:39 -0700[diff] [blame]2369<A NAME="hashCode()"></A>
2370
2371<div class="jd-details api apilevel-">
2372 <h4 class="jd-details-title">
2373 <span class="normal">
2374 public
2375
2376
2377
2378
2379 int
2380 </span>
2381 <span class="sympad">hashCode</span>
2382 <span class="normal">()</span>
2383 </h4>
2384 <div class="api-level">
2385 <div></div>
2386
2387
2388
2389 </div>
2390 <div class="jd-details-descr">
2391
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2392
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]2393
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2394
Dirk Dougherty8f1a7592013-06-28 14:04:39 -0700[diff] [blame]2395 <div class="jd-tagdata jd-tagdescr"><p></p></div>
2396
2397 </div>
2398</div>
2399
2400
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2401<A NAME="setExpirationDuration(long)"></A>
2402
2403<div class="jd-details api apilevel-">
2404 <h4 class="jd-details-title">
2405 <span class="normal">
2406 public
2407
2408
2409
2410
2411 <a href="/reference/com/google/android/gms/location/LocationRequest.html">LocationRequest</a>
2412 </span>
2413 <span class="sympad">setExpirationDuration</span>
2414 <span class="normal">(long millis)</span>
2415 </h4>
2416 <div class="api-level">
2417 <div></div>
2418
2419
2420
2421 </div>
2422 <div class="jd-details-descr">
2423
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2424
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]2425
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2426
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2427 <div class="jd-tagdata jd-tagdescr"><p>Set the duration of this request, in milliseconds.
2428
2429 <p>The duration begins immediately (and not when the request is passed to the location
2430 client), so call this method again if the request is re-used at a later time.
2431
2432 <p>The location client will automatically stop updates after the request expires.
2433
2434 <p>The duration includes suspend time. Values less than 0 are allowed, but indicate that
2435 the request has already expired.</p></div>
2436 <div class="jd-tagdata">
2437 <h5 class="jd-tagtitle">Parameters</h5>
2438 <table class="jd-tagtable">
2439 <tr>
2440 <th>millis</td>
2441 <td>duration of request in milliseconds</td>
2442 </tr>
2443 </table>
2444 </div>
2445 <div class="jd-tagdata">
2446 <h5 class="jd-tagtitle">Returns</h5>
2447 <ul class="nolist"><li>the same object, so that setters can be chained
2448</li></ul>
2449 </div>
2450
2451 </div>
2452</div>
2453
2454
2455<A NAME="setExpirationTime(long)"></A>
2456
2457<div class="jd-details api apilevel-">
2458 <h4 class="jd-details-title">
2459 <span class="normal">
2460 public
2461
2462
2463
2464
2465 <a href="/reference/com/google/android/gms/location/LocationRequest.html">LocationRequest</a>
2466 </span>
2467 <span class="sympad">setExpirationTime</span>
2468 <span class="normal">(long millis)</span>
2469 </h4>
2470 <div class="api-level">
2471 <div></div>
2472
2473
2474
2475 </div>
2476 <div class="jd-details-descr">
2477
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2478
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]2479
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2480
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2481 <div class="jd-tagdata jd-tagdescr"><p>Set the request expiration time, in millisecond since boot.
2482
Dirk Dougherty4e847bd2013-08-06 09:59:51 -0700[diff] [blame]2483 <p>This expiration time uses the same time base as <code><a href="/reference/android/os/SystemClock.html#elapsedRealtime()">elapsedRealtime()</a></code>.
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2484
2485 <p>The location client will automatically stop updates after the request expires.
2486
Dirk Dougherty4e847bd2013-08-06 09:59:51 -0700[diff] [blame]2487 <p>The duration includes suspend time. Values before <code><a href="/reference/android/os/SystemClock.html#elapsedRealtime()">elapsedRealtime()</a></code>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2488 are allowed, but indicate that the request has already expired.</p></div>
2489 <div class="jd-tagdata">
2490 <h5 class="jd-tagtitle">Parameters</h5>
2491 <table class="jd-tagtable">
2492 <tr>
2493 <th>millis</td>
2494 <td>expiration time of request, in milliseconds since boot including suspend</td>
2495 </tr>
2496 </table>
2497 </div>
2498 <div class="jd-tagdata">
2499 <h5 class="jd-tagtitle">Returns</h5>
2500 <ul class="nolist"><li>the same object, so that setters can be chained
2501</li></ul>
2502 </div>
2503
2504 </div>
2505</div>
2506
2507
2508<A NAME="setFastestInterval(long)"></A>
2509
2510<div class="jd-details api apilevel-">
2511 <h4 class="jd-details-title">
2512 <span class="normal">
2513 public
2514
2515
2516
2517
2518 <a href="/reference/com/google/android/gms/location/LocationRequest.html">LocationRequest</a>
2519 </span>
2520 <span class="sympad">setFastestInterval</span>
2521 <span class="normal">(long millis)</span>
2522 </h4>
2523 <div class="api-level">
2524 <div></div>
2525
2526
2527
2528 </div>
2529 <div class="jd-details-descr">
2530
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2531
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]2532
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2533
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2534 <div class="jd-tagdata jd-tagdescr"><p>Explicitly set the fastest interval for location updates, in milliseconds.
2535
2536 <p>This controls the fastest rate at which your application will receive location updates,
2537 which might be faster than <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setInterval(long)">setInterval(long)</a></code> in some situations (for example, if other
2538 applications are triggering location updates).
2539
2540 <p>This allows your application to passively acquire locations at a rate faster than it
2541 actively acquires locations, saving power.
2542
2543 <p>Unlike <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setInterval(long)">setInterval(long)</a></code>, this parameter is exact. Your application will never
2544 receive updates faster than this value.
2545
2546 <p>If you don't call this method, a fastest interval will be selected for you. It will be
2547 a value faster than your active interval (<code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setInterval(long)">setInterval(long)</a></code>).
2548
2549 <p>An interval of 0 is allowed, but not recommended, since location updates may be
2550 extremely fast on future implementations.
2551
2552 <p>If <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setFastestInterval(long)">setFastestInterval(long)</a></code> is set slower than <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setInterval(long)">setInterval(long)</a></code>, then your
2553 effective fastest interval is <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setInterval(long)">setInterval(long)</a></code>.</p></div>
2554 <div class="jd-tagdata">
2555 <h5 class="jd-tagtitle">Parameters</h5>
2556 <table class="jd-tagtable">
2557 <tr>
2558 <th>millis</td>
2559 <td>fastest interval for updates in milliseconds, exact</td>
2560 </tr>
2561 </table>
2562 </div>
2563 <div class="jd-tagdata">
2564 <h5 class="jd-tagtitle">Returns</h5>
2565 <ul class="nolist"><li>the same object, so that setters can be chained
2566</li></ul>
2567 </div>
2568 <div class="jd-tagdata">
2569 <h5 class="jd-tagtitle">Throws</h5>
2570 <table class="jd-tagtable">
2571 <tr>
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]2572 <th>IllegalArgumentException</td>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2573 <td>if the interval is less than zero</td>
2574 </tr>
2575 </table>
2576 </div>
2577
2578 </div>
2579</div>
2580
2581
2582<A NAME="setInterval(long)"></A>
2583
2584<div class="jd-details api apilevel-">
2585 <h4 class="jd-details-title">
2586 <span class="normal">
2587 public
2588
2589
2590
2591
2592 <a href="/reference/com/google/android/gms/location/LocationRequest.html">LocationRequest</a>
2593 </span>
2594 <span class="sympad">setInterval</span>
2595 <span class="normal">(long millis)</span>
2596 </h4>
2597 <div class="api-level">
2598 <div></div>
2599
2600
2601
2602 </div>
2603 <div class="jd-details-descr">
2604
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2605
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]2606
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2607
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2608 <div class="jd-tagdata jd-tagdescr"><p>Set the desired interval for active location updates, in milliseconds.
2609
2610 <p>The location client will actively try to obtain location updates for your application
2611 at this interval, so it has a direct influence on the amount of power used by your
2612 application. Choose your interval wisely.
2613
2614 <p>This interval is inexact. You may not receive updates at all (if no location sources
2615 are available), or you may receive them slower than requested. You may also receive them
2616 faster than requested (if other applications are requesting location at a faster interval).
Mark Dolinerd0646dc2014-08-27 16:04:02 -0700[diff] [blame]2617 The fastest rate that you will receive updates can be controlled with
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2618 <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setFastestInterval(long)">setFastestInterval(long)</a></code>. By default this fastest rate is 6x the interval frequency.
2619
2620 <p>Applications with only the coarse location permission may have their interval silently
2621 throttled.
2622
2623 <p>An interval of 0 is allowed, but not recommended, since location updates may be extremely
2624 fast on future implementations.
2625
2626 <p><code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setPriority(int)">setPriority(int)</a></code> and <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setInterval(long)">setInterval(long)</a></code> are the most important parameters
2627 on a location request.</p></div>
2628 <div class="jd-tagdata">
2629 <h5 class="jd-tagtitle">Parameters</h5>
2630 <table class="jd-tagtable">
2631 <tr>
2632 <th>millis</td>
2633 <td>desired interval in millisecond, inexact</td>
2634 </tr>
2635 </table>
2636 </div>
2637 <div class="jd-tagdata">
2638 <h5 class="jd-tagtitle">Returns</h5>
2639 <ul class="nolist"><li>the same object, so that setters can be chained
2640</li></ul>
2641 </div>
2642 <div class="jd-tagdata">
2643 <h5 class="jd-tagtitle">Throws</h5>
2644 <table class="jd-tagtable">
2645 <tr>
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]2646 <th>IllegalArgumentException</td>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2647 <td>if the interval is less than zero</td>
2648 </tr>
2649 </table>
2650 </div>
2651
2652 </div>
2653</div>
2654
2655
2656<A NAME="setNumUpdates(int)"></A>
2657
2658<div class="jd-details api apilevel-">
2659 <h4 class="jd-details-title">
2660 <span class="normal">
2661 public
2662
2663
2664
2665
2666 <a href="/reference/com/google/android/gms/location/LocationRequest.html">LocationRequest</a>
2667 </span>
2668 <span class="sympad">setNumUpdates</span>
2669 <span class="normal">(int numUpdates)</span>
2670 </h4>
2671 <div class="api-level">
2672 <div></div>
2673
2674
2675
2676 </div>
2677 <div class="jd-details-descr">
2678
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2679
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]2680
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2681
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2682 <div class="jd-tagdata jd-tagdescr"><p>Set the number of location updates.
2683
2684 <p>By default locations are continuously updated until the request is explicitly removed,
2685 however you can optionally request a set number of updates. For example, if your
2686 application only needs a single fresh location, then call this method with a value of 1
quddusc563daee2013-12-03 19:31:14 -0800[diff] [blame]2687 before passing the request to the location client.
2688
2689 <p>When using this option care must be taken to either explicitly remove the request
2690 when no longer needed or to set an expiration with (<code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setExpirationDuration(long)">setExpirationDuration(long)</a></code> or
2691 <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setExpirationTime(long)">setExpirationTime(long)</a></code>. Otherwise in some cases if a location can't be computed, this
2692 request could stay active indefinitely consuming power.</p></div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2693 <div class="jd-tagdata">
2694 <h5 class="jd-tagtitle">Parameters</h5>
2695 <table class="jd-tagtable">
2696 <tr>
2697 <th>numUpdates</td>
2698 <td>the number of location updates requested</td>
2699 </tr>
2700 </table>
2701 </div>
2702 <div class="jd-tagdata">
2703 <h5 class="jd-tagtitle">Returns</h5>
2704 <ul class="nolist"><li>the same object, so that setters can be chained
2705</li></ul>
2706 </div>
2707 <div class="jd-tagdata">
2708 <h5 class="jd-tagtitle">Throws</h5>
2709 <table class="jd-tagtable">
2710 <tr>
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]2711 <th>IllegalArgumentException</td>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2712 <td>if numUpdates is 0 or less</td>
2713 </tr>
2714 </table>
2715 </div>
2716
2717 </div>
2718</div>
2719
2720
2721<A NAME="setPriority(int)"></A>
2722
2723<div class="jd-details api apilevel-">
2724 <h4 class="jd-details-title">
2725 <span class="normal">
2726 public
2727
2728
2729
2730
2731 <a href="/reference/com/google/android/gms/location/LocationRequest.html">LocationRequest</a>
2732 </span>
2733 <span class="sympad">setPriority</span>
2734 <span class="normal">(int priority)</span>
2735 </h4>
2736 <div class="api-level">
2737 <div></div>
2738
2739
2740
2741 </div>
2742 <div class="jd-details-descr">
2743
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2744
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]2745
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2746
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2747 <div class="jd-tagdata jd-tagdescr"><p>Set the priority of the request.
2748
2749 <p>Use with a priority constant such as <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#PRIORITY_HIGH_ACCURACY">PRIORITY_HIGH_ACCURACY</a></code>. No other values
2750 are accepted.
2751
2752 <p>The priority of the request is a strong hint to the LocationClient for which location
2753 sources to use. For example, <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#PRIORITY_HIGH_ACCURACY">PRIORITY_HIGH_ACCURACY</a></code> is more likely to use GPS, and
2754 <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#PRIORITY_BALANCED_POWER_ACCURACY">PRIORITY_BALANCED_POWER_ACCURACY</a></code> is more likely to use WIFI &amp; Cell tower
2755 positioning, but it also depends on many other factors (such as which sources are available)
2756 and is implementation dependent.
2757
2758 <p><code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setPriority(int)">setPriority(int)</a></code> and <code><a href="/reference/com/google/android/gms/location/LocationRequest.html#setInterval(long)">setInterval(long)</a></code> are the most important parameters
2759 on a location request.</p></div>
2760 <div class="jd-tagdata">
2761 <h5 class="jd-tagtitle">Parameters</h5>
2762 <table class="jd-tagtable">
2763 <tr>
2764 <th>priority</td>
2765 <td>an accuracy or power constant</td>
2766 </tr>
2767 </table>
2768 </div>
2769 <div class="jd-tagdata">
2770 <h5 class="jd-tagtitle">Returns</h5>
2771 <ul class="nolist"><li>the same object, so that setters can be chained
2772</li></ul>
2773 </div>
2774 <div class="jd-tagdata">
2775 <h5 class="jd-tagtitle">Throws</h5>
2776 <table class="jd-tagtable">
2777 <tr>
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]2778 <th>IllegalArgumentException</td>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2779 <td>if the quality constant is not valid</td>
2780 </tr>
2781 </table>
2782 </div>
2783
2784 </div>
2785</div>
2786
2787
2788<A NAME="setSmallestDisplacement(float)"></A>
2789
2790<div class="jd-details api apilevel-">
2791 <h4 class="jd-details-title">
2792 <span class="normal">
2793 public
2794
2795
2796
2797
2798 <a href="/reference/com/google/android/gms/location/LocationRequest.html">LocationRequest</a>
2799 </span>
2800 <span class="sympad">setSmallestDisplacement</span>
2801 <span class="normal">(float smallestDisplacementMeters)</span>
2802 </h4>
2803 <div class="api-level">
2804 <div></div>
2805
2806
2807
2808 </div>
2809 <div class="jd-details-descr">
2810
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2811
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]2812
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2813
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2814 <div class="jd-tagdata jd-tagdescr"><p>Set the minimum displacement between location updates in meters
2815
2816 <p>By default this is 0.</p></div>
2817 <div class="jd-tagdata">
2818 <h5 class="jd-tagtitle">Parameters</h5>
2819 <table class="jd-tagtable">
2820 <tr>
2821 <th>smallestDisplacementMeters</td>
2822 <td>the smallest displacement in meters the user must move
2823 between location updates.</td>
2824 </tr>
2825 </table>
2826 </div>
2827 <div class="jd-tagdata">
2828 <h5 class="jd-tagtitle">Returns</h5>
2829 <ul class="nolist"><li>the same object, so that setters can be chained
2830</li></ul>
2831 </div>
2832 <div class="jd-tagdata">
2833 <h5 class="jd-tagtitle">Throws</h5>
2834 <table class="jd-tagtable">
2835 <tr>
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]2836 <th>IllegalArgumentException</td>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2837 <td>if smallestDisplacementMeters is negative</td>
2838 </tr>
2839 </table>
2840 </div>
2841
2842 </div>
2843</div>
2844
2845
2846<A NAME="toString()"></A>
2847
2848<div class="jd-details api apilevel-">
2849 <h4 class="jd-details-title">
2850 <span class="normal">
2851 public
2852
2853
2854
2855
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]2856 String
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2857 </span>
2858 <span class="sympad">toString</span>
2859 <span class="normal">()</span>
2860 </h4>
2861 <div class="api-level">
2862 <div></div>
2863
2864
2865
2866 </div>
2867 <div class="jd-details-descr">
2868
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2869
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]2870
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2871
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2872 <div class="jd-tagdata jd-tagdescr"><p></p></div>
2873
2874 </div>
2875</div>
2876
2877
2878<A NAME="writeToParcel(android.os.Parcel, int)"></A>
2879
2880<div class="jd-details api apilevel-">
2881 <h4 class="jd-details-title">
2882 <span class="normal">
2883 public
2884
2885
2886
2887
2888 void
2889 </span>
2890 <span class="sympad">writeToParcel</span>
Dirk Dougherty78ec7322013-09-16 10:37:40 -0700[diff] [blame]2891 <span class="normal">(Parcel parcel, int flags)</span>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2892 </h4>
2893 <div class="api-level">
2894 <div></div>
2895
2896
2897
2898 </div>
2899 <div class="jd-details-descr">
2900
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2901
Quddus Chong2b4b3d22014-10-26 18:10:42 -0700[diff] [blame]2902
Quddus Chongfd19ada2014-11-18 16:41:07 -0800[diff] [blame]2903
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700[diff] [blame]2904 <div class="jd-tagdata jd-tagdescr"><p></p></div>
2905
2906 </div>
2907</div>
2908
2909
2910
2911
2912
2913<!-- ========= METHOD DETAIL ======== -->
2914
2915
2916
2917<!-- ========= END OF CLASS DATA ========= -->
2918<A NAME="navbar_top"></A>
2919
2920<div id="footer" class="wrap" >
2921
2922
2923 <div id="copyright">
2924
2925 Except as noted, this content is licensed under <a
2926 href="http://www.apache.org/licenses/LICENSE-2.0">Apache 2.0</a>.
2927 For details and restrictions, see the <a href="/license.html">
2928 Content License</a>.
2929 </div>
2930 <div id="build_info">
2931
2932<script src="/timestamp.js" type="text/javascript"></script>
2933<script>document.write(BUILD_TIMESTAMP)</script>
2934
2935 </div>
2936
2937
2938 <div id="footerlinks">
2939
2940 <p>
2941 <a href="/about/index.html">About Android</a>&nbsp;&nbsp;|&nbsp;
2942 <a href="/legal.html">Legal</a>&nbsp;&nbsp;|&nbsp;
2943 <a href="/support.html">Support</a>
2944 </p>
2945 </div>
2946
2947</div> <!-- end footer -->
2948</div> <!-- jd-content -->
2949
2950</div><!-- end doc-content -->
2951
2952</div> <!-- end body-content -->
2953
2954
2955
2956
2957
2958
2959</body>
2960</html>