Back to Uni App

Get Battery Info

docs/api/get-battery-info.md

2.3.37.1 KB
Original Source

uni.getBatteryInfo(options) @getbatteryinfo

获取电池电量信息

本 API 是 uni ext api,需下载插件:uni-getbatteryinfo

getBatteryInfo 兼容性

Web微信小程序AndroidAndroid uni-app x UTS 插件iOSiOS uni-app x UTS 插件HarmonyOS
4.04.353.93.94.114.11<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>

参数

名称类型必填默认值兼容性描述
optionsGetBatteryInfoOptions-Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

options 的属性描述

名称类型必备默认值兼容性描述
success(res: GetBatteryInfoSuccess) => void-Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x接口调用成功的回调
fail(res: UniError) => void-Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x接口调用失败的回调函数
complete(res: any) => void-Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x接口调用结束的回调函数(调用成功、失败都会执行)

GetBatteryInfoSuccess 的属性值 @getbatteryinfosuccess-values

名称类型必备默认值兼容性描述
errMsgstring-Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
levelnumber-Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x设备电量,范围1 - 100
isChargingboolean-Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x是否正在充电中

示例

示例为hello uni-app x alpha分支,与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例另见 ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-battery-info/get-battery-info

appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/get-battery-info/get-battery-info

示例

vue
<template>
  <view>
    <text>当前电量:{{data.level}}%</text>
    <text>是否充电中:{{data.isCharging}}</text>
  </view>
</template>

<script setup lang="uts">
  type DataType = {
    level: number;
    isCharging: boolean;
  }

  const data = reactive({
    level: 0,
    isCharging: false
  } as DataType)

  onLoad(() => {
    try {
      uni.getBatteryInfo({
        success: res => {
          data.level = res.level;
          data.isCharging = res.isCharging;
        }
      });
    } catch (e) {
      console.error((e as Error).message);
      uni.showModal({
        content: (e as Error).message,
        showCancel: false
      });
    }
  })

  defineExpose({
    data
  })
</script>

:::

参见

uni.getBatteryInfoSync() @getbatteryinfosync

同步获取电池电量信息

本 API 是 uni ext api,需下载插件:uni-getbatteryinfo

getBatteryInfoSync 兼容性

Web微信小程序AndroidAndroid uni-app x UTS 插件iOSiOS uni-app x UTS 插件HarmonyOS
4.04.353.93.94.114.11<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>

返回值

类型
GetBatteryInfoResult

GetBatteryInfoResult 的属性描述

名称类型必备默认值兼容性描述
levelnumber-Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x设备电量,范围1 - 100
isChargingboolean-Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x是否正在充电中
<!-- UTSAPIJSON.getBatteryInfoSync.example -->

参见

通用类型

GeneralCallbackResult

名称类型必备默认值兼容性描述
errMsgstring-Web: -; 微信小程序: 4.41; Android: -; iOS: -; HarmonyOS: -错误信息