github/awesome-cordova-plugins
github/awesome-cordova-plugins
3
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2025-03-21 12:37:23 +08:00
Code Issues Projects Releases Wiki Activity

docs(backgroundMode): improve docs

Browse Source
This commit is contained in:
mhartington 2016-07-01 15:46:15 -04:00
parent e802571726
commit f2f3741819
No known key found for this signature in database
GPG Key ID: C0CE5F60E890DB47
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/plugins/backgroundmode.ts
View File

@ -8,9 +8,22 @@ import {Plugin, Cordova} from './plugin';
*@usage
* ```js
* import {BackgroundMode} from 'ionic-native';
*
*
* BackgroundMode.enable();
* ```
*
* @advanced
*
* Configuration options
*
* | Property | Type | Description |
* |----------|-----------|------------------------------------------------------------------------------|
* | title | `string` | Title of the background task. Optional |
* | ticker | `string` | The text that scrolls itself on the statusbar. Optional |
* | text | `string` | Description of the background task. Optional |
* | silent | `boolean` | If the plugin will display a notification or not. Default is false. Optional |
* | resume | `boolean` | Bring the app into the foreground if the notification is tapped. Optional |
*
*/
@Plugin({
plugin: 'de.appplant.cordova.plugin.background-mode',
@ -37,11 +50,14 @@ export class BackgroundMode {
/**
* Checks if background mode is enabled or not.
* @returns {boolean} returns a true of false if the background mode is enabled.
*/
@Cordova()
static isEnabled(): Promise<boolean> {return; }
/**
* Can be used to get the information if the background mode is active.
* @returns {boolean} returns tru or flase if the background mode is active.
*/
@Cordova()
static isActive(): Promise<boolean> {return; }
@ -49,6 +65,7 @@ export class BackgroundMode {
/**
* Override the default title, ticker and text.
* Available only for Android platform.
* @param {Configure} options List of option to configure. See table below
*/
@Cordova({
platforms: ['Android']
@ -58,11 +75,13 @@ export class BackgroundMode {
/**
* Modify the displayed information.
* Available only for Android platform.
* @param {Configure} options Any options you want to update. See table below.
*/
@Cordova({
platforms: ['Android']
})
static update(options?: Configure): void {}
/**
* Sets a callback for a specific event
* Can be used to get notified or run function when the background mode has been activated, deactivated or failed.