phonegap-backgroundjs

    3.4.0 • Public • Published

    PhoneGap + Background.js

    Whoa! Now you can background JavaScript operations on iOS with PhoneGap!

    Please note that this code is now very old, but you can read more on my old (dead, archived) blog: https://web.archive.org/web/20170203171054/http://www.codefromjames.com/wordpress/?p=154

    Uses a sleep countdown timer paired with a UIBackgroundTaskIdentifier. The magic looks like this:

        - (void)doBackgroundTimeLoop
        {
            __block UIBackgroundTaskIdentifier task;
            UIApplication* app = [UIApplication sharedApplication];
            task = [app beginBackgroundTaskWithExpirationHandler:^{
                [app endBackgroundTask:task];
                task = UIBackgroundTaskInvalid;
            }];
     
            while(YES){
                @synchronized(self){
                    backgroundSecondsCounter--;
                    NSLog(@"Remaining background seconds: %i", backgroundSecondsCounter);
                    if (backgroundSecondsCounter <= 0)
                        break// Exit loop 
                }
                [NSThread sleepForTimeInterval:1];
            }
     
            // End this background task now 
            [app endBackgroundTask:task];
            task = UIBackgroundTaskInvalid;
        }

    While the background task is active, anything goes! You can run JavaScript in the background.

    Add the BackgroundJS plugin to your Phonegap project:

    phonegap local plugin add <location of BackgroundJS git repository>

    ...enable the plugin in config.xml:

        <feature name="BackgroundJS">
          <param name="ios-package" value="BackgroundJS" />
        </feature>

    ...and request some background time from JavaScript!

    BackgroundJS is available in JavaScript via:

      window.plugins.backgroundjs

    Get a block of secondsi (e.g. use a background thread for 10 seconds):

        window.plugins.backgroundjs.setBackgroundSeconds(10);

    Run in the background indefinitely:

        window.plugins.backgroundjs.lockBackgroundTime();

    Stop running background tasks immediately:

     window.plugins.backgroundjs.unlockBackgroundTime();

    Be careful when using this, as Apple specifications are picky. If you're not using background audio or tracking location, your app may be rejected for background tasking guidelines. Read up, and write some code!

    ALSO... Please don't kill my battery life just because you backgrounded more than you had to. You're not a special snowflake (yet) so play by the rules. Code smart, and make your app work right!

    Have a patch? Pull requests appreciated!

    Thanks! -James

    Keywords

    none

    Install

    npm i phonegap-backgroundjs

    DownloadsWeekly Downloads

    1

    Version

    3.4.0

    License

    none

    Unpacked Size

    15.6 MB

    Total Files

    127

    Last publish

    Collaborators

    • artanisix