BackgroundService class

Manages a generic background service capable of running arbitrary Dart functions.

This service uses a local SQLite database (background_service_jobs table) as a job queue. Tasks are enqueued from the main UI isolate and processed by the background service.

Setup

1. Initialize the service: Call BackgroundService.initialize once, typically in your main() function. Provide an AppInitializationCallback.
2. Implement AppInitializationCallback:
   • Initialize resources needed by background tasks (e.g., database connection for the background isolate, Supabase client).
   • Call BackgroundService.setBackgroundDbConnection with the background isolate's database connection.
   • Register all job handlers using BackgroundService.registerJobHandler.
3. Define Job Handlers: Create functions matching the JobHandler signature for each type of background task.
4. Enqueue Jobs: Use BackgroundService.job from your UI isolate to add tasks to the queue.

Android Configuration

Ensure your AndroidManifest.xml is configured for foreground services as per the flutter_background_service plugin documentation. This includes adding necessary permissions and the service declaration.

iOS Configuration

Follow flutter_background_service documentation for Info.plist and AppDelegate.swift modifications if background fetch or custom task identifiers are needed. Note that iOS has limitations on long-running background tasks.