Skip to content

Latest commit

 

History

History
247 lines (190 loc) · 9.22 KB

README.md

File metadata and controls

247 lines (190 loc) · 9.22 KB
Raw

android_job_scheduler

This plugin is currently unmaintained. Do not use it. If you are interested in continuing to maintain this plugin, please contact me directly.

Schedule Jobs using Android's JobScheduler API. This is very much Work in progress. Much of this Plugin is based on the android_alarm_manager Plugin.

Getting Started

Add the Dependency

Check the latest Version on pub.

Then, in your pubspec.yml:

dependencies:
  ...
  android_job_scheduler: ^0.0.7

Declare the JobScheduler Service in AndroidManifest.xml

In your project's android/app/src/main directory, open the AndroidManifest.xml and add the following to the <application /> block:

<service
    android:exported="false"
    android:permission="android.permission.BIND_JOB_SERVICE"
    android:name="io.gjg.androidjobscheduler.AndroidJobScheduler" />

Usage

import 'package:android_job_scheduler/android_job_scheduler.dart';

Installing Jobs

Periodic Jobs

// This MUST be a top level Function or a Static Class Member. It may not be a Class Method
// or a Closure. Inside this method, you don't have access to anything assuming a running
// Application.
void iRunPeriodically() {
    print('This gets run periodically by the Android JobScheduler API. '
          'Even when the App is not running. '
          'The Timings are not guaranteed to be exact by the Android OS, though.');
}

void main() {
    ...
    bool jobIsInstalled =
        // For every distinct Job you wish to create, set a new JobId.
        // Calling this Function twice with the same JobId will have no effect.
        await AndroidJobScheduler.scheduleEvery(
            const Duration(seconds: 10), 42, iRunPeriodically);
}

One-shot Jobs

You may schedule a Job to be run once, at some point in the Future. The Job will run even if the user closes the App in the meantime. If you reschedule the Job in the Period where it is not yet executed (by specifying the same JobId), the JobScheduler will restart the Job Execution Timeout, without executing the Job twice.

await AndroidJobScheduler.scheduleOnce(
  const Duration(seconds: 10), 44, iRunOnlyOnceInTenSecs
);

Canceling Jobs

void main() {
  ...
  // Cancel a unique Job
  await AndroidJobScheduler.cancelJob(42);
  // Cancel all Jobs scheduled by this Application
  await AndroidJobScheduler.cancelAllJobs();
}

Get Pending Jobs

void main() {
    ...
    await AndroidJobScheduler.scheduleEvery(
        const Duration(seconds: 10), 42, iRunPeriodically);
    await AndroidJobScheduler.scheduleEvery(
        const Duration(seconds: 10), 43, iRunPeriodically);
    
    final List<AndroidJobInfo> pendingJobs = await AndroidJobScheduler.getAllPendingJobs();
    print(pendingJobs.map((AndroidJobInfo i) => i.id).toList().join(", ")); // 42, 43
}

Reboot Persistence

You can specify that your job is persistent across Reboots. You'll need an additional Permission in your app's android/src/main/AndroidManifest.xml, though:

<manifest ...>
  ...
  
  <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />
  
  <application>
    ...
  </application>
</manifest>

After you added the Permission, restart the test device or uninstall your application! Otherwise you will still get a permission error. This is because the JobScheduler holds a cache of which App Uids hold permission, which needs to be invalidated by one of these actions. After you got that sorted out, you can specify your Job to be persistent:

await AndroidJobScheduler.scheduleEvery(
   ...
   persistentAcrossReboots: true,
   ...
]);

Conditional Job Execution

Android's JobScheduler allows us to execute Jobs conditionally.

Only execute when Device is charging

await AndroidJobScheduler.scheduleEvery(
    const Duration(seconds: 10), 42, iRunPeriodically
    constraints: [
          const RequiresCharging(),
]);

Only execute with a certain Network connectivity State

await AndroidJobScheduler.scheduleEvery(
    const Duration(seconds: 10), 42, iRunPeriodically,
    constraints: [
          const RequiredNetworkType(requiredType: RequiredNetworkType.NETWORK_TYPE_CELLULAR),
]);

Only execute if not on low Storage condition

