auto_start_flutter 1.5.0

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

example/lib/main.dart

import 'package:flutter/material.dart';
import 'dart:async';
import 'package:flutter/services.dart';
import 'package:auto_start_flutter/auto_start_flutter.dart';

@pragma('vm:entry-point')
void myBootCallback() {
  WidgetsFlutterBinding.ensureInitialized();
  debugPrint("Boot Callback execution triggered! The device just booted.");
}

@pragma('vm:entry-point')
void myScheduledTaskCallback() {
  WidgetsFlutterBinding.ensureInitialized();
  debugPrint("Scheduled Task execution triggered! Running headlessly.");
}

@pragma('vm:entry-point')
void myExecuteInBackgroundCallback() {
  WidgetsFlutterBinding.ensureInitialized();
  debugPrint("Execute In Background triggered! Running headlessly right now.");
}

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: HomePage(),
    );
  }
}

class HomePage extends StatefulWidget {
  const HomePage({super.key});

  @override
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  String _batteryOptimizationStatus = "Unknown";
  String _exactAlarmStatus = "Unknown";
  String _manufacturer = "Unknown";
  String _launchArgs = "None";

  @override
  void initState() {
    super.initState();
    initAutoStart();
    _getManufacturer();
    _checkLaunchArgs();
    _checkExactAlarm();
  }

  Future<void> _checkExactAlarm() async {
    bool canSchedule = await canScheduleExactAlarms();
    setState(() {
      _exactAlarmStatus = canSchedule ? "Allowed (Yes)" : "Denied (No)";
    });
  }

  Future<void> _openExactAlarm() async {
    bool success = await openExactAlarmSettings();
    if (!mounted) return;
    ScaffoldMessenger.of(context).showSnackBar(SnackBar(
        content: Text(success
            ? "Opening Exact Alarm Settings..."
            : "Could not open Exact Alarm settings (pre-Android 12 or unsupported).")));
  }

  Future<void> _openBatteryOptimizationSettings() async {
    bool success = await openBatteryOptimizationSettings();
    if (!mounted) return;
    ScaffoldMessenger.of(context).showSnackBar(SnackBar(
        content: Text(success
            ? "Opening Battery Optimization Settings..."
            : "Could not open Battery Optimization settings.")));
  }

  Future<void> _checkLaunchArgs() async {
    final args = await getLaunchArguments();
    if (args.isNotEmpty) {
      setState(() {
        _launchArgs = args.toString();
      });
      debugPrint("App launched with arguments: $args");
    }
  }

  Future<void> _getManufacturer() async {
    String? manufacturer = await getDeviceManufacturer();
    if (manufacturer != null) {
      setState(() {
        _manufacturer = manufacturer;
      });
    }
  }

  //initializing the autoStart with the first build.
  Future<void> initAutoStart() async {
    try {
      //check auto-start availability.
      var isAvailable = (await isAutoStartAvailable) ?? false;
      debugPrint("Auto start available: $isAvailable");
      //if available then navigate to auto-start setting page.
      if (isAvailable) {
        bool success = await getAutoStartPermission();
        debugPrint("Auto start permission open success: $success");
      }
    } on PlatformException catch (e) {
      debugPrint(e.toString());
    }
    if (!mounted) return;
  }

  Future<void> _checkBatteryOptimization() async {
    bool? isDisabled = await isBatteryOptimizationDisabled;
    setState(() {
      _batteryOptimizationStatus =
          isDisabled == true ? "Disabled (Good)" : "Enabled (Bad)";
    });
  }

  Future<void> _disableBatteryOptimization() async {
    await disableBatteryOptimization();
  }

  Future<void> _openAutoStart() async {
    bool success = await getAutoStartPermission();
    if (!success) {
      if (!mounted) return;
      // Now this context is below MaterialApp, so ScaffoldMessenger works.
      ScaffoldMessenger.of(context).showSnackBar(SnackBar(
          content: Text("Could not open Auto-Start settings directly.")));
    }
  }

  Future<void> _openAppInfo() async {
    await openAppInfo();
  }

  final TextEditingController _packageNameController = TextEditingController();
  final TextEditingController _activityNameController = TextEditingController();

  @override
  void dispose() {
    _packageNameController.dispose();
    _activityNameController.dispose();
    super.dispose();
  }

  Future<void> _openCustomSetting() async {
    if (_packageNameController.text.isEmpty ||
        _activityNameController.text.isEmpty) {
      ScaffoldMessenger.of(context).showSnackBar(SnackBar(
          content: Text("Please enter both package and activity names")));
      return;
    }
    bool success = await openCustomSetting(
      packageName: _packageNameController.text,
      activityName: _activityNameController.text,
    );
    if (!success) {
      if (!mounted) return;
      ScaffoldMessenger.of(context).showSnackBar(
          SnackBar(content: Text("Failed to open custom setting")));
    }
  }

  Future<void> _testRegisterBootCallback() async {
    bool success = await registerBootCallback(myBootCallback);
    if (!mounted) return;
    ScaffoldMessenger.of(context).showSnackBar(
        SnackBar(content: Text("Boot Callback Registered: $success")));
  }

