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 d91045fa561e3c9d1792d0b10e54effef57628c1..d4211241f7a7240db2dc4c2ebd6e485bb314c659 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-settings.md +++ b/zh-cn/application-dev/reference/apis/js-apis-settings.md @@ -35,8 +35,6 @@ import settings from '@ohos.settings'; **系统能力：** SystemCapability.Applications.settings.Core - - | 名称 | 类型 | 可读 | 可写 | 说明 | | ----------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ | | FONT_SCALE | string | 是 | 是 | 字体的比例因子，值为浮点数。 | @@ -187,112 +185,9 @@ import settings from '@ohos.settings'; | WIFI_STATUS | string | 是 | 是 | Wi-Fi是否可用。
值为true表示Wi-Fi可用；
值为false表示Wi-Fi不可用。 | | WIFI_WATCHDOG_STATUS | string | 是 | 是 | Wi-Fi的WatchDog是否可用。
值为true表示可用；
值为false表示不可用。 | -## settings.enableAirplaneMode - -enableAirplaneMode(enable: boolean, callback: AsyncCallback\): void - -启用或禁用飞行模式。使用callback异步回调。 - -**系统能力**：SystemCapability.Applications.settings.Core - -**参数**： - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | ----------------------------------------------- | -| enable | boolean | 是 | 是否开启飞行模式。true表示开启，false表示禁用。 | -| callback | AsyncCallback\ | 是 | 回调函数。 | - -**示例**： - -```js -let isEnabled = true; -settings.enableAirplaneMode(isEnabled, (err) => { - if (err) { - console.log('Failed to enable AirplaneMode.'); - return; - } - console.log('Return true if enable.'); -}) -``` - -## settings.enableAirplaneMode - -enableAirplaneMode(enable: boolean): Promise\ - -启用或禁用飞行模式。使用Promise异步回调。 - -**系统能力**：SystemCapability.Applications.settings.Core - -**参数**： - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------- | ---- | ----------------------------------------------- | -| enable | boolean | 是 | 是否开启飞行模式。true表示开启，false表示禁用。 | - -**返回值**： - -| 类型 | 说明 | -| -------------- | ------------------------- | -| Promise\ | 无返回结果的Promise对象。 | - -**示例**： - -```js -let isEnabled = true; -settings.enableAirplaneMode(isEnabled).then(() => { - console.log('Succeeded in enabling AirplaneMode.'); -}).catch((err) => { - console.log(`Failed to enable AirplaneMode. Cause: ${err}`); -}) -``` - -## settings.canShowFloating - -canShowFloating(callback: AsyncCallback\): void - -检查应用是否能够以悬浮窗形式显示。使用callback异步回调。 - -**系统能力**：SystemCapability.Applications.settings.Core - -**参数**： - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------- | ---- | ------------------------------------------------------------ | -| callback | AsyncCallback\ | 是 | 回调函数。
返回true，表示应用能够以悬浮窗形式显示；返回false，则表示不能。 | - -**示例**： - -```js -settings.canShowFloating((result) => { - console.log('Checks whether a specified application can show as float window.'); -}); -``` - -## settings.canShowFloating - -canShowFloating(): Promise\ - -检查应用是否能够以悬浮窗形式显示。使用Promise异步回调。 - -**系统能力**：SystemCapability.Applications.settings.Core - -**返回值**： - -| 类型 | 说明 | -| ----------------- | ------------------------------------------------------------ | -| Promise\ | Promise对象。
返回true，表示应用能够以悬浮窗形式显示；返回false，则表示不能。 | - -**示例**： - -```js -settings.canShowFloating().then((result) => { - console.log('Checks whether a specified application can show as float window.'); -}); -``` - ## setting.getURI -getURI(name: string, callback: AsyncCallback\): void +getURI(name: string, callback: AsyncCallback\): void 获取数据项的URI。使用callback异步回调。 @@ -303,7 +198,7 @@ getURI(name: string, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ------------------------------------------------------------ | | name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | -| callback | AsyncCallback\ | 是 | 回调函数。获取数据项的URI。 | +| callback | AsyncCallback\ | 是 | 回调函数。获取数据项的URI。 | **示例**： @@ -315,7 +210,7 @@ settings.getURI(settings.display.SCREEN_BRIGHTNESS_STATUS, (uri) => { ## setting.getURI -getURI(name: string): Promise\ +getURI(name: string): Promise\ 获取数据项的URI。使用Promise异步回调。 @@ -331,7 +226,7 @@ getURI(name: string): Promise\ | 类型 | 说明 | | ---------------- | ------------------------------------ | -| Promise\ | Promise对象。返回获取的数据项的URI。 | +| Promise\ | Promise对象。返回获取的数据项的URI。 | **示例**： @@ -341,55 +236,30 @@ settings.getURI(settings.display.SCREEN_BRIGHTNESS_STATUS).then((uri) => { }) ``` -## settings.getUriSync8+ - -getUriSync(name: string): string - -获取数据项的URI。 - -**系统能力**：SystemCapability.Applications.settings.Core - -**参数**： - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------------------------------------------------------------ | -| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | - -**返回值**： - -| 类型 | 说明 | -| ------ | ------------- | -| string | 数据项的URI。 | - -**示例**： - -```js -// 获取数据项的URI -let urivar = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); -``` - -## setting.getValue9+ +## setting.getValue -getValue(context: Context, name: string, callback: AsyncCallback\): void +getValue(dataAbilityHelper: DataAbilityHelper, name: string, callback: AsyncCallback\): void 获取数据库中指定数据项的值。使用callback异步回调。 **系统能力**：SystemCapability.Applications.settings.Core -**模型约束**：此接口仅可在Stage模型下使用。 - **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------- | ---- | ------------------------------------------------------------ | -| context | Context | 是 | 上下文内容。 | -| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | -| callback | AsyncCallback\ | 是 | 使用callback方式获取数据项的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | +| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | +| callback | AsyncCallback\ | 是 | 使用callback方式获取数据项的值。 | **示例**： ```js -settings.getValue(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS, (err, value) => { +import featureAbility from '@ohos.ability.featureAbility'; + +let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); +let helper = featureAbility.acquireDataAbilityHelper(uri); +settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, (err, value) => { if (err) { console.error(`Failed to get the setting. ${err.message} `); return; @@ -398,117 +268,88 @@ settings.getValue(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS, (err, }); ``` -## setting.getValue9+ +## setting.getValue -getValue(context: Context, name: string): Promise\ +getValue(dataAbilityHelper: DataAbilityHelper, name: string): Promise\ 获取数据库中指定数据项的值。使用Promise异步回调。 **系统能力**：SystemCapability.Applications.settings.Core -**模型约束**：此接口仅可在Stage模型下使用。 - **参数**： | 参数名 | 类型 | 必填 | 说明 | | ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | -| context | Context | 是 | 上下文内容。 | +| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | | name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | **返回值**： | 类型 | 说明 | | ---------------- | ----------------------------------- | -| Promise\ | Promise对象。返回获得的数据项的值。 | +| Promise\ | Promise对象。返回获得的数据项的值。 | **示例**： ```js -settings.getValue(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS) -.then((value) => { +import featureAbility from '@ohos.ability.featureAbility'; + +let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); +let helper = featureAbility.acquireDataAbilityHelper(uri); +settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS).then((value) => { console.log(`promise:value -> ${JSON.stringify(value)}`) }); ``` -## settings.getValueSync9+ +## settings.setValue -getValueSync(context: Context, name: string, defValue: string): string - -获取数据项的值。此方法相较getValue为同步方法。 - -**系统能力**：SystemCapability.Applications.settings.Core - -**模型约束**：此接口仅可在Stage模型下使用。 - -**参数**： - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------- | ---- | ------------------------------------------------------------ | -| context | Context | 是 | 上下文内容。 | -| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | -| defValue | string | 是 | 默认值。由开发者设置，当未从数据库中查询到该数据时，表示返回该默认值。 | - -**返回值**： - -| 类型 | 说明 | -| ------ | ---------------- | -| string | 返回数据项的值。 | - -**示例**： - -```js -//获取数据项亮度的值（该数据项在数据库中已存在） -let value = settings.getValueSync(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS, '10'); -``` - -## settings.setValue9+ - -setValue(context: Context, name: string, value: string, callback: AsyncCallback\): void +setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object, callback: AsyncCallback\): void 将数据项名称及数据项的值保存到数据库中。使用callback异步回调。 -**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS，仅系统应用可用。 +**系统接口**：此接口为系统接口。 **系统能力**：SystemCapability.Applications.settings.Core -**模型约束**：此接口仅可在Stage模型下使用。 - **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------- | ---- | ------------------------------------------------------------ | -| context | Context | 是 | 上下文内容。 | -| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | -| value | string | 是 | 数据项值。取值范围随业务变动。 | -| callback | AsyncCallback\ | 是 | 回调函数。返回true表示操作成功，否则操作失败。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | +| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | +| value | object | 是 | 数据项值。取值范围随业务变动。 | +| callback | AsyncCallback\ | 是 | 回调函数。返回true表示操作成功，否则操作失败。 | **示例**： ```js -settings.setValue(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS, '100', (result) => { +import featureAbility from '@ohos.ability.featureAbility'; + +//更新数据项亮度的值（该数据项在数据库中已存在，故setValue方法将更新该数据项的值） +let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); +let helper = featureAbility.acquireDataAbilityHelper(uri); +settings.setValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100', (status) => { console.log('Callback return whether value is set.'); }); ``` -## settings.setValue9+ +## settings.setValue -setValue(context: Context, name: string, value: string): Promise\ +setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object): Promise\ 将数据项名称及数据项的值保存到数据库中。使用Promise异步回调。 -**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS，仅系统应用可用。 +**系统接口**：此接口为系统接口。 **系统能力**：SystemCapability.Applications.settings.Core -**模型约束**：此接口仅可在Stage模型下使用。 - **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------- | ---- | ------------------------------------------------------------ | -| context | Context | 是 | 上下文内容。 | -| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | -| value | string | 是 | 数据项值。取值范围随业务变动。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | +| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | +| value | object | 是 | 数据项值。取值范围随业务变动。 | **返回值**： @@ -519,199 +360,147 @@ setValue(context: Context, name: string, value: string): Promise\ **示例**： ```js -settings.setValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100').then((result) => { +import featureAbility from '@ohos.ability.featureAbility'; + +//更新数据项亮度的值（该数据项在数据库中已存在，故setValue方法将更新该数据项的值） +let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); +let helper = featureAbility.acquireDataAbilityHelper(uri); +settings.setValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100').then((status) => { console.log('Callback return whether value is set.'); }); ``` -## settings.setValueSync9+ - -setValueSync(context: Context, name: string, value: string): boolean - -设置数据项的值。此方法相较setValue为同步方法。 +## settings.enableAirplaneMode -如果数据库中已经存在该数据项，则setValueSync方法将更新该数据项的值；如果数据库中尚未存在该数据项，则setValueSync方法将向数据库中插入该数据项。 +enableAirplaneMode(enable: boolean, callback: AsyncCallback\): void -**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS，仅系统应用可用。 +启用或禁用飞行模式。使用callback异步回调。 **系统能力**：SystemCapability.Applications.settings.Core -**模型约束**：此接口仅可在Stage模型下使用。 - **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------- | ---- | ------------------------------------------------------------ | -| context | Context | 是 | 上下文内容。 | -| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | -| value | string | 是 | 数据项的具体数值。取值范围随业务变动。 | - -**返回值**： - -| 类型 | 说明 | -| ------- | ------------------------------------------------------------ | -| boolean | 返回设置数据项的值是否成功的结果。true表示设置成功，false表示设置失败。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ----------------------------------------------- | +| enable | boolean | 是 | 是否开启飞行模式。true表示开启，false表示禁用。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | **示例**： ```js -//更新数据项亮度的值（该数据项在数据库中已存在，故setValueSync方法将更新该数据项的值） -let ret = settings.setValueSync(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS, '100'); +let isEnabled = true; +settings.enableAirplaneMode(isEnabled, (err) => { + if (err) { + console.log('Failed to enable AirplaneMode.'); + return; + } + console.log('Return true if enable.'); +}) ``` -## setting.getValue(deprecated) - -> 从API version 7开始支持，从API version 9开始废弃，推荐使用[getValue()](#settinggetvalue9)。 +## settings.enableAirplaneMode -getValue(dataAbilityHelper: DataAbilityHelper, name: string, callback: AsyncCallback\): void +enableAirplaneMode(enable: boolean): Promise\ -获取数据库中指定数据项的值。使用callback异步回调。 +启用或禁用飞行模式。使用Promise异步回调。 **系统能力**：SystemCapability.Applications.settings.Core -**模型约束**：此接口仅可在FA模型下使用。 - **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | -| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | -| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | -| callback | AsyncCallback\ | 是 | 使用callback方式获取数据项的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------- | ---- | ----------------------------------------------- | +| enable | boolean | 是 | 是否开启飞行模式。true表示开启，false表示禁用。 | + +**返回值**： + +| 类型 | 说明 | +| -------------- | ------------------------- | +| Promise\ | 无返回结果的Promise对象。 | **示例**： ```js -import featureAbility from '@ohos.ability.featureAbility'; - -let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); -let helper = featureAbility.acquireDataAbilityHelper(uri); -settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, (err, value) => { - if (err) { - console.error(`Failed to get the setting. ${err.message} `); - return; - } - console.log(`callback:value -> ${JSON.stringify(value)}`) -}); +let isEnabled = true; +settings.enableAirplaneMode(isEnabled).then(() => { + console.log('Succeeded in enabling AirplaneMode.'); +}).catch((err) => { + console.log(`Failed to enable AirplaneMode. Cause: ${err}`); +}) ``` -## setting.getValue(deprecated) - -> 从API version 7开始支持，从API version 9开始废弃，推荐使用[getValue()](#settinggetvalue9-1)。 +## settings.canShowFloating -getValue(dataAbilityHelper: DataAbilityHelper, name: string): Promise\ +canShowFloating(callback: AsyncCallback\): void -获取数据库中指定数据项的值。使用Promise异步回调。 +检查应用是否能够以悬浮窗形式显示。使用callback异步回调。 **系统能力**：SystemCapability.Applications.settings.Core -**模型约束**：此接口仅可在FA模型下使用。 - **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | -| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | -| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | - -**返回值**： - -| 类型 | 说明 | -| ---------------- | ----------------------------------- | -| Promise\ | Promise对象。返回获得的数据项的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------- | ---- | ------------------------------------------------------------ | +| callback | AsyncCallback\ | 是 | 回调函数。
返回true，表示应用能够以悬浮窗形式显示；返回false，则表示不能。 | **示例**： ```js -import featureAbility from '@ohos.ability.featureAbility'; - -let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); -let helper = featureAbility.acquireDataAbilityHelper(uri); -settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS).then((value) => { - console.log(`promise:value -> ${JSON.stringify(value)}`) +settings.canShowFloating((status) => { + console.log('Checks whether a specified application can show as float window.'); }); ``` -## settings.setValue(deprecated) - -> 从API version 7开始支持，从API version 9开始废弃，推荐使用[setValue()](#settingssetvalue9)。 - -setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: string, callback: AsyncCallback\): void +## settings.canShowFloating -将数据项名称及数据项的值保存到数据库中。使用callback异步回调。 +canShowFloating(): Promise\ -**系统接口**：此接口为系统接口。 +检查应用是否能够以悬浮窗形式显示。使用Promise异步回调。 **系统能力**：SystemCapability.Applications.settings.Core -**模型约束**：此接口仅可在FA模型下使用。 - -**参数**： +**返回值**： -| 参数名 | 类型 | 必填 | 说明 | -| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | -| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | -| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | -| value | string | 是 | 数据项值。取值范围随业务变动。 | -| callback | AsyncCallback\ | 是 | 回调函数。返回true表示操作成功，否则操作失败。 | +| 类型 | 说明 | +| ----------------- | ------------------------------------------------------------ | +| Promise\ | Promise对象。
返回true，表示应用能够以悬浮窗形式显示；返回false，则表示不能。 | **示例**： ```js -import featureAbility from '@ohos.ability.featureAbility'; - -//更新数据项亮度的值（该数据项在数据库中已存在，故setValue方法将更新该数据项的值） -let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); -let helper = featureAbility.acquireDataAbilityHelper(uri); -settings.setValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100', (result) => { - console.log('Callback return whether value is set.'); +settings.canShowFloating().then((status) => { + console.log('Checks whether a specified application can show as float window.'); }); ``` -## settings.setValue(deprecated) - -> 从API version 7开始支持，从API version 9开始废弃，推荐使用[setValue()](#settingssetvalue9-1)。 - -setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: string): Promise\ +## settings.getUriSync8+ -将数据项名称及数据项的值保存到数据库中。使用Promise异步回调。 +getUriSync(name: string): string -**系统接口**：此接口为系统接口。 +获取数据项的URI。 **系统能力**：SystemCapability.Applications.settings.Core -**模型约束**：此接口仅可在FA模型下使用。 - **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | -| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | -| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | -| value | string | 是 | 数据项值。取值范围随业务变动。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | **返回值**： -| 类型 | 说明 | -| ----------------- | -------------------------------------------------- | -| Promise\ | Promise对象。返回true表示操作成功，否则返回false。 | +| 类型 | 说明 | +| ------ | ------------- | +| string | 数据项的URI。 | **示例**： ```js -import featureAbility from '@ohos.ability.featureAbility'; - -//更新数据项亮度的值（该数据项在数据库中已存在，故setValue方法将更新该数据项的值） -let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); -let helper = featureAbility.acquireDataAbilityHelper(uri); -settings.setValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100').then((result) => { - console.log('Callback return whether value is set.'); -}); +// 获取数据项的URI +let urivar = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); ``` -## settings.getValueSync(deprecated) - -> 从API version 8开始支持，从API version 9开始废弃，推荐使用[getValueSync()](#settingsgetvaluesync9)。 +## settings.getValueSync8+ getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: string): string @@ -719,8 +508,6 @@ getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: strin **系统能力**：SystemCapability.Applications.settings.Core -**模型约束**：此接口仅可在FA模型下使用。 - **参数**： | 参数名 | 类型 | 必填 | 说明 | @@ -746,9 +533,7 @@ let helper = featureAbility.acquireDataAbilityHelper(uri); let value = settings.getValueSync(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '10'); ``` -## settings.setValueSync(deprecated) - -> 从API version 8开始支持，从API version 9开始废弃，推荐使用[setValueSync()](#settingssetvaluesync9)。 +## settings.setValueSync8+ setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string): boolean @@ -760,8 +545,6 @@ setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string): **系统能力**：SystemCapability.Applications.settings.Core -**模型约束**：此接口仅可在FA模型下使用。 - **参数**： | 参数名 | 类型 | 必填 | 说明 |