Saltare al contenuto principale
Torna ai plugin
@capgo/capacitor-background-task
Tutorial
@capgo/capacitor-background-task

Icona del background task

Pianifica compiti di fetch di background periodici su iOS e Android con la registrazione di compiti Expo-style

Guida

Tutorial sui compiti di background

Usa @capgo/capacitor-background-task

Pianifica compiti di fetch di background periodici in un'app Capacitor con compiti denominati, registrazione persistente, controlli di stato, disiscrizione e un trigger di sviluppo. Il plugin utilizza Android WorkManager e iOS BGTaskScheduler.

Installare

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

Impostazione iOS

Aggiungi supporto per il processo di background ios/App/App/Info.plist:

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

Esegui quindi:

npx cap sync ios

Cosa questo plugin espone

  • defineTask - Definisci il callback JavaScript per un compito denominato.
  • registerTaskAsync - Persisti e programma un compito periodico.
  • unregisterTaskAsync - Annulla un compito.
  • isTaskRegisteredAsync - Controlla lo stato di registrazione di un compito.
  • getRegisteredTasksAsync - Elencare i nomi dei compiti registrati.
  • getStatusAsync - Controlla la disponibilità del compito di background nativo.
  • triggerTaskWorkerForTestingAsync - Attiva immediatamente i compiti registrati per lo sviluppo.
  • addExpirationListener - Rispondi quando iOS scade un compito.

Esempio di utilizzo

Definisci la task al livello di modulo in modo che sia disponibile quando l'OS risveglia l'app:

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

Controlla lo stato e i nomi delle task registrate:

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

console.log({ status, tasks });

Avvia un run di sviluppo:

await BackgroundTask.triggerTaskWorkerForTestingAsync();

Annulla la task:

await BackgroundTask.unregisterTaskAsync(SYNC_TASK);

Note sulla piattaforma

  • Il calendario delle task di background è opportunistico, non un timer esatto.
  • La programmazione periodica di Android ha un intervallo minimo di 15 minuti.
  • iOS considera minimumInterval come una data di inizio più presto e può eseguire il processo in un momento successivo.
  • Testa la gestione di background di iOS su un dispositivo fisico.

Riferimento completo

Continua con l'uso di @capgo/capacitor-background-task

Se stai utilizzando Utilizzando @capgo/capacitor-background-task per pianificare il lavoro del plugin nativo, connettilo con @capgo/capacitor-background-task per i dettagli di implementazione in @capgo/capacitor-background-task, Avvio rapido per i dettagli di implementazione in Avvio rapido, Capgo Directory dei plugin per il workflow del prodotto nella cartella di plugin Capgo, I plugin Capacitor di Capgo per i dettagli di implementazione in I plugin Capacitor di Capgo, e Aggiungere o aggiornare i plugin per i dettagli di implementazione in Aggiungere o aggiornare i plugin.