  Future<void> _testStartForegroundService() async {
    bool success = await startForegroundService(
      title: "Example Foreground Service",
      content: "This prevents the app from being killed.",
    );
    if (!mounted) return;
    ScaffoldMessenger.of(context).showSnackBar(
        SnackBar(content: Text("Started Foreground Service: $success")));
  }

  Future<void> _testStopForegroundService() async {
    bool success = await stopForegroundService();
    if (!mounted) return;
    ScaffoldMessenger.of(context).showSnackBar(
        SnackBar(content: Text("Stopped Foreground Service: $success")));
  }

  Future<void> _testScheduleTask() async {
    final TimeOfDay? timeOfDay = await showTimePicker(
      context: context,
      initialTime: TimeOfDay.now(),
    );

    if (timeOfDay != null) {
      final now = DateTime.now();
      var scheduledDate = DateTime(
        now.year,
        now.month,
        now.day,
        timeOfDay.hour,
        timeOfDay.minute,
      );

      // If the selected time is before now, schedule for tomorrow
      if (scheduledDate.isBefore(now)) {
        scheduledDate = scheduledDate.add(const Duration(days: 1));
      }

      bool success = await scheduleTask(scheduledDate, myScheduledTaskCallback,
          taskId: "test_task_${scheduledDate.millisecondsSinceEpoch}");
      if (!mounted) return;
      ScaffoldMessenger.of(context).showSnackBar(SnackBar(
          content:
              Text("Task Scheduled for ${scheduledDate.toLocal()}: $success")));
    }
  }

  Future<void> _testExecuteInBackground() async {
    bool success = await executeInBackground(myExecuteInBackgroundCallback);
    if (!mounted) return;
    ScaffoldMessenger.of(context).showSnackBar(
        SnackBar(content: Text("Execute in Background: $success")));
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Auto Start Flutter Example'),
      ),
      body: Center(
        child: SingleChildScrollView(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              Text("Manufacturer: $_manufacturer"),
              SizedBox(height: 10),
              Text("Launch Args: $_launchArgs"),
              SizedBox(height: 20),
              Text("Battery Optimization: $_batteryOptimizationStatus"),
              SizedBox(height: 10),
              ElevatedButton(
                onPressed: _checkBatteryOptimization,
                child: Text("Check Battery Optimization"),
              ),
              ElevatedButton(
                onPressed: _disableBatteryOptimization,
                child: Text("Disable Battery Optimization (Direct Dialog)"),
              ),
              ElevatedButton(
                onPressed: _openBatteryOptimizationSettings,
                child: Text("Open Battery Settings (Google Play Safe)"),
              ),
              SizedBox(height: 20),
              ElevatedButton(
                onPressed: _openAutoStart,
                child: Text("Open Auto Start Settings"),
              ),
              ElevatedButton(
                onPressed: _openAppInfo,
                child: Text("Open App Info"),
              ),
              Divider(height: 40),
              Text("Test Custom Intent",
                  style: TextStyle(fontWeight: FontWeight.bold)),
              Padding(
                padding: const EdgeInsets.all(8.0),
                child: TextField(
                  controller: _packageNameController,
                  decoration: InputDecoration(
                      labelText: "Package Name", border: OutlineInputBorder()),
                ),
              ),
              Padding(
                padding: const EdgeInsets.all(8.0),
                child: TextField(
                  controller: _activityNameController,
                  decoration: InputDecoration(
                      labelText: "Activity Name", border: OutlineInputBorder()),
                ),
              ),
              ElevatedButton(
                onPressed: _openCustomSetting,
                child: Text("Open Custom Setting"),
              ),
              Divider(height: 40),
              Text("Phase 1 Features",
                  style: TextStyle(fontWeight: FontWeight.bold)),
              ElevatedButton(
                onPressed: _testRegisterBootCallback,
                child: Text("Register Boot Callback"),
              ),
              ElevatedButton(
                onPressed: _testStartForegroundService,
                child: Text("Start Foreground Service"),
              ),
              ElevatedButton(
                onPressed: _testStopForegroundService,
                child: Text("Stop Foreground Service"),
              ),
              Divider(height: 40),
              Text("Phase 2 Features (Exact Alarms & Tasks)",
                  style: TextStyle(fontWeight: FontWeight.bold)),
              Text("Exact Alarm: $_exactAlarmStatus"),
              SizedBox(height: 6),
              ElevatedButton(
                onPressed: _checkExactAlarm,
                child: Text("Check Exact Alarm (Android 12+)"),
              ),
              ElevatedButton(
                onPressed: _openExactAlarm,
                child: Text("Open Exact Alarm Settings"),
              ),
              ElevatedButton(
                onPressed: _testScheduleTask,
                child: Text("Schedule Task (Pick Time)"),
              ),
              Divider(height: 40),
              Text("Phase 3 Features",
                  style: TextStyle(fontWeight: FontWeight.bold)),
              ElevatedButton(
                onPressed: _testExecuteInBackground,
                child: Text("Test Headless Execution"),
              ),
              SizedBox(height: 40),
            ],
          ),
        ),
      ),
    );
  }
}