mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2025-03-17 17:21:08 +08:00
56 lines
1.2 KiB
TypeScript
56 lines
1.2 KiB
TypeScript
import { Injectable } from '@angular/core';
|
|
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
|
|
|
|
|
/**
|
|
* @beta
|
|
* @name Backlight
|
|
* @description
|
|
* This plugin adds turning on/off the device backlight.
|
|
*
|
|
* @usage
|
|
* ```typescript
|
|
* import { Backlight } from '@ionic-native/backlight/ngx';
|
|
*
|
|
* constructor(private backlight: Backlight) { }
|
|
*
|
|
* ...
|
|
*
|
|
* // Turn backlight on
|
|
* this.backlight.on().then(() => console.log('backlight on'));
|
|
*
|
|
* // Turn backlight off
|
|
* this.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']
|
|
})
|
|
@Injectable()
|
|
export class Backlight extends IonicNativePlugin {
|
|
|
|
/**
|
|
* This function turns backlight on
|
|
* @return {Promise<any>} Returns a promise that resolves when the backlight is on
|
|
*/
|
|
@Cordova()
|
|
on(): Promise<any> {
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* This function turns backlight off
|
|
* @return {Promise<any>} Returns a promise that resolves when the backlight is off
|
|
*/
|
|
@Cordova()
|
|
off(): Promise<any> {
|
|
return;
|
|
}
|
|
|
|
}
|