Getting Started

@capgo/capacitor-background-task lets a Capacitor app register named periodic jobs for sync, cache refreshes, analytics delivery, and other background fetch operations.

Pasang

Anda dapat menggunakan Setup yang Dibantu AI kami untuk menginstal plugin. Tambahkan Capgo kemampuan ke alat AI Anda menggunakan perintah berikut:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Lalu gunakan prompt berikut:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-background-task` plugin in my project.

Jika Anda lebih suka Setup Manual, instal plugin dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah ini:

npm install @capgo/capacitor-background-task
npx cap sync

Pengaturan iOS

Tambahkan mode pengolahan latar belakang dan identifikasi tugas yang diizinkan ke ios/App/App/Info.plist:

<key>UIBackgroundModes</key>
<array>
  <string>processing</string>
</array>
<key>BGTaskSchedulerPermittedIdentifiers</key>
<array>
  <string>app.capgo.backgroundtask.processing</string>
</array>

Lalu jalankan:

npx cap sync ios

Impor

import { BackgroundTask, BackgroundTaskResult } from '@capgo/capacitor-background-task';

Tentukan Tugas A

Tentukan callback di lingkungan modul sehingga terdaftar segera ketika aplikasi dimulai oleh sistem operasi.

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;
  }
});

Daftarkan Jadwal

Tunggu registerTaskAsync Setelah aplikasi Anda memiliki konteks yang cukup untuk mengaktifkan pekerjaan latar belakang.

await BackgroundTask.registerTaskAsync(SYNC_TASK, {
  minimumInterval: 30,
  requiresNetwork: true,
});

minimumInterval Waktu yang ditentukan dalam menit. Android menetapkan batasan minimum 15 menit. iOS menganggap nilai sebagai tanggal mulai terakhir dan mungkin menjalankan lebih lambat.

Periksa Status

const status = await BackgroundTask.getStatusAsync();
const isRegistered = await BackgroundTask.isTaskRegisteredAsync(SYNC_TASK);
const registeredTasks = await BackgroundTask.getRegisteredTasksAsync();

console.log({ status, isRegistered, registeredTasks });

Aktifkan Pengujian

Gunakan trigger pengujian dalam pengembangan atau QA. Ia memanggil setiap tugas yang terdaftar secara langsung.

await BackgroundTask.triggerTaskWorkerForTestingAsync();

Menghapus Tugas

await BackgroundTask.unregisterTaskAsync(SYNC_TASK);

Kadaluarsa iOS

iOS dapat menghentikan tugas latar belakang sebelum pekerjaan JavaScript Anda selesai. Dengarkan event kadaluarsa ketika membersihkan atau memantau titik kontrol penting.

const expiration = await BackgroundTask.addExpirationListener((event) => {
  console.warn('Background task expired', event.taskName, event.taskId);
});

await expiration.remove();

Kompatibilitas Tugas Latar Belakang React Native

Plugin ini juga menampilkan layer kompatibilitas kecil untuk aplikasi yang bermigrasi dari react-native-background-task.

import { BackgroundTask } from '@capgo/capacitor-background-task';

BackgroundTask.define(async () => {
  await fetch('https://api.example.com/sync', { method: 'POST' });
});

await BackgroundTask.schedule({
  period: 1800,
});

Catatan Produksi

• Pengaturan latar belakang adalah opportunis, bukan tepat.
• Tetapkan pekerjaan singkat dan idempoten.
• Simpan semua keadaan yang Anda butuhkan sebelum kembali. BackgroundTaskResult.Success.
• Hindari mengandalkan tugas latar belakang untuk jadwal pengguna yang terlihat atau alarm.

Lanjutkan dari Getting Started

Jika Anda menggunakan Getting Started untuk merencanakan pekerjaan plugin native, hubungkannya dengan Menggunakan @capgo/capacitor-tugas-kebelakang untuk kemampuan native di Menggunakan @capgo/capacitor-tugas-kebelakang Direktori Plugin Capgo untuk alur kerja produk di Direktori Plugin Capgo Plugin-Plugin Capacitor oleh Capgo untuk detail implementasi di Plugin-Plugin Capacitor oleh Capgo, Menambahkan atau Mengupdate Plugin untuk detail implementasi di Menambahkan atau Mengupdate Plugin, dan Alternatif Plugin Enterprise Ionic untuk alur kerja produk di Alternatif Plugin Enterprise Ionic.