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

docs(background-mode): add missing return types

Browse Source
This commit is contained in:
Daniel 2018-04-08 19:04:37 +02:00
parent c26735f366
commit 64cbb6181a
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/@ionic-native/plugins/background-mode/index.ts
View File

@ -1,5 +1,5 @@
import { Injectable } from '@angular/core';
import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
import { Observable } from 'rxjs/Observable';
/**
@ -21,9 +21,9 @@ export interface BackgroundModeConfiguration {
*/
icon?: string;
/**
* Set the background color of the notification circle
*/
/**
* Set the background color of the notification circle
*/
color?: string;
/**
@ -31,9 +31,9 @@ export interface BackgroundModeConfiguration {
*/
resume?: boolean;
/**
* When set to false makes the notifications visible on lockscreen (Android 5.0+)
*/
/**
* When set to false makes the notifications visible on lock screen (Android 5.0+)
*/
hidden?: boolean;
/** Big text */
@ -122,6 +122,7 @@ export class BackgroundMode extends IonicNativePlugin {
* Override the default title, ticker and text.
* Available only for Android platform.
* @param {BackgroundModeConfiguration} options List of option to configure. See table below
* @returns {Promise<any>}
*/
@Cordova({
platforms: ['Android']
@ -133,7 +134,7 @@ export class BackgroundMode extends IonicNativePlugin {
/**
* Modify the displayed information.
* Available only for Android platform.
* @param {BackgroundModeConfiguration} options Any options you want to update. See table below.
* @param {BackgroundModeConfiguration} [options] Any options you want to update. See table below.
*/
@Cordova({
platforms: ['Android'],
@ -202,6 +203,7 @@ export class BackgroundMode extends IonicNativePlugin {
/**
* The method works async instead of isActive() or isEnabled().
* @returns {Promise<boolean>}
*/
@Cordova({
platforms: ['Android']