Run background tasks when the app screen is locked

[AvishkaG]

The background task execution does not work for me when the device is locked for both iOS and Android as well. (Screen lock).

Plugin version: background_fetch: ^1.3.4
Platform: iOS/ Android
OS version: Android 10
Device manufacturer / model: Vivo 1806

This is my code.

import 'dart:io';

import 'package:background_task_app/network_service.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:background_fetch/background_fetch.dart';

Future<void> performTask() async {
  await storeTime("Your Name");
}

void main() {
  runApp(const MainApp());
  // Register background fetch headless task.
  if (Platform.isAndroid) {
    BackgroundFetch.registerHeadlessTask(backgroundFetchHeadlessTask);
  }
}

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

  @override
  Widget build(BuildContext context) {
    // Configure background fetch
    configureBackgroundFetch();

    if (Platform.isIOS) {
      BackgroundFetch.scheduleTask(
        TaskConfig(
          taskId: 'com.transistorsoft.customtask',
          delay: 5000,
          periodic: true,
        ),
      );
    }

    return MaterialApp(
      debugShowCheckedModeBanner: false,
      home: Scaffold(
        body: Center(
          child: Column(
            children: [
              Text("Mode: ${kDebugMode.toString()}"),
              const ElevatedButton(
                  onPressed: performTask, child: Text("Submit")),
            ],
          ),
        ),
      ),
    );
  }
}

// This function is called by `background_fetch` periodically.
void backgroundFetchHeadlessTask(HeadlessTask task) async {
  var taskId = task.taskId;
  bool isTimeout = task.timeout;
  if (isTimeout) {
    // This task has exceeded its allowed running-time.
    BackgroundFetch.finish(taskId);
    return;
  }
  // Perform your background task here
  await performTask();
  BackgroundFetch.finish(taskId);
}

void onBackgroundFetch(String taskId) async {
  // This is the fetch-event callback.
  print("[BackgroundFetch] Event received: $taskId");
  await performTask();
  BackgroundFetch.finish(taskId);
}

void onBackgroundFetchTimeout(String taskId) async {
  // This is the fetch-event timeout callback.
  print("[BackgroundFetch] TIMEOUT: $taskId");
  BackgroundFetch.finish(taskId);
}

void configureBackgroundFetch() async {
  await performTask();
  BackgroundFetch.configure(
    BackgroundFetchConfig(
      minimumFetchInterval: 15,
      stopOnTerminate: false,
      enableHeadless: true,
      requiresBatteryNotLow: false,
      requiresCharging: false,
      requiresStorageNotLow: false,
      requiresDeviceIdle: false,
      requiredNetworkType: NetworkType.ANY,
    ),
    onBackgroundFetch,
    onBackgroundFetchTimeout,
  );
}

[christocracy]

Are you simulating events?

[AvishkaG]

Yes I am doing an api POST call in this code block.

Future<void> performTask() async {
  await storeTime("Your Name");
}

[christocracy]

Are you simulating events as directed in the readme?

[AvishkaG]

Yes I did this for iOS as directed in the read me. But this periodic thing is not working for me even in the Android during the screen is locked.

[christocracy]

Are you observing the device logs?

[AvishkaG]

No, I am not observing the device logs. Should it work even when the phone is locked?

[christocracy]

Observe your logs.

Should it work even when the phone is locked?

That’s what the word “background” in the plug-in’s name implies.

[AvishkaG]

Ok I will observe the device logs. But I tried with another device as well and it either didn't work.

[christocracy]

I suggest you install the /example app here in this repo.

[github-actions]

This issue is stale because it has been open for 30 days with no activity.

[github-actions]

This issue was closed because it has been inactive for 14 days since being marked as stale.