Battery API

This API provides information about device battery.

MacOS/WebKit does not support this API. In the future, it may be implemented using native syscalls.

The API is available in the WebView::$battery property.

$app = new Boson\Application();

$app->webview->battery; // Access to Battery API

#Battery Level

To get the current battery charge level you can use the read-only $level property. The battery level contain a float value between 0.0 and 1.0.

$level = $app->webview->battery->level;

echo 'Charge level is ' . (int) ($level * 100) . '%';

// 
// Expects: Charge level is 100%
// 

For non-mobile devices the charge level is always 1.0

#Charging Status

To get the battery charging status you can use the read-only $isCharging property.

$isCharging = $app->webview->battery->isCharging;

echo 'The battery is ' . ($isCharging ? '' : 'not ') . 'charging now';
// 
// Expects: The battery is charging now
// 

For non-mobile devices the charging status is always true

#Charging Time

To get the time until the battery is fully charged, use the read-only $chargingTime property. The charging time property will contain an integer value in seconds.

$chargingTime = $app->webview->battery->chargingTime;

echo vsprintf('It takes another %d seconds to fully charge', [
    $chargingTime,
]);

For non-mobile devices the charging time is always 0

#Discharging Time

To get the time until the battery is fully discharged, use the read-only $dischargingTime property. The discharging time property will contain an integer value in seconds or null in case the discharge time is not available.

$dischargingTime = $app->webview->battery->dischargingTime;

if ($dischargingTime === null) {
    echo 'Battery is missing';
    
    return;
}

echo vsprintf('It takes another %d seconds to fully discharge', [
    $dischargingTime,
]);

For non-mobile devices the discharging time is always null

#Events

The battery will automatically emit the following events (and intentions) during its lifecycle.

More information about events can be found in the events documentation.

#Charging State Changed Event

An Boson\WebView\Api\Battery\Event\BatteryChargingStateChanged event fired after charging state has been changed.

class BatteryChargingStateChanged<WebView>
{
    public readonly bool $isCharging;
}

#Charging Level Changed Event

An Boson\WebView\Api\Battery\Event\BatteryLevelChanged event fired after charging level has been changed.

class BatteryLevelChanged<WebView>
{
    public readonly float<0.0, 1.0> $level;
}

#Charging Time Changed Event

An Boson\WebView\Api\Battery\Event\BatteryChargingTimeChanged event fired after charging time has been changed.

class BatteryChargingTimeChanged<WebView>
{
    public readonly int<0, max> $chargingTime;
}

#Discharging Time Changed Event

An Boson\WebView\Api\Battery\Event\BatteryDischargingTimeChanged event fired after discharging time has been changed.

class BatteryDischargingTimeChanged<WebView>
{
    public readonly ?int<0, max> $dischargingTime;
}