WebAPI/PowerManagementAPI - Revision history

Chaasof at 23:54, 1 October 2014

2014-10-01T23:54:14Z

← Older revision		Revision as of 23:54, 1 October 2014
Line 111:		Line 111:

	PowerManager probably should implement the EventTarget interface and remove the add/remove wake lock listener method.		PowerManager probably should implement the EventTarget interface and remove the add/remove wake lock listener method.

			[[Category:Web APIs]]

Seanlin: /* API */

2014-06-04T03:30:33Z

API

← Older revision		Revision as of 03:30, 4 June 2014
Line 50:		Line 50:
	*/		*/
	attribute boolean screenEnabled;		attribute boolean screenEnabled;

	/**		/**
	* Is the device's keypad/button backlight enabled? Setting it to false will		* Is the device's keypad/button backlight enabled? Setting it to false will
Line 57:		Line 57:
	*/		*/
	attribute boolean keyLightEnabled;		attribute boolean keyLightEnabled;

	/**		/**
	* How bright is the screen's backlight, on a scale from 0 (very dim) to 1		* How bright is the screen's backlight, on a scale from 0 (very dim) to 1

Seanlin: /* API */

2014-06-04T03:29:32Z

API

← Older revision		Revision as of 03:29, 4 June 2014
Line 50:		Line 50:
	*/		*/
	attribute boolean screenEnabled;		attribute boolean screenEnabled;

			/**
			* Is the device's keypad/button backlight enabled? Setting it to false will
			* turn off the device's keypad/button backlight. And the brightness level
			* is the same as \|screenBrightness\|.
			*/
			attribute boolean keyLightEnabled;

	/**		/**
	* How bright is the screen's backlight, on a scale from 0 (very dim) to 1		* How bright is the screen's backlight, on a scale from 0 (very dim) to 1

Airpingu: /* API */

2012-10-02T07:25:59Z

API

← Older revision		Revision as of 07:25, 2 October 2012
Line 9:		Line 9:
	* This API will power off the machine.		* This API will power off the machine.
	*/		*/
	void powerOff();		void powerOff();

	/**		/**
	* This API will completely shut down and boot the machine.		* This API will completely shut down and boot the machine.
	*/		*/
	void reboot();		void reboot();

	/**		/**
	* This API will restart the Gecko processes without powering off the machine.		* This API will restart the Gecko processes without powering off the machine.
	*/		*/
	void restart();		void restart();

	/**		/**

Airpingu: Provide a new API: restart() and add some comments.

2012-10-02T07:25:09Z

Provide a new API: restart() and add some comments.

← Older revision		Revision as of 07:25, 2 October 2012
Line 6:		Line 6:

	interface PowerManager {		interface PowerManager {
	void powerOff();		/**
	void reboot();		* This API will power off the machine.
			*/
			void powerOff();

			/**
			* This API will completely shut down and boot the machine.
			*/
			void reboot();

			/**
			* This API will restart the Gecko processes without powering off the machine.
			*/
			void restart();

	/**		/**

Kanru: /* API */

2012-04-23T02:46:09Z

API

← Older revision		Revision as of 02:46, 23 April 2012
Line 4:		Line 4:
	readonly attribute PowerManager power;		readonly attribute PowerManager power;
	};		};

	interface PowerManager {		interface PowerManager {
	void powerOff();		void powerOff();
Line 55:		Line 55:
	*/		*/
	attribute double screenBrightness;		attribute double screenBrightness;

	/**		/**
	* Is it possible that the device's CPU will sleep after the screen is		* Is it possible that the device's CPU will sleep after the screen is
Line 63:		Line 63:
	attribute boolean cpuSleepAllowed;		attribute boolean cpuSleepAllowed;
	};		};

	interface WakeLockListener {		interface WakeLockListener {
	/**		/**
Line 84:		Line 84:
	void callback(DOMString topic, DOMString state);		void callback(DOMString topic, DOMString state);
	};		};

	== Security/Privacy implications ==		== Security/Privacy implications ==

Kanru at 02:45, 23 April 2012

2012-04-23T02:45:34Z

← Older revision		Revision as of 02:45, 23 April 2012
Line 55:		Line 55:
	*/		*/
	attribute double screenBrightness;		attribute double screenBrightness;

			/**
			* Is it possible that the device's CPU will sleep after the screen is
			* disabled? Setting this attribute to false will prevent the device
			* entering suspend state.
			*/
			attribute boolean cpuSleepAllowed;
	};		};

Kanru: Initial content.

2012-04-05T07:07:50Z

Initial content.

New page

== API ==

partial interface Navigator {
readonly attribute PowerManager power;
};

interface PowerManager {
void powerOff();
void reboot();

/**
* The listeners are notified when a resource changes its lock state to:
* - unlocked
* - locked but not visible
* - locked and visible
*/
void addWakeLockListener(WakeLockListener listener);
void removeWakeLockListener(WakeLockListener listener);

/**
* Query the wake lock state of the topic.
*
* Possible states are:
*
* - "unlocked" - nobody holds the wake lock.
*
* - "locked-foreground" - at least one window holds the wake lock,
* and it is visible.
*
* - "locked-background" - at least one window holds the wake lock,
* but all of them are hidden.
*/
DOMString getWakeLockState(DOMString topic);

/**
* Is the device's screen currently enabled? This attribute controls the
* device's screen, so setting it to false will turn off the screen.
*/
attribute boolean screenEnabled;

/**
* How bright is the screen's backlight, on a scale from 0 (very dim) to 1
* (full brightness)? Setting this attribute modifies the screen's
* brightness.
*
* You can read and write this attribute even when the screen is disabled,
* but the backlight is off while the screen is disabled.
*
* If you write a value of X into this attribute, the attribute may not have
* the same value X when you later read it. Most screens don't support as
* many different brightness levels as there are doubles between 0 and 1, so
* we may reduce the value's precision before storing it.
*
* @throw NS_ERROR_INVALID_ARG if brightness is not in the range [0, 1].
*/
attribute double screenBrightness;
};

interface WakeLockListener {
/**
* The callback will be called when a lock topic changes its lock
* state.
*
* Possible states are:
*
* - "unlocked" - nobody holds the wake lock.
*
* - "locked-foreground" - at least one window holds the wake lock,
* and it is visible.
*
* - "locked-background" - at least one window holds the wake lock,
* but all of them are hidden.
*
* @param topic The resource name related to the wake lock.
* @param state The wake lock state
*/
void callback(DOMString topic, DOMString state);
};
== Security/Privacy implications ==

Only privileged code could access PowerManager.

== ToDo ==

PowerManager probably should implement the EventTarget interface and remove the add/remove wake lock listener method.