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