GetPowerOptions

Will return information about the power options of the device

Syntax

Method ID

#define WAAPI_MID_GET_POWER_OPTIONS 30007

JSON Input Structure

{
  "input": {
    "method": 30007
  }
}

Input Properties

This method does not require any additional parameters beyond the method ID.

JSON Output Structure

{
  "result": {
    "method": 30007,
    "code": number,
    "timing": number,
    "timestamp": string,
    "on_battery": boolean,
    "screen_off_timeout": number,
    "sleep_timeout": number,
    "screen_saver": {
      "timeout": number,
      "is_secure": boolean
    },
    "required_password_timeout": number
  }
}

Output Properties

Property	Type	Description
`result.method`	number	The method ID that generated this result.
`result.code`	number	The result code. See Result Codes.
`result.timing`	number	The measured time for the method call in milliseconds.
`result.timestamp`	string	The timestamp in seconds of when the call was made.
`result.on_battery`	boolean	(optional) Indicates the device is using battery. (Linux) Support GNOME, Cinnamon, KDE Plasma and Xfce4 (with Light Locker disabled) only
`result.screen_off_timeout`	number	(optional) Timeout to turn off screen in seconds. (Linux) Support Cinnamon, KDE Plasma and Xfce4 (with Light Locker disabled) only
`result.sleep_timeout`	number	(optional) Timeout to sleep device in seconds. (Linux) Support GNOME, KDE Plasma and Xfce4 (with Light Locker disabled) only
`result.screen_saver`	object	(optional) Detail information of screen_saver. (Linux) Support GNOME, Cinnamon, KDE Plasma and Xfce4 (with Light Locker disabled) only
`result.screen_saver.timeout`	number	(optional) Timeout to enter screen saver mode in seconds. (Linux) Support GNOME, Cinnamon, KDE Plasma and Xfce4 (with Light Locker disabled) only
`result.screen_saver.is_secure`	boolean	(optional) Require login after entering screen saver mode. (Windows) Supported. (macOS) Support only for macOS Big Sur and later. (Linux) Support GNOME, Cinnamon, KDE Plasma and Xfce4 (with Light Locker disabled) only
`result.required_password_timeout`	number	(optional) (macOS, Linux only) Timeout to require login after sleep or screen saver begins (0: never, -1: immediate, >0: number of seconds). (macOS) Support only for macOS Big Sur and later. Only show when getting info successfully. (Linux) Support GNOME, Cinnamon, KDE Plasma and Xfce4 (with Light Locker disabled) only

Result Codes

Code	Name	Description
0	`WAAPI_OK`	The operation completed successfully.

note

Other codes may be returned. See the full Result Codes reference for the complete list.

Remarks

Error Handling

The results of this function are determined by the error code returned by the call. If successful, WAAPI_OK or a special success code will be returned. Always check both the function return value and the result.code field in the output JSON.

Examples

Examples will be added here demonstrating the usage of this method.

Syntax​

Method ID​

JSON Input Structure​

Input Properties​

JSON Output Structure​

Output Properties​

Result Codes​

Remarks​

Error Handling​

Examples​

See Also​