github/awesome-cordova-plugins
github/awesome-cordova-plugins
2
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2025-02-01 02:53:03 +08:00
Code Issues Projects Releases Wiki Activity

Merge pull request #836 from amuramoto/background-mode

Browse Source 
docs(background mode): fix incorrect return types and typos
This commit is contained in:
Alex Muramoto 2016-11-29 08:23:57 -08:00 committed by GitHub
commit b7a562053a
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/plugins/backgroundmode.ts
View File

@ -53,14 +53,14 @@ export class BackgroundMode {
/** /**
* Checks if background mode is enabled or not. * Checks if background mode is enabled or not.
* @returns {boolean} returns a true of false if the background mode is enabled. * @returns {Promise<boolean>} returns a true of false if the background mode is enabled.
*/ */
@Cordova() @Cordova()
static isEnabled(): Promise<boolean> { return; } static isEnabled(): Promise<boolean> { return; }
/** /**
* Can be used to get the information if the background mode is active. * 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. * @returns {Promise<boolean>} returns true or false if the background mode is active.
*/ */
@Cordova() @Cordova()
static isActive(): Promise<boolean> { return; } static isActive(): Promise<boolean> { return; }
@ -87,18 +87,21 @@ export class BackgroundMode {
/** /**
* Called when background mode is activated. * Called when background mode is activated.
* @returns {Observable<any>} returns an observable that emits when background mode is activated
*/ */
@CordovaFunctionOverride() @CordovaFunctionOverride()
static onactivate(): Observable<any> { return; }; static onactivate(): Observable<any> { return; };
/** /**
* Called when background mode is deactivated. * Called when background mode is deactivated.
* @returns {Observable<any>} returns an observable that emits when background mode is deactivated
*/ */
@CordovaFunctionOverride() @CordovaFunctionOverride()
static ondeactivate(): Observable<any> { return; }; static ondeactivate(): Observable<any> { return; };
/** /**
* Called when background mode fails * Called when background mode fails
* @returns {Observable<any>} returns an observable that emits when background mode fails
*/ */
@CordovaFunctionOverride() @CordovaFunctionOverride()
static onfailure(): Observable<any> { return; }; static onfailure(): Observable<any> { return; };