Private methods:

setState

Private.

com.palm.display/control/setState

Set the state of the display.

Syntax:

{
    "state": string
}

Parameters

state

The state to which the display is set. Can be:

on
dimmed
off
unlock
dock
undock

Returns:

{
    "returnValue": boolean,
    "errorText": string
}

Parameters

@subsection

com_palm_display_control_set_state_examples Examples:

luna-send -n 1 -f luna://com.palm.display/control/setState '{ "state": "dock" }'

Example response for a succesful call:

{
    "returnValue": true
}

Example response for a failed call:

{
    "returnValue": false,
    "errorText": "call failed"
}

getProperty

Private.

com.palm.display/control/getProperty

Get display properties.

Syntax:

{
    "properties": [string array]
}

Parameters

properties

List of properties to get, can include one or more of the following:

requestBlock
powerKeyBlock
timeout
maximumBrightness
onWhenConnected
proximityEnabled

Returns:

{
    "returnValue": boolean,
    "<property name>": <value>,
    ...
    "<property name>": <value>,
    "errorCode": int,
    "errorText": string
}

Parameters

returnValue	Indicates if the call was succesful.
errorCode	Code for the error if call was not succesful.
errorText	Describes the error if call was not succesful.

Examples:

luna-send -n 1 -f luna://com.palm.display/control/getProperty '{ "properties": ["maximumBrightness", "timeout", "requestBlock", "onWhenConnected" ] } '

Example response for a succesful call:

{
    "returnValue": true,
    "maximumBrightness": 75,
    "timeout": 120,
    "requestBlock": false,
    "onWhenConnected": false
}

Example response for a failed call:

{
    "returnValue": false,
    "errorCode": 1,
    "errorText": "failed to get property"
}

setProperty

Private.

com.palm.display/control/setProperty

Set display properties.

Syntax:

{
    "requestBlock": boolean,
    "client": string,
    "powerKeyBlock": boolean,
    "timeout": integer,
    "onWhenConnected": boolean,
    "maximumBrightness": integer,
    "proximityEnabled": boolean
}

Parameters

requestBlock	Block changes of display state. Requires client parameter to be set.
client	Client ID.
powerKeyBlock	Block the power key. Requires client parameter to be set.
timeout	Timeout in seconds for the display to turn off.
onWhenConnected	Should the display remain on when a USB cable is connected to the device.
maximumBrightness	Display maximum brightness.
proximityEnabled	Toggle proximity sensor. Requires client parameter to be set.

Returns:

{
    "returnValue": boolean,
    "errorCode": int,
    "errorText": string
}

Parameters

returnValue	Indicates if the call was succesful.
errorCode	Code for the error if call was not succesful.
errorText	Describes the error if call was not succesful.

Examples:

luna-send -n 1 -f luna://com.palm.display/control/setProperty '{ "timeout": 140 }'

Example response for a succesful call:

{
    "returnValue": true
}

Example response for a failed call:

{
    "returnValue": false,
    "errorCode": 22,
    "errorText": "'powerKeyBlock' needs 'client' string"
}

status

Private.

com.palm.display/control/status

Get the status of the display.

Syntax:

{
    "subscribe": boolean
}

Parameters

subscribe Subscribe for updates.

Returns:

{
    "returnValue": boolean,
    "event": string,
    "state": string,
    "timeout": int,
    "blockDisplay": string,
    "active": boolean,
    "subscribed": boolean
}

Parameters

returnValue	Indicates if the call was succesful.
event	Event that triggered this call.
state	State of the display. "Undefined", "dimmed", "off" or "on".
timeout	Time in seconds after which the display turns off.
blockDisplay	True if display state is blocked from changes.
active	True if the timer that shuts down the display after timeout seconds of inactivity is running.
subscribed	True if subscribed for updates.

Examples:

luna-send -n 1 -f luna://com.palm.display/control/status '{}'

Example response for a succesful call:

{
    "returnValue": true,
    "event": "request",
    "state": "off",
    "timeout": 120,
    "blockDisplay": "false",
    "active": false,
    "subscribed": false
}