auto_start_flutter 0.6.0 copy "auto_start_flutter: ^0.6.0" to clipboard
auto_start_flutter: ^0.6.0 copied to clipboard

A Flutter plugin to manage background execution permissions. Supports Android Auto-Start settings (Xiaomi, etc.) and iOS Background App Refresh.

auto_start_flutter #

A Flutter plugin to help manage background execution permissions on Android, iOS, macOS, and Windows devices. It supports requesting "Auto-Start" permissions on specific Android OEM devices, checking "Background App Refresh" status on iOS, and managing "Startup Apps / Login Items" settings on Windows and macOS to ensure your app can run reliably in the background.

Features #

  • Auto-Start Permission:
    • Android: Open manufacturer-specific "Auto-Start" or "App Launch" settings.
    • iOS: Check Background App Refresh status.
    • Windows/macOS: Open the "Startup Apps" or "Login Items" system settings.
  • Battery Optimization: Check if the app is exempt from battery optimizations and open settings to request exemption (Android) or power settings (Windows/macOS).
  • Device Support:
    • Android: Xiaomi, Redmi, Poco, Oppo, Vivo, Huawei, Honor, Samsung, ASUS, OnePlus, Nokia, LeTV, Meizu, HTC, Infinix, and more.
    • iOS: All devices.
    • Windows: Windows 10/11.
    • macOS: macOS 10.14+ (limitations apply).
  • Robustness: The plugin attempts multiple known intents for each manufacturer to ensure the settings page opens correctly.

pub package

Getting Started #

Add the package to your pubspec.yaml:

  auto_start_flutter: ^0.6.0

Import the package:

import 'package:auto_start_flutter/auto_start_flutter.dart';

Platform Support #

Feature Android iOS Windows macOS
isAutoStartAvailable Checks manufacturer whitelist Checks UIBackgroundRefreshStatus Returns true Returns true
getAutoStartPermission Opens Auto Start / App Info Opens App Settings Opens Startup Apps Opens Login Items
openAppInfo Opens App Info Opens App Settings Opens Apps & Features Opens General Settings
getDeviceManufacturer Returns Build.MANUFACTURER Returns "Apple" Returns "Microsoft" Returns "Apple"
isBatteryOptimizationDisabled Checks doze mode status Returns true (Always valid) Returns true Returns true
disableBatteryOptimization Opens ignore battery optimization settings Opens App Settings Opens Power & Sleep Opens Energy Saver
openCustomSetting Opens specific activity Not Supported Not Supported Not Supported

Usage #

AutoStart Permission / Background Refresh #

On Android, this checks if the device is from a manufacturer known to have aggressive auto-start restrictions and redirects the user to the appropriate settings page. On iOS, this checks if Background App Refresh is enabled. If not, it redirects the user to the App Settings page where they can enable it. On Windows and macOS, this opens the Startup Apps or Login Items system settings, where users can toggle your app's startup status.

import 'package:auto_start_flutter/auto_start_flutter.dart';
// ...

// 1. Check if auto-start permission is available / relevant
// Android: Returns true for Xiaomi, Oppo, Vivo, etc.
// iOS: Returns true if Background App Refresh is available (not restricted).
var isAvailable = await isAutoStartAvailable;

if (isAvailable == true) {
    // 2. Request permission / Open Settings
    // Android: Opens Auto Start settings or App Info.
    // iOS: Opens App Settings.
    // Windows/macOS: Opens Startup Apps / Login Items settings.
    await getAutoStartPermission();
}

Other Features #

  1. App Info: Open the system settings page for the app.

    // Android: Opens App Info
    // iOS: Opens App Settings
    await openAppInfo();
    
  2. Device Manufacturer: Get the device manufacturer.

    String? manufacturer = await getDeviceManufacturer(); 
    // e.g. "Xiaomi", "Apple", "Samsung"
    
  3. Custom Settings (Android Only): If you know the specific package and activity name for a setting page on a specific device, you can attempt to open it directly.

    // Example: Try opening a specific hidden setting
    await openCustomSetting(
      packageName: 'com.android.settings',
      activityName: 'com.android.settings.Settings\$PowerUsageSummaryActivity',
    );
    

Battery Optimization (Android & Windows) #

Android's Doze mode and App Standby can restrict background processing. On Windows, power settings can similarly affect background performance. On iOS, this API returns true (disabled) to maintain API compatibility.

  1. Check Status: Check if your app is already ignoring battery optimizations.

    bool isExempt = await isBatteryOptimizationDisabled ?? false;
    print("Battery Optimization Disabled: $isExempt");
    
  2. Open Settings: If not exempt, open the "Ignore Battery Optimization" settings to let the user allow your app.

    if (!isExempt) {
      await disableBatteryOptimization();
    }
    

Platform Support #

Platform Supported Notes
Android Supports custom OEM intents and standard battery optimization settings.
iOS Checks UIBackgroundRefreshStatus and opens App Settings.
Windows Opens Startup Apps settings.
macOS Opens Login Items settings.

Note: Standard Android APIs do not allow checking if "Auto Start" is actually enabled. isAutoStartAvailable only returns true if the device manufacturer is on the supported list (e.g. Xiaomi, Oppo). On Windows and macOS, isAutoStartAvailable returns true to indicate that the "Startup Apps" / "Login Items" setting is accessible. Only iOS allows verifying the actual background refresh status programmatically.

Contributing #

If you find any issues or would like to add support for more devices, please file an issue or pull request on GitHub.

71
likes
150
points
1.69k
downloads

Publisher

verified publishertechflow.ir

Weekly Downloads

A Flutter plugin to manage background execution permissions. Supports Android Auto-Start settings (Xiaomi, etc.) and iOS Background App Refresh.

Repository (GitHub)
View/report issues

Documentation

API reference

License

Apache-2.0, MIT (license)

Dependencies

flutter, plugin_platform_interface

More

Packages that depend on auto_start_flutter

Packages that implement auto_start_flutter