public/awesome-cordova-plugins
public/awesome-cordova-plugins
9
0
Fork 0
forked from github/awesome-cordova-plugins
Code Pull Requests Activity

docs(brightness): add correct types

Browse Source 
docs(brightness): add correct types
This commit is contained in:
Daniel Sogl 2018-03-16 16:52:56 +01:00 committed by GitHub
commit 2536ef2009
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/@ionic-native/plugins/brightness/index.ts
View File

@ -1,6 +1,5 @@
import { Injectable } from '@angular/core';
import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
/**
* @name Brightness
@ -17,7 +16,7 @@ import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
*
* ...
*
* let brightnessValue: number = 0.8;
* let brightnessValue = 0.8;
* this.brightness.setBrightness(brightnessValue);
* ```
*
@ -31,15 +30,16 @@ import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
})
@Injectable()
export class Brightness extends IonicNativePlugin {
/**
* Sets the brightness of the display.
*
* @param {value} Floating number between 0 and 1 in which case 1 means 100% brightness and 0 means 0% brightness.
* @param value {number} Floating number between 0 and 1 in which case 1 means 100% brightness and 0 means 0% brightness.
* @returns {Promise<any>} Returns a Promise that resolves if setting brightness was successful.
*/
@Cordova()
setBrightness(value: number): Promise<any> { return; }
setBrightness(value: number): Promise<any> {
return;
}
/**
* Reads the current brightness of the device display.
@ -48,12 +48,13 @@ export class Brightness extends IonicNativePlugin {
* brightness value of the device display (floating number between 0 and 1).
*/
@Cordova()
getBrightness(): Promise<any> { return; }
getBrightness(): Promise<any> {
return;
}
/**
* Keeps the screen on. Prevents the device from setting the screen to sleep.
*/
* Keeps the screen on. Prevents the device from setting the screen to sleep.
*/
@Cordova()
setKeepScreenOn(value: boolean): void { }
setKeepScreenOn(value: boolean): void {}
}