@capawesome/capacitor-background-task
v6.0.0
Published
Capacitor plugin for running background tasks.
Downloads
9,869
Readme
@capawesome/capacitor-background-task
Capacitor plugin for running background tasks.
Installation
npm install @capawesome/capacitor-background-task
npx cap sync
Configuration
No configuration required for this plugin.
Demo
A working example can be found here: robingenz/capacitor-plugin-demo
Usage
import { App } from '@capacitor/app';
import { BackgroundTask } from '@capawesome/capacitor-background-task';
App.addListener('appStateChange', async ({ isActive }) => {
if (isActive) {
return;
}
// The app state has been changed to inactive.
// Start the background task by calling `beforeExit`.
const taskId = await BackgroundTask.beforeExit(async () => {
// Run your code...
// Finish the background task as soon as everything is done.
BackgroundTask.finish({ taskId });
});
});
API
beforeExit(...)
beforeExit(cb: () => void) => Promise<CallbackID>
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<string>
finish(...)
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 |
Interfaces
FinishOptions
| Prop | Type |
| ------------ | ------------------------------------------------- |
| taskId
| CallbackID |
Type Aliases
CallbackID
string
Quirks
iOS
On iOS the UIKit framework is used. Read more about the implementation and any limitations here.
Android
There is currently no ready implementation on Android. It's planned to add the support in the near future.
Changelog
See CHANGELOG.md.
License
See LICENSE.
Credits
This plugin is based on the Capacitor Background Task plugin. Thanks to everyone who contributed to the project!