interface.uts 3.2 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 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
// export type GetBatteryInfoFail = {
// 	/**
// 	* 错误码
// 	*/
// 	errCode : number,
// 	/**
// 	* 调用API的名称
// 	*/
// 	errSubject : string,
// 	/**
// 	* 错误的详细信息
// 	*/
// 	errMsg : string,
// 	/**
// 	* 错误来源
// 	*/
// 	cause : any | null
// }
31 32 33 34



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

export type GetBatteryInfoResult = {
	/**
	* 设备电量,范围1 - 100
	*/
	level : number,
	/**
	* 是否正在充电中
	*/
	isCharging : boolean
58 59 60 61 62 63 64 65 66 67 68 69 70
}

/**
 * 错误码
 * - 1001 getAppContext is null
 */
export type GetBatteryInfoErrorCode = 1001 ;
/**
 * myApi 的错误回调参数
 */
export interface GetBatteryInfoFail extends IUniError {
  errCode : GetBatteryInfoErrorCode
};
71 72

/**
fxy060608's avatar
fxy060608 已提交
73 74
* 获取电量信息
* @param {GetBatteryInfoOptions} options
75
*
fxy060608's avatar
fxy060608 已提交
76 77 78 79
*
* @tutorial https://uniapp.dcloud.net.cn/api/system/batteryInfo.html
* @platforms APP-IOS = ^9.0,APP-ANDROID = ^22
* @since 3.6.11
80
*
fxy060608's avatar
fxy060608 已提交
81 82 83
* @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_ 已提交
84 85
export type GetBatteryInfo = (options : GetBatteryInfoOptions) => void

86

lizhongyi_'s avatar
lizhongyi_ 已提交
87
export type GetBatteryInfoSync = () => GetBatteryInfoResult
88 89

interface Uni {
杜庆泉's avatar
杜庆泉 已提交
90 91 92 93

	/**
	 * 获取电池电量信息
	 * @description 获取电池电量信息
94
	 * @param {GetBatteryInfoOptions} options
杜庆泉's avatar
杜庆泉 已提交
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
	 * @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_ 已提交
113
	 *            "osVer": "9.0",
杜庆泉's avatar
杜庆泉 已提交
114 115 116 117 118 119 120 121
	 *            "uniVer": "3.6.11",
	 *            "unixVer": "3.9.0"
	 *        }
	 *    }
	 * }
	 * @uniVueVersion 2,3  //支持的vue版本
	 *
	 */
122
	getBatteryInfo (options : GetBatteryInfoOptions) : void,
lizhongyi_'s avatar
lizhongyi_ 已提交
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
	/**
	 * 同步获取电池电量信息
	 * @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",
	 *            "unixVer": "3.9.0"
	 *        }
	 *    }
	 * }
	 * @uniVueVersion 2,3  //支持的vue版本
	 *
	 */
149
	getBatteryInfoSync():GetBatteryInfoResult
杜庆泉's avatar
杜庆泉 已提交
150

151
}