Merge branch 'master' into patch-1

This commit is contained in:
Daniel Sogl
2018-03-17 00:58:32 +01:00
committed by GitHub
45 changed files with 1424 additions and 672 deletions
@@ -2,21 +2,19 @@ import { Injectable } from '@angular/core';
import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
import { Observable } from 'rxjs/Observable';
/**
* Configurations items that can be updated.
*/
export interface BackgroundModeConfiguration {
/**
* Title of the background task
*/
title?: String;
title?: string;
/**
* Description of background task
*/
text?: String;
text?: string;
/**
* This will look for `<icon name>.png` in platforms/android/res/drawable|mipmap
@@ -29,7 +27,7 @@ export interface BackgroundModeConfiguration {
color?: string;
/**
* By default the app will come to foreground when taping on the notification. If false, plugin won't come to foreground when tapped.
* By default the app will come to foreground when tapping on the notification. If false, plugin won't come to foreground when tapped.
*/
resume?: boolean;
@@ -38,18 +36,18 @@ export interface BackgroundModeConfiguration {
*/
hidden?: boolean;
/** Big text */
bigText?: boolean;
/**
* The text that scrolls itself on statusbar
*/
ticker?: String;
ticker?: string;
/**
* if true plugin will not display a notification. Default is false.
*/
silent?: boolean;
}
/**
@@ -80,7 +78,6 @@ export interface BackgroundModeConfiguration {
})
@Injectable()
export class BackgroundMode extends IonicNativePlugin {
/**
* Enable the background mode.
* Once called, prevents the app from being paused while in background.
@@ -88,14 +85,16 @@ export class BackgroundMode extends IonicNativePlugin {
@Cordova({
sync: true
})
enable(): void { }
enable(): void {}
/**
* Disable the background mode.
* Once the background mode has been disabled, the app will be paused when in background.
*/
@Cordova()
disable(): Promise<any> { return; }
disable(): Promise<any> {
return;
}
/**
* Checks if background mode is enabled or not.
@@ -104,7 +103,9 @@ export class BackgroundMode extends IonicNativePlugin {
@Cordova({
sync: true
})
isEnabled(): boolean { return; }
isEnabled(): boolean {
return;
}
/**
* Can be used to get the information if the background mode is active.
@@ -113,7 +114,9 @@ export class BackgroundMode extends IonicNativePlugin {
@Cordova({
sync: true
})
isActive(): boolean { return; }
isActive(): boolean {
return;
}
/**
* Override the default title, ticker and text.
@@ -123,7 +126,9 @@ export class BackgroundMode extends IonicNativePlugin {
@Cordova({
platforms: ['Android']
})
setDefaults(options?: BackgroundModeConfiguration): Promise<any> { return; }
setDefaults(options?: BackgroundModeConfiguration): Promise<any> {
return;
}
/**
* Modify the displayed information.
@@ -146,7 +151,9 @@ export class BackgroundMode extends IonicNativePlugin {
clearFunction: 'un',
clearWithArgs: true
})
on(event: string): Observable<any> { return; }
on(event: string): Observable<any> {
return;
}
/**
* Android allows to programmatically move from foreground to background.
@@ -155,7 +162,7 @@ export class BackgroundMode extends IonicNativePlugin {
platforms: ['Android'],
sync: true
})
moveToBackground(): void { }
moveToBackground(): void {}
/**
* Enable GPS-tracking in background (Android).
@@ -164,7 +171,7 @@ export class BackgroundMode extends IonicNativePlugin {
platforms: ['Android'],
sync: true
})
disableWebViewOptimizations (): void { }
disableWebViewOptimizations(): void {}
/**
* Android allows to programmatically move from background to foreground.
@@ -173,7 +180,7 @@ export class BackgroundMode extends IonicNativePlugin {
platforms: ['Android'],
sync: true
})
moveToForeground(): void { }
moveToForeground(): void {}
/**
* Override the back button on Android to go to background instead of closing the app.
@@ -182,7 +189,7 @@ export class BackgroundMode extends IonicNativePlugin {
platforms: ['Android'],
sync: true
})
overrideBackButton(): void { }
overrideBackButton(): void {}
/**
* Exclude the app from the recent task list. Works on Android 5.0+.
@@ -191,7 +198,7 @@ export class BackgroundMode extends IonicNativePlugin {
platforms: ['Android'],
sync: true
})
excludeFromTaskList(): void { }
excludeFromTaskList(): void {}
/**
* The method works async instead of isActive() or isEnabled().
@@ -199,7 +206,9 @@ export class BackgroundMode extends IonicNativePlugin {
@Cordova({
platforms: ['Android']
})
isScreenOff(): Promise<boolean> { return; }
isScreenOff(): Promise<boolean> {
return;
}
/**
* Turn screen on
@@ -208,7 +217,7 @@ export class BackgroundMode extends IonicNativePlugin {
platforms: ['Android'],
sync: true
})
wakeUp(): void { }
wakeUp(): void {}
/**
* Turn screen on and show app even locked
@@ -217,6 +226,5 @@ export class BackgroundMode extends IonicNativePlugin {
platforms: ['Android'],
sync: true
})
unlock(): void { }
unlock(): void {}
}