From 64cbb6181a67e758928e1e85dbbac1fe39c22b8c Mon Sep 17 00:00:00 2001 From: Daniel Date: Sun, 8 Apr 2018 19:04:37 +0200 Subject: [PATCH] docs(background-mode): add missing return types --- .../plugins/background-mode/index.ts | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/src/@ionic-native/plugins/background-mode/index.ts b/src/@ionic-native/plugins/background-mode/index.ts index 6619db59f..afd8817e1 100644 --- a/src/@ionic-native/plugins/background-mode/index.ts +++ b/src/@ionic-native/plugins/background-mode/index.ts @@ -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} */ @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} */ @Cordova({ platforms: ['Android']