Skip to content

Latest commit

 

History

History

README.md

Use Cases

Practical guides for common native_workmanager scenarios.

📚 Guides

Getting Started

  1. Periodic API Sync - Most common use case
  2. File Upload with Retry - Error handling patterns

Advanced Features

  1. Background Cleanup - Scheduled maintenance tasks
  2. Photo Auto-Backup - ContentUri triggers (Android)
  3. Hybrid Workflow - Native + Dart workers combined
  4. Chain Processing - Sequential workflows

🎯 Quick Navigation

By Platform:

  • Android-specific: Photo Auto-Backup
  • iOS-specific: None (all cross-platform)
  • Cross-platform: All others

By Complexity:

By Feature:


💡 Usage Tips

Reading Order

If you're new to native_workmanager:

  1. Start with Periodic API Sync to understand basics
  2. Learn error handling with File Upload
  3. Try Dart workers with Background Cleanup
  4. Explore advanced features with remaining guides

Code Examples

All examples in these guides are:

  • Complete - Copy-paste ready
  • Tested - Verified on Android & iOS
  • Production-ready - Include error handling
  • Commented - Explain key concepts

Platform Notes

Each guide includes:

  • Android-specific behavior - How it works on Android
  • iOS-specific behavior - How it works on iOS
  • Common pitfalls - What to avoid
  • Best practices - Recommended patterns

🚀 Getting Help

In these guides, you'll learn:

  • How to schedule different types of tasks
  • When to use native workers vs Dart workers
  • How to handle errors and retries
  • How to chain tasks together
  • Platform-specific considerations
  • Common mistakes to avoid

Not covered here:

  • API reference - See main README.md
  • API documentation - See doc/API_REFERENCE.md

📝 Contributing

Found an issue or have a suggestion? Please open an issue at: https://github.com/user/native_workmanager/issues


Last updated: 2026-01-27