Git Product home page Git Product logo

cordova-plugin-scheduler's Introduction

Cordova plugin scheduler

A Cordova plugin that schedules periodic Android background tasks using the JobScheduler.

Installation

   $ cordova plugin add --save cordova-plugin-scheduler

Usage

To schedule a job:

window.SchedulerPlugin.configure(
    fetchTask,
    errorHandler,
    { minimumFetchInterval: i }  // i in minutes
);

fetchTask should call SchedulerPlugin.finish() to release the Android wakelock.

Example

var fetchTask = function() {
    codePush.sync(null);
    window.SchedulerPlugin.finish();
};

var errorHandler = function(error) {
    console.log('SchedulerPlugin error: ', error);
};

window.SchedulerPlugin.configure(
    fetchTask,
    errorHandler,
    { minimumFetchInterval: 60 }  // run every hour
);

Debugging

  • Observe the plugin logs:
$ adb logcat -s SchedulerPluginTag
  • Simulate a background-fetch event on a device (only works for Android >=7.0):
$ adb shell cmd jobscheduler run -f <your.application.id> 999
  • See all scheduled jobs on your phone (only works for Android >=7.0)
$ adb shell dumpsys jobscheduler

Notes

  • The same jobId (999) is used every time a job is scheduled, so former fetch handlers are overriden when you define a new fetch handler.
  • The job is persisted on device reboots.
  • SchedulerPlugin.finish() will call JobService.jobFinished.

Credits

This plugin is mostly a merge of https://github.com/transistorsoft/cordova-plugin-background-fetch and https://github.com/transistorsoft/transistor-background-fetch, with extra built-in job parameters.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.