Star897
5795
代码
代码
Issues905
Pull Requests1208
项目讨论
Wiki
分析
Star897
5795
已合并
fix: add js example code & fix docs description #135232
cjw123qq创建于 3月21日
fix: add js example code & fix docs description #135232
已合并
cjw123qq创建于 3月21日
从cjw123qq/docsmaster合入到openharmony/docsmaster
共 5 个文件变更+311-10
Mzh-cn/application-dev/reference/apis-basic-services-kit/capi-ohbattery-info-h.md+1-1
@@ -77,7 +77,7 @@ int32_t OH_BatteryInfo_GetCapacity()
77 77 
78**描述**78**描述**
79 79 
80-返回当前电池容量。80+返回当前电池容量百分比。
81 81 
82**系统能力：** SystemCapability.PowerManager.BatteryManager.Core82**系统能力：** SystemCapability.PowerManager.BatteryManager.Core
83 83 
Mzh-cn/application-dev/reference/apis-basic-services-kit/js-apis-battery-info.md+1-1
@@ -28,7 +28,7 @@ import {batteryInfo} from '@kit.BasicServicesKit';
28 28 
29| 名称 | 类型 | 只读 | 说明 |29| 名称 | 类型 | 只读 | 说明 |
30| --------------- | ------------------- | ---- | ---------------------|30| --------------- | ------------------- | ---- | ---------------------|
31-| batterySOC | number | 是 | 表示当前设备剩余电池电量百分比。<br>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 |31+| batterySOC | number | 是 | 表示当前设备剩余电池电量百分比，取值范围是[0，100]。<br>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 |
32| chargingStatus | [BatteryChargeState](#batterychargestate) | 是 | 表示当前设备电池的充电状态。<br>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 |32| chargingStatus | [BatteryChargeState](#batterychargestate) | 是 | 表示当前设备电池的充电状态。<br>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 |
33| healthStatus | [BatteryHealthState](#batteryhealthstate) | 是 | 表示当前设备电池的健康状态。 |33| healthStatus | [BatteryHealthState](#batteryhealthstate) | 是 | 表示当前设备电池的健康状态。 |
34| pluggedType | [BatteryPluggedType](#batterypluggedtype) | 是 | 表示当前设备连接的充电器类型。 |34| pluggedType | [BatteryPluggedType](#batterypluggedtype) | 是 | 表示当前设备连接的充电器类型。 |
Mzh-cn/application-dev/reference/apis-basic-services-kit/js-apis-batteryStatistics-sys.md+2-2
@@ -159,7 +159,7 @@ getAppPowerPercent(uid: number): number
159 159 
160| 类型 | 说明 |160| 类型 | 说明 |
161| ------ | ------------------------- |161| ------ | ------------------------- |
162-| number | UID对应应用的耗电百分比。 |162+| number | UID对应应用的耗电百分比，取值范围是[0.00，1.00]。 |
163 163 
164**错误码：**164**错误码：**
165 165 
@@ -245,7 +245,7 @@ getHardwareUnitPowerPercent(type: ConsumptionType): number
245 245 
246| 类型 | 说明 |246| 类型 | 说明 |
247| ------ | ---------------------------------- |247| ------ | ---------------------------------- |
248-| number | 电量消耗类型对应硬件的耗电百分比。 |248+| number | 电量消耗类型对应硬件的耗电百分比，取值范围是[0.00，1.00]。 |
249 249 
250**错误码：**250**错误码：**
251 251 
Mzh-cn/application-dev/reference/apis-basic-services-kit/js-apis-system-battery.md+55-1
@@ -45,6 +45,7 @@ getStatus(options?: GetStatusOptions): void;
45 45 
46**示例：**46**示例：**
47 47 
48+ArkTS示例：
48```js49```js
49Battery.getStatus({50Battery.getStatus({
50 success: (data: BatteryResponse) => {51 success: (data: BatteryResponse) => {
@@ -56,6 +57,59 @@ Battery.getStatus({
56});57});
57```58```
58 59 
60+JS示例：
61+```xml
62+<!-- xxx.hml -->
63+<div class="container">
64+ <input type="button" value="Get Data" style="width: 240px; height: 50px; margin: 5px;" onclick="getBatteryInfo"></input>
65+ <text class="title">level: {{ capacity }}</text>
66+ <text class="title">charging: {{ charging }}</text>
67+</div>
68+```
69+```css
70+/* xxx.css */
71+.container {
72+ width: 100%;
73+ height: 100%;
74+ justify-content: center;
75+ align-items: center;
76+ flex-direction: column;
77+}
78+.title {
79+ width: 200px;
80+ font-size: 30px;
81+ text-align: center;
82+}
83+```
84+```js
85+// xxx.js
86+import Battery from '@system.battery';
87+ 
88+export default {
89+ data: {
90+ capacity: '',
91+ charging: ''
92+ },
93+ getBatteryInfo() {
94+ let TAG = 'get_status_success_test';
95+ Battery.getStatus({
96+ success: (batteryResponse) => {
97+ this.capacity = batteryResponse.level;
98+ this.charging = batteryResponse.charging;
99+ console.info(`${TAG} batteryResponse.level: ${batteryResponse.level}`);
100+ console.info(`${TAG} batteryResponse.charging: ${batteryResponse.charging}`);
101+ },
102+ fail: (data, code) => {
103+ console.error(`${TAG} fail data: ${data}, code: ${code}`);
104+ },
105+ complete: () => {
106+ console.info(`${TAG} getStatus complete`);
107+ }
108+ });
109+ },
110+}
111+```
112+ 
59## GetStatusOptions<sup>(deprecated)</sup>113## GetStatusOptions<sup>(deprecated)</sup>
60 114 
61包含接口调用结果的对象。115包含接口调用结果的对象。
@@ -77,4 +131,4 @@ Battery.getStatus({
77| 名称 | 类型 | 只读 | 可选 | 说明 |131| 名称 | 类型 | 只读 | 可选 | 说明 |
78| -------- | -------- | -------- | -------- | -------- |132| -------- | -------- | -------- | -------- | -------- |
79| charging | boolean | 否 | 否 | 当前电池是否在充电中。true表示在充电，false表示没有充电，默认为false。<br>**说明：** 除Lite Wearable外，从API Version 6开始不再维护，建议使用[`batteryInfo.chargingStatus`](js-apis-battery-info.md#常量)替代。 |133| charging | boolean | 否 | 否 | 当前电池是否在充电中。true表示在充电，false表示没有充电，默认为false。<br>**说明：** 除Lite Wearable外，从API Version 6开始不再维护，建议使用[`batteryInfo.chargingStatus`](js-apis-battery-info.md#常量)替代。 |
80-| level | number | 否 | 否 | 当前电池的电量，取值范围：0.00&nbsp;-&nbsp;1.00&nbsp;。 <br>**说明：** 除Lite Wearable外，从API Version 6开始不再维护，建议使用[`batteryInfo.batterySOC`](js-apis-battery-info.md#常量)替代。 |134+| level | number | 否 | 否 | 当前电池的电量百分比，取值范围：0.00&nbsp;-&nbsp;1.00&nbsp;。 <br>**说明：** 除Lite Wearable外，从API Version 6开始不再维护，建议使用[`batteryInfo.batterySOC`](js-apis-battery-info.md#常量)替代。 |
Mzh-cn/application-dev/reference/apis-basic-services-kit/js-apis-system-brightness.md+252-5
@@ -45,10 +45,11 @@ getValue(options?: GetBrightnessOptions): void
45 45 
46**示例：**46**示例：**
47 47 
48+ArkTS示例：
48 ```js49 ```js
49 brightness.getValue({50 brightness.getValue({
50 success: (data: BrightnessResponse) => {51 success: (data: BrightnessResponse) => {
51- console.log('success get brightness value:' + data.value);52+ console.info('success get brightness value:' + data.value);
52 },53 },
53 fail: (data: string, code: number) => {54 fail: (data: string, code: number) => {
54 console.error('get brightness fail, code: ' + code + ', data: ' + data);55 console.error('get brightness fail, code: ' + code + ', data: ' + data);
@@ -56,6 +57,54 @@ getValue(options?: GetBrightnessOptions): void
56 });57 });
57 ```58 ```
58 59 
60+JS示例：
61+```xml
62+<!-- xxx.hml -->
63+<div class="container">
64+ <input type="button" value="Get Value" style="width: 240px; height: 50px; margin: 5px;" onclick="getValue"></input>
65+ <text class="title">getValue: {{ value }}</text>
66+</div>
67+```
68+```css
69+/* xxx.css */
70+.container {
71+ width: 100%;
72+ height: 100%;
73+ justify-content: center;
74+ align-items: center;
75+ flex-direction: column;
76+}
77+.title {
78+ width: 200px;
79+ font-size: 30px;
80+ text-align: center;
81+}
82+```
83+```js
84+// xxx.js
85+import brightness from '@system.brightness';
86+ 
87+export default {
88+ data: {
89+ value: ''
90+ },
91+ getValue() {
92+ let TAG = 'get_value_success_test';
93+ brightness.getValue({
94+ success: (brightnessResponse) => {
95+ this.value = brightnessResponse.value;
96+ console.info(`${TAG} brightnessResponse.value: ${brightnessResponse.value}`);
97+ },
98+ fail: (data, code) => {
99+ console.error(`${TAG} fail data: ${data}, code: ${code}`);
100+ },
101+ complete: () => {
102+ console.info(`${TAG} getValue complete`);
103+ }
104+ });
105+ },
106+}
107+```
59 108 
60## brightness.setValue<sup>(deprecated)</sup>109## brightness.setValue<sup>(deprecated)</sup>
61 110 
@@ -73,11 +122,12 @@ setValue(options?: SetBrightnessOptions): void
73 122 
74**示例：**123**示例：**
75 124 
125+ArkTS示例：
76 ```js126 ```js
77 brightness.setValue({127 brightness.setValue({
78 value: 100,128 value: 100,
79 success: () => {129 success: () => {
80- console.log('handling set brightness success.');130+ console.info('handling set brightness success.');
81 },131 },
82 fail: (data: string, code: number) => {132 fail: (data: string, code: number) => {
83 console.error('handling set brightness value fail, code:' + code + ', data: ' + data);133 console.error('handling set brightness value fail, code:' + code + ', data: ' + data);
@@ -85,6 +135,54 @@ setValue(options?: SetBrightnessOptions): void
85 });135 });
86 ```136 ```
87 137 
138+JS示例：
139+```xml
140+<!-- xxx.hml -->
141+<div class="container">
142+ <input type="button" value="Set Value" style="width: 240px; height: 50px; margin: 5px;" onclick="setValue"></input>
143+ <text class="title">setValue: {{ value }}</text>
144+</div>
145+```
146+```css
147+/* xxx.css */
148+.container {
149+ width: 100%;
150+ height: 100%;
151+ justify-content: center;
152+ align-items: center;
153+ flex-direction: column;
154+}
155+.title {
156+ width: 200px;
157+ font-size: 30px;
158+ text-align: center;
159+}
160+```
161+```js
162+// xxx.js
163+import brightness from '@system.brightness';
164+ 
165+export default {
166+ data: {
167+ value: 100
168+ },
169+ setValue() {
170+ let TAG = 'set_value_success_test';
171+ brightness.setValue({
172+ value: this.value,
173+ success: () => {
174+ console.info(`${TAG} setValue success!`);
175+ },
176+ fail: (data, code) => {
177+ console.error(`${TAG} fail data: ${data}, code: ${code}`);
178+ },
179+ complete: () => {
180+ console.info(`${TAG} setValue complete`);
181+ }
182+ });
183+ },
184+}
185+```
88 186 
89## brightness.getMode<sup>(deprecated)</sup>187## brightness.getMode<sup>(deprecated)</sup>
90 188 
@@ -102,10 +200,11 @@ getMode(options?: GetBrightnessModeOptions): void
102 200 
103**示例：**201**示例：**
104 202 
203+ArkTS示例：
105 ```js204 ```js
106 brightness.getMode({205 brightness.getMode({
107 success: (data: BrightnessModeResponse) => {206 success: (data: BrightnessModeResponse) => {
108- console.log('success get mode:' + data.mode);207+ console.info('success get mode:' + data.mode);
109 },208 },
110 fail: (data: string, code: number) => {209 fail: (data: string, code: number) => {
111 console.error('handling get mode fail, code:' + code + ', data: ' + data);210 console.error('handling get mode fail, code:' + code + ', data: ' + data);
@@ -113,6 +212,54 @@ getMode(options?: GetBrightnessModeOptions): void
113 });212 });
114 ```213 ```
115 214 
215+JS示例：
216+```xml
217+<!-- xxx.hml -->
218+<div class="container">
219+ <input type="button" value="Get Mode" style="width: 240px; height: 50px; margin: 5px;" onclick="getMode"></input>
220+ <text class="title">getMode: {{ mode }}</text>
221+</div>
222+```
223+```css
224+/* xxx.css */
225+.container {
226+ width: 100%;
227+ height: 100%;
228+ justify-content: center;
229+ align-items: center;
230+ flex-direction: column;
231+}
232+.title {
233+ width: 200px;
234+ font-size: 30px;
235+ text-align: center;
236+}
237+```
238+```js
239+// xxx.js
240+import brightness from '@system.brightness';
241+ 
242+export default {
243+ data: {
244+ mode: ''
245+ },
246+ getMode() {
247+ let TAG = 'get_mode_success_test';
248+ brightness.getMode({
249+ success: (brightnessModeResponse) => {
250+ this.mode = brightnessModeResponse.mode;
251+ console.info(`${TAG} brightnessModeResponse mode: ${brightnessModeResponse.mode}`);
252+ },
253+ fail: (data, code) => {
254+ console.error(`${TAG} fail data: ${data}, code: ${code}`);
255+ },
256+ complete: () => {
257+ console.info(`${TAG} getMode complete`);
258+ }
259+ });
260+ },
261+}
262+```
116 263 
117## brightness.setMode<sup>(deprecated)</sup>264## brightness.setMode<sup>(deprecated)</sup>
118 265 
@@ -129,11 +276,12 @@ setMode(options?: SetBrightnessModeOptions): void
129 276 
130**示例：**277**示例：**
131 278 
279+ArkTS示例：
132 ```js280 ```js
133 brightness.setMode({281 brightness.setMode({
134 mode: 1,282 mode: 1,
135 success: () => {283 success: () => {
136- console.log('handling set mode success.');284+ console.info('handling set mode success.');
137 },285 },
138 fail: (data: string, code: number) => {286 fail: (data: string, code: number) => {
139 console.error('handling set mode fail, code:' + code + ', data: ' + data);287 console.error('handling set mode fail, code:' + code + ', data: ' + data);
@@ -141,6 +289,54 @@ setMode(options?: SetBrightnessModeOptions): void
141 });289 });
142 ```290 ```
143 291 
292+JS示例：
293+```xml
294+<!-- xxx.hml -->
295+<div class="container">
296+ <input type="button" value="Set Mode" style="width: 240px; height: 50px; margin: 5px;" onclick="setMode"></input>
297+ <text class="title">setMode: {{ mode }}</text>
298+</div>
299+```
300+```css
301+/* xxx.css */
302+.container {
303+ width: 100%;
304+ height: 100%;
305+ justify-content: center;
306+ align-items: center;
307+ flex-direction: column;
308+}
309+.title {
310+ width: 200px;
311+ font-size: 30px;
312+ text-align: center;
313+}
314+```
315+```js
316+// xxx.js
317+import brightness from '@system.brightness';
318+ 
319+export default {
320+ data: {
321+ mode: 1
322+ },
323+ setMode() {
324+ let TAG = 'set_mode_success_test';
325+ brightness.setMode({
326+ mode: this.mode,
327+ success: () => {
328+ console.info(`${TAG} setMode success`);
329+ },
330+ fail: (data, code) => {
331+ console.error(`${TAG} fail data: ${data}, code: ${code}`);
332+ },
333+ complete: () => {
334+ console.info(`${TAG} setMode complete`);
335+ }
336+ });
337+ },
338+}
339+```
144 340 
145## brightness.setKeepScreenOn<sup>(deprecated)</sup>341## brightness.setKeepScreenOn<sup>(deprecated)</sup>
146 342 
@@ -160,17 +356,68 @@ setKeepScreenOn(options?: SetKeepScreenOnOptions): void
160 356 
161**示例：**357**示例：**
162 358 
359+ArkTS示例：
163 ```js360 ```js
164 brightness.setKeepScreenOn({361 brightness.setKeepScreenOn({
165 keepScreenOn: true,362 keepScreenOn: true,
166 success: () => {363 success: () => {
167- console.log('handling set keep screen on success.');364+ console.info('handling set keep screen on success.');
168 },365 },
169 fail: (data: string, code: number) => {366 fail: (data: string, code: number) => {
170 console.error('handling set keep screen on fail, code:' + code + ', data: ' + data);367 console.error('handling set keep screen on fail, code:' + code + ', data: ' + data);
171 }368 }
172 });369 });
173 ```370 ```
371+ 
372+JS示例：
373+```xml
374+<!-- xxx.hml -->
375+<div class="container">
376+ <input type="button" value="SetKeepScreenOn" style="width: 240px; height: 50px; margin: 5px;" onclick="setKeepScreenOn"></input>
377+ <text class="title">setKeepScreenOn: {{ keepScreenOn }}</text>
378+</div>
379+```
380+```css
381+/* xxx.css */
382+.container {
383+ width: 100%;
384+ height: 100%;
385+ justify-content: center;
386+ align-items: center;
387+ flex-direction: column;
388+}
389+.title {
390+ width: 200px;
391+ font-size: 30px;
392+ text-align: center;
393+}
394+```
395+```js
396+// xxx.js
397+import brightness from '@system.brightness';
398+ 
399+export default {
400+ data: {
401+ keepScreenOn: true
402+ },
403+ setKeepScreenOn() {
404+ let TAG = 'set_keep_screen_on_success_test';
405+ brightness.setKeepScreenOn({
406+ keepScreenOn: this.keepScreenOn,
407+ success: () => {
408+ console.info(`${TAG} setKeepScreenOn success`);
409+ },
410+ fail: (data, code) => {
411+ console.error(`${TAG} fail data: ${data}, code: ${code}`);
412+ },
413+ complete: () => {
414+ console.info(`${TAG} setKeepScreenOn complete`);
415+ }
416+ });
417+ },
418+}
419+```
420+ 
174## GetBrightnessOptions<sup>(deprecated)</sup>421## GetBrightnessOptions<sup>(deprecated)</sup>
175 422 
176获取屏幕亮度的参数对象。423获取屏幕亮度的参数对象。