workmanager | Flutter package

link管理

链接快照平台

输入网页链接，自动生成快照
标签化管理网页链接

相关文章推荐

路过的泡面 · 哪些学校有保研资格？都是自己挑学校吗？-高顿教育· 2 月前 ·

没人理的红茶 · GitHub - ...· 3 月前 ·

大气的手电筒 · Upgrade problem, ...· 4 月前 ·

温文尔雅的野马 · 穿书后与师尊二三事漫画｜官方在线漫画全集-快看漫画· 8 月前 ·

逆袭的烈马 · python numpy array 空 ...· 9 月前 ·

</noscript><div class="site-header"><button class="hamburger" aria-label="menu toggle"/><a class="logo" href="/"><img class="site-logo" src="/static/hash-ompf3npf/img/pub-dev-logo.svg" alt="" width="140" height="30" role="presentation"/></a><div class="site-header-space"/><div class="site-header-mask"/><div class="site-header-search"><form action="/packages" method="GET"><input class="site-header-search-input" name="q" placeholder="New search..." autocomplete="on" title="Search"/></form></div><nav class="site-header-nav scroll-container"><div class="nav-login-container"><button id="-account-login" class="nav-main-button link">Sign in</button></div><div class="nav-container nav-help-container hoverable"><button class="nav-main-button">Help</button><div class="nav-hover-popup"><div class="nav-table-columns"><div class="nav-table-column"><h3>Pub.dev</h3><a class="nav-link" href="/help/search" rel="noopener" target="_blank">Searching for packages</a><a class="nav-link" href="/help/scoring" rel="noopener" target="_blank">Package scoring and pub points</a></div><div class="nav-table-column"><h3>Flutter</h3><a class="nav-link" href="https://flutter.dev/using-packages/" rel="noopener" target="_blank">Using packages</a><a class="nav-link" href="https://flutter.dev/developing-packages/" rel="noopener" target="_blank">Developing packages and plugins</a><a class="nav-link" href="https://dart.dev/tools/pub/publishing" rel="noopener" target="_blank">Publishing a package</a></div><div class="nav-table-column"><h3>Dart</h3><a class="nav-link" href="https://dart.dev/guides/packages" rel="noopener" target="_blank">Using packages</a><a class="nav-link" href="https://dart.dev/tools/pub/publishing" rel="noopener" target="_blank">Publishing a package</a></div></div></div></div><div class="nav-container nav-help-container-mobile foldable"><h3 class="foldable-button">Pub.dev <img class="foldable-icon" src="/static/hash-ompf3npf/img/nav-mobile-foldable-icon.svg" alt="toggle folding of the section" width="13" height="6"/></h3><div class="foldable-content"><a class="nav-link" href="/help/search" rel="noopener" target="_blank">Searching for packages</a><a class="nav-link" href="/help/scoring" rel="noopener" target="_blank">Package scoring and pub points</a></div></div><div class="nav-container nav-help-container-mobile foldable"><h3 class="foldable-button">Flutter <img class="foldable-icon" src="/static/hash-ompf3npf/img/nav-mobile-foldable-icon.svg" alt="toggle folding of the section" width="13" height="6"/></h3><div class="foldable-content"><a class="nav-link" href="https://flutter.dev/using-packages/" rel="noopener" target="_blank">Using packages</a><a class="nav-link" href="https://flutter.dev/developing-packages/" rel="noopener" target="_blank">Developing packages and plugins</a><a class="nav-link" href="https://dart.dev/tools/pub/publishing" rel="noopener" target="_blank">Publishing a package</a></div></div><div class="nav-container nav-help-container-mobile foldable"><h3 class="foldable-button">Dart <img class="foldable-icon" src="/static/hash-ompf3npf/img/nav-mobile-foldable-icon.svg" alt="toggle folding of the section" width="13" height="6"/></h3><div class="foldable-content"><a class="nav-link" href="https://dart.dev/guides/packages" rel="noopener" target="_blank">Using packages</a><a class="nav-link" href="https://dart.dev/tools/pub/publishing" rel="noopener" target="_blank">Publishing a package</a></div></div></nav></div><div id="banner-container"/><main class="container"><div class="detail-wrapper -active -has-info-box"><div class="detail-header -is-loose"><div class="detail-container"><div class="detail-header-outer-block"><div class="detail-header-content-block"><h1 class="title">workmanager 0.5.2 <span class="pkg-page-title-copy"><img class="pkg-page-title-copy-icon" src="/static/hash-ompf3npf/img/content-copy-icon.svg" alt="copy &quot;workmanager: ^0.5.2&quot; to clipboard" width="18" height="18" title="Copy &quot;workmanager: ^0.5.2&quot; to clipboard" data-copy-content="workmanager: ^0.5.2" data-ga-click-event="copy-package-version"/><div class="pkg-page-title-copy-feedback"><span class="code">workmanager: ^0.5.2</span> copied to clipboard</div></span></h1><div class="metadata">Published <span><a class="-x-ago" href="" title="Sep 28, 2023" aria-label="7 months ago" aria-role="button" role="button" data-timestamp="1695934258064">7 months ago</a></span> • <a class="-pub-publisher" href="/publishers/fluttercommunity.dev"><img class="-pub-publisher-shield" src="/static/hash-ompf3npf/img/material-icon-verified.svg" alt="verified publisher" width="14" height="14" title="Published by a pub.dev verified publisher"/>fluttercommunity.dev</a><span class="package-badge" title="Package is compatible with Dart 3.">Dart 3 compatible</span></div><div class="detail-tags-and-like"><div class="detail-tags"><div class="-pub-tag-badge"><span class="tag-badge-main">SDK</span><a class="tag-badge-sub" href="/packages?q=sdk%3Aflutter" rel="nofollow" title="Packages compatible with Flutter SDK">Flutter</a></div><div class="-pub-tag-badge"><span class="tag-badge-main">Platform</span><a class="tag-badge-sub" href="/packages?q=platform%3Aandroid" rel="nofollow" title="Packages compatible with Android platform">Android</a><a class="tag-badge-sub" href="/packages?q=platform%3Aios" rel="nofollow" title="Packages compatible with iOS platform">iOS</a></div></div><div class="detail-like"><button id="-pub-like-icon-button" class="mdc-icon-button" data-ga-click-event="toggle-like" aria-pressed="false" title="Like this package"><img class="mdc-icon-button__icon" src="/static/hash-ompf3npf/img/like-inactive.svg" alt="liked status: inactive" width="18" height="18"/><img class="mdc-icon-button__icon mdc-icon-button__icon--on" src="/static/hash-ompf3npf/img/like-active.svg" alt="liked status: active" width="18" height="18"/></button><span class="likes-count"><span id="likes-count">1.9k</span></span></div></div></div></div></div></div><div class="detail-container"><div class="detail-lead"><div class="detail-metadata-toggle"><div class="detail-metadata-toggle-icon">→</div><h3 class="detail-lead-title">Metadata</h3></div><p class="detail-lead-text">Flutter Workmanager. This plugin allows you to schedule background work on Android and iOS.</p><p class="detail-lead-more"><a class="detail-metadata-toggle">More...</a></p></div></div><div class="detail-body"><div class="detail-tabs"><div class="detail-tabs-wide-header"><div class="detail-container"><ul class="detail-tabs-header"><li class="detail-tab tab-button detail-tab-readme-title -active">Readme</li><li class="detail-tab tab-link detail-tab-changelog-title"><a href="/packages/workmanager/changelog" role="button">Changelog</a></li><li class="detail-tab tab-link detail-tab-example-title"><a href="/packages/workmanager/example" role="button">Example</a></li><li class="detail-tab tab-link detail-tab-installing-title"><a href="/packages/workmanager/install" role="button">Installing</a></li><li class="detail-tab tab-link detail-tab-versions-title"><a href="/packages/workmanager/versions" role="button">Versions</a></li><li class="detail-tab tab-link detail-tab-analysis-title"><a href="/packages/workmanager/score" role="button">Scores</a></li></ul></div></div><div class="detail-container detail-body-main"><div class="detail-tabs-content"><section class="tab-content detail-tab-readme-content -active markdown-body"><h1 class="hash-header" id="flutter-workmanager">Flutter Workmanager <a href="#flutter-workmanager" class="hash-link">#</a></h1> <p>Flutter WorkManager is a wrapper around <a href="https://developer.android.com/topic/libraries/architecture/workmanager" rel="ugc">Android's WorkManager</a>, <a href="https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1623125-application" rel="ugc">iOS' performFetchWithCompletionHandler</a> and <a href="https://developer.apple.com/documentation/backgroundtasks/bgapprefreshtask" rel="ugc">iOS BGAppRefreshTask</a>, effectively enabling headless execution of Dart code in the background.</p> <p>For iOS users, please watch this video on a general introduction to background processing: <a href="https://developer.apple.com/videos/play/wwdc2020/10063" rel="ugc">https://developer.apple.com/videos/play/wwdc2020/10063</a>. All of the constraints discussed in the video also apply to this plugin.</p> <p>This is especially useful to run periodic tasks, such as fetching remote data on a regular basis.</p> <p>This plugin was featured in this <a href="https://medium.com/vrt-digital-studio/flutter-workmanager-81e0cfbd6f6e" rel="ugc">Medium blogpost</a></p> <h1 class="hash-header" id="platform-setup">Platform Setup <a href="#platform-setup" class="hash-link">#</a></h1> <p>In order for background work to be scheduled correctly you should follow the Android and iOS setup first.</p> <li><a href="https://github.com/fluttercommunity/flutter_workmanager/blob/master/ANDROID_SETUP.md" rel="ugc">Android Setup</a></li> <li><a href="https://github.com/fluttercommunity/flutter_workmanager/blob/master/IOS_SETUP.md" rel="ugc">iOS Setup</a></li> <h1 class="hash-header" id="how-to-use-the-package">How to use the package? <a href="#how-to-use-the-package" class="hash-link">#</a></h1> <p>See sample folder for a complete working example.<br/> Before registering any task, the WorkManager plugin must be initialized.</p> <pre><code class="language-dart">@pragma('vm:entry-point') // Mandatory if the App is obfuscated or using Flutter 3.1+ void callbackDispatcher() { Workmanager().executeTask((task, inputData) { print("Native called background task: $task"); //simpleTask will be emitted here. return Future.value(true); void main() { Workmanager().initialize( callbackDispatcher, // The top level function, aka callbackDispatcher isInDebugMode: true // If enabled it will post a notification whenever the task is running. Handy for debugging tasks Workmanager().registerOneOffTask("task-identifier", "simpleTask"); runApp(MyApp()); <p>The <code>callbackDispatcher</code> needs to be either a static function or a top level function to be accessible as a Flutter entry point.</p> <p>The workmanager runs on a separate isolate from the main flutter isolate. Ensure to initialize all dependencies inside the <code>Workmanager().executeTask</code>.</p> <h5 id="debugging-tips">Debugging tips</h5> <p>Wrap the code inside your <code>Workmanager().executeTask</code> in a <code>try and catch</code> in order to catch any exceptions thrown.</p> <pre><code class="language-dart">@pragma('vm:entry-point') void callbackDispatcher() { Workmanager().executeTask((task, inputData) { int? totalExecutions; final _sharedPreference = await SharedPreferences.getInstance(); //Initialize dependency try { //add code execution totalExecutions = _sharedPreference.getInt("totalExecutions"); _sharedPreference.setInt("totalExecutions", totalExecutions == null ? 1 : totalExecutions+1); } catch(err) { Logger().e(err.toString()); // Logger flutter package, prints error on the debug console throw Exception(err); return Future.value(true); <p>Android tasks are identified using their <code>taskName</code>. iOS tasks are identitied using their <code>taskIdentifier</code>.</p> <p>However, there is an exception for iOS background fetch: <code>Workmanager.iOSBackgroundTask</code>, a constant for iOS background fetch task.</p> <h1 class="hash-header" id="work-result">Work Result <a href="#work-result" class="hash-link">#</a></h1> <p>The <code>Workmanager().executeTask(...</code> block supports 3 possible outcomes:</p> <li><code>Future.value(true)</code>: The task is successful.</li> <li><code>Future.value(false)</code>: The task did not complete successfully and needs to be retried. On Android, the retry is done automatically. On iOS (when using BGTaskScheduler), the retry needs to be scheduled manually.</li> <li><code>Future.error(...)</code>: The task failed.</li> <p>On Android, the <code>BackoffPolicy</code> will configure how <code>WorkManager</code> is going to retry the task.</p> <p>Refer to the example app for a successful, retrying and a failed task.</p> <h1 class="hash-header" id="ios-specific-setup-and-note">iOS specific setup and note <a href="#ios-specific-setup-and-note" class="hash-link">#</a></h1> <p>iOS supports <strong>One off tasks</strong> with a few basic constraints:</p> <pre><code class="language-dart">Workmanager().registerOneOffTask( "task-identifier", simpleTaskKey, // Ignored on iOS initialDelay: Duration(minutes: 30), constraints: Constraints( // connected or metered mark the task as requiring internet networkType: NetworkType.connected, // require external power requiresCharging: true, inputData: ... // fully supported <p>For more information see the <a href="https://developer.apple.com/documentation/backgroundtasks" rel="ugc">BGTaskScheduler documentation</a>.</p> <h1 class="hash-header" id="customisation-android">Customisation (Android) <a href="#customisation-android" class="hash-link">#</a></h1> <p>Not every <code>Android WorkManager</code> feature is ported.</p> <p>Two kinds of background tasks can be registered :</p> <li><strong>One off task</strong> : runs only once</li> <li><strong>Periodic tasks</strong> : runs indefinitely on a regular basis</li> <pre><code class="language-dart">// One off task registration Workmanager().registerOneOffTask( "oneoff-task-identifier", "simpleTask" // Periodic task registration Workmanager().registerPeriodicTask( "periodic-task-identifier", "simplePeriodicTask", // When no frequency is provided the default 15 minutes is set. // Minimum frequency is 15 min. Android will automatically change your frequency to 15 min if you have configured a lower frequency. frequency: Duration(hours: 1), <p>Each task must have an <strong>unique name</strong>;<br/> This allows cancellation of a started task.<br/> The second parameter is the <code>String</code> that will be sent to your <code>callbackDispatcher</code> function, indicating the task's <em>type</em>.</p> <h2 class="hash-header" id="tagging">Tagging <a href="#tagging" class="hash-link">#</a></h2> <p>You can set the optional <code>tag</code> property.<br/> Handy for cancellation by <code>tag</code>.<br/> This is different from the unique name in that you can group multiple tasks under one tag.</p> <pre><code class="language-dart">Workmanager().registerOneOffTask("1", "simpleTask", tag: "tag"); <h2 class="hash-header" id="existing-work-policy">Existing Work Policy <a href="#existing-work-policy" class="hash-link">#</a></h2> <p>Indicates the desired behaviour when the same task is scheduled more than once.<br/> The default is <code>KEEP</code></p> <pre><code class="language-dart">Workmanager().registerOneOffTask("1", "simpleTask", existingWorkPolicy: ExistingWorkPolicy.append); <h2 class="hash-header" id="initial-delay">Initial Delay <a href="#initial-delay" class="hash-link">#</a></h2> <p>Indicates how along a task should waitbefore its first run.</p> <pre><code class="language-dart">Workmanager().registerOneOffTask("1", "simpleTask", initialDelay: Duration(seconds: 10)); <h2 class="hash-header" id="constraints">Constraints <a href="#constraints" class="hash-link">#</a></h2> <p>Constraints are mapped at best effort to each platform. Android's WorkManager supports most of the specific constraints, whereas iOS tasks are limited.</p> <li>NetworkType Constrains the type of network required for your work to run. For example, Connected. The <code>NetworkType</code> lists various network conditions. <code>.connected</code> &amp; <code>.metered</code> will be mapped to <a href="https://developer.apple.com/documentation/backgroundtasks/bgprocessingtaskrequest/3142242-requiresnetworkconnectivity" rel="ugc"><code>requiresNetworkConnectivity</code></a> on iOS.</li> <li>RequiresBatteryNotLow (Android only) When set to true, your work will not run if the device is in low battery mode. <strong>Enabling the battery saving mode on the android device prevents the job from running</strong></li> <li>RequiresCharging When set to true, your work will only run when the device is charging.</li> <li>RequiresDeviceIdle (Android only) When set to true, this requires the user’s device to be idle before the work will run. This can be useful for running batched operations that might otherwise have a - negative performance impact on other apps running actively on the user’s device.</li> <li>RequiresStorageNotLow (Android only) When set to true, your work will not run if the user’s storage space on the device is too low.</li> <pre><code class="language-dart">Workmanager().registerOneOffTask( "simpleTask", constraints: Constraints( networkType: NetworkType.connected, requiresBatteryNotLow: true, requiresCharging: true, requiresDeviceIdle: true, requiresStorageNotLow: true <h3 class="hash-header" id="inputdata">InputData <a href="#inputdata" class="hash-link">#</a></h3> <p>Add some input data for your task. Valid value types are: <code>int</code>, <code>bool</code>, <code>double</code>, <code>String</code> and their <code>list</code></p> <pre><code class="language-dart"> Workmanager().registerOneOffTask( "simpleTask", inputData: { 'int': 1, 'bool': true, 'double': 1.0, 'string': 'string', 'array': [1, 2, 3], <h2 class="hash-header" id="backoffpolicy">BackoffPolicy <a href="#backoffpolicy" class="hash-link">#</a></h2> <p>Indicates the waiting strategy upon task failure.<br/> The default is <code>BackoffPolicy.exponential</code>.<br/> You can also specify the delay.</p> <pre><code class="language-dart">Workmanager().registerOneOffTask("1", "simpleTask", backoffPolicy: BackoffPolicy.exponential, backoffPolicyDelay: Duration(seconds: 10)); <h2 class="hash-header" id="cancellation">Cancellation <a href="#cancellation" class="hash-link">#</a></h2> <p>A task can be cancelled in different ways :</p> <h3 class="hash-header" id="by-tag">By Tag <a href="#by-tag" class="hash-link">#</a></h3> <p>Cancels the task that was previously registered using this <strong>Tag</strong>, if any.</p> <pre><code class="language-dart">Workmanager().cancelByTag("tag"); <h3 class="hash-header" id="by-unique-name">By Unique Name <a href="#by-unique-name" class="hash-link">#</a></h3>