From a9d3849f8880ee9e71ebd45343a57c75473b338e Mon Sep 17 00:00:00 2001 From: Paul Thiel Date: Tue, 12 Apr 2016 17:31:04 +0200 Subject: [PATCH] feat(): add type definition for cordova-plugin-background-mode (#8936) fix(): space out the comment text from commenting slash --- .../cordova-plugin-background-mode-tests.ts | 14 ++++ .../cordova-plugin-background-mode.d.ts | 76 +++++++++++++++++++ 2 files changed, 90 insertions(+) create mode 100644 cordova-plugin-background-mode/cordova-plugin-background-mode-tests.ts create mode 100644 cordova-plugin-background-mode/cordova-plugin-background-mode.d.ts diff --git a/cordova-plugin-background-mode/cordova-plugin-background-mode-tests.ts b/cordova-plugin-background-mode/cordova-plugin-background-mode-tests.ts new file mode 100644 index 000000000..9620d7775 --- /dev/null +++ b/cordova-plugin-background-mode/cordova-plugin-background-mode-tests.ts @@ -0,0 +1,14 @@ +/// +/// + +cordova.plugins.backgroundMode.setDefaults({ silent: true }); + +cordova.plugins.backgroundMode.enable(); +cordova.plugins.backgroundMode.isEnabled(); +cordova.plugins.backgroundMode.isActivated(); + +cordova.plugins.backgroundMode.configure({ text: 'Insane Title' }); + +cordova.plugins.backgroundMode.onactivate = () => { } +cordova.plugins.backgroundMode.ondeactivate = () => { } +cordova.plugins.backgroundMode.onfailure = (errorCode) => { } \ No newline at end of file diff --git a/cordova-plugin-background-mode/cordova-plugin-background-mode.d.ts b/cordova-plugin-background-mode/cordova-plugin-background-mode.d.ts new file mode 100644 index 000000000..48a1be08c --- /dev/null +++ b/cordova-plugin-background-mode/cordova-plugin-background-mode.d.ts @@ -0,0 +1,76 @@ +// Type definitions for Apache Background Mode plugin +// Project: https://github.com/katzer/cordova-plugin-background-mode +// Definitions by: Paul Thiel +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +/** + * The plugin prevent the app from going to sleep while in background + */ +interface CordovaPluginBackgroundMode { + + /** + * The background mode can be enabled + */ + enable(): void; + /** + * The background mode can be disabled + */ + disable(): void; + /** + * Checks if the background mode is enabled or not + */ + isEnabled(): boolean; + /** + * Checks if the background mode is activated or not + */ + isActivated(): boolean; + /** + * Function to get notified when the background mode has been activated + */ + onactivate(): void; + /** + * Function to get notified when the background mode has been deactivated + */ + ondeactivate(): void; + /** + * Function to get notified when the background could not benn activated + */ + onfailure(callback: (errorCode: number) => void): void; + /** + * Customize default title, ticker and text for the notification + */ + setDefaults(item: ICordovaPluginBackgroundModeNotificationItem): void; + /** + * Configure the default background notification + */ + configure(item: ICordovaPluginBackgroundModeNotificationItem): void; +} + +interface ICordovaPluginBackgroundModeNotificationItem { + + /** + * The title of the notification displayed in background mode + */ + title?: string, + /** + * The ticker of the notification displayed in background mode + */ + ticker?: string, + /** + * The body of the notification displayed in background mode + */ + text?: string, + /** + * Handles if app is coming to foreground when tapping on the notification + */ + resume?: boolean, + /** + * Handles if there is a notification when background is activated + */ + silent?: boolean +} + +interface CordovaPlugins { + + backgroundMode: CordovaPluginBackgroundMode +} \ No newline at end of file