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