Iniziare

@capgo/capacitor-background-task consente a un'app Capacitor di registrare lavori periodici denominati per la sincronizzazione, l'aggiornamento della cache, la consegna degli analytics e altre operazioni di fetch in background.

Installazione

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

Configurazione iOS

Aggiungi il modello di elaborazione in background e l'identificatore della task autorizzata 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

Importa

import { BackgroundTask, BackgroundTaskResult } from '@capgo/capacitor-background-task';

Definisci un compito

Definisci il callback all'interno dello scope del modulo affinché venga registrato non appena l'applicazione viene avviata dal sistema operativo.

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

Registra il calendario

Chiamalo registerTaskAsync dopo che l'applicazione ha abbastanza contesto per abilitare il lavoro di background.

await BackgroundTask.registerTaskAsync(SYNC_TASK, {
  minimumInterval: 30,
  requiresNetwork: true,
});

minimumInterval è in minuti. Android impone un minimo di 15 minuti. iOS considera il valore come una data di inizio più presto e può eseguire in un momento successivo.

Verifica lo stato

const status = await BackgroundTask.getStatusAsync();
const isRegistered = await BackgroundTask.isTaskRegisteredAsync(SYNC_TASK);
const registeredTasks = await BackgroundTask.getRegisteredTasksAsync();

console.log({ status, isRegistered, registeredTasks });

Avvia un ciclo di test

Utilizza il trigger di testamento in fase di sviluppo o QA. Esegue ogni task registrato immediatamente.

await BackgroundTask.triggerTaskWorkerForTestingAsync();

Disiscrivi un task

await BackgroundTask.unregisterTaskAsync(SYNC_TASK);

Scadenza iOS

iOS può interrompere un compito di background prima che il tuo lavoro JavaScript sia completato. Ascolta gli eventi di scadenza quando la pulizia o il checkpointing sono importanti.

const expiration = await BackgroundTask.addExpirationListener((event) => {
  console.warn('Background task expired', event.taskName, event.taskId);
});

await expiration.remove();

Compatibilità compiti di background React Native

Il plugin esporre anche una piccola layer di compatibilità per le app che migrano da react-native-background-task.

import { BackgroundTask } from '@capgo/capacitor-background-task';

BackgroundTask.define(async () => {
  await fetch('https://api.example.com/sync', { method: 'POST' });
});

await BackgroundTask.schedule({
  period: 1800,
});

Note di produzione

• La programmazione in background è occasionale, non esatta.
• Tieni il lavoro breve e idempotente.
• Mantieni qualsiasi stato necessario prima di tornare BackgroundTaskResult.Success.
• Evita di basarti sui compiti di background per i termini o gli allarmi visibili dall'utente.