import { Cordova, Plugin } from './plugin';

/**
 * @name Brightness
 * @description
 * The Brightness plugin let you control the display brightness of your device.
 *
 * Requires Cordova plugin: `cordova-plugin-brightness`. For more info, please see the [Brightness plugin docs](https://github.com/mgcrea/cordova-plugin-brightness).
 *
 * @usage
 * ```typescript
 * import { Brightness } from 'ionic-native';
 *
 *
 * let brightnessValue: number = 0.8;
 * Brightness.setBrightness(brightnessValue);
 * ```
 *
 */
@Plugin({
  plugin: 'cordova-plugin-brightness',
  pluginRef: 'cordova.plugins.brightness',
  repo: 'https://github.com/mgcrea/cordova-plugin-brightness',
  platforms: ['Android', 'iOS']
})
export class Brightness {

  /**
   * 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.
   * @returns {Promise} Returns a Promise that resolves if setting brightness was successful.
   */
  @Cordova()
  static setBrightness(value: number): Promise<any> { return; }

  /**
   * Reads the current brightness of the device display.
   *
   * @returns {Promise} Returns a Promise that resolves with the
   * brightness value of the device display (floating number between 0 and 1).
   */
  @Cordova()
  static getBrightness(): Promise<any> { return; }

  /**
  * Keeps the screen on. Prevents the device from setting the screen to sleep.
  */
  @Cordova()
  static setKeepScreenOn(value: boolean): void { }

}