feat(): add type definition for cordova-plugin-background-mode (#8936)

fix(): space out the comment text from commenting slash
This commit is contained in:
Paul Thiel
2016-04-13 00:31:04 +09:00
committed by Masahiro Wakame
parent ac71dd02de
commit a9d3849f88
2 changed files with 90 additions and 0 deletions
@@ -0,0 +1,14 @@
/// <reference path='../cordova/cordova.d.ts' />
/// <reference path='./cordova-plugin-background-mode.d.ts' />
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) => { }
@@ -0,0 +1,76 @@
// Type definitions for Apache Background Mode plugin
// Project: https://github.com/katzer/cordova-plugin-background-mode
// Definitions by: Paul Thiel <https://github.com/Lordnoname>
// 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
}