index.html 46 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342
  1. <html>
  2. <head>
  3. <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
  4. <title>Interval</title>
  5. <link href="../../../../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../";</script><script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script><link href="../../../styles/style.css" rel="Stylesheet"><link href="../../../styles/logo-styles.css" rel="Stylesheet"><link href="../../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../../styles/main.css" rel="Stylesheet"><script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script><script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script><script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script><script type="text/javascript" src="../../../scripts/main.js" async="async"></script> </head>
  6. <body>
  7. <div id="container">
  8. <div id="leftColumn"><a href="../../../index.html">
  9. <div id="logo"></div>
  10. </a>
  11. <div id="paneSearch"></div>
  12. <div id="sideMenu"></div>
  13. </div>
  14. <div id="main">
  15. <div id="leftToggler"><span class="icon-toggler"></span></div>
  16. <script type="text/javascript" src="../../../scripts/main.js"></script> <div class="main-content" id="content" pageIds="Net::com.drake.net.time/Interval///PointingToDeclaration//1281733757">
  17. <div class="navigation-wrapper" id="navigation-wrapper">
  18. <div class="breadcrumbs"><a href="../../../index.html">Net</a>/<a href="../index.html">com.drake.net.time</a>/<a href="index.html">Interval</a></div>
  19. <div class="pull-right d-flex">
  20. <div id="searchBar"></div>
  21. </div>
  22. </div>
  23. <div class="cover ">
  24. <h1 class="cover"><span>Interval</span></h1>
  25. <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><div class="symbol monospace">open class <a href="index.html">Interval</a> <span>@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html">JvmOverloads</a>() </span>constructor(end: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>, period: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>, unit: <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/TimeUnit.html">TimeUnit</a>, start: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>, initialDelay: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>) : <a href="https://developer.android.com/reference/kotlin/java/io/Serializable.html">Serializable</a>, <a href="https://developer.android.com/reference/kotlin/java/io/Closeable.html">Closeable</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph">创建一个轮询器</p><p class="paragraph">操作</p><ol><li><p class="paragraph">开启 <a href="start.html">start</a> 只有在闲置状态下才可以开始</p></li><li><p class="paragraph">停止 <a href="stop.html">stop</a></p></li><li><p class="paragraph">暂停 <a href="pause.html">pause</a></p></li><li><p class="paragraph">继续 <a href="resume.html">resume</a></p></li><li><p class="paragraph">重置 <a href="reset.html">reset</a> 重置不会导致轮询器停止</p></li><li><p class="paragraph">开关 <a href="switch.html">switch</a> 开启|暂停切换</p></li><li><p class="paragraph">生命周期 <a href="life.html">life</a></p></li></ol><p class="paragraph">函数回调: 允许多次订阅同一个轮询器</p><ol><li><p class="paragraph">每个事件 <a href="subscribe.html">subscribe</a></p></li><li><p class="paragraph">停止或者结束 <a href="finish.html">finish</a></p></li></ol></div></div>
  26. </div>
  27. <div class="tabbedcontent">
  28. <div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Constructors">Constructors</button><button class="section-tab" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Properties">Properties</button><button class="section-tab" data-togglable="Extensions">Extensions</button><button class="section-tab" data-togglable="Parameters">Parameters</button></div>
  29. <div class="tabs-section-body">
  30. <h2 class="">Parameters</h2>
  31. <div data-togglable="Parameters">
  32. <div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">end</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">结束值, -1 表示永远不结束</p></div></div></div></div></div><div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">period</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">计时器间隔</p></div></div></div></div></div><div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">unit</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">计时器单位</p></div></div></div></div></div><div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">initialDelay</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">第一次事件的间隔时间, 默认0</p></div></div></div></div></div><div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">start</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">开始值, 当<a href="start.html">start</a>]比<a href="end.html">end</a>值大, 且end不等于-1时, 即为倒计时, 反之正计时</p></div></div></div></div></div></div></div></div></div>
  33. </div>
  34. <h2 class="tabbedcontent">Constructors</h2>
  35. <div class="table" data-togglable="Constructors"><a data-name="-1791713923%2FConstructors%2F1281733757" anchor-label="Interval" id="-1791713923%2FConstructors%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
  36. <div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
  37. <div class="main-subrow keyValue TabbedContent">
  38. <div class=""><span class="inline-flex"><a href="-interval.html">Interval</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1791713923%2FConstructors%2F1281733757"></span>
  39. <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  40. </span></span></div>
  41. <div>
  42. <div class="title">
  43. <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html">JvmOverloads</a>()</div></div>fun <a href="-interval.html">Interval</a>(period: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>, unit: <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/TimeUnit.html">TimeUnit</a>, initialDelay: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a> = 0)<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief ">创建一个不会自动结束的轮询器/计时器</div></div></div>
  44. </div>
  45. </div>
  46. </div>
  47. </div>
  48. <a data-name="1595381041%2FConstructors%2F1281733757" anchor-label="Interval" id="1595381041%2FConstructors%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
  49. <div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
  50. <div class="main-subrow keyValue TabbedContent">
  51. <div class=""><span class="inline-flex"><a href="-interval.html">Interval</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1595381041%2FConstructors%2F1281733757"></span>
  52. <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  53. </span></span></div>
  54. <div>
  55. <div class="title">
  56. <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html">JvmOverloads</a>()</div></div>fun <a href="-interval.html">Interval</a>(end: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>, period: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>, unit: <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/TimeUnit.html">TimeUnit</a>, start: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a> = 0, initialDelay: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a> = 0)<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief ">结束值, -1 表示永远不结束</div></div></div>
  57. </div>
  58. </div>
  59. </div>
  60. </div>
  61. </div>
  62. <h2 class="">Functions</h2>
  63. <div class="table" data-togglable="Functions"><a data-name="1339174108%2FFunctions%2F1281733757" anchor-label="cancel" id="1339174108%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
  64. <div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
  65. <div class="main-subrow keyValue ">
  66. <div class=""><span class="inline-flex"><a href="cancel.html">cancel</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1339174108%2FFunctions%2F1281733757"></span>
  67. <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  68. </span></span></div>
  69. <div>
  70. <div class="title"><div class="divergent-group" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release"><div class="with-platform-tags"><span class="pull-right"></span></div>
  71. <div>
  72. <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><div class="symbol monospace">fun <a href="cancel.html">cancel</a>()<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
  73. </div>
  74. <a data-name="1339174108%2FFunctions%2F1281733757" anchor-label="cancel" id="1339174108%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="brief "><a data-name="1339174108%2FFunctions%2F1281733757" anchor-label="cancel" id="1339174108%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>取消 区别于<a href="stop.html">stop</a>并不会执行<a href="finish.html">finish</a></div></div>
  75. </div>
  76. </div>
  77. </div>
  78. </div>
  79. <a data-name="2111333196%2FFunctions%2F1281733757" anchor-label="close" id="2111333196%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
  80. <div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
  81. <div class="main-subrow keyValue ">
  82. <div class=""><span class="inline-flex"><a href="close.html">close</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2111333196%2FFunctions%2F1281733757"></span>
  83. <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  84. </span></span></div>
  85. <div>
  86. <div class="title"><div class="divergent-group" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release"><div class="with-platform-tags"><span class="pull-right"></span></div>
  87. <div>
  88. <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><div class="symbol monospace">open override fun <a href="close.html">close</a>()<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
  89. </div>
  90. <a data-name="2111333196%2FFunctions%2F1281733757" anchor-label="close" id="2111333196%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="brief "><a data-name="2111333196%2FFunctions%2F1281733757" anchor-label="close" id="2111333196%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>等于<a href="cancel.html">cancel</a></div></div>
  91. </div>
  92. </div>
  93. </div>
  94. </div>
  95. <a data-name="848167357%2FFunctions%2F1281733757" anchor-label="finish" id="848167357%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
  96. <div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
  97. <div class="main-subrow keyValue ">
  98. <div class=""><span class="inline-flex"><a href="finish.html">finish</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="848167357%2FFunctions%2F1281733757"></span>
  99. <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  100. </span></span></div>
  101. <div>
  102. <div class="title"><div class="divergent-group" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release"><div class="with-platform-tags"><span class="pull-right"></span></div>
  103. <div>
  104. <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><div class="symbol monospace">fun <a href="finish.html">finish</a>(block: <a href="index.html">Interval</a>.(<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>) -&gt; <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>): <span data-unresolved-link="/&amp;lt;ERROR CLASS&amp;gt;///PointingToDeclaration/">&lt;ERROR CLASS&gt;</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
  105. </div>
  106. <a data-name="848167357%2FFunctions%2F1281733757" anchor-label="finish" id="848167357%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="brief "><a data-name="848167357%2FFunctions%2F1281733757" anchor-label="finish" id="848167357%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>轮询器完成时回调该函数</div></div>
  107. </div>
  108. </div>
  109. </div>
  110. </div>
  111. <a data-name="-1550481670%2FFunctions%2F1281733757" anchor-label="life" id="-1550481670%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
  112. <div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
  113. <div class="main-subrow keyValue ">
  114. <div class=""><span class="inline-flex"><a href="life.html">life</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1550481670%2FFunctions%2F1281733757"></span>
  115. <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  116. </span></span></div>
  117. <div>
  118. <div class="title"><div class="divergent-group" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release"><div class="with-platform-tags"><span class="pull-right"></span></div>
  119. <div>
  120. <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html">JvmOverloads</a>()</div></div>fun <a href="life.html">life</a>(fragment: <a href="https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment.html">Fragment</a>, lifeEvent: <a href="https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle.Event.html">Lifecycle.Event</a> = Lifecycle.Event.ON_DESTROY): <a href="index.html">Interval</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
  121. </div>
  122. <a data-name="-1453661394%2FFunctions%2F1281733757" anchor-label="life" id="-1453661394%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="brief "><a data-name="-1453661394%2FFunctions%2F1281733757" anchor-label="life" id="-1453661394%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>自动在指定生命周期后取消<a href="cancel.html">cancel</a>轮询器</div></div>
  123. <div class="divergent-group" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release"><div class="with-platform-tags"><span class="pull-right"></span></div>
  124. <div>
  125. <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html">JvmOverloads</a>()</div></div>fun <a href="life.html">life</a>(lifecycleOwner: <a href="https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleOwner.html">LifecycleOwner</a>, lifeEvent: <a href="https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle.Event.html">Lifecycle.Event</a> = Lifecycle.Event.ON_DESTROY): <span data-unresolved-link="/&amp;lt;ERROR CLASS&amp;gt;///PointingToDeclaration/">&lt;ERROR CLASS&gt;</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
  126. </div>
  127. <a data-name="1129928924%2FFunctions%2F1281733757" anchor-label="life" id="1129928924%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="brief "><a data-name="1129928924%2FFunctions%2F1281733757" anchor-label="life" id="1129928924%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>自动在指定生命周期后取消<a href="cancel.html">cancel</a>轮询器</div></div>
  128. </div>
  129. </div>
  130. </div>
  131. </div>
  132. <a data-name="745458455%2FFunctions%2F1281733757" anchor-label="onlyResumed" id="745458455%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
  133. <div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
  134. <div class="main-subrow keyValue ">
  135. <div class=""><span class="inline-flex"><a href="only-resumed.html">onlyResumed</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="745458455%2FFunctions%2F1281733757"></span>
  136. <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  137. </span></span></div>
  138. <div>
  139. <div class="title"><div class="divergent-group" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release"><div class="with-platform-tags"><span class="pull-right"></span></div>
  140. <div>
  141. <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><div class="symbol monospace">fun <a href="only-resumed.html">onlyResumed</a>(lifecycleOwner: <a href="https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleOwner.html">LifecycleOwner</a>): <span data-unresolved-link="/&amp;lt;ERROR CLASS&amp;gt;///PointingToDeclaration/">&lt;ERROR CLASS&gt;</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
  142. </div>
  143. <a data-name="745458455%2FFunctions%2F1281733757" anchor-label="onlyResumed" id="745458455%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="brief "><a data-name="745458455%2FFunctions%2F1281733757" anchor-label="onlyResumed" id="745458455%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>当界面不可见时暂停<a href="pause.html">pause</a>, 当界面可见时继续<a href="resume.html">resume</a>, 当界面销毁时<a href="cancel.html">cancel</a>轮询器</div></div>
  144. </div>
  145. </div>
  146. </div>
  147. </div>
  148. <a data-name="1695839502%2FFunctions%2F1281733757" anchor-label="pause" id="1695839502%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
  149. <div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
  150. <div class="main-subrow keyValue ">
  151. <div class=""><span class="inline-flex"><a href="pause.html">pause</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1695839502%2FFunctions%2F1281733757"></span>
  152. <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  153. </span></span></div>
  154. <div>
  155. <div class="title"><div class="divergent-group" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release"><div class="with-platform-tags"><span class="pull-right"></span></div>
  156. <div>
  157. <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><div class="symbol monospace">fun <a href="pause.html">pause</a>()<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
  158. </div>
  159. <a data-name="1695839502%2FFunctions%2F1281733757" anchor-label="pause" id="1695839502%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="brief "><a data-name="1695839502%2FFunctions%2F1281733757" anchor-label="pause" id="1695839502%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>暂停</div></div>
  160. </div>
  161. </div>
  162. </div>
  163. </div>
  164. <a data-name="592987093%2FFunctions%2F1281733757" anchor-label="reset" id="592987093%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
  165. <div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
  166. <div class="main-subrow keyValue ">
  167. <div class=""><span class="inline-flex"><a href="reset.html">reset</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="592987093%2FFunctions%2F1281733757"></span>
  168. <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  169. </span></span></div>
  170. <div>
  171. <div class="title"><div class="divergent-group" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release"><div class="with-platform-tags"><span class="pull-right"></span></div>
  172. <div>
  173. <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><div class="symbol monospace">fun <a href="reset.html">reset</a>()<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
  174. </div>
  175. <a data-name="592987093%2FFunctions%2F1281733757" anchor-label="reset" id="592987093%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="brief "><a data-name="592987093%2FFunctions%2F1281733757" anchor-label="reset" id="592987093%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>重置</div></div>
  176. </div>
  177. </div>
  178. </div>
  179. </div>
  180. <a data-name="117559945%2FFunctions%2F1281733757" anchor-label="resume" id="117559945%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
  181. <div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
  182. <div class="main-subrow keyValue ">
  183. <div class=""><span class="inline-flex"><a href="resume.html">resume</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="117559945%2FFunctions%2F1281733757"></span>
  184. <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  185. </span></span></div>
  186. <div>
  187. <div class="title"><div class="divergent-group" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release"><div class="with-platform-tags"><span class="pull-right"></span></div>
  188. <div>
  189. <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><div class="symbol monospace">fun <a href="resume.html">resume</a>()<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
  190. </div>
  191. <a data-name="117559945%2FFunctions%2F1281733757" anchor-label="resume" id="117559945%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="brief "><a data-name="117559945%2FFunctions%2F1281733757" anchor-label="resume" id="117559945%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>继续 要求轮询器为暂停状态<a href="../-interval-status/-s-t-a-t-e_-p-a-u-s-e/index.html">IntervalStatus.STATE_PAUSE</a>, 否则无效</div></div>
  192. </div>
  193. </div>
  194. </div>
  195. </div>
  196. <a data-name="-1977702366%2FFunctions%2F1281733757" anchor-label="start" id="-1977702366%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
  197. <div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
  198. <div class="main-subrow keyValue ">
  199. <div class=""><span class="inline-flex"><a href="start.html">start</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1977702366%2FFunctions%2F1281733757"></span>
  200. <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  201. </span></span></div>
  202. <div>
  203. <div class="title"><div class="divergent-group" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release"><div class="with-platform-tags"><span class="pull-right"></span></div>
  204. <div>
  205. <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><div class="symbol monospace">fun <a href="start.html">start</a>(): <span data-unresolved-link="/&amp;lt;ERROR CLASS&amp;gt;///PointingToDeclaration/">&lt;ERROR CLASS&gt;</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
  206. </div>
  207. <a data-name="-1977702366%2FFunctions%2F1281733757" anchor-label="start" id="-1977702366%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="brief "><a data-name="-1977702366%2FFunctions%2F1281733757" anchor-label="start" id="-1977702366%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>开始 如果当前为暂停状态将重新开始轮询</div></div>
  208. </div>
  209. </div>
  210. </div>
  211. </div>
  212. <a data-name="2062900884%2FFunctions%2F1281733757" anchor-label="stop" id="2062900884%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
  213. <div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
  214. <div class="main-subrow keyValue ">
  215. <div class=""><span class="inline-flex"><a href="stop.html">stop</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2062900884%2FFunctions%2F1281733757"></span>
  216. <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  217. </span></span></div>
  218. <div>
  219. <div class="title"><div class="divergent-group" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release"><div class="with-platform-tags"><span class="pull-right"></span></div>
  220. <div>
  221. <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><div class="symbol monospace">fun <a href="stop.html">stop</a>()<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
  222. </div>
  223. <a data-name="2062900884%2FFunctions%2F1281733757" anchor-label="stop" id="2062900884%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="brief "><a data-name="2062900884%2FFunctions%2F1281733757" anchor-label="stop" id="2062900884%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>停止</div></div>
  224. </div>
  225. </div>
  226. </div>
  227. </div>
  228. <a data-name="-706319290%2FFunctions%2F1281733757" anchor-label="subscribe" id="-706319290%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
  229. <div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
  230. <div class="main-subrow keyValue ">
  231. <div class=""><span class="inline-flex"><a href="subscribe.html">subscribe</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-706319290%2FFunctions%2F1281733757"></span>
  232. <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  233. </span></span></div>
  234. <div>
  235. <div class="title"><div class="divergent-group" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release"><div class="with-platform-tags"><span class="pull-right"></span></div>
  236. <div>
  237. <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><div class="symbol monospace">fun <a href="subscribe.html">subscribe</a>(block: <a href="index.html">Interval</a>.(<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>) -&gt; <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>): <span data-unresolved-link="/&amp;lt;ERROR CLASS&amp;gt;///PointingToDeclaration/">&lt;ERROR CLASS&gt;</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
  238. </div>
  239. <a data-name="-706319290%2FFunctions%2F1281733757" anchor-label="subscribe" id="-706319290%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="brief "><a data-name="-706319290%2FFunctions%2F1281733757" anchor-label="subscribe" id="-706319290%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>订阅轮询器 每次轮询器计时都会调用该回调函数 轮询器完成时会同时触发回调<a href="subscribe.html">block</a>和<a href="finish.html">finish</a></div></div>
  240. </div>
  241. </div>
  242. </div>
  243. </div>
  244. <a data-name="1652558178%2FFunctions%2F1281733757" anchor-label="switch" id="1652558178%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
  245. <div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
  246. <div class="main-subrow keyValue ">
  247. <div class=""><span class="inline-flex"><a href="switch.html">switch</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1652558178%2FFunctions%2F1281733757"></span>
  248. <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  249. </span></span></div>
  250. <div>
  251. <div class="title"><div class="divergent-group" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release"><div class="with-platform-tags"><span class="pull-right"></span></div>
  252. <div>
  253. <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><div class="symbol monospace">fun <a href="switch.html">switch</a>()<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
  254. </div>
  255. <a data-name="1652558178%2FFunctions%2F1281733757" anchor-label="switch" id="1652558178%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="brief "><a data-name="1652558178%2FFunctions%2F1281733757" anchor-label="switch" id="1652558178%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>切换轮询器开始或结束 假设轮询器为暂停<a href="../-interval-status/-s-t-a-t-e_-p-a-u-s-e/index.html">IntervalStatus.STATE_PAUSE</a>状态将继续运行<a href="resume.html">resume</a></div></div>
  256. </div>
  257. </div>
  258. </div>
  259. </div>
  260. </div>
  261. <h2 class="">Properties</h2>
  262. <div class="table" data-togglable="Properties"><a data-name="-1680553963%2FProperties%2F1281733757" anchor-label="count" id="-1680553963%2FProperties%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
  263. <div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
  264. <div class="main-subrow keyValue ">
  265. <div class=""><span class="inline-flex"><a href="count.html">count</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1680553963%2FProperties%2F1281733757"></span>
  266. <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  267. </span></span></div>
  268. <div>
  269. <div class="title">
  270. <div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><a data-name="-1680553963%2FProperties%2F1281733757" anchor-label="count" id="-1680553963%2FProperties%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="symbol monospace">var <a href="count.html">count</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><a data-name="-1680553963%2FProperties%2F1281733757" anchor-label="count" id="-1680553963%2FProperties%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>轮询器的计数</div></div></div>
  271. </div>
  272. </div>
  273. </div>
  274. </div>
  275. <a data-name="1215210377%2FProperties%2F1281733757" anchor-label="end" id="1215210377%2FProperties%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
  276. <div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
  277. <div class="main-subrow keyValue ">
  278. <div class=""><span class="inline-flex"><a href="end.html">end</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1215210377%2FProperties%2F1281733757"></span>
  279. <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  280. </span></span></div>
  281. <div>
  282. <div class="title">
  283. <div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><a data-name="1215210377%2FProperties%2F1281733757" anchor-label="end" id="1215210377%2FProperties%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="symbol monospace">var <a href="end.html">end</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><a data-name="1215210377%2FProperties%2F1281733757" anchor-label="end" id="1215210377%2FProperties%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>结束值, -1 表示永远不结束</div></div></div>
  284. </div>
  285. </div>
  286. </div>
  287. </div>
  288. <a data-name="-519771437%2FProperties%2F1281733757" anchor-label="state" id="-519771437%2FProperties%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
  289. <div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
  290. <div class="main-subrow keyValue ">
  291. <div class=""><span class="inline-flex"><a href="state.html">state</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-519771437%2FProperties%2F1281733757"></span>
  292. <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  293. </span></span></div>
  294. <div>
  295. <div class="title">
  296. <div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><a data-name="-519771437%2FProperties%2F1281733757" anchor-label="state" id="-519771437%2FProperties%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="symbol monospace">var <a href="state.html">state</a>: <a href="../-interval-status/index.html">IntervalStatus</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><a data-name="-519771437%2FProperties%2F1281733757" anchor-label="state" id="-519771437%2FProperties%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>轮询器当前状态</div></div></div>
  297. </div>
  298. </div>
  299. </div>
  300. </div>
  301. </div>
  302. <h2 class="tabbedcontent">Extensions</h2>
  303. <div class="table" data-togglable="Extensions"><a data-name="-597246228%2FExtensions%2F1281733757" anchor-label="life" id="-597246228%2FExtensions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
  304. <div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
  305. <div class="main-subrow keyValue ">
  306. <div class=""><span class="inline-flex"><a href="../../androidx.lifecycle/life.html">life</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-597246228%2FExtensions%2F1281733757"></span>
  307. <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  308. </span></span></div>
  309. <div>
  310. <div class="title"><div class="divergent-group" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release"><div class="with-platform-tags"><span class="pull-right"></span></div>
  311. <div>
  312. <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":net:dokkaHtml/release"><div class="symbol monospace">fun <a href="index.html">Interval</a>.<a href="../../androidx.lifecycle/life.html">life</a>(viewModel: <a href="https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModel.html">ViewModel</a>): <span data-unresolved-link="/&amp;lt;ERROR CLASS&amp;gt;///PointingToDeclaration/">&lt;ERROR CLASS&gt;</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
  313. </div>
  314. <a data-name="-597246228%2FExtensions%2F1281733757" anchor-label="life" id="-597246228%2FExtensions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="brief "><a data-name="-597246228%2FExtensions%2F1281733757" anchor-label="life" id="-597246228%2FExtensions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>轮询器根据ViewModel生命周期自动取消</div></div>
  315. </div>
  316. </div>
  317. </div>
  318. </div>
  319. </div>
  320. </div>
  321. </div>
  322. </div>
  323. <div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2023 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span></div>
  324. </div>
  325. </div>
  326. </body>
  327. </html>