feat(backlight): add Backlight plugin (#973)

* feat(backlight): add Backlight plugin * fix(backlight): set as beta
2026-05-02 00:07:23 +08:00 · 2017-01-21 05:14:29 +08:00
parent 7c30718369
commit 1279114b73
2 changed files with 47 additions and 0 deletions
@@ -0,0 +1,44 @@
+import { Plugin, Cordova } from './plugin';
+
+/**
+ * @beta
+ * @name Backlight
+ * @description
+ * This plugin adds turning on/off the device backlight.
+ *
+ * @usage
+ * ```
+ * import { Backlight } from 'ionic-native';
+ *
+ * // Turn backlight on
+ * Backlight.on().then(() => console.log('backlight on'));
+ *
+ * // Turn backlight off
+ * Backlight.off().then(() => console.log('backlight off'));
+ *
+ * ```
+ */
+@Plugin({
+  pluginName: 'Backlight',
+  plugin: 'cordova-plugin-backlight',
+  pluginRef: 'cordova.plugins.Backlight',
+  repo: 'https://github.com/mebibou/cordova-plugin-backlight',
+  platforms: ['Android']
+})
+export class Backlight {
+
+  /**
+   * This function turns backlight on
+   * @return {Promise<any>} Returns a promise that resolves when the backlight is on
+   */
+  @Cordova()
+  static on(): Promise<any> { return; }
+
+  /**
+   * This function turns backlight off
+   * @return {Promise<any>} Returns a promise that resolves when the backlight is off
+   */
+  @Cordova()
+  static off(): Promise<any> { return; }
+
+}