Flutter Workmanager#

Execute Dart code in the background, even when your app is closed. A Flutter wrapper aroundAndroid's WorkManager andiOS Background Tasks.

📖 Documentation#

Complete documentation is available at docs.page →

• Quick Start Guide - Installation and platform setup
• API Documentation - Complete Dart API reference
• Debugging Guide - Troubleshooting and debug hooks

🚀 Quick Example#

@pragma('vm:entry-point')void callbackDispatcher() {  Workmanager().executeTask((task, inputData) async {    print("Background task: $task");    // Your background work here    return Future.value(true);  });}void main() {  Workmanager().initialize(callbackDispatcher);  Workmanager().registerOneOffTask("task-id", "simpleTask");  runApp(MyApp());}

🎯 Use Cases#

Perfect for:

• Data sync - Keep your app's data fresh
• File uploads - Reliable uploads in background
• Cleanup tasks - Remove old files and cache
• Notifications - Check for new messages
• Database maintenance - Optimize and clean databases

🏗️ Federated Architecture#

This plugin uses a federated architecture with platform-specific implementations:

• workmanager: Main package providing the unified API
• workmanager_android: Android implementation using WorkManager
• workmanager_apple: iOS/macOS implementation using Background Tasks

🐛 Support & Issues#

• Documentation:docs.page/fluttercommunity/flutter_workmanager
• Bug Reports:GitHub Issues
• Questions:GitHub Discussions

📱 Example App#

See theexample folder for a complete working demo with all features.

For detailed setup instructions, advanced configuration, and troubleshooting, visit thecomplete documentation.