1# @ohos.settings (设置数据项名称) 2 3本模块提供访问设置数据项的能力。 4 5> **说明：** 6> 7> - 本模块首批接口从API version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 8> 9> - 如果访问的数据项没有获取到值，表示当前系统应用没有将该数据项的值添加到数据库。 10 11## 导入模块 12 13```js 14import settings from '@ohos.settings'; 15``` 16## domainName 17 18提供查询的域名 19 20### 属性 21 22**系统能力：** SystemCapability.Applications.Settings.Core 23 24| 名称 | 类型 | 可读 | 可写 | 说明 | 25|-----------------------------| ------ | ---- | ---- | ------------------------------------------------------------ | 26| DEVICE_SHARED<sup>11+</sup> | string | 是 | 是 | 设备属性共享域 | 27| USER_PROPERTY<sup>11+</sup> | string | 是 | 是 | 为用户属性域 | 28 29## date 30 31提供设置时间和日期格式的数据项。(暂不支持) 32 33### 属性 34 35**系统能力：** SystemCapability.Applications.Settings.Core 36 37| 名称 | 类型 | 可读 | 可写 | 说明 | 38| ------------------- | ------ | ---- | ---- | ------------------------------------------------------------ | 39| DATE_FORMAT | string | 是 | 是 | 日期格式。<br/>日期格式包括mm/dd/yyyy、dd/mm/yyyy和yyyy/mm/dd ，其中mm、dd和yyyy分别代表月份、日期和年份。 | 40| TIME_FORMAT | string | 是 | 是 | 时间是以12小时格式还是24小时格式显示。<br>值为 “12” 表示12小时格式；<br/>值为 ”24“ 表示24小时格式。 | 41| AUTO_GAIN_TIME | string | 是 | 是 | 是否自动从网络获取日期、时间和时区。 <br>值为true表示自动从网络获取信息；<br/>值为false表示不自动获取。 | 42| AUTO_GAIN_TIME_ZONE | string | 是 | 是 | 是否自动从NITZ获取时区。 <br>值为true表示自动获取；<br/>值为false表示不自动获取。 | 43 44## display 45 46提供设置显示效果的数据项。(暂不支持) 47 48### 属性 49 50**系统能力：** SystemCapability.Applications.Settings.Core 51 52| 名称 | 类型 | 可读 | 可写 | 说明 | 53| ----------------------------- | ------ | ---- | ---- |-------------------------------------------------------------------------------------------------------------| 54| FONT_SCALE | string | 是 | 是 | 字体的比例因子，值为浮点数。（当前版本参数仅支持固定值查询） | 55| SCREEN_BRIGHTNESS_STATUS | string | 是 | 是 | 屏幕亮度。该值的范围从0到255。 | 56| AUTO_SCREEN_BRIGHTNESS | string | 是 | 是 | 是否启用屏幕亮度自动调整。<br/>值为AUTO_SCREEN_BRIGHTNESS_MODE，表示启用自动调整；<br/>值为MANUAL_SCREEN_BRIGHTNESS_MODE，表示不启用自动调整。 | 57| AUTO_SCREEN_BRIGHTNESS_MODE | number | 是 | 是 | 使用屏幕亮度自动调整时AUTO_SCREEN_BRIGHTNESS的值。 | 58| MANUAL_SCREEN_BRIGHTNESS_MODE | number | 是 | 是 | 使用屏幕亮度手动调整时的AUTO_SCREEN_BRIGHTNESS值。 | 59| SCREEN_OFF_TIMEOUT | string | 是 | 是 | 设备在一段时间不活动后进入睡眠状态的等待时间（单位：ms）。 | 60| DEFAULT_SCREEN_ROTATION | string | 是 | 是 | 启用屏幕的自动旋转时，此属性无效；不启用自动旋转时，以下值可用：<br>值为0，表示屏幕旋转0度；<br>值为1，表示屏幕旋转90度；<br/>值为2，表示屏幕旋转180度；<br/>值为3，表示屏幕旋转270度。 | 61| ANIMATOR_DURATION_SCALE | string | 是 | 是 | 动画持续时间的比例因子。这会影响所有此类动画的开始延迟和持续时间。<br/>值为0，表示动画将立即结束，默认值为1。 | 62| TRANSITION_ANIMATION_SCALE | string | 是 | 是 | 过渡动画的比例因子。<br/>值为0，表示禁用过渡动画。 | 63| WINDOW_ANIMATION_SCALE | string | 是 | 是 | 普通窗口动画的比例因子。<br/>值为0，表示禁用窗口动画。 | 64| DISPLAY_INVERSION_STATUS | string | 是 | 是 | 是否启用显示颜色反转。<br/>值为1，表示启用显示颜色反转；<br/>值为0，表示不启用显示颜色反转。 | 65 66## general 67 68提供设置设备常规信息的数据项。(暂不支持) 69 70### 属性 71 72**系统能力：** SystemCapability.Applications.Settings.Core 73 74| 名称 | 类型 | 可读 | 可写 | 说明 | 75| -------------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ | 76| SETUP_WIZARD_FINISHED | string | 是 | 是 | 是否已运行启动向导。<br>值为0，表示启动向导尚未运行；<br/>值不是0，表示启动向导已运行。 | 77| END_BUTTON_ACTION | string | 是 | 是 | 在用户不在呼叫中时，用户按下呼叫结束按钮会发生的情况。<br/>值为0，表示没有任何反应；<br/>值为1，表示显示主屏幕；<br/>值为2，表示设备进入睡眠状态，屏幕锁定；<br/>值为3，表示显示主屏幕。如果用户已在主屏幕上，设备将进入睡眠状态。 | 78| ACCELEROMETER_ROTATION_STATUS | string | 是 | 是 | 是否使用加速计更改屏幕方向，即是否启用自动旋转。<br>值为1，表示启用加速度计；<br/>值为0，表示不启用加速计。 | 79| DEVICE_PROVISION_STATUS | string | 是 | 是 | 是否预配设备。<br>在具有单个系统用户的多用户设备上，当值为true时，屏幕可能会被锁定。此外，其他功能无法在系统用户上启动，除非它们被标记为在屏幕锁定上显示。 | 80| HDC_STATUS | string | 是 | 是 | 是否启用USB设备上的硬盘控制器（HDC）。<br>值为true，表示启用HDC；<br/>值为false，表示不启用HDC。 | 81| BOOT_COUNTING | string | 是 | 是 | 设备开机后的启动操作数。 | 82| CONTACT_METADATA_SYNC_STATUS | string | 是 | 是 | 是否启用联系人元数据同步。<br>值为true，表示启用同步；<br/>值为false，表示不启用同步。 | 83| DEVICE_NAME | string | 是 | 是 | 设备名称。 | 84| USB_STORAGE_STATUS | string | 是 | 是 | 是否启用USB大容量存储。<br>值为true，表示启用USB大容量存储；<br/>值为false，表示不启用USB大容量存储。 | 85| DEBUGGER_WAITING | string | 是 | 是 | 设备在启动应用程序进行调试时是否等待调试器进行调试。<br>值为1，表示设备等待调试器；<br/>值为0，表示系统不会等待调试器，因此应用程序会正常运行。 | 86| DEBUG_APP_PACKAGE | string | 是 | 是 | 要调试的应用程序的bundle name。 | 87| ACCESSIBILITY_STATUS | string | 是 | 是 | 是否启用辅助功能。<br>值为1，表示启用辅助功能；<br/>值为0，表示不启用辅助功能。 | 88| ACTIVATED_ACCESSIBILITY_SERVICES | string | 是 | 是 | 已激活的辅助功能的列表。 | 89| GEOLOCATION_ORIGINS_ALLOWED | string | 是 | 是 | 浏览器可以使用的默认地理位置。多个地理位置由空格分隔。 | 90| SKIP_USE_HINTS | string | 是 | 是 | 应用程序是否应在首次启动时尝试跳过所有介绍性提示。这适用于临时用户或熟悉环境的用户。<br>值为1，表示应用程序将尝试在第一次启动时跳过所有介绍性提示；<br/>值为0，表示应用程序不会在首次启动时跳过介绍性提示。 | 91| TOUCH_EXPLORATION_STATUS | string | 是 | 是 | 是否启用触摸浏览。<br>值为1，表示启用触摸浏览；<br/>值为0，表示不启用触摸浏览。 | 92 93## input 94 95提供设置有关输入法信息的数据项。(暂不支持) 96 97### 属性 98 99**系统能力：** SystemCapability.Applications.Settings.Core 100 101| 名称 | 类型 | 可读 | 可写 | 说明 | 102| ------------------------------------ | ------ | ---- | ---- | ------------------------------------------------------------ | 103| DEFAULT_INPUT_METHOD | string | 是 | 是 | 默认输入法及其ID。 | 104| ACTIVATED_INPUT_METHOD_SUB_MODE | string | 是 | 是 | 默认输入法键盘类型及其ID。 | 105| ACTIVATED_INPUT_METHODS | string | 是 | 是 | 已激活的输入法的列表。<br>该列表是一个字符串，由已激活的输入法的ID和输入法键盘类型组成。输入法ID后添加冒号':'连接，输入法的键盘类型后添加分号';'连接。用ima代表输入法ID，keyboardType代表键盘类型，示例格式是ima0:keyboardType0;keyboardType1;ima1:ima2:keyboardTypes0。 | 106| SELECTOR_VISIBILITY_FOR_INPUT_METHOD | string | 是 | 是 | 输入法选择器是否可见。<br>值为1，表示输入法选择器可见；<br/>值为0，表示输入法选择器不可见。 | 107| AUTO_CAPS_TEXT_INPUT | string | 是 | 是 | 是否为文本编辑器启用自动大写。<br>值为0，表示不启用自动大写；<br/>值为1，表示启用自动大写。 | 108| AUTO_PUNCTUATE_TEXT_INPUT | string | 是 | 是 | 是否为文本编辑器启用自动标点符号。自动标点符号使文本编辑器能够将两个空格转换为句点'.'和空格。<br>值为0，表示不启用自动标点符号；<br/>值为1，表示启用自动标点符号。 | 109| AUTO_REPLACE_TEXT_INPUT | string | 是 | 是 | 是否为文本编辑器启用自动更正。自动更正使文本编辑器能够更正拼写错误。<br>值为0，表示不启用自动更正；<br/>值为1，表示启用自动更正。 | 110| SHOW_PASSWORD_TEXT_INPUT | string | 是 | 是 | 是否在文本编辑器中启用密码显示。密码显示使文本编辑器能够在用户键入密码字符时显示密码字符。<br>值为0，表示不启用密码显示；<br/>值为1，表示启用密码显示。 | 111 112## network 113 114提供设置网络信息的数据项。(暂不支持) 115 116### 属性 117 118**系统能力：** SystemCapability.Applications.Settings.Core 119 120| 名称 | 类型 | 可读 | 可写 | 说明 | 121| ------------------------ | ------ | ---- | ---- | ------------------------------------------------------------ | 122| DATA_ROAMING_STATUS | string | 是 | 是 | 是否启用数据漫游。<br>值为true，表示启用数据漫游；<br/>值为false，表示不启用数据漫游。 | 123| HTTP_PROXY_CFG | string | 是 | 是 | 全局 HTTP 代理的主机名和端口号。主机名和端口号由冒号':'分隔。 | 124| NETWORK_PREFERENCE_USAGE | string | 是 | 是 | 要使用的网络的用户首选项。 | 125 126## phone 127 128提供设置来电和去电接听方式的数据项。(暂不支持) 129 130### 属性 131 132**系统能力：** SystemCapability.Applications.Settings.Core 133 134| 名称 | 类型 | 可读 | 可写 | 说明 | 135| ------------------ | ------ | ---- | ---- | ------------------------------------------------------------ | 136| RTT_CALLING_STATUS | string | 是 | 是 | 是否启用实时文本 (RTT) 呼叫。启用，来电和去电在设备和运营商支持时作为 RTT 呼叫应答。 <br> 值为1，表示启用RTT 呼叫； <br/> 值为0，表示不启用 RTT 呼叫。 | 137 138## sound 139 140提供设置声音效果的数据项。(暂不支持) 141 142### 属性 143 144**系统能力：** SystemCapability.Applications.Settings.Core 145 146| 名称 | 类型 | 可读 | 可写 | 说明 | 147| ---------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ | 148| VIBRATE_WHILE_RINGING | string | 是 | 是 | 设备在来电响铃时是否振动。此属性将由电话和设置应用程序使用。 该值是布尔类型，仅影响设备因来电而响铃的情况，不影响任何其他应用程序或场景。 | 149| DEFAULT_ALARM_ALERT | string | 是 | 是 | 系统默认告警的存储区域。 | 150| DTMF_TONE_TYPE_WHILE_DIALING | string | 是 | 是 | 拨号时播放的双音多频 (DTMF) 音的类型。 <br>值为0表示常规的短音效，<br/>值为1表示长音效。 | 151| DTMF_TONE_WHILE_DIALING | string | 是 | 是 | 拨号时是否播放 DTMF 音。<br>值为1，表示播放 DTMF 音；<br/>值为0，表示不播放。 | 152| AFFECTED_MODE_RINGER_STREAMS | string | 是 | 是 | 哪些音频流受振铃模式和请勿打扰 (DND) 模式更改的影响。希望特定的音频流受到振铃模式和 DDN 模式变化的影响，请将对应比特位设置为1。 | 153| AFFECTED_MUTE_STREAMS | string | 是 | 是 | 受静音模式影响的音频流。希望特定音频流在静音模式下保持静音，请将相应位设置为1。 | 154| DEFAULT_NOTIFICATION_SOUND | string | 是 | 是 | 系统默认通知音的存储区域。 | 155| DEFAULT_RINGTONE | string | 是 | 是 | 系统默认铃声的存储区域。 | 156| SOUND_EFFECTS_STATUS | string | 是 | 是 | 声音功能是否可用。<br>值为0表示不可用； <br/>值为1表示可用 | 157| VIBRATE_STATUS | string | 是 | 是 | 设备是否为事件振动。该参数在系统内部使用。 <br>值为1，表示设备会因事件而振动； <br/>值为0，表示设备不因事件振动。 | 158| HAPTIC_FEEDBACK_STATUS | string | 是 | 是 | 设备是否启用触觉反馈。<br/>值为true，表示启用触觉反馈；<br/>值为false，表示不启用触觉反馈。 | 159 160## TTS 161 162提供设置文本到语音 (TTS) 转换信息的数据项。(暂不支持) 163 164### 属性 165 166**系统能力：** SystemCapability.Applications.Settings.Core 167 168| 名称 | 类型 | 可读 | 可写 | 说明 | 169| ------------------- | ------ | ---- | ---- | ------------------------------------------------------------ | 170| DEFAULT_TTS_PITCH | string | 是 | 是 | 文本转语音 (TTS) 引擎的默认音高。<br>其中100=1x，该值设置为200，表示频率是正常声音频率的两倍。 | 171| DEFAULT_TTS_RATE | string | 是 | 是 | TTS 引擎的默认语速。<br>其中100=1x。 | 172| DEFAULT_TTS_SYNTH | string | 是 | 是 | 默认TTS引擎。 | 173| ENABLED_TTS_PLUGINS | string | 是 | 是 | 用于TTS的已激活插件包列表， 多个插件包以空格分隔。 | 174 175 176## wireless 177 178提供设置无线网络信息的数据项。(暂不支持) 179 180### 属性 181 182**系统能力：** SystemCapability.Applications.Settings.Core 183 184| 名称 | 类型 | 可读 | 可写 | 说明 | 185| --------------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ | 186| BLUETOOTH_DISCOVER_ABILITY_STATUS | string | 是 | 是 | 设备是否可以被其他设备通过蓝牙发现或连接。<br>值为0表示设备不可以被连接或发现；<br/>值为1表示设备可以被连接但不可以被发现；<br/>值为2表示设备可以被连接和发现。 | 187| BLUETOOTH_DISCOVER_TIMEOUT | string | 是 | 是 | 可以通过蓝牙发现设备的持续时间（以秒为单位）。<br>这段时间之后，设备不可以被蓝牙搜寻到。 | 188| AIRPLANE_MODE_RADIOS | string | 是 | 是 | 启用飞行模式时要禁用的无线电信号列表。 <br>多个无线电信号用逗号 (,) 分隔。取值包括以下常量：BLUETOOTH_RADIO、 CELL_RADIO、 NFC_RADIO、 WIFI_RADIO。 | 189| BLUETOOTH_RADIO | string | 是 | 否 | 常量，作为AIRPLANE_MODE_RADIOS的取值时表示蓝牙在飞行模式下禁用。 | 190| CELL_RADIO | string | 是 | 否 | 常量，作为AIRPLANE_MODE_RADIOS的取值时表示蜂窝无线电在飞行模式下禁用。 | 191| NFC_RADIO | string | 是 | 否 | 常量，作为AIRPLANE_MODE_RADIOS的取值时表示NFC在飞行模式下禁用。 | 192| WIFI_RADIO | string | 是 | 否 | 常量，作为AIRPLANE_MODE_RADIOS的取值时表示Wi-Fi在飞行模式下禁用。 | 193| BLUETOOTH_STATUS | string | 是 | 是 | 蓝牙是否可用。 <br>值为true表示蓝牙可用；<br/>值为false表示蓝牙不可用。 | 194| OWNER_LOCKDOWN_WIFI_CFG | string | 是 | 是 | 是否应锁定由设备所有者的应用程序创建的Wi-Fi配置。<br>值为true表示Wi-Fi配置应该被锁定；<br/>值为false表示不应该被锁定。 | 195| WIFI_DHCP_MAX_RETRY_COUNT | string | 是 | 是 | 尝试从DHCP服务器获取 IP 地址的最大次数。 | 196| WIFI_TO_MOBILE_DATA_AWAKE_TIMEOUT | string | 是 | 是 | Wi-Fi连接断开后等待移动数据连接建立时保持唤醒锁的最长时间。 | 197| WIFI_STATUS | string | 是 | 是 | Wi-Fi是否可用。<br>值为true表示Wi-Fi可用；<br/>值为false表示Wi-Fi不可用。 | 198| WIFI_WATCHDOG_STATUS | string | 是 | 是 | Wi-Fi的WatchDog是否可用。 <br>值为true表示可用；<br/>值为false表示不可用。 | 199 200 201## settings.setValue<sup>10+</sup> 202 203setValue(context: Context, name: string, value: string, callback: AsyncCallback\<boolean>): void 204 205将数据项名称及数据项的值保存到数据库中，使用callback异步回调。 206 207**模型约束**：此接口仅可在Stage模型下使用。 208 209**系统能力**：SystemCapability.Applications.Settings.Core 210 211**需要权限**： ohos.permission.MANAGE_SETTINGS，仅系统应用可用。 212 213**参数**： 214 215| 参数名 | 类型 | 必填 | 说明 | 216| -------- | ----------------------- | ---- | ------------------------------------------------------------ | 217| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 218| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 219| value | string | 是 | 数据项值。取值范围随业务变动。 | 220| callback | AsyncCallback\<boolean> | 是 | 回调函数。返回true表示操作成功，否则操作失败。 | 221 222**示例**： 223 224```js 225import settings from '@ohos.settings'; 226 227// 更新数据项亮度的值（该数据项在数据库中已存在，故setValue方法将更新该数据项的值） 228const context: Context = getContext(this); 229settings.setValue(context, settings.display.SCREEN_BRIGHTNESS_STATUS, '100', (status) => { 230 console.log('Callback return whether value is set.'); 231}); 232``` 233 234## settings.setValue<sup>10+</sup> 235 236setValue(context: Context, name: string, value: string): Promise\<boolean> 237 238将数据项名称及数据项的值保存到数据库中。使用Promise异步回调。 239 240**模型约束**：此接口仅可在Stage模型下使用。 241 242**系统能力**：SystemCapability.Applications.Settings.Core 243 244**需要权限**： ohos.permission.MANAGE_SETTINGS，仅系统应用可用。 245 246**参数**： 247 248| 参数名 | 类型 | 必填 | 说明 | 249| ------- | ------- | ---- | ------------------------------------------------------------ | 250| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 251| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 252| value | string | 是 | 数据项值。取值范围随业务变动。 | 253 254**返回值**： 255 256| 类型 | 说明 | 257| ----------------- | -------------------------------------------------- | 258| Promise\<boolean> | Promise对象。返回true表示操作成功，否则返回false。 | 259 260**示例**： 261 262```js 263import settings from '@ohos.settings'; 264 265// 更新数据项亮度的值（该数据项在数据库中已存在，故setValue方法将更新该数据项的值） 266const context: Context = getContext(this); 267settings.setValue(context, settings.display.SCREEN_BRIGHTNESS_STATUS, '100').then((status) => { 268 console.log('Callback return whether value is set.'); 269}); 270``` 271 272## settings.setValue<sup>11+</sup> 273 274setValue(context: Context, name: string, value: string, domainName: string): Promise\<boolean> 275 276将数据项名称及数据项的值保存到数据库中。使用 Promise异步回调。 277 278**模型约束**：此接口仅可在Stage模型下使用。 279 280**系统能力**：SystemCapability.Applications.Settings.Core 281 282**需要权限**： 283写入DEVICE_SHARED、USER_PROPRERTY域 284需要权限ohos.permission.MANAGE_SETTINGS，仅系统应用可用。 285写入USER_SECURITY域 286需要权限ohos.permission.MANAGE_SECURE_SETTINGS，仅系统应用可用。 287 288**参数**： 289 290| 参数名 | 类型 | 必填 | 说明 | 291| -------- | ---------------------- | ---- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 292| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 293| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 294| value | string | 是 | 数据项值。取值范围随业务变动。 | 295|domainName| string | 是 | 指定要设置的域名 <br> - domainName为domainName.DEVICE_SHARED,<br> 表示设备属性共享域。<br>- domainName为domainName.USER_PROPRERTY,<br> 表示为用户属性域。 <br> - domainName为domainName.USER_SECURITY,<br> 表示为用户安全属性域（仅对系统应用开放） | 296 297**返回值**： 298 299| 类型 | 说明 | 300| ---------------- | ----------------------------------- | 301| Promise\<string> | Promise对象。返回true表示操作成功，否则返回false。 | 302 303**错误码**： 304 305以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md) 306 307| 错误码ID | 错误信息 | 308| ------- | -------- | 309| 201 | Permission denied. | 310 311**示例**： 312 313```js 314import settings from '@ohos.settings'; 315 316// 更新数据项亮度的值（该数据项在数据库中已存在，故setValue方法将更新该数据项的值） 317const context: Context = getContext(this); 318settings.setValue(context, settings.display.SCREEN_BRIGHTNESS_STATUS, '100', settings.domainName.DEVICE_SHARED).then((status) => { 319 console.log(`callback:return whether value is set.`) 320}); 321``` 322 323## settings.getValue<sup>10+</sup> 324 325getValue(context: Context, name: string, callback: AsyncCallback\<string>): void 326 327获取数据库中指定数据项的值。使用callback异步回调。 328 329**模型约束**：此接口仅可在Stage模型下使用。 330 331**系统能力**：SystemCapability.Applications.Settings.Core 332 333**参数**： 334 335| 参数名 | 类型 | 必填 | 说明 | 336| -------- | ---------------------- | ---- | ------------------------------------------------------------ | 337| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 338| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 339| callback | AsyncCallback\<string> | 是 | 使用callback方式获取数据项的值。 | 340 341**示例**： 342 343```js 344import settings from '@ohos.settings'; 345const context: Context = getContext(this); 346settings.getValue(context, settings.display.SCREEN_BRIGHTNESS_STATUS, (err, value) => { 347 if (err) { 348 console.error(`Failed to get the setting. ${err.message} `); 349 return; 350 } 351 console.log(`callback:value -> ${value}`) 352}); 353``` 354 355## settings.getValue<sup>10+</sup> 356 357getValue(context: Context, name: string): Promise\<string> 358 359获取数据库中指定数据项的值。使用Promise异步回调。 360 361**模型约束**：此接口仅可在Stage模型下使用。 362 363**系统能力**：SystemCapability.Applications.Settings.Core 364 365**参数**： 366 367| 参数名 | 类型 | 必填 | 说明 | 368| ------- | ------- | ---- | ------------------------------------------------------------ | 369| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 370| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 371 372**返回值**： 373 374| 类型 | 说明 | 375| ---------------- | ----------------------------------- | 376| Promise\<string> | Promise对象。返回获得的数据项的值。 | 377 378**示例**： 379 380```js 381import settings from '@ohos.settings'; 382const context: Context = getContext(this); 383settings.getValue(context, settings.display.SCREEN_BRIGHTNESS_STATUS).then((value) => { 384 console.log(`promise:value -> ${value}`) 385}); 386``` 387 388## settings.getValue<sup>11+</sup> 389 390getValue(context: Context, name: string, domainName: string): Promise\<string>; 391 392获取数据库中指定数据项的值。使用 Promise异步回调。 393 394**模型约束**：此接口仅可在Stage模型下使用。 395 396**系统能力**：SystemCapability.Applications.Settings.Core 397 398**需要权限**： 399读取USER_SECURITY域 400需要权限ohos.permission.MANAGE_SECURE_SETTINGS，仅系统应用可用。 401 402**参数**： 403 404| 参数名 | 类型 | 必填 | 说明 | 405| -------- | ---------------------- | ---- | ------------------------------------------------------------ | 406| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 407| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 408|domainName| string | 是 | 指定要设置的域名 <br> - domainName为domainName.DEVICE_SHARED,<br> 设备属性共享域。<br>- domainName为domainName.USER_PROPRERTY,<br> 表示为用户属性域。 <br> - domainName为domainName.USER_SECURITY,<br> 表示为用户安全属性域（仅对系统应用开放）| 409 410**返回值**： 411 412| 类型 | 说明 | 413| ---------------- | ----------------------------------- | 414| Promise\<string> | Promise对象。返回获得的数据项的值。 | 415 416**示例**： 417 418```js 419import settings from '@ohos.settings'; 420 421// 更新数据项亮度的值（该数据项在数据库中已存在，故getValue方法将更新该数据项的值） 422const context: Context = getContext(this); 423settings.getValue(context, settings.display.SCREEN_BRIGHTNESS_STATUS, settings.domainName.DEVICE_SHARED).then((value) => { 424 console.log(`Promise:value -> ${value}`); 425}); 426``` 427 428## settings.getValueSync<sup>10+</sup> 429 430getValueSync(context: Context, name: string, defValue: string): string; 431 432获取数据项的值。此方法相较getValue为同步方法。 433 434**模型约束**：此接口仅可在Stage模型下使用。 435 436**系统能力**：SystemCapability.Applications.Settings.Core 437 438**参数**： 439 440| 参数名 | 类型 | 必填 | 说明 | 441| -------- | ------- | ---- | ------------------------------------------------------------ | 442| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 443| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 444| defValue | string | 是 | 默认值。由开发者设置，当未从数据库中查询到该数据时，表示返回该默认值。 | 445 446**返回值**： 447 448| 类型 | 说明 | 449| ------ | ---------------- | 450| string | 返回数据项的值。 | 451 452**示例**： 453 454```js 455import settings from '@ohos.settings'; 456 457// 获取数据项亮度的值（该数据项在数据库中已存在） 458const context: Context = getContext(this); 459let value = settings.getValueSync(context, settings.display.SCREEN_BRIGHTNESS_STATUS, '10'); 460``` 461 462## settings.getValueSync<sup>11+</sup> 463 464getValueSync(context: Context, name: string, defValue: string, domainName: string): string; 465 466获取数据项的值。此方法相较getValue为同步方法。 467 468**模型约束**：此接口仅可在Stage模型下使用。 469 470**系统能力**：SystemCapability.Applications.Settings.Core 471 472**需要权限**： 473读取USER_SECURITY域 474需要权限ohos.permission.MANAGE_SECURE_SETTINGS，仅系统应用可用。 475 476**参数**： 477 478| 参数名 | 类型 | 必填 | 说明 | 479|------------| ---------------------- | ---- | ------------------------------------------------------------ | 480| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 481| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 482| defValue | string | 是 | 数据项值。取值范围随业务变动。 | 483| domainName | string | 是 | 指定要设置的域名 <br> - domainName为domainName.DEVICE_SHARED,<br> 设备属性共享域。<br>- domainName为domainName.USER_PROPRERTY,<br> 表示为用户属性域。 <br> - domainName为domainName.USER_SECURITY,<br> 表示为用户安全属性域（仅对系统应用开放）| 484 485 486**返回值**： 487 488| 类型 | 说明 | 489| ---------------- | ----------------------------------- | 490| string | 返回数据项的值 | 491 492**示例**： 493 494```js 495import settings from '@ohos.settings'; 496 497// 更新数据项亮度的值（该数据项在数据库中已存在） 498const context: Context = getContext(this); 499let value = settings.getValueSync(context, settings.display.SCREEN_BRIGHTNESS_STATUS, '100', settings.domainName.DEVICE_SHARED); 500``` 501 502## settings.setValueSync<sup>10+</sup> 503 504setValueSync(context: Context, name: string, value: string): boolean 505 506设置数据项的值。此方法相较setValue为同步方法。 507 508如果数据库中已经存在该数据项，则setValueSync方法将更新该数据项的值；如果数据库中尚未存在该数据项，则setValueSync方法将向数据库中插入该数据项。 509 510**模型约束**：此接口仅可在Stage模型下使用。 511 512**系统能力**：SystemCapability.Applications.Settings.Core 513 514**需要权限**： ohos.permission.MANAGE_SETTINGS，仅系统应用可用。 515 516**参数**： 517 518| 参数名 | 类型 | 必填 | 说明 | 519| ------- | ------- | ---- | ------------------------------------------------------------ | 520| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 521| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 522| value | string | 是 | 数据项的具体数值。取值范围随业务变动。 | 523 524**返回值**： 525 526| 类型 | 说明 | 527| ------- | ------------------------------------------------------------ | 528| boolean | 返回设置数据项的值是否成功的结果。true表示设置成功，false表示设置失败。 | 529 530**示例**： 531 532```js 533import settings from '@ohos.settings'; 534 535// 更新数据项亮度的值（该数据项在数据库中已存在，故setValueSync方法将更新该数据项的值） 536const context: Context = getContext(this); 537let ret = settings.setValueSync(context, settings.display.SCREEN_BRIGHTNESS_STATUS, '100'); 538``` 539 540## settings.setValueSync<sup>11+</sup> 541 542setValueSync(context: Context, name: string, value: string, domainName: string): boolean 543 544设置数据项的值。此方法相较setValue为同步方法。 545 546如果数据库中已经存在该数据项，则setValueSync方法将更新该数据项的值；如果数据库中尚未存在该数据项，则setValueSync方法将向数据库中插入该数据项。 547 548**模型约束**：此接口仅可在Stage模型下使用。 549 550**系统能力**：SystemCapability.Applications.Settings.Core 551 552**需要权限**： 553写入DEVICE_SHARED、USER_PROPRERTY域 554需要权限ohos.permission.MANAGE_SETTINGS，仅系统应用可用。 555写入USER_SECURITY域 556需要权限ohos.permission.MANAGE_SECURE_SETTINGS，仅系统应用可用。 557 558**参数**： 559 560| 参数名 | 类型 | 必填 | 说明 | 561|---------| ---------------------- | ---- | ------------------------------------------------------------ | 562| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 563| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 564| value | string | 是 | 数据项值。取值范围随业务变动。 | 565| domainName | string | 是 | 指定要设置的域名 <br> - domainName为domainName.DEVICE_SHARED,<br> 设备属性共享域。<br>- domainName为domainName.USER_PROPRERTY,<br> 表示为用户属性域。 <br> - domainName为domainName.USER_SECURITY,<br> 表示为用户安全属性域（仅对系统应用开放）| 566 567**返回值**： 568 569| 类型 | 说明 | 570| ---------------- | ----------------------------------- | 571| boolean | 返回设置数据项的值是否成功发结果。返回true表示设置成功，false表示设置失败。 | 572 573**错误码**： 574 575以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md) 576 577| 错误码ID | 错误信息 | 578| ------- | -------- | 579| 201 | Permission denied. | 580 581**示例**： 582 583```js 584import settings from '@ohos.settings'; 585 586// 更新数据项亮度的值（该数据项在数据库中已存在，故setValueSync方法将更新该数据项的值） 587const context: Context = getContext(this); 588let ret = settings.setValueSync(context, settings.display.SCREEN_BRIGHTNESS_STATUS, '100', settings.domainName.DEVICE_SHARED); 589``` 590 591## settings.registerKeyObserver<sup>11+</sup> 592 593registerKeyObserver(context: Context, name: string, domainName: string, observer:AsyncCallback\<void>): boolean 594 595用于在指定上下文中注册一个观察者，以便于在指定域名中观察指定的域名。当该键值发生变化时，将调用注册的回调函数，如果成功注册则返回true，否则返回false。 596 597**模型约束**：此接口仅可在Stage模型下使用。 598 599**系统能力**：SystemCapability.Applications.Settings.Core 600 601**参数**： 602 603| 参数名 | 类型 | 必填 | 说明 | 604| -------- | ---------------------- | ---- | ------------------------------------------------------------ | 605| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 606| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 607|domainName| string | 是 | 指定要设置的域名 <br> - domainName为domainName.DEVICE_SHARED,<br> 设备属性共享域。<br>- domainName为domainName.USER_PROPRERTY,<br> 表示为用户属性域。 <br> - domainName为domainName.USER_SECURITY,<br> 表示为用户安全属性域（仅对系统应用开放）| 608|observer | AsyncCallback\<void> | 是 | 使用collback方式获取数据项的值。 | 609 610**返回值**： 611 612| 类型 | 说明 | 613| ---------------- | ----------------------------------- | 614| boolean | 返回设置数据项的值是否成功的结果，true表示设置成功，false表示设置失败。 | 615 616**示例**： 617 618```js 619import settings from '@ohos.settings'; 620 621const context: Context = getContext(this); 622settings.registerKeyObserver(context, settings.display.SCREEN_BRIGHTNESS_STATUS, settings.domainName.DEVICE_SHARED, (err, val) => { 623 if (err) { 624 console.error(`Failed to get the setting. ${err.message} `); 625 return; 626 } 627 console.log(`callback:value -> ${JSON.stringify(val)}`) 628 let value:string = settings.getValueSync(context, settings.display.SCREEN_BRIGHTNESS_STATUS, '10'); 629 console.log(`Promise:value -> ${value}`); 630}); 631``` 632 633## settings.unregisterKeyObserver<sup>11+</sup> 634 635unregisterKeyObserver(context: Context, name: string, domainName: string): boolean 636 637同步方法，进行注销指定域名下对指定键的监视器。 638 639**模型约束**：此接口仅可在Stage模型下使用。 640 641**系统能力**：SystemCapability.Applications.Settings.Core 642 643| 参数名 | 类型 | 必填 | 说明 | 644| -------- | ---------------------- | ---- | ------------------------------------------------------------ | 645| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 646| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 647|domainName| string | 是 | 指定要设置的域名 <br> - domainName为domainName.DEVICE_SHARED,<br> 设备属性共享域。<br>- domainName为domainName.USER_PROPRERTY,<br> 表示为用户属性域。 <br> - domainName为domainName.USER_SECURITY,<br> 表示为用户安全属性域（仅对系统应用开放）| 648 649**返回值**： 650 651| 类型 | 说明 | 652| ---------------- | ----------------------------------- | 653| boolean | 返回注销指定域名下对指定键的监视器是否成功的结果，true表示注销成功，false表示注销失败。 | 654 655**示例**： 656 657```js 658import settings from '@ohos.settings'; 659 660const context: Context = getContext(this); 661let ret = settings.unregisterKeyObserver(context, settings.display.SCREEN_BRIGHTNESS_STATUS, settings.domainName.DEVICE_SHARED); 662``` 663 664## settings.enableAirplaneMode 665 666enableAirplaneMode(enable: boolean, callback: AsyncCallback\<void>): void 667 668启用或禁用飞行模式。使用callback异步回调。(暂不支持) 669 670**系统能力**：SystemCapability.Applications.Settings.Core 671 672**参数**： 673 674| 参数名 | 类型 | 必填 | 说明 | 675| -------- | -------------------- | ---- | ----------------------------------------------- | 676| enable | boolean | 是 | 是否开启飞行模式。true表示开启，false表示禁用。 | 677| callback | AsyncCallback\<void> | 是 | 回调函数。 | 678 679**示例**： 680 681```js 682let isEnabled :boolean = true; 683settings.enableAirplaneMode(isEnabled, (err:Error) => { 684 if (err) { 685 console.log('Failed to enable AirplaneMode.'); 686 return; 687 } 688 console.log('Return true if enable.'); 689}) 690``` 691 692## settings.enableAirplaneMode 693 694enableAirplaneMode(enable: boolean): Promise\<void> 695 696启用或禁用飞行模式。使用Promise异步回调。(暂不支持) 697 698**系统能力**：SystemCapability.Applications.Settings.Core 699 700**参数**： 701 702| 参数名 | 类型 | 必填 | 说明 | 703| ------ | ------- | ---- | ----------------------------------------------- | 704| enable | boolean | 是 | 是否开启飞行模式。true表示开启，false表示禁用。 | 705 706**返回值**： 707 708| 类型 | 说明 | 709| -------------- | ------------------------- | 710| Promise\<void> | 无返回结果的Promise对象。 | 711 712**示例**： 713 714```js 715let isEnabled :boolean = true; 716settings.enableAirplaneMode(isEnabled).then(() => { 717 console.log('Succeeded in enabling AirplaneMode.'); 718}).catch((err:Error) => { 719 console.log(`Failed to enable AirplaneMode. Cause: ${err}`); 720}) 721``` 722 723## settings.canShowFloating 724 725canShowFloating(callback: AsyncCallback\<boolean>): void 726 727检查应用是否能够以悬浮窗形式显示。使用callback异步回调。(暂不支持) 728 729**系统能力**：SystemCapability.Applications.Settings.Core 730 731**参数**： 732 733| 参数名 | 类型 | 必填 | 说明 | 734| -------- | ----------------------- | ---- | ------------------------------------------------------------ | 735| callback | AsyncCallback\<boolean> | 是 | 回调函数。<br/>返回true，表示应用能够以悬浮窗形式显示；返回false，则表示不能。 | 736 737**示例**： 738 739```js 740settings.canShowFloating((err:Error, status: boolean) => { 741 if (err) { 742 console.error(`Failed to Checks whether a specified application can show as float window ${err.message} `); 743 return; 744 } 745 console.log('Checks whether a specified application can show as float window.'); 746}); 747``` 748 749## settings.canShowFloating 750 751canShowFloating(): Promise\<boolean> 752 753检查应用是否能够以悬浮窗形式显示。使用Promise异步回调。(暂不支持) 754 755**系统能力**：SystemCapability.Applications.Settings.Core 756 757**返回值**： 758 759| 类型 | 说明 | 760| ----------------- | ------------------------------------------------------------ | 761| Promise\<boolean> | Promise对象。<br/>返回true，表示应用能够以悬浮窗形式显示；返回false，则表示不能。 | 762 763**示例**： 764 765```js 766settings.canShowFloating().then((status:boolean) => { 767 console.log('Checks whether a specified application can show as float window.'); 768}); 769``` 770 771## settings.getUriSync<sup>8+</sup> 772 773getUriSync(name: string): string 774 775获取数据项的URI。(暂不支持) 776 777**系统能力**：SystemCapability.Applications.Settings.Core 778 779**参数**： 780 781| 参数名 | 类型 | 必填 | 说明 | 782| ------ | ------ | ---- | ------------------------------------------------------------ | 783| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 784 785**返回值**： 786 787| 类型 | 说明 | 788| ------ | ------------- | 789| string | 数据项的URI。 | 790 791**示例**： 792 793```js 794// 获取数据项的URI 795let uriVar:string = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); 796``` 797 798## settings.getURI<sup>(deprecated)</sup> 799 800getURI(name: string, callback: AsyncCallback\<object>): void 801 802获取数据项的URI。使用callback异步回调。(暂不支持) 803 804> **说明：** 805> 806> 从 API version 7开始支持，从API version 9开始废弃，此接口不再提供代替接口。 807 808**系统能力**：SystemCapability.Applications.Settings.Core 809 810**参数**： 811 812| 参数名 | 类型 | 必填 | 说明 | 813| -------- | ---------------------- | ---- | ------------------------------------------------------------ | 814| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 815| callback | AsyncCallback\<object> | 是 | 回调函数。获取数据项的URI。 | 816 817**示例**： 818 819```js 820settings.getURI(settings.display.SCREEN_BRIGHTNESS_STATUS, (uri:string) => { 821 console.log(`callback:uri -> ${JSON.stringify(uri)}`) 822}) 823``` 824 825## settings.getURI<sup>(deprecated)</sup> 826 827getURI(name: string): Promise\<object> 828 829获取数据项的URI。使用Promise异步回调。(暂不支持) 830 831> **说明：** 832> 833> 从 API version 7开始支持，从API version 9开始废弃，此接口不再提供代替接口。 834 835**系统能力**：SystemCapability.Applications.Settings.Core 836 837**参数**： 838 839| 参数名 | 类型 | 必填 | 说明 | 840| ------ | ------ | ---- | ------------------------------------------------------------ | 841| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 842 843**返回值**： 844 845| 类型 | 说明 | 846| ---------------- | ------------------------------------ | 847| Promise\<object> | Promise对象。返回获取的数据项的URI。 | 848 849**示例**： 850 851```js 852settings.getURI(settings.display.SCREEN_BRIGHTNESS_STATUS).then((uri:string) => { 853 console.log(`promise:uri -> ${JSON.stringify(uri)}`) 854}) 855``` 856 857 858 859## settings.getValue<sup>(deprecated)</sup> 860 861getValue(dataAbilityHelper: DataAbilityHelper, name: string, callback: AsyncCallback\<object>): void 862 863获取数据库中指定数据项的值。使用callback异步回调。 864 865> **说明：** 866> 867> 从 API version 7开始支持，从API version 9开始废弃，推荐使用[getValue()](#settingsgetvalue10)。 868 869**模型约束**：此接口仅可在FA模型下使用。 870 871**系统能力**：SystemCapability.Applications.Settings.Core 872 873**参数**： 874 875| 参数名 | 类型 | 必填 | 说明 | 876| ----------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | 877| dataAbilityHelper | [DataAbilityHelper](../apis-ability-kit/js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | 878| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 879| callback | AsyncCallback\<object> | 是 | 使用callback方式获取数据项的值。 | 880 881**示例**： 882 883```js 884import featureAbility from '@ohos.ability.featureAbility'; 885 886let uri:string = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); 887let helper = featureAbility.acquireDataAbilityHelper(uri); 888settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, (err:Error, value:string) => { 889 if (err) { 890 console.error(`Failed to get the setting. ${err.message} `); 891 return; 892 } 893 console.log(`callback:value -> ${JSON.stringify(value)}`) 894}); 895``` 896 897## settings.getValue<sup>(deprecated)</sup> 898 899getValue(dataAbilityHelper: DataAbilityHelper, name: string): Promise\<object> 900 901获取数据库中指定数据项的值。使用Promise异步回调。 902 903> **说明：** 904> 905> 从 API version 7开始支持，从API version 9开始废弃，推荐使用[getValue()](#settingsgetvalue10-1)。 906 907**模型约束**：此接口仅可在FA模型下使用。 908 909**系统能力**：SystemCapability.Applications.Settings.Core 910 911**参数**： 912 913| 参数名 | 类型 | 必填 | 说明 | 914| ----------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | 915| dataAbilityHelper | [DataAbilityHelper](../apis-ability-kit/js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | 916| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 917 918**返回值**： 919 920| 类型 | 说明 | 921| ---------------- | ----------------------------------- | 922| Promise\<object> | Promise对象。返回获得的数据项的值。 | 923 924**示例**： 925 926```js 927import featureAbility from '@ohos.ability.featureAbility'; 928 929let uri:string = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); 930let helper = featureAbility.acquireDataAbilityHelper(uri); 931settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS).then((value:string) => { 932 console.log(`promise:value -> ${JSON.stringify(value)}`) 933}); 934``` 935 936## settings.getValueSync<sup>(deprecated)</sup> 937 938getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: string): string 939 940获取数据项的值。此方法相较getValue为同步方法。 941 942> **说明：** 943> 944> 从 API version 8开始支持，从API version 9开始废弃，推荐使用[getValueSync()](#settingsgetvaluesync10)。 945 946**模型约束**：此接口仅可在FA模型下使用。 947 948**系统能力**：SystemCapability.Applications.Settings.Core 949 950**参数**： 951 952| 参数名 | 类型 | 必填 | 说明 | 953| ----------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | 954| dataAbilityHelper | [DataAbilityHelper](../apis-ability-kit/js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | 955| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 956| defValue | string | 是 | 默认值。由开发者设置，当未从数据库中查询到该数据时，表示返回该默认值。 | 957 958**返回值**： 959 960| 类型 | 说明 | 961| ------ | ---------------- | 962| string | 返回数据项的值。 | 963 964**示例**： 965 966```js 967import featureAbility from '@ohos.ability.featureAbility'; 968 969//获取数据项亮度的值（该数据项在数据库中已存在） 970let uri:string = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); 971let helper = featureAbility.acquireDataAbilityHelper(uri); 972let value:string = settings.getValueSync(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '10'); 973``` 974 975## settings.setValueSync<sup>(deprecated)</sup> 976 977setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string): boolean 978 979设置数据项的值。此方法相较setValue为同步方法。 980 981如果数据库中已经存在该数据项，则setValueSync方法将更新该数据项的值；如果数据库中尚未存在该数据项，则setValueSync方法将向数据库中插入该数据项。 982 983> **说明：** 984> 985> 从 API version 8开始支持，从API version 9开始废弃，推荐使用[setValueSync()](#settingssetvaluesync10)。 986 987**模型约束**：此接口仅可在FA模型下使用。 988 989**需要权限**：ohos.permission.MANAGE_SETTINGS，仅系统应用可用。 990 991**系统能力**：SystemCapability.Applications.Settings.Core 992 993**参数**： 994 995| 参数名 | 类型 | 必填 | 说明 | 996| ----------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | 997| dataAbilityHelper | [DataAbilityHelper](../apis-ability-kit/js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | 998| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 999| value | string | 是 | 数据项的具体数值。取值范围随业务变动。 | 1000 1001**返回值**： 1002 1003| 类型 | 说明 | 1004| ------- | ------------------------------------------------------------ | 1005| boolean | 返回设置数据项的值是否成功的结果。true表示设置成功，false表示设置失败。 | 1006 1007**示例**： 1008 1009```js 1010import featureAbility from '@ohos.ability.featureAbility'; 1011 1012//更新数据项亮度的值（该数据项在数据库中已存在，故setValueSync方法将更新该数据项的值） 1013let uri:string = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); 1014let helper = featureAbility.acquireDataAbilityHelper(uri); 1015let ret:string = settings.setValueSync(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100'); 1016```