Using @capgo/capacitor-background-task

Schedule periodic background fetch work in a Capacitor app with named tasks, persistent registration, status checks, unregistering, and a development trigger. The plugin uses Android WorkManager and iOS BGTaskScheduler.

__CAPGO_KEEP_0__

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

Configuración de iOS

Agregar soporte de procesamiento de fondo ios/App/App/Info.plist:

<key>UIBackgroundModes</key>
<array>
  <string>processing</string>
</array>
<key>BGTaskSchedulerPermittedIdentifiers</key>
<array>
  <string>app.capgo.backgroundtask.processing</string>
</array>

Luego ejecuta:

npx cap sync ios

¿Qué expone este complemento?

defineTask - Defina el callback de JavaScript para una tarea nombrada.
registerTaskAsync - Persista y programar una tarea periódica.
unregisterTaskAsync - Cancelar una tarea.
isTaskRegisteredAsync - Verificar el estado de registro de una tarea.
getRegisteredTasksAsync - Listar nombres de tareas registradas.
getStatusAsync - Verificar la disponibilidad de tareas de fondo nativas.
triggerTaskWorkerForTestingAsync - Desencadenar tareas registradas inmediatamente para desarrollo.
addExpirationListener - Reaccionar cuando iOS expira una tarea.

Ejemplo de uso

Define la tarea en el ámbito del módulo para que esté disponible cuando el sistema active la aplicación:

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

Verificar el estado y los nombres de las tareas registradas:

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

console.log({ status, tasks });

Desencadenar una ejecución de desarrollo:

await BackgroundTask.triggerTaskWorkerForTestingAsync();

Cancelar la tarea:

await BackgroundTask.unregisterTaskAsync(SYNC_TASK);

Observaciones de plataforma

Las programaciones de tareas de fondo son oportunistas, no temporizadores exactos.
El trabajo periódico de Android tiene un mínimo de intervalo de 15 minutos.
iOS trata minimumInterval como una fecha de inicio más temprana y puede ejecutarse más tarde.
Probar la procesamiento de fondo de iOS en un dispositivo físico.

Referencia completa

GitHub: https://github.com/Cap-go/capacitor-tarea-de-fondo/
Documentación: /docs/plugins/tarea-de-fondo/

Sigue adelante desde Usando @capgo/capacitor-tarea-de-fondo

Si estás utilizando Usando @capgo/capacitor-tarea-de-fondo para planificar el trabajo de plugin nativo, conecta con @capgo/capacitor-tarea-de-fondo para obtener detalles de implementación en @capgo/capacitor-tarea-de-fondo Inicio para obtener detalles de implementación en Inicio Directorio de plugin Capgo para el flujo de trabajo del producto en el directorio de plugins Capgo plugins Capacitor por Capgo para el detalle de implementación en plugins Capacitor por Capgo, y Agregar o actualizar plugins para el detalle de implementación en Agregar o actualizar plugins.

Tarea de fondo

Tutoría sobre tarea de fondo