提交 1b3ad13e 编写于 作者: DCloud-yyl's avatar DCloud-yyl

同步uni-getbatteryinfo模块 for HBuilderX3.9.0

上级 c06c4272
declare namespace UniNamespace {
interface GetBatteryInfoSuccessCallbackResult {
/**
* 是否正在充电中
*/
isCharging: boolean;
/**
* 设备电量,范围 1 - 100
*/
level: number;
errMsg: string;
}
interface GetBatteryInfoOption {
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete?: Function
/**
* 接口调用失败的回调函数
*/
fail?: Function
/**
* 接口调用成功的回调函数
*/
success?: (result: GetBatteryInfoSuccessCallbackResult) => void
}
}
declare interface Uni {
/**
* 获取设备电量
*
* 文档: [https://uniapp.dcloud.net.cn/api/system/batteryInfo.html](https://uniapp.dcloud.net.cn/api/system/batteryInfo.html)
*/
getBatteryInfo(option?: UniNamespace.GetBatteryInfoOption): void;
}
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
], ],
"repository": "", "repository": "",
"engines": { "engines": {
"HBuilderX": "^3.6.0" "HBuilderX": "^3.9.0"
}, },
"dcloudext": { "dcloudext": {
"type": "uts", "type": "uts",
...@@ -32,10 +32,12 @@ ...@@ -32,10 +32,12 @@
}, },
"uni_modules": { "uni_modules": {
"uni-ext-api": { "uni-ext-api": {
"uni": [ "uni": {
"getBatteryInfo", "getBatteryInfo": "getBatteryInfo",
"getBatteryInfoSync" "getBatteryInfoSync": {
] "web": false
}
}
}, },
"dependencies": [], "dependencies": [],
"encrypt": [], "encrypt": [],
......
export type GetBatteryInfoSuccess = { export type GetBatteryInfoSuccess = {
errMsg : string, errMsg : string,
/** /**
* 设备电量,范围1 - 100 * 设备电量,范围1 - 100
*/ */
level : number, level : number,
/** /**
* 是否正在充电中 * 是否正在充电中
*/ */
isCharging : boolean isCharging : boolean
} }
export type GetBatteryInfoFail = { // export type GetBatteryInfoFail = {
/** // /**
* 错误码 // * 错误码
*/ // */
errCode : number, // errCode : number,
/** // /**
* 调用API的名称 // * 调用API的名称
*/ // */
errSubject : string, // errSubject : string,
/** // /**
* 错误的详细信息 // * 错误的详细信息
*/ // */
errMsg : string, // errMsg : string,
/** // /**
* 错误来源 // * 错误来源
*/ // */
cause : any | null // cause : any | null
} // }
export type GetBatteryInfoOptions = { export type GetBatteryInfoOptions = {
/** /**
* 接口调用结束的回调函数(调用成功、失败都会执行) * 接口调用结束的回调函数(调用成功、失败都会执行)
*/ */
success ?: (res : GetBatteryInfoSuccess) => void success ?: (res : GetBatteryInfoSuccess) => void
/** /**
* 接口调用失败的回调函数 * 接口调用失败的回调函数
*/ */
fail ?: (res : GetBatteryInfoFail) => void fail ?: (res : UniError) => void
/** /**
* 接口调用成功的回调 * 接口调用成功的回调
*/ */
complete ?: (res : any) => void complete ?: (res : any) => void
}
export type GetBatteryInfoResult = {
/**
* 设备电量,范围1 - 100
*/
level : number,
/**
* 是否正在充电中
*/
isCharging : boolean
} }
/** export type GetBatteryInfoResult = {
* 获取电量信息 /**
* @param {GetBatteryInfoOptions} options * 设备电量,范围1 - 100
* */
* level : number,
* @tutorial https://uniapp.dcloud.net.cn/api/system/batteryInfo.html /**
* @platforms APP-IOS = ^9.0,APP-ANDROID = ^22 * 是否正在充电中
* @since 3.6.11 */
* isCharging : boolean
* @assert () => success({errCode: 0, errSubject: "uni-getBatteryInfo", errMsg: "getBatteryInfo:ok", level: 60, isCharging: false }) }
* @assert () => fail({errCode: 1001, errSubject: "uni-getBatteryInfo", errMsg: "getBatteryInfo:fail getAppContext is null" })
*/ /**
* 获取电量信息
* @param {GetBatteryInfoOptions} options
*
*
* @tutorial https://uniapp.dcloud.net.cn/api/system/batteryInfo.html
* @platforms APP-IOS = ^9.0,APP-ANDROID = ^22
* @since 3.6.11
*
* @assert () => success({errCode: 0, errSubject: "uni-getBatteryInfo", errMsg: "getBatteryInfo:ok", level: 60, isCharging: false })
* @assert () => fail({errCode: 1001, errSubject: "uni-getBatteryInfo", errMsg: "getBatteryInfo:fail getAppContext is null" })
*/
export type GetBatteryInfo = (options : GetBatteryInfoOptions) => void export type GetBatteryInfo = (options : GetBatteryInfoOptions) => void
export type GetBatteryInfoSync = () => GetBatteryInfoResult export type GetBatteryInfoSync = () => GetBatteryInfoResult
interface Uni { interface Uni {
/** /**
* 获取电池电量信息 * 获取电池电量信息
* @description 获取电池电量信息 * @description 获取电池电量信息
* @param {GetBatteryInfoOptions} options * @param {GetBatteryInfoOptions} options
* @example * @example
* ```typescript * ```typescript
* uni.getBatteryInfo({ * uni.getBatteryInfo({
* success(res) { * success(res) {
* console.log(res); * console.log(res);
* } * }
* }) * })
* ``` * ```
* @remark * @remark
* - 该接口需要同步调用 * - 该接口需要同步调用
* @uniPlatform { * @uniPlatform {
* "app": { * "app": {
* "android": { * "android": {
* "osVer": "4.4.4", * "osVer": "4.4.4",
* "uniVer": "3.6.11", * "uniVer": "3.6.11",
* "unixVer": "3.9.0" * "unixVer": "3.9.0"
* }, * },
* "ios": { * "ios": {
* "osVer": "9.0", * "osVer": "9.0",
* "uniVer": "3.6.11", * "uniVer": "3.6.11",
* "unixVer": "3.9.0" * "unixVer": "3.9.0"
* } * }
* } * }
* } * }
* @uniVueVersion 2,3 //支持的vue版本 * @uniVueVersion 2,3 //支持的vue版本
* *
*/ */
getBatteryInfo : GetBatteryInfo, getBatteryInfo : GetBatteryInfo,
/** /**
* 同步获取电池电量信息 * 同步获取电池电量信息
...@@ -134,6 +134,6 @@ interface Uni { ...@@ -134,6 +134,6 @@ interface Uni {
* @uniVueVersion 2,3 //支持的vue版本 * @uniVueVersion 2,3 //支持的vue版本
* *
*/ */
getBatteryInfoSync: GetBatteryInfoSync getBatteryInfoSync: GetBatteryInfoSync
} }
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册