Lompat ke konten utama
Kembali ke plugin
@capgo/capacitor-background-task
Tutorial
oleh github.com/Cap-go

Tugas Latar Belakang

Jadwalkan tugas fetch latar belakang berulang pada iOS dan Android dengan registrasi tugas Expo-style

Panduan

Tutorial tentang Tugas Latar Belakang

Menggunakan @capgo/capacitor-tugas-latar-belakang

Jadwalkan pekerjaan fetch latar belakang berkala dalam aplikasi Capacitor dengan tugas yang dinamai, pendaftaran yang persisten, pengecekan status, penghapusan pendaftaran, dan pengaktifan pengembang.

Instal

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

Pengaturan iOS

Tambahkan dukungan pengolahan latar belakang 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

Apa yang Dapat Diketahui Plugin Ini

  • defineTask - Tentukan callback JavaScript untuk sebuah tugas bernama.
  • registerTaskAsync - Simpan dan jadwalkan tugas periodik.
  • unregisterTaskAsync - Batalkan satu tugas.
  • isTaskRegisteredAsync - Periksa status pendaftaran satu tugas.
  • getRegisteredTasksAsync - Daftar nama-nama tugas yang didaftarkan.
  • getStatusAsync - Periksa ketersediaan tugas latar belakang native.
  • triggerTaskWorkerForTestingAsync - Aktifkan tugas-tugas yang didaftarkan secara langsung untuk pengembangan.
  • addExpirationListener - Reaksi ketika iOS mengakhiri tugas.

Contoh Penggunaan

Tentukan tugas di lingkungan modul sehingga tersedia ketika OS mengaktifkan aplikasi:

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

Periksa status dan nama tugas yang terdaftar:

const status = await BackgroundTask.getStatusAsync();
const tasks = await BackgroundTask.getRegisteredTasksAsync();

console.log({ status, tasks });

Aktifkan pengembangan:

await BackgroundTask.triggerTaskWorkerForTestingAsync();

Batalkan tugas:

await BackgroundTask.unregisterTaskAsync(SYNC_TASK);

Catatan Platform

  • Jadwal tugas latar belakang bersifat opportunis, bukan timer tepat.
  • Android periodic work memiliki interval minimum 15 menit.
  • iOS menganggap minimumInterval sebagai tanggal mulai tercepat dan mungkin berjalan lebih lambat.
  • Uji pengolahan latar belakang iOS pada perangkat fisik.

Referensi Lengkap

Teruskan dari Menggunakan @capgo/capacitor-background-task

Jika Anda menggunakan Menggunakan @capgo/capacitor-background-task untuk merencanakan pekerjaan plugin native, hubungkannya dengan @capgo/capacitor-background-task untuk detail implementasi di @capgo/capacitor-background-task, Mengawali untuk detail implementasi di Mengawali, Direktori Plugin Capgo untuk alur kerja produk di Direktori Plugin Capgo, Capacitor Plugin oleh Capgo untuk detail implementasi di Capacitor Plugin oleh Capgo, dan Mengambah atau Mengupdate Plugin untuk detail implementasi di Mengambah atau Mengupdate Plugin.