@red-mobile/cordova-plugin-powermanagement

    2.0.1 • Public • Published

    PowerManagement

    The PowerManagement plugin offers access to the devices power-management functionality. It should be used for applications which keep running for a long time without any user interaction.

    For details on power functionality see:

    Supported Platforms

    • Android

    Installation

    cordova plugin add @red-mobile/cordova-plugin-powermanagement

    uninstall

    cordova plugin remove @red-mobile/cordova-plugin-powermanagement

    Usage

    window.powerManagement.acquire(successCallback, failureCallback)

    Acquire a wakelock by calling this.

    	window.powerManagement.acquire(function() {
    		console.log('Wakelock acquired');
    	}, function() {
    		console.log('Failed to acquire wakelock');
    	});

    window.powerManagement.dim(successCallback, failureCallback)

    This acquires a partial wakelock, allowing the screen to be dimmed.

    	window.powerManagement.dim(function() {
    		console.log('Wakelock acquired');
    	}, function() {
    		console.log('Failed to acquire wakelock');
    	});

    This function is nort supported on windows platform and will invoke the successCallback.

    window.powerManagement.release(successCallback, failureCallback)

    Release the wakelock. It's important to do this when you're finished with the wakelock, to avoid unnecessary battery drain.

    	window.powerManagement.release(function() {
    		console.log('Wakelock released');
    	}, function() {
    		console.log('Failed to release wakelock');
    	});

    window.powerManagement.setReleaseOnPause(enabled, successCallback, failureCallback)

    By default, the plugin will automatically release a wakelock when your app is paused (e.g. when the screen is turned off, or the user switches to another app). It will reacquire the wakelock upon app resume. If you would prefer to disable this behaviour, you can use this function.

    	window.powerManagement.setReleaseOnPause(false, function() {
    		console.log('Set successfully');
    	}, function() {
    		console.log('Failed to set');
    	});

    Note that in all the above examples, all callbacks are optional.

    Install

    npm i @red-mobile/cordova-plugin-powermanagement

    DownloadsWeekly Downloads

    4

    Version

    2.0.1

    License

    Apache-2.0

    Unpacked Size

    23.4 kB

    Total Files

    7

    Last publish

    Collaborators

    • okhiroyuki