PowerSettings Interface Reference

import"PowerSettingsPlugin.idl";

Classes
interface	sleepTimerUpdatedEvent

Public Member Functions
void	addEventListener ([in] String event_name, [in] EventListener listener)
Integer	getAutoTvOffMode ()
Boolean	isActiveStandbyEnabled ()
void	removeEventListener ([in] String event_name, [in] EventListener listener)
void	removeEventListener ([in] String event_name)
Boolean	setActiveStandbyEnabled ([in] Boolean active)
Boolean	setAutoTvOffMode ([in] enumerations mode)
Boolean	setSleepTimer ([in] enumerations sleep_timer_value)

Public Attributes
const Integer	AutoTvOff1Hour = 1
const Integer	AutoTvOff2Hour = 2
const Integer	AutoTvOff3Hour = 3
const Integer	AutoTvOff4Hour = 4
const Integer	AutoTvOff5Hour = 5
const Integer	AutoTvOff6Hour = 6
const Integer	AutoTvOff7Hour = 7
const Integer	AutoTvOff8Hour = 8
const Integer	AutoTvOffDisabled = 0
const Integer	AutoTvOffInvalid = -1
const Integer	SLEEP_TIMER_120_MIN = 4
const Integer	SLEEP_TIMER_30_MIN = 1
const Integer	SLEEP_TIMER_60_MIN = 2
const Integer	SLEEP_TIMER_90_MIN = 3
const Integer	SLEEP_TIMER_OFF = 0

Detailed Description

This is a class which implements global Power Settings.

Member Function Documentation

void PowerSettings.addEventListener	(	[in] String	event_name,
		[in] EventListener	listener
	)

Adds DOM2 event listener for specified event.

Possible values are: event_name: "sleepTimerUpdatedEvent", listener: function that has arguments similar to the sleepTimerUpdatedEvent interface properties.

Parameters

event_name	Name of the event.
listener	javascript function that has arguments like the properties listed in the listener's interface.

Integer PowerSettings.getAutoTvOffMode

(

)

Get auto off mode.

            var mode = PowerSettings.getAutoTvOffMode();

Returns

current AutoTvOffMode

Boolean PowerSettings.isActiveStandbyEnabled

(

)

Get whether active standby feature is enabled. Active standby means, no real (low power) standby, always keep in pseudo standby

            var isEnabled = PowerSettings.isActiveStandbyEnabled();

Returns

true if activeStandby is enabled or not.

void PowerSettings.removeEventListener	(	[in] String	event_name,
		[in] EventListener	listener
	)

Removes single DOM2 event listener for specified event

Possible values are: event_name: "sleepTimerUpdatedEvent", listener: function that has arguments similar to the sleepTimerUpdatedEvent interface properties.

Parameters

event_name	Name of the event
listener	named javascript function that has arguments like the properties listed in the listener's interface.

void PowerSettings.removeEventListener

(

[in] String

event_name

)

Removes all DOM2 event listeners for specified event

Parameters

event_name

Name of the event

See also

removeEventListener([in] String event_name, [in] EventListener listener);

Boolean PowerSettings.setActiveStandbyEnabled

(

[in] Boolean

active

)

Set Active Standby Enabled.

            var isSet = PowerSettings.setActiveStandbyEnabled(true);

Parameters

active

enable activeStandby or not.

Returns

true if function call is successful, false otherwise

Boolean PowerSettings.setAutoTvOffMode

(

[in] enumerations

mode

)

Set auto off mode. Display enters standby after specified hours if there is no user activity during that amount of time. Exceeding values throws runtime error.

            var success = PowerSettings.setAutoTvOffMode(PowerSettings.AutoTvOff4Hour);

Parameters

mode	sets AutoTvOffMode.

Returns

true if function call is successful, false otherwise

Boolean PowerSettings.setSleepTimer

(

[in] enumerations

sleep_timer_value

)

Set 30, 60, 90, or 120 minutes sleep timer. Exceeding values throw runtime error.

            expect(PowerSettings.setSleepTimer(PowerSettings.SLEEP_TIMER_30_MIN)).toBe(true);

Parameters

sleep_timer_value

Value to set for sleep timer.

Returns

true if function call is successful, false otherwise

Member Data Documentation

const Integer PowerSettings.AutoTvOff1Hour = 1

AutoTvOff1Hour mode

const Integer PowerSettings.AutoTvOff2Hour = 2

AutoTvOff2Hour mode

const Integer PowerSettings.AutoTvOff3Hour = 3

AutoTvOff3Hour mode

const Integer PowerSettings.AutoTvOff4Hour = 4

AutoTvOff4Hour mode

const Integer PowerSettings.AutoTvOff5Hour = 5

AutoTvOff5Hour mode

const Integer PowerSettings.AutoTvOff6Hour = 6

AutoTvOff6Hour mode

const Integer PowerSettings.AutoTvOff7Hour = 7

AutoTvOff7Hour mode

const Integer PowerSettings.AutoTvOff8Hour = 8

AutoTvOff8Hour mode

const Integer PowerSettings.AutoTvOffDisabled = 0

AutoTvOffDisabled mode

const Integer PowerSettings.AutoTvOffInvalid = -1

AutoTvOffInvalid mode

const Integer PowerSettings.SLEEP_TIMER_120_MIN = 4

120 minutes sleep timer

const Integer PowerSettings.SLEEP_TIMER_30_MIN = 1

30 minutes sleep timer

const Integer PowerSettings.SLEEP_TIMER_60_MIN = 2

60 minutes sleep timer

const Integer PowerSettings.SLEEP_TIMER_90_MIN = 3

90 minutes sleep timer

const Integer PowerSettings.SLEEP_TIMER_OFF = 0

Sleep timer off

---

The documentation for this interface was generated from the following file:

• PowerSettingsPlugin.idl