@capgo/capacitor-배경 작업 사용
이름이 지정된 작업, 지속적인 등록, 상태 확인, 등록 해제 및 개발자 트리거를 사용하여 주기적인 배경 fetch 작업을 스케줄링하는 Capacitor 앱에 배경 처리 지원을 추가합니다. 플러그인은 Android WorkManager 및 iOS BGTaskScheduler를 사용합니다.
설치
npm install @capgo/capacitor-background-task
npx cap sync
iOS 설정
__CAPGO_KEEP_0__ 앱에 배경 처리 지원을 추가합니다. ios/App/App/Info.plist:
<key>UIBackgroundModes</key>
<array>
<string>processing</string>
</array>
<key>BGTaskSchedulerPermittedIdentifiers</key>
<array>
<string>app.capgo.backgroundtask.processing</string>
</array>
그런 다음 실행하세요:
npx cap sync ios
이 플러그인이 노출하는 것
defineTask- 이름이 지정된 작업에 대한 자바스크립트 콜백을 정의합니다.registerTaskAsync- 주기적인 작업을 저장하고 예약합니다.unregisterTaskAsync- 하나의 작업을 취소합니다.isTaskRegisteredAsync- 하나의 작업의 등록 상태를 확인합니다.getRegisteredTasksAsync- 등록된 작업 이름 목록을 확인합니다.getStatusAsync- 네이티브 배경 작업 사용 가능 여부를 확인합니다.triggerTaskWorkerForTestingAsync- 개발 시에 등록된 작업을 즉시 트리거합니다.addExpirationListener- iOS에서 작업이 만료되었을 때 반응합니다.
- 예시 사용법
- 모듈 스코프에서 작업을 정의하여 OS가 앱을 깨울 때 작업이 사용 가능하도록 합니다.
import { BackgroundTask, BackgroundTaskResult } from '@capgo/capacitor-background-task';
const SYNC_TASK = 'sync-offline-data';
BackgroundTask.defineTask(SYNC_TASK, async () => {
try {
await fetch('https://api.example.com/sync', { method: 'POST' });
return BackgroundTaskResult.Success;
} catch {
return BackgroundTaskResult.Failed;
}
});
await BackgroundTask.registerTaskAsync(SYNC_TASK, {
minimumInterval: 30,
requiresNetwork: true,
});
- 상태를 확인하고 등록된 작업 이름 목록을 확인합니다.
const status = await BackgroundTask.getStatusAsync();
const tasks = await BackgroundTask.getRegisteredTasksAsync();
console.log({ status, tasks });
- 개발 실행을 트리거합니다.
await BackgroundTask.triggerTaskWorkerForTestingAsync();
- 작업을 취소합니다.
await BackgroundTask.unregisterTaskAsync(SYNC_TASK);
플랫폼 참고 사항
- 배경 작업 스케줄은 기회주의적이므로 정확한 타이머가 아닙니다.
- Android의 주기적인 작업은 15분의 최소 간격이 있습니다.
- iOS는
minimumInterval을 가장 빠른 시작 날짜로 처리하고 나중에 실행될 수 있습니다. - iOS 배경 처리를 테스트하려면 물리 장치를 사용하세요.
전체 참조
- GitHub: https://github.com/Cap-go/capacitor-background-task/
- 문서: /docs/plugins/background-task/
Using @capgo/capacitor-background-task
__CAPGO_KEEP_0__를 사용 중이라면 Capacitor @capgo/capacitor-background-task Capacitor @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-background-task Capacitor @capgo/capacitor-background-task for the @capgo implementation detail in @capacitor-background-task Getting Started Capacitor 플러그인 목록 Capgo 플러그인 디렉토리 Capgo 제품 워크플로우에 대한 플러그인 디렉토리에서. Capacitor Capgo 플러그인 Capacitor 플러그인에 대한 구현 세부 사항은 Capgo 플러그인에 의해 제공됩니다. 플러그인 추가 또는 업데이트 플러그인 추가 또는 업데이트