interface.uts 2.9 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 13
}

export type GetBatteryInfoOptions = {
杜庆泉's avatar
杜庆泉 已提交
14 15 16 17 18 19 20
	/**
		* 接口调用结束的回调函数(调用成功、失败都会执行)
		*/
	success ?: (res : GetBatteryInfoSuccess) => void
	/**
		* 接口调用失败的回调函数
		*/
21
	fail ?: (res : UniError) => void
杜庆泉's avatar
杜庆泉 已提交
22 23 24 25
	/**
		* 接口调用成功的回调
		*/
	complete ?: (res : any) => void
lizhongyi_'s avatar
lizhongyi_ 已提交
26 27 28 29 30 31 32 33 34 35 36
}

export type GetBatteryInfoResult = {
	/**
	* 设备电量,范围1 - 100
	*/
	level : number,
	/**
	* 是否正在充电中
	*/
	isCharging : boolean
37 38 39 40 41 42 43 44
}

/**
 * 错误码
 * - 1001 getAppContext is null
 */
export type GetBatteryInfoErrorCode = 1001 ;
/**
45
 * GetBatteryInfo 的错误回调参数
46 47 48 49
 */
export interface GetBatteryInfoFail extends IUniError {
  errCode : GetBatteryInfoErrorCode
};
50 51

/**
fxy060608's avatar
fxy060608 已提交
52 53
* 获取电量信息
* @param {GetBatteryInfoOptions} options
54
*
fxy060608's avatar
fxy060608 已提交
55 56 57 58
*
* @tutorial https://uniapp.dcloud.net.cn/api/system/batteryInfo.html
* @platforms APP-IOS = ^9.0,APP-ANDROID = ^22
* @since 3.6.11
59
*
fxy060608's avatar
fxy060608 已提交
60 61 62
* @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" })
*/
lizhongyi_'s avatar
lizhongyi_ 已提交
63 64
export type GetBatteryInfo = (options : GetBatteryInfoOptions) => void

65

lizhongyi_'s avatar
lizhongyi_ 已提交
66
export type GetBatteryInfoSync = () => GetBatteryInfoResult
67 68

interface Uni {
杜庆泉's avatar
杜庆泉 已提交
69 70 71 72

	/**
	 * 获取电池电量信息
	 * @description 获取电池电量信息
73
	 * @param {GetBatteryInfoOptions} options
杜庆泉's avatar
杜庆泉 已提交
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
	 * @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": {
lizhongyi_'s avatar
lizhongyi_ 已提交
92
	 *            "osVer": "9.0",
杜庆泉's avatar
杜庆泉 已提交
93
	 *            "uniVer": "3.6.11",
lizhongyi_'s avatar
lizhongyi_ 已提交
94
	 *            "unixVer": "x"
杜庆泉's avatar
杜庆泉 已提交
95 96 97 98 99 100
	 *        }
	 *    }
	 * }
	 * @uniVueVersion 2,3  //支持的vue版本
	 *
	 */
101
	getBatteryInfo (options : GetBatteryInfoOptions) : void,
lizhongyi_'s avatar
lizhongyi_ 已提交
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
	/**
	 * 同步获取电池电量信息
	 * @description 获取电池电量信息
	 * @example
	 * ```typescript
	 * uni.getBatteryInfo()
	 * ```
	 * @remark
	 * - 该接口需要同步调用
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "4.4.4",
	 *            "uniVer": "3.6.11",
	 *            "unixVer": "3.9.0"
	 *        },
	 *        "ios": {
	 *            "osVer": "9.0",
	 *            "uniVer": "3.6.11",
lizhongyi_'s avatar
lizhongyi_ 已提交
121
	 *            "unixVer": "x"
lizhongyi_'s avatar
lizhongyi_ 已提交
122 123 124 125 126 127
	 *        }
	 *    }
	 * }
	 * @uniVueVersion 2,3  //支持的vue版本
	 *
	 */
128
	getBatteryInfoSync():GetBatteryInfoResult
杜庆泉's avatar
杜庆泉 已提交
129

130
}