<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>AndroidScope</title>
<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>
<body>
<div id="container">
<div id="leftColumn"><a href="../../../index.html">
<div id="logo"></div>
</a>
<div id="paneSearch"></div>
<div id="sideMenu"></div>
</div>
<div id="main">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<script type="text/javascript" src="../../../scripts/main.js"></script> <div class="main-content" id="content" pageIds="Net::com.drake.net.scope/AndroidScope///PointingToDeclaration//1281733757">
<div class="navigation-wrapper" id="navigation-wrapper">
<div class="breadcrumbs"><a href="../../../index.html">Net</a>/<a href="../index.html">com.drake.net.scope</a>/<a href="index.html">AndroidScope</a></div>
<div class="pull-right d-flex">
<div id="searchBar"></div>
</div>
</div>
<div class="cover ">
<h1 class="cover"><span>Android</span><wbr></wbr><span>Scope</span></h1>
<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">AndroidScope</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>, dispatcher: <span data-unresolved-link="kotlinx.coroutines/CoroutineDispatcher///PointingToDeclaration/">CoroutineDispatcher</span>) : <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span>, <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></div></div>
</div>
<div class="tabbedcontent">
<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="Parameters">Parameters</button><button class="section-tab" data-togglable="Inheritors">Inheritors</button></div>
<div class="tabs-section-body">
<h2 class="">Parameters</h2>
<div data-togglable="Parameters">
<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">lifecycleOwner</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">lifeEvent</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">生命周期事件, 默认为<a href="https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle.Event.ON_DESTROY.html">Lifecycle.Event.ON_DESTROY</a>下取消协程作用域</p></div></div></div></div></div></div></div></div></div>
</div>
<h2 class="tabbedcontent">Constructors</h2>
<div class="table" data-togglable="Constructors"><a data-name="989660485%2FConstructors%2F1281733757" anchor-label="AndroidScope" id="989660485%2FConstructors%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
<div class="main-subrow keyValue TabbedContent">
<div class=""><span class="inline-flex"><a href="-android-scope.html">AndroidScope</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="989660485%2FConstructors%2F1281733757"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<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="-android-scope.html">AndroidScope</a>(lifecycleOwner: <a href="https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleOwner.html">LifecycleOwner</a>? = null, lifeEvent: <a href="https://developer.android.com/reference/kotlin/androidx/lifecycle/Lifecycle.Event.html">Lifecycle.Event</a> = Lifecycle.Event.ON_DESTROY, dispatcher: <span data-unresolved-link="kotlinx.coroutines/CoroutineDispatcher///PointingToDeclaration/">CoroutineDispatcher</span> = Dispatchers.Main)<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>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="1043003444%2FFunctions%2F1281733757" anchor-label="cancel" id="1043003444%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="cancel.html">cancel</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1043003444%2FFunctions%2F1281733757"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<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>
<div>
<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 fun <a href="cancel.html">cancel</a>(cause: <span data-unresolved-link="/&lt;ERROR CLASS&gt;///PointingToDeclaration/"><ERROR CLASS></span>? = null)<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="symbol monospace">open fun <a href="cancel.html">cancel</a>(message: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, cause: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a>? = null)<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>
</div>
</div>
</div>
</div>
</div>
</div>
<a data-name="1794742027%2FFunctions%2F1281733757" anchor-label="catch" id="1794742027%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="catch.html">catch</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1794742027%2FFunctions%2F1281733757"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<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>
<div>
<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 fun <a href="catch.html">catch</a>(block: <a href="index.html">AndroidScope</a>.(<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a>) -> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a> = {}): <a href="index.html">AndroidScope</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>
</div>
<a data-name="1794742027%2FFunctions%2F1281733757" anchor-label="catch" id="1794742027%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="brief "><a data-name="1794742027%2FFunctions%2F1281733757" anchor-label="catch" id="1794742027%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>当作用域内发生异常时回调</div></div>
</div>
</div>
</div>
</div>
<a data-name="849460629%2FFunctions%2F1281733757" anchor-label="close" id="849460629%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="close.html">close</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="849460629%2FFunctions%2F1281733757"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<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>
<div>
<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>
</div>
</div>
</div>
</div>
</div>
</div>
<a data-name="-1356360738%2FFunctions%2F1281733757" anchor-label="finally" id="-1356360738%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="finally.html">finally</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1356360738%2FFunctions%2F1281733757"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<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>
<div>
<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 fun <a href="finally.html">finally</a>(block: <a href="index.html">AndroidScope</a>.(<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a>?) -> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a> = {}): <a href="index.html">AndroidScope</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>
</div>
<a data-name="-1356360738%2FFunctions%2F1281733757" anchor-label="finally" id="-1356360738%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="brief "><a data-name="-1356360738%2FFunctions%2F1281733757" anchor-label="finally" id="-1356360738%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>无论正常或者异常结束都将最终执行</div></div>
</div>
</div>
</div>
</div>
<a data-name="409551354%2FFunctions%2F1281733757" anchor-label="handleError" id="409551354%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="handle-error.html">handleError</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="409551354%2FFunctions%2F1281733757"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<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>
<div>
<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 fun <a href="handle-error.html">handleError</a>(e: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</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>
</div>
<a data-name="409551354%2FFunctions%2F1281733757" anchor-label="handleError" id="409551354%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="brief "><a data-name="409551354%2FFunctions%2F1281733757" anchor-label="handleError" id="409551354%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>错误处理</div></div>
</div>
</div>
</div>
</div>
<a data-name="-1936524176%2FFunctions%2F1281733757" anchor-label="launch" id="-1936524176%2FFunctions%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="launch.html">launch</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1936524176%2FFunctions%2F1281733757"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<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>
<div>
<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 fun <a href="launch.html">launch</a>(block: suspend <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span>.() -> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>): <a href="index.html">AndroidScope</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>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="798807318%2FProperties%2F1281733757" anchor-label="coroutineContext" id="798807318%2FProperties%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="coroutine-context.html">coroutineContext</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="798807318%2FProperties%2F1281733757"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<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="798807318%2FProperties%2F1281733757" anchor-label="coroutineContext" id="798807318%2FProperties%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="symbol monospace">open override val <a href="coroutine-context.html">coroutineContext</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</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>
</div>
</div>
</div>
</div>
<a data-name="-528403418%2FProperties%2F1281733757" anchor-label="dispatcher" id="-528403418%2FProperties%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="dispatcher.html">dispatcher</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-528403418%2FProperties%2F1281733757"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<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="-528403418%2FProperties%2F1281733757" anchor-label="dispatcher" id="-528403418%2FProperties%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="symbol monospace">val <a href="dispatcher.html">dispatcher</a>: <span data-unresolved-link="kotlinx.coroutines/CoroutineDispatcher///PointingToDeclaration/">CoroutineDispatcher</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>
</div>
</div>
</div>
</div>
<a data-name="1227086530%2FProperties%2F1281733757" anchor-label="scopeGroup" id="1227086530%2FProperties%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="scope-group.html">scopeGroup</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1227086530%2FProperties%2F1281733757"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<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="1227086530%2FProperties%2F1281733757" anchor-label="scopeGroup" id="1227086530%2FProperties%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a><div class="symbol monospace">val <a href="scope-group.html">scopeGroup</a>: <span data-unresolved-link="/&lt;ERROR CLASS&gt;///PointingToDeclaration/"><ERROR CLASS></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>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Inheritors</h2>
<div class="table" data-togglable="Inheritors"><a data-name="91047826%2FInheritors%2F1281733757" anchor-label="NetCoroutineScope" id="91047826%2FInheritors%2F1281733757" data-filterable-set=":net:dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":net:dokkaHtml/release" data-filterable-set=":net:dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="../-net-coroutine-scope/index.html">NetCoroutineScope</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="91047826%2FInheritors%2F1281733757"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<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>
</div>
</div>
</body>
</html>