From c2b7a6ed82c472272f2c0e4041f678098bd63bd2 Mon Sep 17 00:00:00 2001 From: chenqi Date: Thu, 14 Jul 2022 15:30:23 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E6=94=B9=20setting=20doc?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: chenqi --- .../reference/apis/js-apis-settings.md | 18 +++++----- .../reference/apis/js-apis-settings.md | 35 ++++++++++--------- 2 files changed, 27 insertions(+), 26 deletions(-) diff --git a/en/application-dev/reference/apis/js-apis-settings.md b/en/application-dev/reference/apis/js-apis-settings.md index 73be3dd960..a546ee0cc3 100644 --- a/en/application-dev/reference/apis/js-apis-settings.md +++ b/en/application-dev/reference/apis/js-apis-settings.md @@ -1,16 +1,15 @@ # Settings +This module provides APIs for setting data items. + > **NOTE** > > The initial APIs of this module are supported since API version 8. Updates will be marked with a superscript to indicate their earliest API version. -This module provides APIs for setting data items. - - ## Modules to Import -```typescript +```ts import settings from '@ohos.settings'; ``` @@ -28,7 +27,8 @@ Obtains the URI of a data item. | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| name | string | Yes| Name of the target data item. Data items can be classified as follows:
| +| settings.display.SCREEN_BRIGHTNESS_STATUS | string | Yes| Brightness of the target data item.| +| settings.date.TIME_FORMAT | string | Yes| Time format of the target data item. Data | **Return value** @@ -38,7 +38,7 @@ Obtains the URI of a data item. **Example** -```typescript +```ts // Obtain the URI of a data item. let urivar = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); ``` @@ -67,7 +67,7 @@ Obtains the value of a data item. **Example** -```typescript +```ts import featureAbility from '@ohos.ability.featureAbility'; // Obtain the value of settings.display.SCREEN_BRIGHTNESS_STATUS (this data item already exists in the database). @@ -95,7 +95,7 @@ If the specified data item exists in the database, the **setValueSync** method u | -------- | -------- | -------- | -------- | | dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | Yes| **DataAbilityHelper** class.| | name | string | Yes| Name of the target data item. Data items can be classified as follows:
| -| value | string | Yes| Value of the data item.| +| value | string | Yes| Value of the data item.The value of range with the service.| **Return value** @@ -105,7 +105,7 @@ If the specified data item exists in the database, the **setValueSync** method u **Example** -```typescript +```ts import featureAbility from '@ohos.ability.featureAbility'; // Update the value of settings.display.SCREEN_BRIGHTNESS_STATUS. (As this data item exists in the database, the setValueSync diff --git a/zh-cn/application-dev/reference/apis/js-apis-settings.md b/zh-cn/application-dev/reference/apis/js-apis-settings.md index e4b3595f06..4dd0a06978 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-settings.md +++ b/zh-cn/application-dev/reference/apis/js-apis-settings.md @@ -1,15 +1,15 @@ # 设置数据项名称 +本模块提供设置数据项的访问功能相关接口的说明及示例。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -本模块提供设置数据项的访问功能相关接口的说明及示例。 - ## 导入模块 -```typescript +```ts import settings from '@ohos.settings'; ``` @@ -23,18 +23,19 @@ getUriSync(name: string): string **系统能力**：SystemCapability.Applictaions.settings.Core。 -- 参数： +**参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | name | string | 是 | 数据项的名称。数据项名称分为以下两种：
| + | settings.display.SCREEN_BRIGHTNESS_STATUS | string | 是 | 亮度数据项的名称。| + | settings.date.TIME_FORMAT | string | 是 | 时间格式数据项的名称。| -- 返回值： +**返回值**： | 类型 | 说明 | | -------- | -------- | | string | 数据项的URI。 | -- 示例： - ```typescript +**示例**： + ```ts // 获取数据项的URI let urivar = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); ``` @@ -48,20 +49,20 @@ getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: strin **系统能力**：SystemCapability.Applictaions.settings.Core。 -- 参数： +**参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | | name | string | 是 | 数据项的名称。数据项名称分为以下两种：
| | defValue | string | 是 | 默认值。由开发者设置，当未从数据库中查询到该数据时，则返回该默认值。 | -- 返回值： +**返回值**： | 类型 | 说明 | | -------- | -------- | | string | 返回数据项的值。 | -- 示例： - ```typescript +**示例**： + ```ts import featureAbility from '@ohos.ability.featureAbility'; //获取数据项亮度的值（该数据项在数据库中已存在） @@ -82,20 +83,20 @@ setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string): **系统能力**：SystemCapability.Applictaions.settings.Core。 -- 参数： +**参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | | name | string | 是 | 数据项的名称。数据项名称分为以下两种：
| - | value | string | 是 | 数据项的具体数值。 | + | value | string | 是 | 数据项的具体数值，取值范围随业务变动。 | -- 返回值： +**返回值**： | 类型 | 说明 | | -------- | -------- | | boolean | 返回设置数据项的值是否成功的结果。true表示设置成功，false则表示设置失败。 | -- 示例： - ```typescript +**示例**： + ```ts import featureAbility from '@ohos.ability.featureAbility'; //更新数据项亮度的值（该数据项在数据库中已存在，故setValueSync方法将更新该数据项的值） -- GitLab