Saltare al contenuto principale
Indietro ai plugin
@capgo/capacitor-background-task
Istruzioni
@capgo/capacitor-background-task

Background Task

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

Guida

Tutorial sul compito di background

Esegui il test sul dispositivo

Scarica l'app Capgo, poi scansione il QR code.

Anteprima del plugin di compito in background QR code

Utilizza @capgo/capacitor-background-task

Schedule periodic background fetch work in a Capacitor app with named tasks, persistent registration, status checks, unregistering, and a development trigger. The plugin uses Android WorkManager and iOS BGTaskScheduler.

Installa

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

Configurazione iOS

Aggiungi supporto per il trattamento in background a ios/App/App/Info.plist:

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

Poi esegui:

npx cap sync ios

Cos'è che 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 - Elenco dei nomi delle attività registrate.
  • getStatusAsync - Verifica la disponibilità delle attività di background native.
  • triggerTaskWorkerForTestingAsync - Attiva immediatamente le attività registrate per lo sviluppo.
  • addExpirationListener - Rispondi quando iOS scade un'attività.

Esempio di utilizzo

Definisci l'attività al livello di modulo affinché sia disponibile quando il sistema operativo riattiva 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 attività registrate:

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

console.log({ status, tasks });

Attiva un run di sviluppo:

await BackgroundTask.triggerTaskWorkerForTestingAsync();

Annulla l'attività:

await BackgroundTask.unregisterTaskAsync(SYNC_TASK);

Nota del sistema operativo

  • Le scadenze delle attività di background sono opportuniste, non timer esatti.
  • Lavoro periodico Android ha un intervallo minimo di 15 minuti.
  • iOS trattamento minimumInterval come una data di inizio più antica e potrebbe eseguire in seguito.
  • Testare il trattamento di background di iOS su un dispositivo fisico.

Riferimento completo

Continua da Utilizzare @capgo/capacitor-background-task

Se stai utilizzando Utilizzare @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, Iniziare per i dettagli di implementazione in Iniziare, Directory Plugin Capgo per il flusso di lavoro del prodotto in Directory Plugin Capgo, Plugin Capacitor di Capgo per i dettagli di implementazione in Plugin Capacitor di Capgo, e Aggiungere o Aggiornare Plugin per i dettagli di implementazione in Aggiungere o Aggiornare Plugin.