Skip to content

D
Docs

OpenHarmony / Docs
9 个月 前同步成功

通知 158
Star 292
Fork 28
D
Docs

前往新版Gitcode，体验更适合开发者的 AI 搜索 >>

提交 78097758 编写于 作者: S suwei06
浏览文件
操作

设置文档适配api10 

Signed-off-by: Nsuwei06 <sunwei156@huawei.com>
上级 6484c837
隐藏空白更改
内联 并排
Showing with 45 addition and 49 deletion
zh-cn/application-dev/reference/apis/js-apis-settings.md
浏览文件 @ 78097758
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
本模块提供访问设置数据项的能力。 本模块提供访问设置数据项的能力。
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 导入模块 ## 导入模块
...@@ -213,9 +213,7 @@ setValue(context: Context, name: string, value: string, callback: AsyncCallback\ ...@@ -213,9 +213,7 @@ setValue(context: Context, name: string, value: string, callback: AsyncCallback\
import settings from '@ohos.settings'; import settings from '@ohos.settings';
//更新数据项亮度的值（该数据项在数据库中已存在，故setValue方法将更新该数据项的值） //更新数据项亮度的值（该数据项在数据库中已存在，故setValue方法将更新该数据项的值）
let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); settings.setValue(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS, '100', (status) => {
//此处数据项值的类型为string
settings.setValue(this.context, uri, '100', (status) => {
console.log('Callback return whether value is set.'); console.log('Callback return whether value is set.');
}); });
``` ```
...@@ -252,9 +250,7 @@ setValue(context: Context, name: string, value: string): Promise\<boolean> ...@@ -252,9 +250,7 @@ setValue(context: Context, name: string, value: string): Promise\<boolean>
import settings from '@ohos.settings'; import settings from '@ohos.settings';
//更新数据项亮度的值（该数据项在数据库中已存在，故setValue方法将更新该数据项的值） //更新数据项亮度的值（该数据项在数据库中已存在，故setValue方法将更新该数据项的值）
let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); settings.setValue(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS, '100').then((status) => {
//此处数据项值的类型为string
settings.setValue(this.context, uri, '100').then((status) => {
console.log('Callback return whether value is set.'); console.log('Callback return whether value is set.');
}); });
``` ```
...@@ -282,8 +278,7 @@ getValue(context: Context, name: string, callback: AsyncCallback\<string>): void ...@@ -282,8 +278,7 @@ getValue(context: Context, name: string, callback: AsyncCallback\<string>): void
```js ```js
import settings from '@ohos.settings'; import settings from '@ohos.settings';
let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); settings.getValue(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS, (err, value) => {
settings.getValue(this.context, uri, (err, value) => {
if (err) { if (err) {
console.error(`Failed to get the setting. ${err.message} `); console.error(`Failed to get the setting. ${err.message} `);
return; return;
...@@ -320,8 +315,7 @@ getValue(context: Context, name: string): Promise\<string> ...@@ -320,8 +315,7 @@ getValue(context: Context, name: string): Promise\<string>
```js ```js
import settings from '@ohos.settings'; import settings from '@ohos.settings';
let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); settings.getValue(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS).then((value) => {
settings.getValue(this.context, uri).then((value) => {
console.log(`promise:value -> ${JSON.stringify(value)}`) console.log(`promise:value -> ${JSON.stringify(value)}`)
}); });
``` ```
...@@ -356,8 +350,7 @@ getValueSync(context: Context, name: string, defValue: string): string; ...@@ -356,8 +350,7 @@ getValueSync(context: Context, name: string, defValue: string): string;
import settings from '@ohos.settings'; import settings from '@ohos.settings';
//获取数据项亮度的值（该数据项在数据库中已存在） //获取数据项亮度的值（该数据项在数据库中已存在）
let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); let value = settings.getValueSync(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS, '10');
let value = settings.getValueSync(this.context, uri, '10');
``` ```
## settings.setValueSync<sup>10+</sup> ## settings.setValueSync<sup>10+</sup>
...@@ -394,11 +387,10 @@ setValueSync(context: Context, name: string, value: string): boolean ...@@ -394,11 +387,10 @@ setValueSync(context: Context, name: string, value: string): boolean
import settings from '@ohos.settings'; import settings from '@ohos.settings';
//更新数据项亮度的值（该数据项在数据库中已存在，故setValueSync方法将更新该数据项的值） //更新数据项亮度的值（该数据项在数据库中已存在，故setValueSync方法将更新该数据项的值）
let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); let ret = settings.setValueSync(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS, '100');
let ret = settings.setValueSync(this.context, uri, '100');
``` ```
## settings.enableAirplaneMode<sup>7+</sup> ## settings.enableAirplaneMode
enableAirplaneMode(enable: boolean, callback: AsyncCallback\<void>): void enableAirplaneMode(enable: boolean, callback: AsyncCallback\<void>): void
...@@ -428,7 +420,7 @@ settings.enableAirplaneMode(isEnabled, (err) => { ...@@ -428,7 +420,7 @@ settings.enableAirplaneMode(isEnabled, (err) => {
}) })
``` ```
## settings.enableAirplaneMode<sup>7+</sup> ## settings.enableAirplaneMode
enableAirplaneMode(enable: boolean): Promise\<void> enableAirplaneMode(enable: boolean): Promise\<void>
...@@ -461,7 +453,7 @@ settings.enableAirplaneMode(isEnabled).then(() => { ...@@ -461,7 +453,7 @@ settings.enableAirplaneMode(isEnabled).then(() => {
}) })
``` ```
## settings.canShowFloating<sup>7+</sup> ## settings.canShowFloating
canShowFloating(callback: AsyncCallback\<boolean>): void canShowFloating(callback: AsyncCallback\<boolean>): void
...@@ -483,7 +475,7 @@ settings.canShowFloating((status) => { ...@@ -483,7 +475,7 @@ settings.canShowFloating((status) => {
}); });
``` ```
## settings.canShowFloating<sup>7+</sup> ## settings.canShowFloating
canShowFloating(): Promise\<boolean> canShowFloating(): Promise\<boolean>
...@@ -529,7 +521,7 @@ getUriSync(name: string): string ...@@ -529,7 +521,7 @@ getUriSync(name: string): string
```js ```js
// 获取数据项的URI // 获取数据项的URI
let urivar = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); let uriVar = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS);
``` ```
## setting.getURI<sup>(deprecated)</sup> ## setting.getURI<sup>(deprecated)</sup>
...@@ -540,7 +532,7 @@ getURI(name: string, callback: AsyncCallback\<object>): void ...@@ -540,7 +532,7 @@ getURI(name: string, callback: AsyncCallback\<object>): void
> **说明：** > **说明：**
> >
> 从 API version 7开始支持，从API version 9开始废弃。 > 从 API version 7开始支持，从API version 9开始废弃，此接口不再提供代替接口。
**系统能力**：SystemCapability.Applications.settings.Core **系统能力**：SystemCapability.Applications.settings.Core
...@@ -567,7 +559,7 @@ getURI(name: string): Promise\<object> ...@@ -567,7 +559,7 @@ getURI(name: string): Promise\<object>
> **说明：** > **说明：**
> >
> 从 API version 7开始支持，从API version 9开始废弃。 > 从 API version 7开始支持，从API version 9开始废弃，此接口不再提供代替接口。
**系统能力**：SystemCapability.Applications.settings.Core **系统能力**：SystemCapability.Applications.settings.Core
...@@ -603,16 +595,18 @@ setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object, call ...@@ -603,16 +595,18 @@ setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object, call
**系统接口**：此接口为系统接口。 **系统接口**：此接口为系统接口。
**模型约束**：此接口仅可在FA模型下使用。
**系统能力**：SystemCapability.Applications.settings.Core **系统能力**：SystemCapability.Applications.settings.Core
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | | ----------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | | dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | | name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
| value | object | 是 | 数据项值。取值范围随业务变动。 | | value | object | 是 | 数据项值。取值范围随业务变动。 |
| callback | AsyncCallback\<boolean> | 是 | 回调函数。返回true表示操作成功，否则操作失败。 | | callback | AsyncCallback\<boolean> | 是 | 回调函数。返回true表示操作成功，否则操作失败。 |
**示例**： **示例**：
...@@ -641,15 +635,17 @@ setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object): Pro ...@@ -641,15 +635,17 @@ setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object): Pro
**系统接口**：此接口为系统接口。 **系统接口**：此接口为系统接口。
**模型约束**：此接口仅可在FA模型下使用。
**系统能力**：SystemCapability.Applications.settings.Core **系统能力**：SystemCapability.Applications.settings.Core
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | | ----------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | | dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | | name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
| value | object | 是 | 数据项值。取值范围随业务变动。 | | value | object | 是 | 数据项值。取值范围随业务变动。 |
**返回值**： **返回值**：
...@@ -688,11 +684,11 @@ getValue(dataAbilityHelper: DataAbilityHelper, name: string, callback: AsyncCall ...@@ -688,11 +684,11 @@ getValue(dataAbilityHelper: DataAbilityHelper, name: string, callback: AsyncCall
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | | ----------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | | dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | | name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
| callback | AsyncCallback\<object> | 是 | 使用callback方式获取数据项的值。 | | callback | AsyncCallback\<object> | 是 | 使用callback方式获取数据项的值。 |
**示例**： **示例**：
...@@ -726,10 +722,10 @@ getValue(dataAbilityHelper: DataAbilityHelper, name: string): Promise\<object> ...@@ -726,10 +722,10 @@ getValue(dataAbilityHelper: DataAbilityHelper, name: string): Promise\<object>
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | | ----------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | | dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | | name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
**返回值**： **返回值**：
...@@ -757,7 +753,7 @@ getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: strin ...@@ -757,7 +753,7 @@ getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: strin
> **说明：** > **说明：**
> >
> 从 API version 8开始支持，从API version 9开始废弃，推荐使用[getValue()](#settingsgetvaluesync10)。 > 从 API version 8开始支持，从API version 9开始废弃，推荐使用[getValueSync()](#settingsgetvaluesync10)。
**模型约束**：此接口仅可在FA模型下使用。 **模型约束**：此接口仅可在FA模型下使用。
...@@ -765,11 +761,11 @@ getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: strin ...@@ -765,11 +761,11 @@ getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: strin
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | | ----------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | | dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | | name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
| defValue | string | 是 | 默认值。由开发者设置，当未从数据库中查询到该数据时，表示返回该默认值。 | | defValue | string | 是 | 默认值。由开发者设置，当未从数据库中查询到该数据时，表示返回该默认值。 |
**返回值**： **返回值**：
...@@ -798,7 +794,7 @@ setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string): ...@@ -798,7 +794,7 @@ setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string):
> **说明：** > **说明：**
> >
> 从 API version 8开始支持，从API version 9开始废弃，推荐使用[setValue()](#settingssetvaluesync10)。 > 从 API version 8开始支持，从API version 9开始废弃，推荐使用[setValueSync()](#settingssetvaluesync10)。
**模型约束**：此接口仅可在FA模型下使用。 **模型约束**：此接口仅可在FA模型下使用。
...@@ -808,11 +804,11 @@ setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string): ...@@ -808,11 +804,11 @@ setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string):
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | | ----------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | | dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | | name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
| value | string | 是 | 数据项的具体数值。取值范围随业务变动。 | | value | string | 是 | 数据项的具体数值。取值范围随业务变动。 |
**返回值**： **返回值**：
...@@ -829,4 +825,4 @@ import featureAbility from '@ohos.ability.featureAbility'; ...@@ -829,4 +825,4 @@ import featureAbility from '@ohos.ability.featureAbility';
let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS);
let helper = featureAbility.acquireDataAbilityHelper(uri); let helper = featureAbility.acquireDataAbilityHelper(uri);
let ret = settings.setValueSync(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100'); let ret = settings.setValueSync(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100');
``` ```
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或