await AndroidJobScheduler.scheduleEvery(
    const Duration(seconds: 10), 42, iRunPeriodically,
    constraints: [
          const RequiresStorageNotLow()
]);

Combinations

Of course, you can also combine Constraints.

// Only execute when the Device is charging,
// the Network connection is unmetered,
// and we have enough storage
await AndroidJobScheduler.scheduleEvery(
    const Duration(seconds: 10), 42, downloadTonsOfData,
    constraints: [
          const RequiredNetworkType(requiredType: RequiredNetworkType.NETWORK_TYPE_UNMETERED),
          const RequiresCharging(),
          const RequiresStorageNotLow()
]);

Using other Plugins from inside your callback

In order to use other Plugins from inside the Dart Callback, you'll need to enable the Scheduler to register with your Applications Main Plugin Registry. Do this by providing a custom Application Implementation in your Android Code:

Warning! Plugins generally have access to the FlutterActivity, in case they need access to any resources they provided by it. However, since we're running in a Job Context and not inside an Activity, the Activity will be null. Some Plugins might not expect this and crash on initialization. Plugins that fundamentally need Activities to function will not work when the main Application is not running. Your callbacks should still work if your Application is running, though.

import io.flutter.app.FlutterApplication;
import io.flutter.plugin.common.PluginRegistry;
import io.flutter.plugins.GeneratedPluginRegistrant;
import io.gjg.androidjobscheduler.AndroidJobScheduler;

public class MainApplication extends FlutterApplication implements PluginRegistry.PluginRegistrantCallback {

    @Override
    public void registerWith(PluginRegistry pluginRegistry) {
        GeneratedPluginRegistrant.registerWith(pluginRegistry);
    }

    @Override
    public void onCreate() {
        super.onCreate();
        AndroidJobScheduler.setPluginRegistrantCallback(this);
    }
}

Don't forget to reference your custom Application Implementation in AndroidManifest.xml.

...
<application
    android:name=".MainApplication">
    ...
</application>

FAQ

My Callbacks won't work with Plugins

One of the Plugins you're using is expecting to be run inside an Activity. Because there is no Activity when running in a Job Context, this will not work (see above).

I'm getting an Error telling be I need additional Permissions when scheduling a Job

E/flutter (25871): PlatformException(error, Error: requested job be persisted without holding RECEIVE_BOOT_COMPLETED permission., null)
E/flutter (25871): #0      StandardMethodCodec.decodeEnvelope (package:flutter/src/services/message_codecs.dart:547:7)

You specified persistentAcrossReboots: true when scheduling the Job, but you didn't declare the appropriate Permission in the Android Manifest. See above for what to add to the Manifest. If you did declare the Permission make sure you reboot your test device or uninstall your application, due to the reasons outlined above.jj

I'm getting an IllegalArgumentException when trying to Schedule anything

E/MethodChannel#plugins.gjg.io/android_job_scheduler(31525): Failed to handle method call
E/MethodChannel#plugins.gjg.io/android_job_scheduler(31525): java.lang.IllegalArgumentException: No such service ComponentInfo{io.gjg.testapp/io.gjg.androidjobscheduler.AndroidJobScheduler}

You forgot adding the JobScheduler Service to your AndroidManifest.xml. Please do this by following the steps outlined above.

For help getting started with Flutter, view our online documentation.

What is the difference to the android_alarm_manager plugin?

Most importantly it uses JobScheduler API instead of the AlarmManager API.

The main reason this plugin exists is that at the moment, android_alarm_manager is not working with the latest Flutter SDK Version. See this issue. If there is Interest from the Flutter Devs, I'll merge the changes relevant for fixing this issue back into android_alarm_manager.

Apart from that, the JobScheduler API offers a lot more Flexibility than the AlarmManager API for scheduling Jobs. For example, we can tell this API to only schedule Jobs when the Device is Charging, or when a unmetered Network Connection is available.

How is this Plugin behaving if run on iOS?

Your App will work on iOS and Compile, but a MissingPluginException will be thrown when you try to call any of android_job_scheduler's methods. You may Schedule Jobs only on the Android Side by doing something like:

if (Platform.isAndroid) {
    await AndroidJobScheduler...;
}

Unfortunately, the way jobs are scheduled on iOS is vastly different to how it's done on Android, so iOS support will never be coming to this Plugin.