freesmartphone.org Idle Notification Interface

Description

The Idle Notification Interface provides information about a device’s idleness state.

Namespace

org.freesmartphone.Device.IdleNotifier

Methods

Signals

Properties

None

Errors

None

Methods

GetState ( ) → s

Description: Get the current idleness status.

Returns:

s: status The idleness status. Expected values are:

  • “busy”
  • “idle”
  • “idle_dim”
  • “idle_prelock”
  • “lock”
  • “suspend”
  • “awake”

GetTimeouts ( ) → a{si}

Description: Gets a list of all the idle states and their correspondent timeouts.

Returns:

a{si}: status The list of the idle states, and their correspondent timeouts.

SetTimeout ( si )

Description: Sets a timeout value for a given state.

Parameters:*

s: status The idle status. See GetState for a list of valid values.

i: timeout The timeout value. Set to -1 to disable the state.

SetState ( s )

Description: Forces a new idleness status.

Parameters:*

s: status The idle status. See GetState for valid values.

Signals

State ( s )

Description: Sent, when the idleness status has changed.

Parameters:

s: status The idle status. See GetState for a list of expected values.