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

Background Task

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

Guida

Tutorial sul compito di background

Utilizza @capgo/capacitor-compito-di-background

Programma il lavoro di fetch di background periodico in un'app Capacitor con compiti denominati, registrazione persistente, controlli di stato, disiscrizione e un trigger di sviluppo.

Installa

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

Configurazione iOS

Aggiungi supporto per il trattamento di 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>

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 una task.
  • isTaskRegisteredAsync - Verifica lo stato di registrazione di una task.
  • getRegisteredTasksAsync - Elenco i nomi delle task registrate.
  • getStatusAsync - Verifica la disponibilità di una task di background nativa.
  • triggerTaskWorkerForTestingAsync - Attiva le task registrate immediatamente per lo sviluppo.
  • addExpirationListener - Rispondi quando iOS scade una task.

Esempio di utilizzo

Definisci la task al livello di modulo affinché 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,
});

Verifica lo stato e i nomi delle task registrate:

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

console.log({ status, tasks });

Attiva un run di sviluppo:

await BackgroundTask.triggerTaskWorkerForTestingAsync();

Annulla la task:

await BackgroundTask.unregisterTaskAsync(SYNC_TASK);

Nota del sistema

  • Le scadenze delle attività di background sono opportuniste, non timer esatti.
  • L'Android ha un intervallo minimo di 15 minuti per le attività periodiche.
  • L'iOS considera minimumInterval come una data di inizio più presto e può eseguire il codice in un momento successivo.
  • Testa la gestione di background dell'iOS su un dispositivo fisico.

Riferimento completo

Continua da Utilizzo di @capgo/capacitor-task-di-background

Se stai utilizzando Utilizzo di @capgo/capacitor-task-di-background per pianificare il lavoro del plugin nativo, connettilo con @capgo/capacitor-task-di-sfondo per i dettagli di implementazione in @capgo/capacitor-task-di-sfondo, Iniziare per i dettagli di implementazione in Iniziare, Directory dei plugin di Capgo per il flusso di lavoro del prodotto in Directory dei plugin di Capgo, Plugin di Capacitor sviluppati da Capgo per i dettagli di implementazione in Plugin di Capacitor sviluppati da Capgo, e Aggiungere o Aggiornare i Plugin per i dettagli di implementazione in Aggiungere o Aggiornare i Plugin.