--- description: Capacitor plugin for running background tasks. It allows apps to execute tasks when moved to the background. title: Capacitor Background Task Plugin for iOS - Capawesome image: https://capawesome.io/docs/assets/images/social/plugins/background-task.png --- [ Skip to content](#capawesomecapacitor-background-task) [ 🎉 Introducing **Capawesome Platform** — one platform for Live Updates, Native Builds, App Store Publishing, and Insider SDKs.](https://capawesome.io) * [ Type Aliases ](#type-aliases) * [ Quirks ](#quirks) * [ Changelog ](#changelog) * [ License ](#license) * [ Credits ](#credits) * [ Badge ](/docs/plugins/badge/) * [ Barometer ](/docs/plugins/barometer/) * [ Biometrics ](/docs/plugins/biometrics/) * [ Bluetooth Low Energy ](/docs/plugins/bluetooth-low-energy/) * [ Cloudinary ](/docs/plugins/cloudinary/) * [ Contacts ](/docs/plugins/contacts/) * [ Datetime Picker ](/docs/plugins/datetime-picker/) * [ File Compressor ](/docs/plugins/file-compressor/) * [ File Opener ](/docs/plugins/file-opener/) * [ File Picker ](/docs/plugins/file-picker/) * [ Firebase ](/docs/plugins/firebase/) * [ Formbricks ](/docs/plugins/formbricks/) * [ Geocoder ](/docs/plugins/geocoder/) * [ Google Sign-In ](/docs/plugins/google-sign-in/) * [ libSQL ](/docs/plugins/libsql/) * [ Live Update ](/docs/plugins/live-update/) * [ Managed Configurations ](/docs/plugins/managed-configurations/) * [ Media Session ](/docs/plugins/media-session/) * [ ML Kit ](/docs/plugins/mlkit/) * [ NFC ](/docs/plugins/nfc/) * [ OAuth ](/docs/plugins/oauth/) * [ Pedometer ](/docs/plugins/pedometer/) * [ Photo Editor ](/docs/plugins/photo-editor/) * [ PostHog ](/docs/plugins/posthog/) * [ Printer ](/docs/plugins/printer/) * [ Purchases ](/docs/plugins/purchases/) * [ RealtimeKit ](/docs/plugins/realtimekit/) * [ Screen Orientation ](/docs/plugins/screen-orientation/) * [ Screenshot ](/docs/plugins/screenshot/) * [ Secure Preferences ](/docs/plugins/secure-preferences/) * [ Speech Recognition ](/docs/plugins/speech-recognition/) * [ Speech Synthesis ](/docs/plugins/speech-synthesis/) * [ Share Target ](/docs/plugins/share-target/) * [ Square Mobile Payments ](/docs/plugins/square-mobile-payments/) * [ SQLite ](/docs/plugins/sqlite/) * [ Superwall ](/docs/plugins/superwall/) * [ Torch ](/docs/plugins/torch/) * [ Wifi ](/docs/plugins/wifi/) * [ Zip ](/docs/plugins/zip/) * [ Cloud ](/docs/cloud/) * [ Live Updates ](/docs/cloud/live-updates/) * Advanced * Integrations * [ Native Builds ](/docs/cloud/native-builds/) * [ Configuration ](/docs/cloud/native-builds/configuration/) * [ Environments ](/docs/cloud/native-builds/environments/) * Guides * [ Sample Projects ](/docs/cloud/native-builds/sample-projects/) * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ Automations ](/docs/cloud/automations/) * [ Assist ](/docs/cloud/assist/) * Account * Organizations * [ Organization and User Management ](/docs/cloud/organizations/memberships/) * [ Single Sign-On (SSO) ](/docs/cloud/organizations/sso/) * [ Teams ](/docs/cloud/organizations/teams/) * [ Two-Factor Authentication ](/docs/cloud/organizations/two-factor-authentication/) * [ Integrations ](/docs/cloud/integrations/) * [ License Keys ](/docs/cloud/license-keys/) * [ Webhooks ](/docs/cloud/webhooks/) * [ Pricing ](https://capawesome.io/pricing/) * [ FAQ ](/docs/cloud/faq/) * [ Support ](/docs/cloud/support/) * [ Contributing ](/docs/contributing/) * [ LLMs ](/docs/llms/) * [ Insiders ](/docs/insiders/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/insiders/support/) * [ FAQ ](/docs/insiders/faq/) * [ Blog ](/blog/) * Categories * [ Type Aliases ](#type-aliases) * [ Quirks ](#quirks) * [ Changelog ](#changelog) * [ License ](#license) * [ Credits ](#credits) # @capawesome/capacitor-background-task[¶](#capawesomecapacitor-background-task "Permanent link") Capacitor plugin for running background tasks. [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) ## Newsletter[¶](#newsletter "Permanent link") Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/). ## Compatibility[¶](#compatibility "Permanent link") | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 8.x.x | \>=8.x.x | Active support | | 7.x.x | 7.x.x | Deprecated | | 6.x.x | 6.x.x | Deprecated | | 5.x.x | 5.x.x | Deprecated | ## Installation[¶](#installation "Permanent link") You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command: `[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-1-1) Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-background-task` plugin in my project. `` If you prefer **Manual Setup**, install the plugin by running the following commands: `[](#%5F%5Fcodelineno-2-1)npm install @capawesome/capacitor-background-task [](#%5F%5Fcodelineno-2-2)npx cap sync ` ## Configuration[¶](#configuration "Permanent link") No configuration required for this plugin. ## Demo[¶](#demo "Permanent link") A working example can be found here: [robingenz/capacitor-plugin-demo](https://github.com/robingenz/capacitor-plugin-demo) ## Usage[¶](#usage "Permanent link") `` [](#%5F%5Fcodelineno-3-1)import { App } from '@capacitor/app'; [](#%5F%5Fcodelineno-3-2)import { BackgroundTask } from '@capawesome/capacitor-background-task'; [](#%5F%5Fcodelineno-3-3) [](#%5F%5Fcodelineno-3-4)App.addListener('appStateChange', async ({ isActive }) => { [](#%5F%5Fcodelineno-3-5) if (isActive) { [](#%5F%5Fcodelineno-3-6) return; [](#%5F%5Fcodelineno-3-7) } [](#%5F%5Fcodelineno-3-8) // The app state has been changed to inactive. [](#%5F%5Fcodelineno-3-9) // Start the background task by calling `beforeExit`. [](#%5F%5Fcodelineno-3-10) const taskId = await BackgroundTask.beforeExit(async () => { [](#%5F%5Fcodelineno-3-11) // Run your code... [](#%5F%5Fcodelineno-3-12) // Finish the background task as soon as everything is done. [](#%5F%5Fcodelineno-3-13) BackgroundTask.finish({ taskId }); [](#%5F%5Fcodelineno-3-14) }); [](#%5F%5Fcodelineno-3-15)}); `` ## API[¶](#api "Permanent link") * [beforeExit(...)](#beforeexit) * [finish(...)](#finish) * [Interfaces](#interfaces) * [Type Aliases](#type-aliases) ### beforeExit(...)[¶](#beforeexit "Permanent link") `[](#%5F%5Fcodelineno-4-1)beforeExit(cb: () => void) => Promise ` Call this method when the app moves to the background. It allows the app to continue running a task in the background. On **iOS** this method should be finished in less than 30 seconds. Only available on Android and iOS. | Param | Type | | ------ | ---------- | | **cb** | () => void | **Returns:** `Promise` --- ### finish(...)[¶](#finish "Permanent link") `[](#%5F%5Fcodelineno-5-1)finish(options: FinishOptions) => void ` Finish the current background task. The OS will put the app to sleep. Only available on Android and iOS. | Param | Type | | ----------- | ------------------------------- | | **options** | [FinishOptions](#finishoptions) | --- ### Interfaces[¶](#interfaces "Permanent link") #### FinishOptions[¶](#finishoptions "Permanent link") | Prop | Type | | ---------- | ------------------------- | | **taskId** | [CallbackID](#callbackid) | ### Type Aliases[¶](#type-aliases "Permanent link") #### CallbackID[¶](#callbackid "Permanent link") `string` ## Quirks[¶](#quirks "Permanent link") ### iOS[¶](#ios "Permanent link") On **iOS** the [UIKit framework](https://developer.apple.com/documentation/uikit) is used. Read more about the implementation and any limitations [here](https://developer.apple.com/documentation/uikit/app%5Fand%5Fenvironment/scenes/preparing%5Fyour%5Fui%5Fto%5Frun%5Fin%5Fthe%5Fbackground/extending%5Fyour%5Fapp%5Fs%5Fbackground%5Fexecution%5Ftime). ### Android[¶](#android "Permanent link") There is currently no ready implementation on **Android**. It's planned to add the support in the near future. ## Changelog[¶](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/background-task/CHANGELOG.md). ## License[¶](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/background-task/LICENSE). ## Credits[¶](#credits "Permanent link") This plugin is based on the [Capacitor Background Task](https://github.com/capawesome-team/capacitor-background-task) plugin. Thanks to everyone who contributed to the project! May 17, 2026 Back to top