Saltare alla navigazione principale

@capgo/capacitor-background-task

Task di background con nome per applicazioni Capacitor, supportate da Android WorkManager e iOS BGTaskScheduler.

Usa @capgo/capacitor-background-task quando la tua applicazione Capacitor ha bisogno di lavoro di fetch di background periodico come sincronizzazione, aggiornamenti della cache, polling della posta in arrivo, svuotamento degli eventi di analisi o lavori di manutenzione leggera.

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

  • defineTask - Registra il callback JavaScript per una task denominata.
  • registerTaskAsync - Persisti e programma una task periodica.
  • unregisterTaskAsync - Annulla future esecuzioni per una task.
  • isTaskRegisteredAsync - Controlla se una task è registrata.
  • getRegisteredTasksAsync - Elenco i nomi delle task attualmente registrate.
  • getPendingTaskRunsAsync - Ispeziona gli eventi di task nativi registrati prima che JavaScript fosse pronto.
  • getStatusAsync - Controlla la disponibilità di task di background nativi.
  • triggerTaskWorkerForTestingAsync - Esegui le task registrate immediatamente durante lo sviluppo.
  • addExpirationListener - Gestisci i 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.

PiattaformaScheduler nativoComportamento importante
AndroidWorkManagerIl lavoro periodico ha un intervallo minimo di 15 minuti.
iOSBGTaskSchedulerminimumInterval è una data di inizio più presto, non un cadenza garantita.
WebFallback di testo soloNon è disponibile alcun scheduler di background reale.
MetodoDescrizione
defineTaskDefinisce il callback JavaScript per una task denominata.
registerTaskAsyncRegistra una task di background periodica denominata.
unregisterTaskAsyncAnnulla 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 la programmazione di background nativa è disponibile.
triggerTaskWorkerForTestingAsyncAttiva le task registrate per lo sviluppo e la QA.
addExpirationListenerAscolta gli eventi di scadenza iOS.

Questa documentazione è sincronizzata da src/definitions.ts in capacitor-background-task.

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