提交 0d8cc240 编写于 作者: 雪洛's avatar 雪洛

docs: 修改getBatteryInfo兼容性

上级 f53f5207
export type GetBatteryInfoSuccess = { export type GetBatteryInfoSuccess = {
errMsg : string, errMsg : string,
/** /**
* 设备电量,范围1 - 100 * 设备电量,范围1 - 100
*/ */
level : number, level : number,
/** /**
* 是否正在充电中 * 是否正在充电中
*/ */
isCharging : boolean isCharging : boolean
} }
export type GetBatteryInfoOptions = { export type GetBatteryInfoOptions = {
/** /**
* 接口调用结束的回调函数(调用成功、失败都会执行) * 接口调用结束的回调函数(调用成功、失败都会执行)
*/ */
success ?: (res : GetBatteryInfoSuccess) => void success ?: (res : GetBatteryInfoSuccess) => void
/** /**
* 接口调用失败的回调函数 * 接口调用失败的回调函数
*/ */
fail ?: (res : UniError) => void fail ?: (res : UniError) => void
/** /**
* 接口调用成功的回调 * 接口调用成功的回调
*/ */
complete ?: (res : any) => void complete ?: (res : any) => void
} }
export type GetBatteryInfoResult = { export type GetBatteryInfoResult = {
/** /**
* 设备电量,范围1 - 100 * 设备电量,范围1 - 100
*/ */
level : number, level : number,
/** /**
* 是否正在充电中 * 是否正在充电中
*/ */
isCharging : boolean isCharging : boolean
} }
/** /**
* 错误码 * 错误码
* - 1001 getAppContext is null * - 1001 getAppContext is null
*/ */
export type GetBatteryInfoErrorCode = 1001 ; export type GetBatteryInfoErrorCode = 1001 ;
/** /**
* GetBatteryInfo 的错误回调参数 * GetBatteryInfo 的错误回调参数
*/ */
export interface GetBatteryInfoFail extends IUniError { export interface GetBatteryInfoFail extends IUniError {
errCode : GetBatteryInfoErrorCode errCode : GetBatteryInfoErrorCode
}; };
/** /**
* 获取电量信息 * 获取电量信息
* @param {GetBatteryInfoOptions} options * @param {GetBatteryInfoOptions} options
* *
* *
* @tutorial https://uniapp.dcloud.net.cn/api/system/batteryInfo.html * @tutorial https://uniapp.dcloud.net.cn/api/system/batteryInfo.html
* @platforms APP-IOS = ^9.0,APP-ANDROID = ^22 * @platforms APP-IOS = ^9.0,APP-ANDROID = ^22
* @since 3.6.11 * @since 3.6.11
* *
* @assert () => success({errCode: 0, errSubject: "uni-getBatteryInfo", errMsg: "getBatteryInfo:ok", level: 60, isCharging: false }) * @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" }) * @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": "12.0", * "osVer": "12.0",
* "uniVer": "3.6.11", * "uniVer": "3.6.11",
* "unixVer": "4.11" * "unixVer": "4.11"
* } * }
* } * },
* } * "web": {
* @uniVueVersion 2,3 //支持的vue版本 * "uniVer": "3.6.11",
* * "unixVer": "4.0"
*/ * }
* }
* @uniVueVersion 2,3 //支持的vue版本
*
*/
getBatteryInfo (options : GetBatteryInfoOptions) : void, getBatteryInfo (options : GetBatteryInfoOptions) : void,
/** /**
* 同步获取电池电量信息 * 同步获取电池电量信息
...@@ -120,11 +124,15 @@ interface Uni { ...@@ -120,11 +124,15 @@ interface Uni {
* "uniVer": "3.6.11", * "uniVer": "3.6.11",
* "unixVer": "4.11" * "unixVer": "4.11"
* } * }
* },
* "web": {
* "uniVer": "3.6.11",
* "unixVer": "4.0"
* } * }
* } * }
* @uniVueVersion 2,3 //支持的vue版本 * @uniVueVersion 2,3 //支持的vue版本
* *
*/ */
getBatteryInfoSync():GetBatteryInfoResult getBatteryInfoSync():GetBatteryInfoResult
} }
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册