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 76 77 78 79 80 81 82 83 84 85 86 87<html> 88<head> 89 90 91<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 92<meta name="viewport" content="width=device-width" /> 93 94<link rel="shortcut icon" type="image/x-icon" href="/favicon.ico" /> 95<title>SessionsApi | Android Developers</title> 96 97<!-- STYLESHEETS --> 98<link rel="stylesheet" 99href="//fonts.googleapis.com/css?family=Roboto+Condensed"> 100<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Roboto:light,regular,medium,thin,italic,mediumitalic,bold" 101 title="roboto"> 102<link href="/assets/css/default.css?v=2" rel="stylesheet" type="text/css"> 103 104 105 106<!-- JAVASCRIPT --> 107<script src="//www.google.com/jsapi" type="text/javascript"></script> 108<script src="/assets/js/android_3p-bundle.js" type="text/javascript"></script> 109<script type="text/javascript"> 110 var toRoot = "/"; 111 var metaTags = []; 112 var devsite = false; 113</script> 114<script src="/assets/js/docs.js?v=2" type="text/javascript"></script> 115 116<script> 117 (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ 118 (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), 119 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) 120 })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); 121 122 ga('create', 'UA-5831155-1', 'android.com'); 123 ga('create', 'UA-49880327-2', 'android.com', {'name': 'universal'}); // New tracker); 124 ga('send', 'pageview'); 125 ga('universal.send', 'pageview'); // Send page view for new tracker. 126</script> 127 128</head> 129 130<body class="gc-documentation google 131 develop" itemscope itemtype="http://schema.org/Article"> 132 <div id="doc-api-level" class="" style="display:none"></div> 133 <a name="top"></a> 134 135 136<a name="top"></a> 137 138 <!-- Header --> 139 <div id="header-wrapper"> 140 <div id="header"> 141 <div class="wrap" id="header-wrap"> 142 <div class="col-3 logo"> 143 <a href="/index.html"> 144 <img src="/assets/images/dac_logo.png" 145 srcset="/assets/images/dac_logo@2x.png 2x" 146 width="123" height="25" alt="Android Developers" /> 147 </a> 148 <div class="btn-quicknav" id="btn-quicknav"> 149 <a href="#" class="arrow-inactive">Quicknav</a> 150 <a href="#" class="arrow-active">Quicknav</a> 151 </div> 152 </div> 153 <ul class="nav-x col-9"> 154 <li class="design"> 155 <a href="/design/index.html" 156 zh-tw-lang="設計" 157 zh-cn-lang="设计" 158 ru-lang="Проектирование" 159 ko-lang="디자인" 160 ja-lang="設計" 161 es-lang="Diseñar" 162 >Design</a></li> 163 <li class="develop"><a href="/develop/index.html" 164 zh-tw-lang="開發" 165 zh-cn-lang="开发" 166 ru-lang="Разработка" 167 ko-lang="개발" 168 ja-lang="開発" 169 es-lang="Desarrollar" 170 >Develop</a></li> 171 <li class="distribute last"><a href="/distribute/index.html" 172 zh-tw-lang="發佈" 173 zh-cn-lang="分发" 174 ru-lang="Распространение" 175 ko-lang="배포" 176 ja-lang="配布" 177 es-lang="Distribuir" 178 >Distribute</a></li> 179 </ul> 180 181 182 183 184<div class="menu-container"> 185 <div class="moremenu"> 186 <div id="more-btn"></div> 187 </div> 188 <div class="morehover" id="moremenu"> 189 <div class="top"></div> 190 <div class="mid"> 191 <div class="header">Links</div> 192 <ul> 193 <li><a href="https://play.google.com/apps/publish/" target="_googleplay">Google Play Developer Console</a></li> 194 <li><a href="http://android-developers.blogspot.com/">Android Developers Blog</a></li> 195 <li><a href="/about/index.html">About Android</a></li> 196 </ul> 197 <div class="header">Android Sites</div> 198 <ul> 199 <li><a href="http://www.android.com">Android.com</a></li> 200 <li class="active"><a>Android Developers</a></li> 201 <li><a href="http://source.android.com">Android Open Source Project</a></li> 202 </ul> 203 204 205 206 <div class="header">Language</div> 207 <div id="language" class="locales"> 208 <select name="language" onChange="changeLangPref(this.value, true)"> 209 <option value="en">English</option> 210 <option value="es">Español</option> 211 <option value="ja">日本語</option> 212 <option value="ko">한국어</option> 213 <option value="ru">Русский</option> 214 <option value="zh-cn">中文 (中国)</option> 215 <option value="zh-tw">中文 (台灣)</option> 216 </select> 217 </div> 218 <script type="text/javascript"> 219 <!-- 220 loadLangPref(); 221 //--> 222 </script> 223 224 225 <br class="clearfix" /> 226 </div><!-- end 'mid' --> 227 <div class="bottom"></div> 228 </div><!-- end 'moremenu' --> 229 230 <div class="search" id="search-container"> 231 <div class="search-inner"> 232 <div id="search-btn"></div> 233 <div class="left"></div> 234 <form onsubmit="return submit_search()"> 235 <input id="search_autocomplete" type="text" value="" autocomplete="off" name="q" 236 onfocus="search_focus_changed(this, true)" onblur="search_focus_changed(this, false)" 237 onkeydown="return search_changed(event, true, '/')" 238 onkeyup="return search_changed(event, false, '/')" /> 239 </form> 240 <div class="right"></div> 241 <a class="close hide">close</a> 242 <div class="left"></div> 243 <div class="right"></div> 244 </div><!-- end search-inner --> 245 </div><!-- end search-container --> 246 247 <div class="search_filtered_wrapper reference"> 248 <div class="suggest-card reference no-display"> 249 <ul class="search_filtered"> 250 </ul> 251 </div> 252 </div> 253 254 <div class="search_filtered_wrapper docs"> 255 <div class="suggest-card dummy no-display"> </div> 256 <div class="suggest-card develop no-display"> 257 <ul class="search_filtered"> 258 </ul> 259 <div class="child-card guides no-display"> 260 </div> 261 <div class="child-card training no-display"> 262 </div> 263 <div class="child-card samples no-display"> 264 </div> 265 </div> 266 <div class="suggest-card design no-display"> 267 <ul class="search_filtered"> 268 </ul> 269 </div> 270 <div class="suggest-card distribute no-display"> 271 <ul class="search_filtered"> 272 </ul> 273 </div> 274 </div> 275</div><!-- end menu-container (search and menu widget) --> 276 277 278 279 <!-- Expanded quicknav --> 280 <div id="quicknav" class="col-13"> 281 <ul> 282 <li class="about"> 283 <ul> 284 <li><a href="/about/index.html">About</a></li> 285 <li><a href="/wear/index.html">Wear</a></li> 286 <li><a href="/tv/index.html">TV</a></li> 287 <li><a href="/auto/index.html">Auto</a></li> 288 </ul> 289 </li> 290 <li class="design"> 291 <ul> 292 <li><a href="/design/index.html">Get Started</a></li> 293 <li><a href="/design/devices.html">Devices</a></li> 294 <li><a href="/design/style/index.html">Style</a></li> 295 <li><a href="/design/patterns/index.html">Patterns</a></li> 296 <li><a href="/design/building-blocks/index.html">Building Blocks</a></li> 297 <li><a href="/design/downloads/index.html">Downloads</a></li> 298 <li><a href="/design/videos/index.html">Videos</a></li> 299 </ul> 300 </li> 301 <li class="develop"> 302 <ul> 303 <li><a href="/training/index.html" 304 zh-tw-lang="訓練課程" 305 zh-cn-lang="培训" 306 ru-lang="Курсы" 307 ko-lang="교육" 308 ja-lang="トレーニング" 309 es-lang="Capacitación" 310 >Training</a></li> 311 <li><a href="/guide/index.html" 312 zh-tw-lang="API 指南" 313 zh-cn-lang="API 指南" 314 ru-lang="Руководства по API" 315 ko-lang="API 가이드" 316 ja-lang="API ガイド" 317 es-lang="Guías de la API" 318 >API Guides</a></li> 319 <li><a href="/reference/packages.html" 320 zh-tw-lang="參考資源" 321 zh-cn-lang="参考" 322 ru-lang="Справочник" 323 ko-lang="참조문서" 324 ja-lang="リファレンス" 325 es-lang="Referencia" 326 >Reference</a></li> 327 <li><a href="/sdk/index.html" 328 zh-tw-lang="相關工具" 329 zh-cn-lang="工具" 330 ru-lang="Инструменты" 331 ko-lang="도구" 332 ja-lang="ツール" 333 es-lang="Herramientas" 334 >Tools</a> 335 </li> 336 <li><a href="/google/index.html">Google Services</a> 337 </li> 338 339 <li><a href="/samples/index.html">Samples</a> 340 </li> 341 342 </ul> 343 </li> 344 <li class="distribute last"> 345 <ul> 346 <li><a href="/distribute/googleplay/index.html">Google Play</a></li> 347 <li><a href="/distribute/essentials/index.html">Essentials</a></li> 348 <li><a href="/distribute/users/index.html">Get Users</a></li> 349 <li><a href="/distribute/engage/index.html">Engage & Retain</a></li> 350 <li><a href="/distribute/monetize/index.html">Monetize</a></li> 351 <li><a href="/distribute/tools/index.html">Tools & Reference</a></li> 352 <li><a href="/distribute/stories/index.html">Developer Stories</a></li> 353 </ul> 354 </li> 355 </ul> 356 </div><!-- /Expanded quicknav --> 357 </div><!-- end header-wrap.wrap --> 358 </div><!-- end header --> 359 360 361 <!-- Secondary x-nav --> 362 <div id="nav-x"> 363 <div class="wrap"> 364 <ul class="nav-x col-9 develop" style="width:100%"> 365 <li class="training"><a href="/training/index.html" 366 zh-tw-lang="訓練課程" 367 zh-cn-lang="培训" 368 ru-lang="Курсы" 369 ko-lang="교육" 370 ja-lang="トレーニング" 371 es-lang="Capacitación" 372 >Training</a></li> 373 <li class="guide"><a href="/guide/index.html" 374 zh-tw-lang="API 指南" 375 zh-cn-lang="API 指南" 376 ru-lang="Руководства по API" 377 ko-lang="API 가이드" 378 ja-lang="API ガイド" 379 es-lang="Guías de la API" 380 >API Guides</a></li> 381 <li class="reference"><a href="/reference/packages.html" 382 zh-tw-lang="參考資源" 383 zh-cn-lang="参考" 384 ru-lang="Справочник" 385 ko-lang="참조문서" 386 ja-lang="リファレンス" 387 es-lang="Referencia" 388 >Reference</a></li> 389 <li class="tools"><a href="/sdk/index.html" 390 zh-tw-lang="相關工具" 391 zh-cn-lang="工具" 392 ru-lang="Инструменты" 393 ko-lang="도구" 394 ja-lang="ツール" 395 es-lang="Herramientas" 396 >Tools</a></li> 397 <li class="google"><a href="/google/index.html" 398 >Google Services</a> 399 </li> 400 401 <li class="samples"><a href="/samples/index.html" 402 >Samples</a> 403 </li> 404 405 </ul> 406 </div> 407 </div> 408 <!-- /Sendondary x-nav DEVELOP --> 409 410 411 412 <div id="searchResults" class="wrap" style="display:none;"> 413 <h2 id="searchTitle">Results</h2> 414 <div id="leftSearchControl" class="search-control">Loading...</div> 415 </div> 416 </div> <!--end header-wrapper --> 417 418 <div id="sticky-header"> 419 <div> 420 <a class="logo" href="#top"></a> 421 <a class="top" href="#top"></a> 422 <ul class="breadcrumb"> 423 424 <li class="current">SessionsApi</li> 425 </ul> 426 </div> 427 </div> 428 429 430 431 432 433 434 <div class="wrap clearfix" id="body-content"> 435 <div class="col-4" id="side-nav" itemscope itemtype="http://schema.org/SiteNavigationElement"> 436 <div id="devdoc-nav" class="scroll-pane"> 437 438 439 440<ul id="nav"> 441 442 <li class="nav-section"> 443 <div class="nav-section-header empty"><a href="/google/index.html"> 444 <span class="en">Overview</span> 445 </a></div> 446 </li> 447 448 <li class="nav-section"> 449 <div class="nav-section-header empty"><a href="/google/play-services/games.html"> 450 <span class="en">Games</span> 451 </a></div> 452 </li> 453 <li class="nav-section"> 454 <div class="nav-section-header empty"><a href="/google/play-services/location.html"> 455 <span class="en">Location</span> 456 </a></div> 457 </li> 458 <li class="nav-section"> 459 <div class="nav-section-header empty"><a href="/google/play-services/plus.html"> 460 <span class="en">Google+</span> 461 </a></div> 462 </li> 463 <li class="nav-section"> 464 <div class="nav-section-header empty"><a href="/google/play-services/maps.html"> 465 <span class="en">Maps</span> 466 </a></div> 467 </li> 468 <li class="nav-section"> 469 <div class="nav-section-header empty"><a href="/google/play-services/drive.html"> 470 <span class="en">Drive</span> 471 </a></div> 472 </li> 473 <li class="nav-section"> 474 <div class="nav-section-header empty"><a href="/google/play-services/cast.html"> 475 <span class="en">Cast</span> 476 </a></div> 477 </li> 478 <li class="nav-section"> 479 <div class="nav-section-header"><a href="/google/play-services/ads.html"> 480 <span class="en">Ads</span></a> 481 </div> 482 <ul> 483 <li><a href="/google/play-services/id.html"> 484 <span class="en">Advertising ID</span></a> 485 </li> 486 </ul> 487 </li> 488 <li class="nav-section"> 489 <div class="nav-section-header empty"><a href="/google/play-services/wallet.html"> 490 <span class="en">Wallet</span> 491 </a></div> 492 </li> 493 494 495 <li class="nav-section"> 496 <div class="nav-section-header"><a href="/google/play-services/index.html"> 497 <span class="en">Google Play Services</span></a> 498 </div> 499 <ul> 500 <li><a href="/google/play-services/setup.html"> 501 <span class="en">Setting Up Google Play Services</span></a> 502 </li> 503 <li class="nav-section"> 504 <div class="nav-section-header"><a href="/google/auth/api-client.html"> 505 <span class="en">Accessing Google APIs</span></a> 506 </div> 507 <ul> 508 <li> 509 <a href="/google/auth/http-auth.html"> 510 <span class="en">Authorizing with Google for REST APIs</span> 511 </a> 512 </li> 513 </ul> 514 </li> 515 <li id="gms-tree-list" class="nav-section"> 516 <div class="nav-section-header"> 517 <a href="/reference/gms-packages.html"> 518 <span class="en">Reference</span> 519 </a> 520 <div> 521 </li> 522 </ul> 523 </li> 524 525 526 <li class="nav-section"> 527 <div class="nav-section-header"><a href="/google/play/billing/index.html"> 528 <span class="en">Google Play In-app Billing</span></a> 529 </div> 530 <ul> 531 <li><a href="/google/play/billing/billing_overview.html"> 532 <span class="en">Overview</span></a> 533 </li> 534 <li class="nav-section"><div class="nav-section-header"><a href="/google/play/billing/api.html"> 535 <span class="en">Version 3 API</span></a></div> 536 <ul> 537 <li><a href="/google/play/billing/billing_integrate.html"> 538 <span class="en">Implementing the API</span></a></li> 539 <li><a href="/google/play/billing/billing_reference.html"> 540 <span class="en">Reference</span></a></li> 541 </ul> 542 </li> 543 <li class="nav-section"><div class="nav-section-header"><a href="/google/play/billing/v2/api.html"> 544 <span class="en">Version 2 API</span></a></div> 545 <ul> 546 <li><a href="/google/play/billing/v2/billing_integrate.html"> 547 <span class="en">Implementing the API</span></a></li> 548 <li><a href="/google/play/billing/v2/billing_subscriptions.html"> 549 <span class="en">Subscriptions</span></a></li> 550 <li><a href="/google/play/billing/v2/billing_reference.html"> 551 <span class="en">Reference</span></a></li> 552 </ul> 553 </li> 554 <li><a href="/google/play/billing/billing_subscriptions.html"> 555 <span class="en">Subscriptions</span></a> 556 </li> 557 <li><a href="/google/play/billing/billing_best_practices.html"> 558 <span class="en">Security and Design</span></a> 559 </li> 560 <li><a href="/google/play/billing/billing_testing.html"> 561 <span class="en">Testing In-app Billing</span></a> 562 </li> 563 <li><a href="/google/play/billing/billing_admin.html"> 564 <span class="en">Administering In-app Billing</span></a> 565 </li> 566 <li><a href="/google/play/billing/versions.html"> 567 <span class="en">Version Notes</span></a> 568 </li> 569 </ul> 570 </li> 571 572 573 574 <li class="nav-section"> 575 <div class="nav-section-header"><a href="/google/gcm/index.html"> 576 <span class="en">Google Cloud Messaging</span></a> 577 </div> 578 <ul> 579 <li><a href="/google/gcm/gcm.html"> 580 <span class="en">Overview</span></a> 581 </li> 582 <li><a href="/google/gcm/gs.html"> 583 <span class="en">Getting Started</span></a> 584 </li> 585 <li><a href="/google/gcm/client.html"> 586 <span class="en">Implementing GCM Client</span></a> 587 </li> 588 <li class="nav-section"><div class="nav-section-header"><a href="/google/gcm/server.html"> 589 <span class="en">Implementing GCM Server</span></a></div> 590 <ul> 591 <li><a href="/google/gcm/ccs.html"> 592 <span class="en">CCS (XMPP)</span></a></li> 593 <li><a href="/google/gcm/http.html"> 594 <span class="en">HTTP</span></a></li> 595 </ul> 596 </li> 597 <li><a href="/google/gcm/notifications.html"> 598 <span class="en">User Notifications</span></a> 599 </li> 600 <li><a href="/google/gcm/adv.html"> 601 <span class="en">Advanced Topics</span></a> 602 </li> 603 <li><a href="/google/gcm/c2dm.html"> 604 <span class="en">Migration</span></a> 605 </li> 606 <li id="gcm-tree-list" class="nav-section"> 607 <div class="nav-section-header"> 608 <a href="/reference/gcm-packages.html"> 609 <span class="en">Reference</span> 610 </a> 611 <div> 612 </li> 613 </ul> 614 </li> 615 616 <li class="nav-section"> 617 <div class="nav-section-header empty"><a href="/google/gcs/index.html"> 618 <span class="en">Google Cloud Save</span></a> 619 </div> 620 </li> 621 622 <li class="nav-section"> 623 <div class="nav-section-header"><a href="/google/play/dist.html"> 624 <span class="en">Google Play Distribution</span></a> 625 </div> 626 <ul> 627 <li><a href="/google/play/filters.html"> 628 <span class="en">Filters on Google Play</span></a> 629 </li> 630 <li><a href="/google/play/billing/gp-purchase-status-api.html"> 631 <span class="en">Google Play Developer API</span></a> 632 </li> 633 <li><a href="/google/play/publishing/multiple-apks.html"> 634 <span class="en">Multiple APK Support</span></a> 635 </li> 636 <li><a href="/google/play/expansion-files.html"> 637 <span class="en">APK Expansion Files</span></a> 638 </li> 639 <li class="nav-section"> 640 <div class="nav-section-header"><a href="/google/play/licensing/index.html"> 641 <span class="en">Application Licensing</span></a> 642 </div> 643 <ul> 644 <li><a href="/google/play/licensing/overview.html"> 645 <span class="en">Licensing Overview</span></a> 646 </li> 647 <li><a href="/google/play/licensing/setting-up.html"> 648 <span class="en">Setting Up for Licensing</span></a> 649 </li> 650 <li><a href="/google/play/licensing/adding-licensing.html"> 651 <span class="en">Adding Licensing to Your App</span></a> 652 </li> 653 <li><a href="/google/play/licensing/licensing-reference.html"> 654 <span class="en">Licensing Reference</span></a> 655 </li> 656 </ul> 657 </li> 658 659 <li class="nav-section"> 660 <div class="nav-section-header"><a href="/google/backup/index.html"> 661 Android Backup Service</a> 662 </div> 663 <ul> 664 <li><a href="/google/backup/signup.html"> 665 Register</a> 666 </li> 667 </ul> 668 </li> 669 670 </ul> 671 672</li> 673 674 675 676</ul> 677 678<script type="text/javascript"> 679<!-- 680 buildToggleLists(); 681 changeNavLang(getLangPref()); 682//--> 683</script> 684 685 686 687 688 </div> 689 <script type="text/javascript"> 690 showGoogleRefTree(); 691 692 </script> 693 </div> <!-- end side-nav --> 694 <script> 695 $(document).ready(function() { 696 scrollIntoView("devdoc-nav"); 697 }); 698 </script> 699 700 701 702 703 704 705<div class="col-12" id="doc-col"> 706 707<div id="api-info-block"> 708 709 710 711 712<div class="sum-details-links"> 713 714</div><!-- end sum-details-links --> 715<div class="api-level"> 716 717 718 719 720</div> 721</div><!-- end api-info-block --> 722 723 724<!-- ======== START OF CLASS DATA ======== --> 725 726<div id="jd-header"> 727 public 728 729 730 731 interface 732<h1 itemprop="name">SessionsApi</h1> 733 734 735 736 737 738 739 740 741</div><!-- end header --> 742 743<div id="naMessage"></div> 744 745<div id="jd-content" class="api apilevel-"> 746<table class="jd-inheritance-table"> 747 748 749 <tr> 750 751 <td colspan="1" class="jd-inheritance-class-cell">com.google.android.gms.fitness.SessionsApi</td> 752 </tr> 753 754 755</table> 756 757 758 759 760 761 762 763<div class="jd-descr"> 764 765 766<h2>Class Overview</h2> 767<p itemprop="articleBody">The Google Fit Sessions API provides methods for managing <code><a href="/reference/com/google/android/gms/fitness/data/Session.html">Sessions</a></code>. 768 Sessions are a way of storing user-visible groups of related stream data in a useful and 769 shareable manner, and allow for easy querying of the data in a detailed or aggregated fashion. 770 <p> 771 The <code><a href="/reference/com/google/android/gms/fitness/SessionsApi.html#startSession(com.google.android.gms.common.api.GoogleApiClient, com.google.android.gms.fitness.data.Session)">startSession(GoogleApiClient, com.google.android.gms.fitness.data.Session)</a></code> and 772 <code><a href="/reference/com/google/android/gms/fitness/SessionsApi.html#stopSession(com.google.android.gms.common.api.GoogleApiClient, java.lang.String, java.lang.String)">stopSession(GoogleApiClient, String, String)</a></code> methods mark the time range of the session. 773 Data inserted using the <code><a href="/reference/com/google/android/gms/fitness/HistoryApi.html">HistoryApi</a></code> during the period where the session is in progress 774 will be associated with that Session once it is stopped. 775 <p> 776 Another way of adding sessions is with 777 <code><a href="/reference/com/google/android/gms/fitness/SessionsApi.html#insertSession(com.google.android.gms.common.api.GoogleApiClient, com.google.android.gms.fitness.request.SessionInsertRequest)">insertSession(GoogleApiClient, com.google.android.gms.fitness.request.SessionInsertRequest)</a></code>. This is designed for bulk 778 insertion when importing a user's historic data into Google Fit; for live sessions use the 779 previous API. All data in Google Fit that falls within the time range of an inserted session 780 will be implicitly associated with that session. 781 <p> 782 Once a session has been saved, it can be retrieved using 783 <code><a href="/reference/com/google/android/gms/fitness/SessionsApi.html#readSession(com.google.android.gms.common.api.GoogleApiClient, com.google.android.gms.fitness.request.SessionReadRequest)">readSession(GoogleApiClient, com.google.android.gms.fitness.request.SessionReadRequest)</a></code>. 784 <p> 785 Clients can register to be notified of sessions, and remove existing registrations, using 786 <code><a href="/reference/com/google/android/gms/fitness/SessionsApi.html#registerForSessions(com.google.android.gms.common.api.GoogleApiClient, android.app.PendingIntent)">registerForSessions(GoogleApiClient, PendingIntent)</a></code> and 787 <code><a href="/reference/com/google/android/gms/fitness/SessionsApi.html#unregisterForSessions(com.google.android.gms.common.api.GoogleApiClient, android.app.PendingIntent)">unregisterForSessions(GoogleApiClient, PendingIntent)</a></code>. Notifications will be sent for 788 sessions when they are started and stopped. 789 <p> 790 Deleting sessions is handled like any other data deletion, via 791 <code><a href="/reference/com/google/android/gms/fitness/HistoryApi.html#deleteData(com.google.android.gms.common.api.GoogleApiClient, com.google.android.gms.fitness.request.DataDeleteRequest)">deleteData(GoogleApiClient, com.google.android.gms.fitness.request.DataDeleteRequest)</a></code>. 792 <p> 793 The Sessions API should be accessed via the <code><a href="/reference/com/google/android/gms/fitness/Fitness.html">Fitness</a></code> entry point. Example: 794 <pre> 795 GoogleApiClient client = new GoogleApiClient.Builder(context) 796 .addApi(Fitness.API) 797 ... 798 .build(); 799 client.connect(); 800 801 Session session = new Session.Builder() 802 .setName(sessionName) 803 .setIdentifier(identifier) 804 .setDescription(description) 805 .setStartTimeMillis(startTime.getMillis()) 806 .build(); 807 808 PendingResult<Status> pendingResult = Fitness.SessionsApi.startSession( 809 client, session); 810 811 Status status = pendingResult.await(); 812 </pre> 813</p> 814 815 816 817 818 819</div><!-- jd-descr --> 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836<div class="jd-descr"> 837 838 839<h2>Summary</h2> 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867<!-- ========== METHOD SUMMARY =========== --> 868<table id="pubmethods" class="jd-sumtable"><tr><th colspan="12">Public Methods</th></tr> 869 870 871 872 873 <tr class="alt-color api apilevel-" > 874 <td class="jd-typecol"><nobr> 875 abstract 876 877 878 879 880 <a href="/reference/com/google/android/gms/common/api/PendingResult.html">PendingResult</a><<a href="/reference/com/google/android/gms/common/api/Status.html">Status</a>></nobr> 881 </td> 882 <td class="jd-linkcol" width="100%"><nobr> 883 <span class="sympad"><a href="/reference/com/google/android/gms/fitness/SessionsApi.html#insertSession(com.google.android.gms.common.api.GoogleApiClient, com.google.android.gms.fitness.request.SessionInsertRequest)">insertSession</a></span>(<a href="/reference/com/google/android/gms/common/api/GoogleApiClient.html">GoogleApiClient</a> client, <a href="/reference/com/google/android/gms/fitness/request/SessionInsertRequest.html">SessionInsertRequest</a> request)</nobr> 884 885 <div class="jd-descrdiv">Inserts specified <code><a href="/reference/com/google/android/gms/fitness/data/Session.html">Session</a></code> and corresponding data into the user's Google Fit store 886 on behalf of the current application.</div> 887 888 </td></tr> 889 890 891 892 <tr class=" api apilevel-" > 893 <td class="jd-typecol"><nobr> 894 abstract 895 896 897 898 899 <a href="/reference/com/google/android/gms/common/api/PendingResult.html">PendingResult</a><<a href="/reference/com/google/android/gms/fitness/result/SessionReadResult.html">SessionReadResult</a>></nobr> 900 </td> 901 <td class="jd-linkcol" width="100%"><nobr> 902 <span class="sympad"><a href="/reference/com/google/android/gms/fitness/SessionsApi.html#readSession(com.google.android.gms.common.api.GoogleApiClient, com.google.android.gms.fitness.request.SessionReadRequest)">readSession</a></span>(<a href="/reference/com/google/android/gms/common/api/GoogleApiClient.html">GoogleApiClient</a> client, <a href="/reference/com/google/android/gms/fitness/request/SessionReadRequest.html">SessionReadRequest</a> request)</nobr> 903 904 <div class="jd-descrdiv">Reads data from the user's Google Fit store of the specific type(s) and for the specific 905 session(s) selected from the request parameters.</div> 906 907 </td></tr> 908 909 910 911 <tr class="alt-color api apilevel-" > 912 <td class="jd-typecol"><nobr> 913 abstract 914 915 916 917 918 <a href="/reference/com/google/android/gms/common/api/PendingResult.html">PendingResult</a><<a href="/reference/com/google/android/gms/common/api/Status.html">Status</a>></nobr> 919 </td> 920 <td class="jd-linkcol" width="100%"><nobr> 921 <span class="sympad"><a href="/reference/com/google/android/gms/fitness/SessionsApi.html#registerForSessions(com.google.android.gms.common.api.GoogleApiClient, android.app.PendingIntent)">registerForSessions</a></span>(<a href="/reference/com/google/android/gms/common/api/GoogleApiClient.html">GoogleApiClient</a> client, PendingIntent intent)</nobr> 922 923 <div class="jd-descrdiv">Registers for notifications of session start and end events using a PendingIntent.</div> 924 925 </td></tr> 926 927 928 929 <tr class=" api apilevel-" > 930 <td class="jd-typecol"><nobr> 931 abstract 932 933 934 935 936 <a href="/reference/com/google/android/gms/common/api/PendingResult.html">PendingResult</a><<a href="/reference/com/google/android/gms/common/api/Status.html">Status</a>></nobr> 937 </td> 938 <td class="jd-linkcol" width="100%"><nobr> 939 <span class="sympad"><a href="/reference/com/google/android/gms/fitness/SessionsApi.html#startSession(com.google.android.gms.common.api.GoogleApiClient, com.google.android.gms.fitness.data.Session)">startSession</a></span>(<a href="/reference/com/google/android/gms/common/api/GoogleApiClient.html">GoogleApiClient</a> client, <a href="/reference/com/google/android/gms/fitness/data/Session.html">Session</a> session)</nobr> 940 941 <div class="jd-descrdiv">Starts a new active session for the current application.</div> 942 943 </td></tr> 944 945 946 947 <tr class="alt-color api apilevel-" > 948 <td class="jd-typecol"><nobr> 949 abstract 950 951 952 953 954 <a href="/reference/com/google/android/gms/common/api/PendingResult.html">PendingResult</a><<a href="/reference/com/google/android/gms/fitness/result/SessionStopResult.html">SessionStopResult</a>></nobr> 955 </td> 956 <td class="jd-linkcol" width="100%"><nobr> 957 <span class="sympad"><a href="/reference/com/google/android/gms/fitness/SessionsApi.html#stopSession(com.google.android.gms.common.api.GoogleApiClient, java.lang.String, java.lang.String)">stopSession</a></span>(<a href="/reference/com/google/android/gms/common/api/GoogleApiClient.html">GoogleApiClient</a> client, String name, String identifier)</nobr> 958 959 <div class="jd-descrdiv">Stops active sessions for the current application.</div> 960 961 </td></tr> 962 963 964 965 <tr class=" api apilevel-" > 966 <td class="jd-typecol"><nobr> 967 abstract 968 969 970 971 972 <a href="/reference/com/google/android/gms/common/api/PendingResult.html">PendingResult</a><<a href="/reference/com/google/android/gms/common/api/Status.html">Status</a>></nobr> 973 </td> 974 <td class="jd-linkcol" width="100%"><nobr> 975 <span class="sympad"><a href="/reference/com/google/android/gms/fitness/SessionsApi.html#unregisterForSessions(com.google.android.gms.common.api.GoogleApiClient, android.app.PendingIntent)">unregisterForSessions</a></span>(<a href="/reference/com/google/android/gms/common/api/GoogleApiClient.html">GoogleApiClient</a> client, PendingIntent intent)</nobr> 976 977 <div class="jd-descrdiv">Unregisters for notifications of session start & end events using a PendingIntent.</div> 978 979 </td></tr> 980 981 982 983</table> 984 985 986 987 988 989 990 991</div><!-- jd-descr (summary) --> 992 993<!-- Details --> 994 995 996 997 998 999 1000 1001 1002<!-- XML Attributes --> 1003 1004 1005<!-- Enum Values --> 1006 1007 1008<!-- Constants --> 1009 1010 1011<!-- Fields --> 1012 1013 1014<!-- Public ctors --> 1015 1016 1017 1018<!-- ========= CONSTRUCTOR DETAIL ======== --> 1019<!-- Protected ctors --> 1020 1021 1022 1023<!-- ========= METHOD DETAIL ======== --> 1024<!-- Public methdos --> 1025 1026<h2>Public Methods</h2> 1027 1028 1029 1030<A NAME="insertSession(com.google.android.gms.common.api.GoogleApiClient, com.google.android.gms.fitness.request.SessionInsertRequest)"></A> 1031 1032<div class="jd-details api apilevel-"> 1033 <h4 class="jd-details-title"> 1034 <span class="normal"> 1035 public 1036 1037 1038 abstract 1039 1040 <a href="/reference/com/google/android/gms/common/api/PendingResult.html">PendingResult</a><<a href="/reference/com/google/android/gms/common/api/Status.html">Status</a>> 1041 </span> 1042 <span class="sympad">insertSession</span> 1043 <span class="normal">(<a href="/reference/com/google/android/gms/common/api/GoogleApiClient.html">GoogleApiClient</a> client, <a href="/reference/com/google/android/gms/fitness/request/SessionInsertRequest.html">SessionInsertRequest</a> request)</span> 1044 </h4> 1045 <div class="api-level"> 1046 <div></div> 1047 1048 1049 1050 </div> 1051 <div class="jd-details-descr"> 1052 1053 <div class="jd-tagdata jd-tagdescr"><p>Inserts specified <code><a href="/reference/com/google/android/gms/fitness/data/Session.html">Session</a></code> and corresponding data into the user's Google Fit store 1054 on behalf of the current application. Useful for bulk upload of a previously recorded 1055 Session.</p></div> 1056 <div class="jd-tagdata"> 1057 <h5 class="jd-tagtitle">Parameters</h5> 1058 <table class="jd-tagtable"> 1059 <tr> 1060 <th>client</td> 1061 <td>an existing GoogleApiClient. It does not need to be connected at the time of 1062 this call, but the insertion will be delayed until the connection is complete.</td> 1063 </tr> 1064 <tr> 1065 <th>request</td> 1066 <td>the <code><a href="/reference/com/google/android/gms/fitness/data/Session.html">Session</a></code> and its associated data that we are adding, which includes 1067 details of the session and data set for data source(s). 1068</td> 1069 </tr> 1070 </table> 1071 </div> 1072 1073 </div> 1074</div> 1075 1076 1077<A NAME="readSession(com.google.android.gms.common.api.GoogleApiClient, com.google.android.gms.fitness.request.SessionReadRequest)"></A> 1078 1079<div class="jd-details api apilevel-"> 1080 <h4 class="jd-details-title"> 1081 <span class="normal"> 1082 public 1083 1084 1085 abstract 1086 1087 <a href="/reference/com/google/android/gms/common/api/PendingResult.html">PendingResult</a><<a href="/reference/com/google/android/gms/fitness/result/SessionReadResult.html">SessionReadResult</a>> 1088 </span> 1089 <span class="sympad">readSession</span> 1090 <span class="normal">(<a href="/reference/com/google/android/gms/common/api/GoogleApiClient.html">GoogleApiClient</a> client, <a href="/reference/com/google/android/gms/fitness/request/SessionReadRequest.html">SessionReadRequest</a> request)</span> 1091 </h4> 1092 <div class="api-level"> 1093 <div></div> 1094 1095 1096 1097 </div> 1098 <div class="jd-details-descr"> 1099 1100 <div class="jd-tagdata jd-tagdescr"><p>Reads data from the user's Google Fit store of the specific type(s) and for the specific 1101 session(s) selected from the request parameters.</p></div> 1102 <div class="jd-tagdata"> 1103 <h5 class="jd-tagtitle">Parameters</h5> 1104 <table class="jd-tagtable"> 1105 <tr> 1106 <th>client</td> 1107 <td>an existing GoogleApiClient. It does not need to be connected at the time of 1108 this call, but the insertion will be delayed until the connection is complete.</td> 1109 </tr> 1110 <tr> 1111 <th>request</td> 1112 <td>a built request specifying the specific session or time interval and/or 1113 data type we are interested in reading.</td> 1114 </tr> 1115 </table> 1116 </div> 1117 <div class="jd-tagdata"> 1118 <h5 class="jd-tagtitle">Returns</h5> 1119 <ul class="nolist"><li>a pending result containing the requested session and data. Includes a data set for 1120 each session and data type that was returned. 1121</li></ul> 1122 </div> 1123 1124 </div> 1125</div> 1126 1127 1128<A NAME="registerForSessions(com.google.android.gms.common.api.GoogleApiClient, android.app.PendingIntent)"></A> 1129 1130<div class="jd-details api apilevel-"> 1131 <h4 class="jd-details-title"> 1132 <span class="normal"> 1133 public 1134 1135 1136 abstract 1137 1138 <a href="/reference/com/google/android/gms/common/api/PendingResult.html">PendingResult</a><<a href="/reference/com/google/android/gms/common/api/Status.html">Status</a>> 1139 </span> 1140 <span class="sympad">registerForSessions</span> 1141 <span class="normal">(<a href="/reference/com/google/android/gms/common/api/GoogleApiClient.html">GoogleApiClient</a> client, PendingIntent intent)</span> 1142 </h4> 1143 <div class="api-level"> 1144 <div></div> 1145 1146 1147 1148 </div> 1149 <div class="jd-details-descr"> 1150 1151 <div class="jd-tagdata jd-tagdescr"><p>Registers for notifications of session start and end events using a PendingIntent. 1152 <p> 1153 The application specifies a PendingIntent callback (typically an IntentService) which will be 1154 called when sessions are started or stopped. When the PendingIntent is called, the 1155 application can use <code><a href="/reference/com/google/android/gms/fitness/data/Session.html#extract(android.content.Intent)">extract(android.content.Intent)</a></code> to extract the Session 1156 from the intent. In addition, the following Intent extras can be used: 1157 <ul> 1158 <li><code><a href="/reference/com/google/android/gms/fitness/FitnessIntents.html#EXTRA_START_TIME">EXTRA_START_TIME</a></code> set to the Session's start time. 1159 <li><code><a href="/reference/com/google/android/gms/fitness/FitnessIntents.html#EXTRA_END_TIME">EXTRA_END_TIME</a></code> optionally set to the Session's end time if 1160 the session has ended. 1161 </ul> 1162 <p> 1163 Finally, the Intent's type will be set to 1164 <code><a href="/reference/com/google/android/gms/fitness/FitnessIntents.html#MIME_TYPE_ACTIVITY_PREFIX">MIME_TYPE_ACTIVITY_PREFIX</a></code> followed by the name of the activity 1165 associated with this session, and can be computed by 1166 <code><a href="/reference/com/google/android/gms/fitness/FitnessIntents.html#getActivityMimeType(int)">getActivityMimeType(int)</a></code>.</p></div> 1167 <div class="jd-tagdata"> 1168 <h5 class="jd-tagtitle">Parameters</h5> 1169 <table class="jd-tagtable"> 1170 <tr> 1171 <th>client</td> 1172 <td>an existing GoogleApiClient. Must be connected at the time of this call.</td> 1173 </tr> 1174 <tr> 1175 <th>intent</td> 1176 <td>a callback intent to be sent every time a session is started or stopped. 1177</td> 1178 </tr> 1179 </table> 1180 </div> 1181 1182 </div> 1183</div> 1184 1185 1186<A NAME="startSession(com.google.android.gms.common.api.GoogleApiClient, com.google.android.gms.fitness.data.Session)"></A> 1187 1188<div class="jd-details api apilevel-"> 1189 <h4 class="jd-details-title"> 1190 <span class="normal"> 1191 public 1192 1193 1194 abstract 1195 1196 <a href="/reference/com/google/android/gms/common/api/PendingResult.html">PendingResult</a><<a href="/reference/com/google/android/gms/common/api/Status.html">Status</a>> 1197 </span> 1198 <span class="sympad">startSession</span> 1199 <span class="normal">(<a href="/reference/com/google/android/gms/common/api/GoogleApiClient.html">GoogleApiClient</a> client, <a href="/reference/com/google/android/gms/fitness/data/Session.html">Session</a> session)</span> 1200 </h4> 1201 <div class="api-level"> 1202 <div></div> 1203 1204 1205 1206 </div> 1207 <div class="jd-details-descr"> 1208 1209 <div class="jd-tagdata jd-tagdescr"><p>Starts a new active session for the current application.</p></div> 1210 <div class="jd-tagdata"> 1211 <h5 class="jd-tagtitle">Parameters</h5> 1212 <table class="jd-tagtable"> 1213 <tr> 1214 <th>client</td> 1215 <td>an existing GoogleApiClient. Must be connected at the time of this call.</td> 1216 </tr> 1217 <tr> 1218 <th>session</td> 1219 <td>the session to be started</td> 1220 </tr> 1221 </table> 1222 </div> 1223 <div class="jd-tagdata"> 1224 <h5 class="jd-tagtitle">Returns</h5> 1225 <ul class="nolist"><li>a pending result containing the status of request</li></ul> 1226 </div> 1227 <div class="jd-tagdata"> 1228 <h5 class="jd-tagtitle">Throws</h5> 1229 <table class="jd-tagtable"> 1230 <tr> 1231 <th>IllegalStateException</td> 1232 <td>if client is not connected 1233</td> 1234 </tr> 1235 </table> 1236 </div> 1237 1238 </div> 1239</div> 1240 1241 1242<A NAME="stopSession(com.google.android.gms.common.api.GoogleApiClient, java.lang.String, java.lang.String)"></A> 1243 1244<div class="jd-details api apilevel-"> 1245 <h4 class="jd-details-title"> 1246 <span class="normal"> 1247 public 1248 1249 1250 abstract 1251 1252 <a href="/reference/com/google/android/gms/common/api/PendingResult.html">PendingResult</a><<a href="/reference/com/google/android/gms/fitness/result/SessionStopResult.html">SessionStopResult</a>> 1253 </span> 1254 <span class="sympad">stopSession</span> 1255 <span class="normal">(<a href="/reference/com/google/android/gms/common/api/GoogleApiClient.html">GoogleApiClient</a> client, String name, String identifier)</span> 1256 </h4> 1257 <div class="api-level"> 1258 <div></div> 1259 1260 1261 1262 </div> 1263 <div class="jd-details-descr"> 1264 1265 <div class="jd-tagdata jd-tagdescr"><p>Stops active sessions for the current application. The active sessions to be stopped are 1266 chosen as per the specifications in the input request.</p></div> 1267 <div class="jd-tagdata"> 1268 <h5 class="jd-tagtitle">Parameters</h5> 1269 <table class="jd-tagtable"> 1270 <tr> 1271 <th>client</td> 1272 <td>an existing GoogleApiClient. Must be connected at the time of this call.</td> 1273 </tr> 1274 <tr> 1275 <th>name</td> 1276 <td>the name of the session to stop.</td> 1277 </tr> 1278 <tr> 1279 <th>identifier</td> 1280 <td>the identifier of the session to stop.</td> 1281 </tr> 1282 </table> 1283 </div> 1284 <div class="jd-tagdata"> 1285 <h5 class="jd-tagtitle">Returns</h5> 1286 <ul class="nolist"><li>a pending result containing the list of sessions that were stopped</li></ul> 1287 </div> 1288 <div class="jd-tagdata"> 1289 <h5 class="jd-tagtitle">Throws</h5> 1290 <table class="jd-tagtable"> 1291 <tr> 1292 <th>IllegalStateException</td> 1293 <td>if client is not connected 1294</td> 1295 </tr> 1296 </table> 1297 </div> 1298 1299 </div> 1300</div> 1301 1302 1303<A NAME="unregisterForSessions(com.google.android.gms.common.api.GoogleApiClient, android.app.PendingIntent)"></A> 1304 1305<div class="jd-details api apilevel-"> 1306 <h4 class="jd-details-title"> 1307 <span class="normal"> 1308 public 1309 1310 1311 abstract 1312 1313 <a href="/reference/com/google/android/gms/common/api/PendingResult.html">PendingResult</a><<a href="/reference/com/google/android/gms/common/api/Status.html">Status</a>> 1314 </span> 1315 <span class="sympad">unregisterForSessions</span> 1316 <span class="normal">(<a href="/reference/com/google/android/gms/common/api/GoogleApiClient.html">GoogleApiClient</a> client, PendingIntent intent)</span> 1317 </h4> 1318 <div class="api-level"> 1319 <div></div> 1320 1321 1322 1323 </div> 1324 <div class="jd-details-descr"> 1325 1326 <div class="jd-tagdata jd-tagdescr"><p>Unregisters for notifications of session start & end events using a PendingIntent.</p></div> 1327 <div class="jd-tagdata"> 1328 <h5 class="jd-tagtitle">Parameters</h5> 1329 <table class="jd-tagtable"> 1330 <tr> 1331 <th>client</td> 1332 <td>an existing GoogleApiClient. Must be connected at the time of this call.</td> 1333 </tr> 1334 </table> 1335 </div> 1336 <div class="jd-tagdata"> 1337 <h5 class="jd-tagtitle">Throws</h5> 1338 <table class="jd-tagtable"> 1339 <tr> 1340 <th>IllegalStateException</td> 1341 <td>if client is not connected 1342</td> 1343 </tr> 1344 </table> 1345 </div> 1346 <div class="jd-tagdata"> 1347 <h5 class="jd-tagtitle">See Also</h5> 1348 <ul class="nolist"><li><code><a href="/">ERROR(#registerForSessions(GoogleApiClient, PendingIntent)}/{@link #registerForSessions(GoogleApiClient, PendingIntent)})</a></code></li> 1349 </ul> 1350 </div> 1351 1352 </div> 1353</div> 1354 1355 1356 1357 1358 1359<!-- ========= METHOD DETAIL ======== --> 1360 1361 1362 1363<!-- ========= END OF CLASS DATA ========= --> 1364<A NAME="navbar_top"></A> 1365 1366<div id="footer" class="wrap" > 1367 1368 1369 <div id="copyright"> 1370 1371 Except as noted, this content is licensed under <a 1372 href="http://www.apache.org/licenses/LICENSE-2.0">Apache 2.0</a>. 1373 For details and restrictions, see the <a href="/license.html"> 1374 Content License</a>. 1375 </div> 1376 <div id="build_info"> 1377 1378<script src="/timestamp.js" type="text/javascript"></script> 1379<script>document.write(BUILD_TIMESTAMP)</script> 1380 1381 </div> 1382 1383 1384 <div id="footerlinks"> 1385 1386 <p> 1387 <a href="/about/index.html">About Android</a> | 1388 <a href="/legal.html">Legal</a> | 1389 <a href="/support.html">Support</a> 1390 </p> 1391 </div> 1392 1393</div> <!-- end footer --> 1394</div> <!-- jd-content --> 1395 1396</div><!-- end doc-content --> 1397 1398</div> <!-- end body-content --> 1399 1400 1401 1402 1403 1404 1405</body> 1406</html> 1407
