• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.settings (设置数据项名称)(系统接口)
2
3本模块提供访问设置数据项的能力。
4
5> **说明:**
6>
7> - 本模块首批接口从API version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
8> - 当前页面仅包含本模块的系统接口,其他公开接口参见[@ohos.settings (设置数据项名称)](./js-apis-settings.md)。
9
10## 导入模块
11
12```js
13import settings from '@ohos.settings';
14```
15
16## domainName
17
18提供查询的域名
19
20### 属性
21
22**系统能力:** SystemCapability.Applications.Settings.Core
23
24| 名称                | 类型   | 可读 | 可写 | 说明                                                         |
25| ------------------- | ------ | ---- | ---- | ------------------------------------------------------------ |
26| USER_SECURITY<sup>11+</sup>      | string | 是   | 是   | 用户安全属性域                                          |
27
28
29## settings.setValue<sup>(deprecated)</sup>
30
31setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object, callback: AsyncCallback\<boolean>): void
32
33将数据项名称及数据项的值保存到数据库中。使用callback异步回调。
34
35> **说明:**
36>
37> 从 API version 7开始支持,从API version 9开始废弃,推荐使用[setValue()](js-apis-settings.md#settingssetvalue10)。
38
39**系统接口**:此接口为系统接口。
40
41**模型约束**:此接口仅可在FA模型下使用。
42
43**系统能力**:SystemCapability.Applications.Settings.Core
44
45**参数**:
46
47| 参数名            | 类型                                                         | 必填 | 说明                                                         |
48| ----------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
49| dataAbilityHelper | [DataAbilityHelper](../apis-ability-kit/js-apis-inner-ability-dataAbilityHelper.md) | 是   | 数据管理辅助类。                                             |
50| name              | string                                                       | 是   | 数据项的名称。数据项名称分为以下两种:<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
51| value             | object                                                       | 是   | 数据项值。取值范围随业务变动。                               |
52| callback          | AsyncCallback\<boolean>                                      | 是   | 回调函数。返回true表示操作成功,否则操作失败。               |
53
54
55## settings.setValue<sup>(deprecated)</sup>
56
57setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object): Promise\<boolean>
58
59将数据项名称及数据项的值保存到数据库中。使用Promise异步回调。
60
61> **说明:**
62>
63> 从 API version 7开始支持,从API version 9开始废弃,推荐使用[setValue()](js-apis-settings.md#settingssetvalue10-1)。
64
65**系统接口**:此接口为系统接口。
66
67**模型约束**:此接口仅可在FA模型下使用。
68
69**系统能力**:SystemCapability.Applications.Settings.Core
70
71**参数**:
72
73| 参数名            | 类型                                                         | 必填 | 说明                                                         |
74| ----------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
75| dataAbilityHelper | [DataAbilityHelper](../apis-ability-kit/js-apis-inner-ability-dataAbilityHelper.md) | 是   | 数据管理辅助类。                                             |
76| name              | string                                                       | 是   | 数据项的名称。数据项名称分为以下两种:<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
77| value             | object                                                       | 是   | 数据项值。取值范围随业务变动。                               |
78
79**返回值**:
80
81| 类型              | 说明                                               |
82| ----------------- | -------------------------------------------------- |
83| Promise\<boolean> | Promise对象。返回true表示操作成功,否则返回false。 |
84
85