interface.uts 2.1 KB
Newer Older
fxy060608's avatar
fxy060608 已提交
1
export type GetBatteryInfoSuccess = {
杜庆泉's avatar
杜庆泉 已提交
2 3 4 5 6 7 8 9 10
	errMsg : string,
	/**
	* 设备电量,范围1 - 100
	*/
	level : number,
	/**
	* 是否正在充电中
	*/
	isCharging : boolean
11 12
}

fxy060608's avatar
fxy060608 已提交
13
export type GetBatteryInfoFail = {
杜庆泉's avatar
杜庆泉 已提交
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
	/**
	* 错误码
	*/
	errCode : number,
	/**
	* 调用API的名称
	*/
	errSubject : string,
	/**
	* 错误的详细信息
	*/
	errMsg : string,
	/**
	* 错误来源
	*/
	cause : any | null
30 31 32 33 34
}



export type GetBatteryInfoOptions = {
杜庆泉's avatar
杜庆泉 已提交
35 36 37 38 39 40 41 42 43 44 45 46
	/**
		* 接口调用结束的回调函数(调用成功、失败都会执行)
		*/
	success ?: (res : GetBatteryInfoSuccess) => void
	/**
		* 接口调用失败的回调函数
		*/
	fail ?: (res : GetBatteryInfoFail) => void
	/**
		* 接口调用成功的回调
		*/
	complete ?: (res : any) => void
47 48 49
}

/**
fxy060608's avatar
fxy060608 已提交
50 51 52 53 54 55 56 57 58 59 60
* 获取电量信息
* @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" })
*/
61 62 63 64
export type GetBatteryInfo = (options : GetBatteryInfoOptions) => void


interface Uni {
杜庆泉's avatar
杜庆泉 已提交
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96

	/**
	 * 获取电池电量信息
	 * @description 获取电池电量信息
	 * @param {GetBatteryInfoOptions} options 
	 * @example
	 * ```typescript
	 * uni.getBatteryInfo({
	 *		success(res) {
	 *			console.log(res);
	 *		}
	 * })
	 * ```
	 * @remark
	 * - 该接口需要同步调用
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "4.4.4",
	 *            "uniVer": "3.6.11",
	 *            "unixVer": "3.9.0"
	 *        },
	 *        "ios": {
	 *            "osVer": "8.0",
	 *            "uniVer": "3.6.11",
	 *            "unixVer": "3.9.0"
	 *        }
	 *    }
	 * }
	 * @uniVueVersion 2,3  //支持的vue版本
	 *
	 */
97
	getBatteryInfo : GetBatteryInfo
杜庆泉's avatar
杜庆泉 已提交
98

99
}