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_SECURE_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_SECURE_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**需要权限**： ohos.permission.MANAGE_SECURE_SETTINGS，仅系统应用可用。 283 284**参数**： 285 286| 参数名 | 类型 | 必填 | 说明 | 287| -------- | ---------------------- | ---- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 288| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 289| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 290| value | string | 是 | 数据项值。取值范围随业务变动。 | 291|domainName| string | 是 | 指定要设置的域名 <br> - domainName为domainName.DEVICE_SHARED,<br> 表示设备属性共享域。<br>- domainName为domainName.USER_PROPRERTY,<br> 表示为用户属性域。 <br> - domainName为domainName.USER_SECURITY,<br> 表示为用户安全属性域（仅对系统应用开放） | 292 293**返回值**： 294 295| 类型 | 说明 | 296| ---------------- | ----------------------------------- | 297| Promise\<string> | Promise对象。返回true表示操作成功，否则返回false。 | 298 299**示例**： 300 301```js 302import settings from '@ohos.settings'; 303 304// 更新数据项亮度的值（该数据项在数据库中已存在，故setValue方法将更新该数据项的值） 305const context: Context = getContext(this); 306settings.setValue(context, settings.display.SCREEN_BRIGHTNESS_STATUS, '100', settings.domainName.DEVICE_SHARED).then((status) => { 307 console.log(`callback:return whether value is set.`) 308}); 309``` 310 311## settings.getValue<sup>10+</sup> 312 313getValue(context: Context, name: string, callback: AsyncCallback\<string>): void 314 315获取数据库中指定数据项的值。使用callback异步回调。 316 317**模型约束**：此接口仅可在Stage模型下使用。 318 319**系统能力**：SystemCapability.Applications.Settings.Core 320 321**参数**： 322 323| 参数名 | 类型 | 必填 | 说明 | 324| -------- | ---------------------- | ---- | ------------------------------------------------------------ | 325| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 326| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 327| callback | AsyncCallback\<string> | 是 | 使用callback方式获取数据项的值。 | 328 329**示例**： 330 331```js 332import settings from '@ohos.settings'; 333const context: Context = getContext(this); 334settings.getValue(context, settings.display.SCREEN_BRIGHTNESS_STATUS, (err, value) => { 335 if (err) { 336 console.error(`Failed to get the setting. ${err.message} `); 337 return; 338 } 339 console.log(`callback:value -> ${JSON.stringify(value)}`) 340}); 341``` 342 343## settings.getValue<sup>10+</sup> 344 345getValue(context: Context, name: string): Promise\<string> 346 347获取数据库中指定数据项的值。使用Promise异步回调。 348 349**模型约束**：此接口仅可在Stage模型下使用。 350 351**系统能力**：SystemCapability.Applications.Settings.Core 352 353**参数**： 354 355| 参数名 | 类型 | 必填 | 说明 | 356| ------- | ------- | ---- | ------------------------------------------------------------ | 357| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 358| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 359 360**返回值**： 361 362| 类型 | 说明 | 363| ---------------- | ----------------------------------- | 364| Promise\<string> | Promise对象。返回获得的数据项的值。 | 365 366**示例**： 367 368```js 369import settings from '@ohos.settings'; 370const context: Context = getContext(this); 371settings.getValue(context, settings.display.SCREEN_BRIGHTNESS_STATUS).then((value) => { 372 console.log(`promise:value -> ${JSON.stringify(value)}`) 373}); 374``` 375 376## settings.getValue<sup>11+</sup> 377 378getValue(context: Context, name: string, domainName: string): Promise\<string>; 379 380获取数据库中指定数据项的值。使用 Promise异步回调。 381 382**模型约束**：此接口仅可在Stage模型下使用。 383 384**系统能力**：SystemCapability.Applications.Settings.Core 385 386**参数**： 387 388| 参数名 | 类型 | 必填 | 说明 | 389| -------- | ---------------------- | ---- | ------------------------------------------------------------ | 390| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 391| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 392|domainName| string | 是 | 指定要设置的域名 <br> - domainName为domainName.DEVICE_SHARED,<br> 设备属性共享域。<br>- domainName为domainName.USER_PROPRERTY,<br> 表示为用户属性域。 <br> - domainName为domainName.USER_SECURITY,<br> 表示为用户安全属性域（仅对系统应用开放）| 393 394**返回值**： 395 396| 类型 | 说明 | 397| ---------------- | ----------------------------------- | 398| Promise\<string> | Promise对象。返回true表示操作成功，否则返回false。 | 399 400**示例**： 401 402```js 403import settings from '@ohos.settings'; 404 405// 更新数据项亮度的值（该数据项在数据库中已存在，故getValue方法将更新该数据项的值） 406const context: Context = getContext(this); 407settings.getValue(context, settings.display.SCREEN_BRIGHTNESS_STATUS, settings.domainName.DEVICE_SHARED).then((value) => { 408 console.log(`Promise:value -> $ {JSON.stringify(value)}`); 409}); 410``` 411 412## settings.getValueSync<sup>10+</sup> 413 414getValueSync(context: Context, name: string, defValue: string): string; 415 416获取数据项的值。此方法相较getValue为同步方法。 417 418**模型约束**：此接口仅可在Stage模型下使用。 419 420**系统能力**：SystemCapability.Applications.Settings.Core 421 422**参数**： 423 424| 参数名 | 类型 | 必填 | 说明 | 425| -------- | ------- | ---- | ------------------------------------------------------------ | 426| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 427| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 428| defValue | string | 是 | 默认值。由开发者设置，当未从数据库中查询到该数据时，表示返回该默认值。 | 429 430**返回值**： 431 432| 类型 | 说明 | 433| ------ | ---------------- | 434| string | 返回数据项的值。 | 435 436**示例**： 437 438```js 439import settings from '@ohos.settings'; 440 441// 获取数据项亮度的值（该数据项在数据库中已存在） 442const context: Context = getContext(this); 443let value = settings.getValueSync(context, settings.display.SCREEN_BRIGHTNESS_STATUS, '10'); 444``` 445 446## settings.getValueSync<sup>11+</sup> 447 448getValueSync(context: Context, name: string, defValue: string, domainName: string): string; 449 450获取数据项的值。此方法相较getValue为同步方法。 451 452**模型约束**：此接口仅可在Stage模型下使用。 453 454**系统能力**：SystemCapability.Applications.Settings.Core 455 456**参数**： 457 458| 参数名 | 类型 | 必填 | 说明 | 459|------------| ---------------------- | ---- | ------------------------------------------------------------ | 460| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 461| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 462| defValue | string | 是 | 数据项值。取值范围随业务变动。 | 463| domainName | string | 是 | 指定要设置的域名 <br> - domainName为domainName.DEVICE_SHARED,<br> 设备属性共享域。<br>- domainName为domainName.USER_PROPRERTY,<br> 表示为用户属性域。 <br> - domainName为domainName.USER_SECURITY,<br> 表示为用户安全属性域（仅对系统应用开放）| 464 465 466**返回值**： 467 468| 类型 | 说明 | 469| ---------------- | ----------------------------------- | 470| string | 返回数据项的值 | 471 472**示例**： 473 474```js 475import settings from '@ohos.settings'; 476 477// 更新数据项亮度的值（该数据项在数据库中已存在） 478const context: Context = getContext(this); 479let value = settings.getValueSync(context, settings.display.SCREEN_BRIGHTNESS_STATUS, '100', settings.domainName.DEVICE_SHARED); 480``` 481 482## settings.setValueSync<sup>10+</sup> 483 484setValueSync(context: Context, name: string, value: string): boolean 485 486设置数据项的值。此方法相较setValue为同步方法。 487 488如果数据库中已经存在该数据项，则setValueSync方法将更新该数据项的值；如果数据库中尚未存在该数据项，则setValueSync方法将向数据库中插入该数据项。 489 490**模型约束**：此接口仅可在Stage模型下使用。 491 492**系统能力**：SystemCapability.Applications.Settings.Core 493 494**需要权限**： ohos.permission.MANAGE_SECURE_SETTINGS，仅系统应用可用。 495 496**参数**： 497 498| 参数名 | 类型 | 必填 | 说明 | 499| ------- | ------- | ---- | ------------------------------------------------------------ | 500| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 501| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 502| value | string | 是 | 数据项的具体数值。取值范围随业务变动。 | 503 504**返回值**： 505 506| 类型 | 说明 | 507| ------- | ------------------------------------------------------------ | 508| boolean | 返回设置数据项的值是否成功的结果。true表示设置成功，false表示设置失败。 | 509 510**示例**： 511 512```js 513import settings from '@ohos.settings'; 514 515// 更新数据项亮度的值（该数据项在数据库中已存在，故setValueSync方法将更新该数据项的值） 516const context: Context = getContext(this); 517let ret = settings.setValueSync(context, settings.display.SCREEN_BRIGHTNESS_STATUS, '100'); 518``` 519 520## settings.setValueSync<sup>11+</sup> 521 522setValueSync(context: Context, name: string, value: string, domainName: string): boolean 523 524设置数据项的值。此方法相较setValue为同步方法。 525 526如果数据库中已经存在该数据项，则setValueSync方法将更新该数据项的值；如果数据库中尚未存在该数据项，则setValueSync方法将向数据库中插入该数据项。 527 528**模型约束**：此接口仅可在Stage模型下使用。 529 530**系统能力**：SystemCapability.Applications.Settings.Core 531 532**需要权限**： ohos.permission.MANAGE_SECURE_SETTINGS，仅系统应用可用。 533 534**参数**： 535 536| 参数名 | 类型 | 必填 | 说明 | 537|---------| ---------------------- | ---- | ------------------------------------------------------------ | 538| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 539| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 540| value | string | 是 | 数据项值。取值范围随业务变动。 | 541| domainName | string | 是 | 指定要设置的域名 <br> - domainName为domainName.DEVICE_SHARED,<br> 设备属性共享域。<br>- domainName为domainName.USER_PROPRERTY,<br> 表示为用户属性域。 <br> - domainName为domainName.USER_SECURITY,<br> 表示为用户安全属性域（仅对系统应用开放）| 542 543**返回值**： 544 545| 类型 | 说明 | 546| ---------------- | ----------------------------------- | 547| boolean | 返回设置数据项的值是否成功发结果。返回true表示设置成功，false表示设置失败。 | 548 549**示例**： 550 551```js 552import settings from '@ohos.settings'; 553 554// 更新数据项亮度的值（该数据项在数据库中已存在，故setValueSync方法将更新该数据项的值） 555const context: Context = getContext(this); 556let ret = settings.setValueSync(context, settings.display.SCREEN_BRIGHTNESS_STATUS, '100', settings.domainName.DEVICE_SHARED); 557``` 558 559## settings.registerKeyObserver<sup>11+</sup> 560 561registerKeyObserver(context: Context, name: string, domainName: string, observer:AsyncCallback\<void>): boolean 562 563用于在指定上下文中注册一个观察者，以便于在指定域名中观察指定的域名。当该键值发生变化时，将调用注册的回调函数，如果成功注册则返回true，否则返回false。 564 565**模型约束**：此接口仅可在Stage模型下使用。 566 567**系统能力**：SystemCapability.Applications.Settings.Core 568 569**参数**： 570 571| 参数名 | 类型 | 必填 | 说明 | 572| -------- | ---------------------- | ---- | ------------------------------------------------------------ | 573| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 574| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 575|domainName| string | 是 | 指定要设置的域名 <br> - domainName为domainName.DEVICE_SHARED,<br> 设备属性共享域。<br>- domainName为domainName.USER_PROPRERTY,<br> 表示为用户属性域。 <br> - domainName为domainName.USER_SECURITY,<br> 表示为用户安全属性域（仅对系统应用开放）| 576|observer | AsyncCallback\<void> | 是 | 使用collback方式获取数据项的值。 | 577 578**返回值**： 579 580| 类型 | 说明 | 581| ---------------- | ----------------------------------- | 582| boolean | 返回设置数据项的值是否成功的结果，true表示设置成功，false表示设置失败。 | 583 584**示例**： 585 586```js 587import settings from '@ohos.settings'; 588 589const context: Context = getContext(this); 590settings.registerKeyObserver(context, settings.display.SCREEN_BRIGHTNESS_STATUS, settings.domainName.DEVICE_SHARED, () => { 591 let value:string = settings.getValueSync(context, settings.display.SCREEN_BRIGHTNESS_STATUS, '10'); 592 console.log(`Promise:value -> $ {value}`); 593}); 594``` 595 596## settings.unregisterKeyObserver<sup>11+</sup> 597 598unregisterKeyObserver(context: Context, name: string, domainName: string): boolean 599 600同步方法，进行注销指定域名下对指定键的监视器。 601 602**模型约束**：此接口仅可在Stage模型下使用。 603 604**系统能力**：SystemCapability.Applications.Settings.Core 605 606| 参数名 | 类型 | 必填 | 说明 | 607| -------- | ---------------------- | ---- | ------------------------------------------------------------ | 608| context | Context | 是 | 应用上下文（仅支持UIAbilityContext和ExtensionContext）。<br />Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 | 609| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 610| value | string | 是 | 数据项值。取值范围随业务变动。 | 611|domainName| string | 是 | 指定要设置的域名 <br> - domainName为domainName.DEVICE_SHARED,<br> 设备属性共享域。<br>- domainName为domainName.USER_PROPRERTY,<br> 表示为用户属性域。 <br> - domainName为domainName.USER_SECURITY,<br> 表示为用户安全属性域（仅对系统应用开放）| 612 613**返回值**： 614 615| 类型 | 说明 | 616| ---------------- | ----------------------------------- | 617| boolean | 返回设置数据项的值是否成功的结果，true表示设置成功，false表示设置失败。 | 618 619**示例**： 620 621```js 622import settings from '@ohos.settings'; 623 624const context: Context = getContext(this); 625let ret = settings.setValueSync(context, settings.display.SCREEN_BRIGHTNESS_STATUS, settings.domainName.DEVICE_SHARED); 626``` 627 628## settings.enableAirplaneMode 629 630enableAirplaneMode(enable: boolean, callback: AsyncCallback\<void>): void 631 632启用或禁用飞行模式。使用callback异步回调。 633 634此接口暂不支持。 635 636**系统能力**：SystemCapability.Applications.Settings.Core 637 638**参数**： 639 640| 参数名 | 类型 | 必填 | 说明 | 641| -------- | -------------------- | ---- | ----------------------------------------------- | 642| enable | boolean | 是 | 是否开启飞行模式。true表示开启，false表示禁用。 | 643| callback | AsyncCallback\<void> | 是 | 回调函数。 | 644 645**示例**： 646 647```js 648let isEnabled :boolean = true; 649settings.enableAirplaneMode(isEnabled, (err:Error) => { 650 if (err) { 651 console.log('Failed to enable AirplaneMode.'); 652 return; 653 } 654 console.log('Return true if enable.'); 655}) 656``` 657 658## settings.enableAirplaneMode 659 660enableAirplaneMode(enable: boolean): Promise\<void> 661 662启用或禁用飞行模式。使用Promise异步回调。 663 664此接口暂不支持。 665 666**系统能力**：SystemCapability.Applications.Settings.Core 667 668**参数**： 669 670| 参数名 | 类型 | 必填 | 说明 | 671| ------ | ------- | ---- | ----------------------------------------------- | 672| enable | boolean | 是 | 是否开启飞行模式。true表示开启，false表示禁用。 | 673 674**返回值**： 675 676| 类型 | 说明 | 677| -------------- | ------------------------- | 678| Promise\<void> | 无返回结果的Promise对象。 | 679 680**示例**： 681 682```js 683let isEnabled :boolean = true; 684settings.enableAirplaneMode(isEnabled).then(() => { 685 console.log('Succeeded in enabling AirplaneMode.'); 686}).catch((err:Error) => { 687 console.log(`Failed to enable AirplaneMode. Cause: ${err}`); 688}) 689``` 690 691## settings.canShowFloating 692 693canShowFloating(callback: AsyncCallback\<boolean>): void 694 695检查应用是否能够以悬浮窗形式显示。使用callback异步回调。 696 697**系统能力**：SystemCapability.Applications.Settings.Core 698 699**参数**： 700 701| 参数名 | 类型 | 必填 | 说明 | 702| -------- | ----------------------- | ---- | ------------------------------------------------------------ | 703| callback | AsyncCallback\<boolean> | 是 | 回调函数。<br/>返回true，表示应用能够以悬浮窗形式显示；返回false，则表示不能。 | 704 705**示例**： 706 707```js 708settings.canShowFloating((err:Error, status: boolean) => { 709 if (err) { 710 console.error(`Failed to Checks whether a specified application can show as float window ${err.message} `); 711 return; 712 } 713 console.log('Checks whether a specified application can show as float window.'); 714}); 715``` 716 717## settings.canShowFloating 718 719canShowFloating(): Promise\<boolean> 720 721检查应用是否能够以悬浮窗形式显示。使用Promise异步回调。 722 723**系统能力**：SystemCapability.Applications.Settings.Core 724 725**返回值**： 726 727| 类型 | 说明 | 728| ----------------- | ------------------------------------------------------------ | 729| Promise\<boolean> | Promise对象。<br/>返回true，表示应用能够以悬浮窗形式显示；返回false，则表示不能。 | 730 731**示例**： 732 733```js 734settings.canShowFloating().then((status:boolean) => { 735 console.log('Checks whether a specified application can show as float window.'); 736}); 737``` 738 739## settings.getUriSync<sup>8+</sup> 740 741getUriSync(name: string): string 742 743获取数据项的URI。 744 745**系统能力**：SystemCapability.Applications.Settings.Core 746 747**参数**： 748 749| 参数名 | 类型 | 必填 | 说明 | 750| ------ | ------ | ---- | ------------------------------------------------------------ | 751| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 752 753**返回值**： 754 755| 类型 | 说明 | 756| ------ | ------------- | 757| string | 数据项的URI。 | 758 759**示例**： 760 761```js 762// 获取数据项的URI 763let uriVar:string = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); 764``` 765 766## settings.getURI<sup>(deprecated)</sup> 767 768getURI(name: string, callback: AsyncCallback\<object>): void 769 770获取数据项的URI。使用callback异步回调。 771 772> **说明：** 773> 774> 从 API version 7开始支持，从API version 9开始废弃，此接口不再提供代替接口。 775 776**系统能力**：SystemCapability.Applications.Settings.Core 777 778**参数**： 779 780| 参数名 | 类型 | 必填 | 说明 | 781| -------- | ---------------------- | ---- | ------------------------------------------------------------ | 782| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 783| callback | AsyncCallback\<object> | 是 | 回调函数。获取数据项的URI。 | 784 785**示例**： 786 787```js 788settings.getURI(settings.display.SCREEN_BRIGHTNESS_STATUS, (uri:string) => { 789 console.log(`callback:uri -> ${JSON.stringify(uri)}`) 790}) 791``` 792 793## settings.getURI<sup>(deprecated)</sup> 794 795getURI(name: string): Promise\<object> 796 797获取数据项的URI。使用Promise异步回调。 798 799> **说明：** 800> 801> 从 API version 7开始支持，从API version 9开始废弃，此接口不再提供代替接口。 802 803**系统能力**：SystemCapability.Applications.Settings.Core 804 805**参数**： 806 807| 参数名 | 类型 | 必填 | 说明 | 808| ------ | ------ | ---- | ------------------------------------------------------------ | 809| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 810 811**返回值**： 812 813| 类型 | 说明 | 814| ---------------- | ------------------------------------ | 815| Promise\<object> | Promise对象。返回获取的数据项的URI。 | 816 817**示例**： 818 819```js 820settings.getURI(settings.display.SCREEN_BRIGHTNESS_STATUS).then((uri:string) => { 821 console.log(`promise:uri -> ${JSON.stringify(uri)}`) 822}) 823``` 824 825 826 827## settings.getValue<sup>(deprecated)</sup> 828 829getValue(dataAbilityHelper: DataAbilityHelper, name: string, callback: AsyncCallback\<object>): void 830 831获取数据库中指定数据项的值。使用callback异步回调。 832 833> **说明：** 834> 835> 从 API version 7开始支持，从API version 9开始废弃，推荐使用[getValue()](#settingsgetvalue10)。 836 837**模型约束**：此接口仅可在FA模型下使用。 838 839**系统能力**：SystemCapability.Applications.Settings.Core 840 841**参数**： 842 843| 参数名 | 类型 | 必填 | 说明 | 844| ----------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | 845| dataAbilityHelper | [DataAbilityHelper](../apis-ability-kit/js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | 846| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 847| callback | AsyncCallback\<object> | 是 | 使用callback方式获取数据项的值。 | 848 849**示例**： 850 851```js 852import featureAbility from '@ohos.ability.featureAbility'; 853 854let uri:string = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); 855let helper = featureAbility.acquireDataAbilityHelper(uri); 856settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, (err:Error, value:string) => { 857 if (err) { 858 console.error(`Failed to get the setting. ${err.message} `); 859 return; 860 } 861 console.log(`callback:value -> ${JSON.stringify(value)}`) 862}); 863``` 864 865## settings.getValue<sup>(deprecated)</sup> 866 867getValue(dataAbilityHelper: DataAbilityHelper, name: string): Promise\<object> 868 869获取数据库中指定数据项的值。使用Promise异步回调。 870 871> **说明：** 872> 873> 从 API version 7开始支持，从API version 9开始废弃，推荐使用[getValue()](#settingsgetvalue10-1)。 874 875**模型约束**：此接口仅可在FA模型下使用。 876 877**系统能力**：SystemCapability.Applications.Settings.Core 878 879**参数**： 880 881| 参数名 | 类型 | 必填 | 说明 | 882| ----------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | 883| dataAbilityHelper | [DataAbilityHelper](../apis-ability-kit/js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | 884| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 885 886**返回值**： 887 888| 类型 | 说明 | 889| ---------------- | ----------------------------------- | 890| Promise\<object> | Promise对象。返回获得的数据项的值。 | 891 892**示例**： 893 894```js 895import featureAbility from '@ohos.ability.featureAbility'; 896 897let uri:string = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); 898let helper = featureAbility.acquireDataAbilityHelper(uri); 899settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS).then((value:string) => { 900 console.log(`promise:value -> ${JSON.stringify(value)}`) 901}); 902``` 903 904## settings.getValueSync<sup>(deprecated)</sup> 905 906getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: string): string 907 908获取数据项的值。此方法相较getValue为同步方法。 909 910> **说明：** 911> 912> 从 API version 8开始支持，从API version 9开始废弃，推荐使用[getValueSync()](#settingsgetvaluesync10)。 913 914**模型约束**：此接口仅可在FA模型下使用。 915 916**系统能力**：SystemCapability.Applications.Settings.Core 917 918**参数**： 919 920| 参数名 | 类型 | 必填 | 说明 | 921| ----------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | 922| dataAbilityHelper | [DataAbilityHelper](../apis-ability-kit/js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | 923| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 924| defValue | string | 是 | 默认值。由开发者设置，当未从数据库中查询到该数据时，表示返回该默认值。 | 925 926**返回值**： 927 928| 类型 | 说明 | 929| ------ | ---------------- | 930| string | 返回数据项的值。 | 931 932**示例**： 933 934```js 935import featureAbility from '@ohos.ability.featureAbility'; 936 937//获取数据项亮度的值（该数据项在数据库中已存在） 938let uri:string = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); 939let helper = featureAbility.acquireDataAbilityHelper(uri); 940let value:string = settings.getValueSync(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '10'); 941``` 942 943## settings.setValueSync<sup>(deprecated)</sup> 944 945setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string): boolean 946 947设置数据项的值。此方法相较setValue为同步方法。 948 949如果数据库中已经存在该数据项，则setValueSync方法将更新该数据项的值；如果数据库中尚未存在该数据项，则setValueSync方法将向数据库中插入该数据项。 950 951> **说明：** 952> 953> 从 API version 8开始支持，从API version 9开始废弃，推荐使用[setValueSync()](#settingssetvaluesync10)。 954 955**模型约束**：此接口仅可在FA模型下使用。 956 957**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS，仅系统应用可用。 958 959**系统能力**：SystemCapability.Applications.Settings.Core 960 961**参数**： 962 963| 参数名 | 类型 | 必填 | 说明 | 964| ----------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | 965| dataAbilityHelper | [DataAbilityHelper](../apis-ability-kit/js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | 966| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 967| value | string | 是 | 数据项的具体数值。取值范围随业务变动。 | 968 969**返回值**： 970 971| 类型 | 说明 | 972| ------- | ------------------------------------------------------------ | 973| boolean | 返回设置数据项的值是否成功的结果。true表示设置成功，false表示设置失败。 | 974 975**示例**： 976 977```js 978import featureAbility from '@ohos.ability.featureAbility'; 979 980//更新数据项亮度的值（该数据项在数据库中已存在，故setValueSync方法将更新该数据项的值） 981let uri:string = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); 982let helper = featureAbility.acquireDataAbilityHelper(uri); 983let ret:string = settings.setValueSync(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100'); 984```