Display Manager

Method

This section describes the following method:

  • status

status

Returns the status of the display on the device. If the subscribe parameter is true, then status returns updates (as events) when the screen turns on or off, or dims or brightens.

Parameters

Parameter Type Description
subscribe boolean When set to true, the status method returns events indicating each change in the display's state. When set to false, the status method returns only the current status of the display.

Return Handling

onSuccess

Attribute Type Description
returnValue boolean true
event string Returned periodically when subscribe is true, event describes a change in the state of the display:
  • displayOn--the display turned on
  • displayDimmed--the display dimmed
  • displayOff--the display turned off
  • request--the initial event received in response to the subscription request
state string Describes the state of the display:
  • on
  • off
  • dimmed
subscribed boolean Indicates whether the subscription succeeded.

Example

this.controller.serviceRequest('palm://com.palm.display', {
  method:'status',
  parameters:{}
});