From e4973d2dd5b26f2c06e922b6457a1403ee500fac Mon Sep 17 00:00:00 2001 From: LiAn Date: Tue, 23 Aug 2022 13:33:33 +0000 Subject: [PATCH] update zh-cn/application-dev/reference/apis/js-apis-system-brightness.md. Signed-off-by: LiAn Signed-off-by: LiAn --- .../apis/js-apis-system-brightness.md | 61 ++++++++++--------- 1 file changed, 32 insertions(+), 29 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-brightness.md b/zh-cn/application-dev/reference/apis/js-apis-system-brightness.md index aa52115fe4..9d231f7b33 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-brightness.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-brightness.md @@ -1,7 +1,7 @@ # 屏幕亮度 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> - 从API Version 7 开始,该接口不再维护,推荐使用新接口[`@ohos.brightness`](js-apis-brightness.md)。 +> **说明:** +> - 从API Version 9 开始,该接口不再维护,推荐使用新接口[`@ohos.brightness`](js-apis-brightness.md)。 > > - 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 @@ -23,17 +23,13 @@ getValue(Object): void **系统能力:** SystemCapability.PowerManager.DisplayPowerManager **参数:** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| success | Function | 否 | 接口调用成功的回调函数。 | -| fail | Function | 否 | 接口调用失败的回调函数。 | -| complete | Function | 否 | 接口调用结束的回调函数。 | - -success返回值: +| success | (data: [BrightnessResponse](#brightnessresponse)) => void | 否 | 接口调用成功的回调函数。 | +| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 | +| complete | () => void | 否 | 接口调用结束的回调函数。 | -| 参数名 | 类型 | 说明 | -| -------- | -------- | -------- | -| value | number | 屏幕亮度,取值为1-255之间的整数。 | **示例:** @@ -62,12 +58,13 @@ setValue(Object): void **系统能力:** SystemCapability.PowerManager.DisplayPowerManager **参数:** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | number | 是 | 屏幕亮度,值为1-255之间的整数。
- 如果值小于等于0,系统按1处理。
- 如果值大于255,系统按255处理。
- 如果值为小数,系统将处理为整数。例如设置为8.1,系统按8处理。 | -| success | Function | 否 | 接口调用成功的回调函数。 | -| fail | Function | 否 | 接口调用失败的回调函数。 | -| complete | Function | 否 | 接口调用结束的回调函数。 | +| mode | number | 是 | 屏幕亮度,值为1-255之间的整数。
- 如果值小于等于0,系统按1处理。
- 如果值大于255,系统按255处理。
- 如果值为小数,系统将处理为整数。例如设置为8.1,系统按8处理。 | +| success | () => void | 否 | 接口调用成功的回调函数。 | +| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 | +| complete | () => void | 否 | 接口调用结束的回调函数。 | **示例:** @@ -97,17 +94,12 @@ getMode(Object): void **系统能力:** SystemCapability.PowerManager.DisplayPowerManager **参数:** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| success | Function | 否 | 接口调用成功的回调函数。 | -| fail | Function | 否 | 接口调用失败的回调函数。 | -| complete | Function | 否 | 接口调用结束的回调函数。 | - - success返回值: - -| 参数名 | 类型 | 说明 | -| -------- | -------- | -------- | -| mode | number | 值为0或1:
- 0为手动调节屏幕亮度模式
- 1为自动调节屏幕亮度模式 | +| success | (data: [BrightnessResponse](#brightnessresponse)) => void | 否 | 接口调用成功的回调函数。 | +| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 | +| complete | () => void | 否 | 接口调用结束的回调函数。 | **示例:** @@ -139,9 +131,9 @@ setMode(Object): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | mode | number | 是 | 值为0或1
- 0为手动调节屏幕亮度
- 1为自动调节屏幕亮度 | -| success | Function | 否 | 接口调用成功的回调函数。 | -| fail | Function | 否 | 接口调用失败的回调函数。 | -| complete | Function | 否 | 接口调用结束的回调函数。 | +| success | () => void | 否 | 接口调用成功的回调函数。 | +| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 | +| complete | () => void | 否 | 接口调用结束的回调函数。 | **示例:** @@ -174,9 +166,9 @@ setKeepScreenOn(Object): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | keepScreenOn | boolean | 是 | 是否保持屏幕常亮。 | -| success | Function | 否 | 接口调用成功的回调函数。 | -| fail | Function | 否 | 接口调用失败的回调函数。 | -| complete | Function | 否 | 接口调用结束的回调函数。 | +| success | () => void | 否 | 接口调用成功的回调函数。 | +| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 | +| complete | () => void | 否 | 接口调用结束的回调函数。 | **示例:** @@ -195,3 +187,14 @@ setKeepScreenOn(Object): void }, } ``` +## + +## BrightnessResponse + +屏幕亮度。 + +| 名称 | 类型 | 说明 | +| -------- | -------- | -------- | +| value | number | 屏幕亮度,取值为1-255之间的整数。 | + + -- GitLab