From 69e7e761d1efc9ceae27f911a88a0cc1b36d599f Mon Sep 17 00:00:00 2001 From: liminjie10 Date: Thu, 8 Dec 2022 12:02:44 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=8E=A5=E5=8F=A3=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: liminjie10 --- .../reference/apis/js-apis-settings.md | 431 +++++++++++++----- 1 file changed, 312 insertions(+), 119 deletions(-) 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 7a8b772f9c..30ca0a6f5a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-settings.md +++ b/zh-cn/application-dev/reference/apis/js-apis-settings.md @@ -35,6 +35,8 @@ import settings from '@ohos.settings'; **系统能力:** SystemCapability.Applications.settings.Core + + | 名称 | 类型 | 可读 | 可写 | 说明 | | ----------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ | | FONT_SCALE | string | 是 | 是 | 字体的比例因子,值为浮点数。 | @@ -185,9 +187,112 @@ 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异步回调。 @@ -198,7 +303,7 @@ getURI(name: string, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ------------------------------------------------------------ | | name | string | 是 | 数据项的名称。数据项名称分为以下两种:
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | -| callback | AsyncCallback\ | 是 | 回调函数。获取数据项的URI。 | +| callback | AsyncCallback\ | 是 | 回调函数。获取数据项的URI。 | **示例**: @@ -210,7 +315,7 @@ settings.getURI(settings.display.SCREEN_BRIGHTNESS_STATUS, (uri) => { ## setting.getURI -getURI(name: string): Promise\ +getURI(name: string): Promise\ 获取数据项的URI。使用Promise异步回调。 @@ -226,7 +331,7 @@ getURI(name: string): Promise\ | 类型 | 说明 | | ---------------- | ------------------------------------ | -| Promise\ | Promise对象。返回获取的数据项的URI。 | +| Promise\ | Promise对象。返回获取的数据项的URI。 | **示例**: @@ -236,30 +341,53 @@ settings.getURI(settings.display.SCREEN_BRIGHTNESS_STATUS).then((uri) => { }) ``` -## setting.getValue +## settings.getUriSync8+ -getValue(dataAbilityHelper: DataAbilityHelper, name: string, callback: AsyncCallback\): void +getUriSync(name: string): string -获取数据库中指定数据项的值。使用callback异步回调。 +获取数据项的URI。 **系统能力**:SystemCapability.Applications.settings.Core **参数**: -| 参数名 | 类型 | 必填 | 说明 | -| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | -| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | -| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | -| callback | AsyncCallback\ | 是 | 使用callback方式获取数据项的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | + +**返回值**: + +| 类型 | 说明 | +| ------ | ------------- | +| string | 数据项的URI。 | **示例**: ```js -import featureAbility from '@ohos.ability.featureAbility'; +// 获取数据项的URI +let urivar = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); +``` -let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); -let helper = featureAbility.acquireDataAbilityHelper(uri); -settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, (err, value) => { +## setting.getValue9+ + +getValue(context: Context, name: string, callback: AsyncCallback\): void + +stage模型使用。获取数据库中指定数据项的值。使用callback异步回调。 + +**系统能力**:SystemCapability.Applications.settings.Core + +**参数**: + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | ------------------------------------------------------------ | +| context | Context | 是 | 上下文内容。 | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | +| callback | AsyncCallback\ | 是 | 使用callback方式获取数据项的值。 | + +**示例**: + +```js +settings.getValue(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS, (err, value) => { if (err) { console.error(`Failed to get the setting. ${err.message} `); return; @@ -268,11 +396,11 @@ settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, (err, value }); ``` -## setting.getValue +## setting.getValue9+ -getValue(dataAbilityHelper: DataAbilityHelper, name: string): Promise\ +getValue(context: Context, name: string): Promise\ -获取数据库中指定数据项的值。使用Promise异步回调。 +stage模型使用。获取数据库中指定数据项的值。使用Promise异步回调。 **系统能力**:SystemCapability.Applications.settings.Core @@ -280,32 +408,58 @@ getValue(dataAbilityHelper: DataAbilityHelper, name: string): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | -| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | +| context | Context | 是 | 上下文内容。 | | name | string | 是 | 数据项的名称。数据项名称分为以下两种:
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | **返回值**: | 类型 | 说明 | | ---------------- | ----------------------------------- | -| Promise\ | Promise对象。返回获得的数据项的值。 | +| 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).then((value) => { +settings.getValue(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS) +.then((value) => { console.log(`promise:value -> ${JSON.stringify(value)}`) }); ``` -## settings.setValue +## settings.getValueSync9+ -setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object, callback: AsyncCallback\): void +getValueSync(context: Context, name: string, defValue: string): string -将数据项名称及数据项的值保存到数据库中。使用callback异步回调。 +stage模型使用。获取数据项的值。此方法相较getValue为同步方法。 + +**系统能力**:SystemCapability.Applications.settings.Core + +**参数**: + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------- | ---- | ------------------------------------------------------------ | +| 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 + +stage模型使用。将数据项名称及数据项的值保存到数据库中。使用callback异步回调。 **系统接口**:此接口为系统接口。 @@ -313,31 +467,26 @@ setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object, call **参数**: -| 参数名 | 类型 | 必填 | 说明 | -| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | -| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | -| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | -| value | object | 是 | 数据项值。取值范围随业务变动。 | -| callback | AsyncCallback\ | 是 | 回调函数。返回true表示操作成功,否则操作失败。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------- | ---- | ------------------------------------------------------------ | +| context | Context | 是 | 上下文内容。 | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | +| value | string | 是 | 数据项值。取值范围随业务变动。 | +| callback | AsyncCallback\ | 是 | 回调函数。返回true表示操作成功,否则操作失败。 | **示例**: ```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', (status) => { +settings.setValue(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS, '100', (result) => { console.log('Callback return whether value is set.'); }); ``` -## settings.setValue +## settings.setValue9+ -setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object): Promise\ +setValue(context: Context, name: string, value: string): Promise\ -将数据项名称及数据项的值保存到数据库中。使用Promise异步回调。 +stage模型使用。将数据项名称及数据项的值保存到数据库中。使用Promise异步回调。 **系统接口**:此接口为系统接口。 @@ -345,11 +494,11 @@ setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object): Pro **参数**: -| 参数名 | 类型 | 必填 | 说明 | -| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | -| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | -| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | -| value | object | 是 | 数据项值。取值范围随业务变动。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------- | ---- | ------------------------------------------------------------ | +| context | Context | 是 | 上下文内容。 | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | +| value | string | 是 | 数据项值。取值范围随业务变动。 | **返回值**: @@ -360,147 +509,189 @@ setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object): Pro **示例**: ```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((status) => { +settings.setValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100').then((result) => { console.log('Callback return whether value is set.'); }); ``` -## settings.enableAirplaneMode +## settings.setValueSync9+ -enableAirplaneMode(enable: boolean, callback: AsyncCallback\): void +setValueSync(context: Context, name: string, value: string): boolean -启用或禁用飞行模式。使用callback异步回调。 +stage模型使用。设置数据项的值。此方法相较setValue为同步方法。 + +如果数据库中已经存在该数据项,则setValueSync方法将更新该数据项的值;如果数据库中尚未存在该数据项,则setValueSync方法将向数据库中插入该数据项。 + +**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS,仅系统应用可用。 **系统能力**:SystemCapability.Applications.settings.Core **参数**: -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | ----------------------------------------------- | -| enable | boolean | 是 | 是否开启飞行模式。true表示开启,false表示禁用。 | -| callback | AsyncCallback\ | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------- | ---- | ------------------------------------------------------------ | +| context | Context | 是 | 上下文内容。 | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | +| value | string | 是 | 数据项的具体数值。取值范围随业务变动。 | + +**返回值**: + +| 类型 | 说明 | +| ------- | ------------------------------------------------------------ | +| boolean | 返回设置数据项的值是否成功的结果。true表示设置成功,false表示设置失败。 | **示例**: ```js -let isEnabled = true; -settings.enableAirplaneMode(isEnabled, (err) => { - if (err) { - console.log('Failed to enable AirplaneMode.'); - return; - } - console.log('Return true if enable.'); -}) +//更新数据项亮度的值(该数据项在数据库中已存在,故setValueSync方法将更新该数据项的值) +let ret = settings.setValueSync(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS, '100'); ``` -## settings.enableAirplaneMode +## setting.getValuedeprecated -enableAirplaneMode(enable: boolean): Promise\ +> 从API version 9开始不再维护,建议使用stage模型的对应接口。 -启用或禁用飞行模式。使用Promise异步回调。 +getValue(dataAbilityHelper: DataAbilityHelper, name: string, callback: AsyncCallback\): void + +获取数据库中指定数据项的值。使用callback异步回调。 **系统能力**:SystemCapability.Applications.settings.Core **参数**: -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------- | ---- | ----------------------------------------------- | -| enable | boolean | 是 | 是否开启飞行模式。true表示开启,false表示禁用。 | - -**返回值**: - -| 类型 | 说明 | -| -------------- | ------------------------- | -| Promise\ | 无返回结果的Promise对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | +| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | +| callback | AsyncCallback\ | 是 | 使用callback方式获取数据项的值。 | **示例**: ```js -let isEnabled = true; -settings.enableAirplaneMode(isEnabled).then(() => { - console.log('Succeeded in enabling AirplaneMode.'); -}).catch((err) => { - console.log(`Failed to enable AirplaneMode. Cause: ${err}`); -}) +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)}`) +}); ``` -## settings.canShowFloating +## setting.getValuedeprecated -canShowFloating(callback: AsyncCallback\): void +> 从API version 9开始不再维护,建议使用stage模型的对应接口。 -检查应用是否能够以悬浮窗形式显示。使用callback异步回调。 +getValue(dataAbilityHelper: DataAbilityHelper, name: string): Promise\ + +获取数据库中指定数据项的值。使用Promise异步回调。 **系统能力**:SystemCapability.Applications.settings.Core **参数**: -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------- | ---- | ------------------------------------------------------------ | -| callback | AsyncCallback\ | 是 | 回调函数。
返回true,表示应用能够以悬浮窗形式显示;返回false,则表示不能。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | +| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | + +**返回值**: + +| 类型 | 说明 | +| ---------------- | ----------------------------------- | +| Promise\ | Promise对象。返回获得的数据项的值。 | **示例**: ```js -settings.canShowFloating((status) => { - console.log('Checks whether a specified application can show as float window.'); +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 +## settings.setValuedeprecated -canShowFloating(): Promise\ +> 从API version 9开始不再维护,建议使用stage模型的对应接口。 -检查应用是否能够以悬浮窗形式显示。使用Promise异步回调。 +setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: string, callback: AsyncCallback\): void + +将数据项名称及数据项的值保存到数据库中。使用callback异步回调。 + +**系统接口**:此接口为系统接口。 **系统能力**:SystemCapability.Applications.settings.Core -**返回值**: +**参数**: -| 类型 | 说明 | -| ----------------- | ------------------------------------------------------------ | -| Promise\ | Promise对象。
返回true,表示应用能够以悬浮窗形式显示;返回false,则表示不能。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | +| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | +| value | string | 是 | 数据项值。取值范围随业务变动。 | +| callback | AsyncCallback\ | 是 | 回调函数。返回true表示操作成功,否则操作失败。 | **示例**: ```js -settings.canShowFloating().then((status) => { - console.log('Checks whether a specified application can show as float window.'); +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.getUriSync8+ +## settings.setValuedeprecated -getUriSync(name: string): string +> 从API version 9开始不再维护,建议使用stage模型的对应接口。 -获取数据项的URI。 +setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: string): Promise\ + +将数据项名称及数据项的值保存到数据库中。使用Promise异步回调。 + +**系统接口**:此接口为系统接口。 **系统能力**:SystemCapability.Applications.settings.Core **参数**: -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------------------------------------------------------------ | -| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | +| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | +| value | string | 是 | 数据项值。取值范围随业务变动。 | **返回值**: -| 类型 | 说明 | -| ------ | ------------- | -| string | 数据项的URI。 | +| 类型 | 说明 | +| ----------------- | -------------------------------------------------- | +| Promise\ | Promise对象。返回true表示操作成功,否则返回false。 | **示例**: ```js -// 获取数据项的URI -let urivar = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); +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.'); +}); ``` -## settings.getValueSync8+ +## settings.getValueSyncdeprecated + +> 从API version 9开始不再维护,建议使用stage模型的对应接口。 getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: string): string @@ -533,7 +724,9 @@ let helper = featureAbility.acquireDataAbilityHelper(uri); let value = settings.getValueSync(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '10'); ``` -## settings.setValueSync8+ +## settings.setValueSyncdeprecated + +> 从API version 9开始不再维护,建议使用stage模型的对应接口。 setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string): boolean @@ -541,7 +734,7 @@ setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string): 如果数据库中已经存在该数据项,则setValueSync方法将更新该数据项的值;如果数据库中尚未存在该数据项,则setValueSync方法将向数据库中插入该数据项。 -**需要权限**:ohos.permission.MANAGE_SECUER_SETTINGS,仅系统应用可用。 +**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS,仅系统应用可用。 **系统能力**:SystemCapability.Applications.settings.Core -- GitLab