Vai al contenuto

@capgo/capacitor-background-task

Task periodici di background fetch su iOS e Android.

Definisci task con scope di modulo, pianifica intervalli e restituisci risultati comprensibili al sistema operativo per sincronizzazione e cache warming.

PiattaformaSupportoNote
iOSSìIdentificatori BGTaskScheduler in Info.plist
AndroidSìJob in stile WorkManager
WebNoUsa service worker
  • defineTask - Registra il callback JavaScript per un task con nome.
  • registerTaskAsync - Persisti e pianifica un task periodico.
  • unregisterTaskAsync - Annulla le esecuzioni future di un task.
  • isTaskRegisteredAsync - Verifica se un task è registrato.
  • getRegisteredTasksAsync - Elenca i nomi dei task attualmente registrati.
  • getPendingTaskRunsAsync - Ispeziona gli eventi nativi del task registrati prima che JavaScript fosse pronto.
  • getStatusAsync - Verifica la disponibilità dei task in background nativi.
  • triggerTaskWorkerForTestingAsync - Esegui immediatamente i task registrati durante lo sviluppo.
  • addExpirationListener - Gestire le callback di scadenza su iOS.
  • define, schedule, cancel, statusAsync, e finish - Helper di compatibilità per react-native-background-task.

Comportamento della piattaforma

Section titled “Platform Behavior”

I background task non sono timer precisi. Android e iOS decidono quando eseguire il lavoro pianificato in base alla batteria, alla rete, all'utilizzo dell'app e alla policy di sistema.

PiattaformaScheduler nativoComportamento importante
AndroidWorkManagerIl lavoro periodico ha un intervallo minimo di 15 minuti.
iOSBGTaskSchedulerminimumInterval è una data di inizio minima, non una cadenza garantita.
WebFallback solo per testNessun scheduler di background reale è disponibile.
MetodoDescrizione
defineTaskDefinisce la callback JavaScript per un task nominato.
registerTaskAsyncRegistra un task periodico in background nominato.
unregisterTaskAsyncAnnulla le esecuzioni future del task.
isTaskRegisteredAsyncRestituisce se un task è registrato.
getRegisteredTasksAsyncElenca i nomi dei task registrati.
getPendingTaskRunsAsyncElenca gli eventi nativi del task in attesa di completamento.
getStatusAsyncRestituisce se la schedulazione nativa in background è disponibile.
triggerTaskWorkerForTestingAsyncAttiva i task registrati per sviluppo e QA.
addExpirationListenerAscolta gli eventi di scadenza iOS.

Questo riferimento è sincronizzato da src/definitions.ts nella capacitor-background-task.

Se stai usando @capgo/capacitor-background-task per pianificare il lavoro sui plugin nativi, collegalo a Utilizzo di @capgo/capacitor-background-task per la funzionalità nativa in Utilizzo di @capgo/capacitor-background-task, Directory dei plugin di Capgo per il workflow del prodotto nella Capgo Plugin Directory, Plugin Capacitor di Capgo per i dettagli di implementazione in Capacitor Plugins di Capgo, Aggiunta o aggiornamento dei plugin per i dettagli su come aggiungere o aggiornare i plugin, e Alternative ai plugin Ionic Enterprise per il workflow del prodotto in Alternative ai plugin Ionic Enterprise.