Saltare alla navigazione principale

@capgo/capacitor-background-task

Task di background denominate con un nome per le app Capacitor, supportate da Android WorkManager e iOS BGTaskScheduler.

Usa @capgo/capacitor-background-task quando il tuo app Capacitor richiede lavoro di fetch di background periodico come sincronizzazione, aggiornamento della cache, polling della posta in arrivo, svuotamento degli analytics o lavori di manutenzione leggera.

Il plugin segue il set di funzionalità pratico di Expo BackgroundTask con compiti denominati, registrazione persistente, controlli di stato, disiscrizione, un trigger di sviluppo e eventi di scadenza iOS.

  • defineTask - Registra il callback JavaScript per un compito denominato.
  • registerTaskAsync - Persisti e programma un compito periodico.
  • unregisterTaskAsync - Annulla future esecuzioni per un compito.
  • isTaskRegisteredAsync - Controlla se un compito è registrato.
  • getRegisteredTasksAsync - Elenco dei nomi delle attività registrate.
  • getPendingTaskRunsAsync - Esamina gli eventi delle attività native registrati prima che JavaScript fosse pronto.
  • getStatusAsync - Controlla la disponibilità delle attività di background native.
  • triggerTaskWorkerForTestingAsync - Esegui le attività registrate immediatamente durante lo sviluppo.
  • addExpirationListener - Gestisci le chiamate di callback di scadenza iOS.
  • define, schedule, cancel, statusAsync, e finish - Aiuti di compatibilità per react-native-background-task.

Le attività di background non sono timer esatti. Android e iOS decidono quando eseguire il lavoro programmato in base alla batteria, alla rete, all'uso dell'app e alla politica del sistema.

PlatformScheduler nativoComportamento importante
AndroidWorkManagerIl lavoro periodico ha un intervallo minimo di 15 minuti.
iOSBGTaskSchedulerminimumInterval è una data di inizio più precoce, non un cadenza garantita.
WebFallback di test unicoNon è disponibile alcun scheduler di background reale.
MetodoDescrizione
defineTaskDefinisce il callback JavaScript per una task denominata.
registerTaskAsyncRegistra una task di background periodica denominata.
unregisterTaskAsyncCancella future esecuzioni di task.
isTaskRegisteredAsyncRestituisce se una task è registrata.
getRegisteredTasksAsyncElencare i nomi delle task registrate.
getPendingTaskRunsAsyncElencare gli eventi di task nativi in attesa di completamento.
getStatusAsyncRestituisce se è disponibile la programmazione di background nativa.
triggerTaskWorkerForTestingAsyncAttiva le task registrate per lo sviluppo e la QA.
addExpirationListenerAscolta gli eventi di scadenza iOS.

Questa riferimento è sincronizzato da src/definitions.ts in capacitor-task di background.

Se stai utilizzando @capgo/capacitor-task di background per pianificare il lavoro del plugin nativo, connettilo con Utilizzare @capgo/capacitor-task di background per la capacità nativa in Utilizzare @capgo/capacitor-task di background, Directory dei plugin Capgo per il flusso di lavoro del prodotto nella cartella di Plugin Capgo Capacitor Plugin da Capgo per la dettaglio di implementazione in Capacitor Plugin da Capgo Aggiungere o Aggiornare Plugin per la dettaglio di implementazione in Aggiungere o Aggiornare Plugin, e Alternative per Plugin Enterprise Ionic per il flusso di lavoro del prodotto in Alternative per Plugin Enterprise Ionic