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