Task in background Plugin Capacitor

Utilizzo di @capgo/capacitor-background-task

Pianifica operazioni di background periodiche in un'app Capacitor con task nominati, registrazione persistente, controllo dello stato, rimozione e un trigger di sviluppo. Il plugin utilizza Android WorkManager e iOS BGTaskScheduler.

Installa

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

Setup iOS

Aggiungi il supporto al processing 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

Cosa espone questo plugin

• defineTask - Definisci la callback JavaScript per un task con nome.
• registerTaskAsync - Persisti e pianifica un task periodico.
• unregisterTaskAsync - Cancella un task.
• isTaskRegisteredAsync - Controlla lo stato di registrazione di un task.
• getRegisteredTasksAsync - Elenca i nomi dei task registrati.
• getStatusAsync - Verifica la disponibilità dei task in background nativi.
• triggerTaskWorkerForTestingAsync - Avvia immediatamente i task registrati per lo sviluppo.
• addExpirationListener - Reagisci quando iOS fa scadere un task.

Esempio d'uso

Definisci il task a livello di modulo per renderlo 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 dei task registrati:

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

console.log({ status, tasks });

Avvia un'esecuzione di sviluppo:

await BackgroundTask.triggerTaskWorkerForTestingAsync();

Annulla il task:

await BackgroundTask.unregisterTaskAsync(SYNC_TASK);

Note sulla piattaforma

• La pianificazione dei task in background è opportunistica, non un timer preciso.
• Il periodic work di Android ha un intervallo minimo di 15 minuti.
• iOS considera minimumInterval come la data di inizio più prossima e potrebbe avviarsi più tardi.
• Testa l'elaborazione in background su iOS con un dispositivo fisico.

Riferimento completo

• GitHub: https://github.com/Cap-go/capacitor-background-task/
• Docs: /docs/plugins/background-task/

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

Se stai usando Utilizzo di @capgo/capacitor-background-task per pianificare il lavoro sui plugin nativi, collegalo a @capgo/capacitor-background-task per i dettagli di implementazione in @capgo/capacitor-background-task, Per iniziare per i dettagli di implementazione nella guida introduttiva, Directory dei plugin di Capgo per il workflow del prodotto nella Capgo Plugin Directory, Plugin Capacitor di Capgo per i dettagli di implementazione in Plugin Capacitor di Capgo, e Aggiunta o aggiornamento dei plugin per i dettagli di implementazione in Aggiunta o aggiornamento dei plugin.