1# @ohos.settings (设置数据项名称) 2 3本模块提供访问设置数据项的能力。 4 5> **说明：** 6> 7> 本模块首批接口从API version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 8 9## 导入模块 10 11```js 12import settings from '@ohos.settings'; 13``` 14 15## date 16 17提供设置时间和日期格式的数据项。 18 19### 属性 20 21**系统能力：** SystemCapability.Applications.settings.Core 22 23| 名称 | 类型 | 可读 | 可写 | 说明 | 24| ------------------- | ------ | ---- | ---- | ------------------------------------------------------------ | 25| DATE_FORMAT | string | 是 | 是 | 日期格式。<br/>日期格式包括mm/dd/yyyy、dd/mm/yyyy和yyyy/mm/dd ，其中mm、dd和yyyy分别代表月份、日期和年份。 | 26| TIME_FORMAT | string | 是 | 是 | 时间是以12小时格式还是24小时格式显示。<br>值为 “12” 表示12小时格式；<br/>值为 ”24“ 表示24小时格式。 | 27| AUTO_GAIN_TIME | string | 是 | 是 | 是否自动从网络获取日期、时间和时区。 <br>值为true表示自动从网络获取信息；<br/>值为false表示不自动获取。 | 28| AUTO_GAIN_TIME_ZONE | string | 是 | 是 | 是否自动从NITZ获取时区。 <br>值为true表示自动获取；<br/>值为false表示不自动获取。 | 29 30## display 31 32提供设置显示效果的数据项。 33 34### 属性 35 36**系统能力：** SystemCapability.Applications.settings.Core 37 38| 名称 | 类型 | 可读 | 可写 | 说明 | 39| ----------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ | 40| FONT_SCALE | string | 是 | 是 | 字体的比例因子，值为浮点数。 | 41| SCREEN_BRIGHTNESS_STATUS | string | 是 | 是 | 屏幕亮度。该值的范围从0到255。 | 42| AUTO_SCREEN_BRIGHTNESS | string | 是 | 是 | 是否启用屏幕亮度自动调整。<br/>值为AUTO_SCREEN_BRIGHTNESS_MODE，表示启用自动调整；<br/>值为MANUAL_SCREEN_BRIGHTNESS_MODE，表示不启用自动调整。 | 43| AUTO_SCREEN_BRIGHTNESS_MODE | number | 是 | 是 | 使用屏幕亮度自动调整时AUTO_SCREEN_BRIGHTNESS的值。 | 44| MANUAL_SCREEN_BRIGHTNESS_MODE | number | 是 | 是 | 使用屏幕亮度手动调整时的AUTO_SCREEN_BRIGHTNESS值。 | 45| SCREEN_OFF_TIMEOUT | string | 是 | 是 | 设备在一段时间不活动后进入睡眠状态的等待时间（单位：ms）。 | 46| DEFAULT_SCREEN_ROTATION | string | 是 | 是 | 启用屏幕的自动旋转时，此属性无效；不启用自动旋转时，以下值可用：<br>值为0，表示屏幕旋转0度；<br>值为1，表示屏幕旋转90度；<br/>值为2，表示屏幕旋转180度；<br/>值为3，表示屏幕旋转270度。 | 47| ANIMATOR_DURATION_SCALE | string | 是 | 是 | 动画持续时间的比例因子。这会影响所有此类动画的开始延迟和持续时间。<br/>值为0，表示动画将立即结束，默认值为1。 | 48| TRANSITION_ANIMATION_SCALE | string | 是 | 是 | 过渡动画的比例因子。<br/>值为0，表示禁用过渡动画。 | 49| WINDOW_ANIMATION_SCALE | string | 是 | 是 | 普通窗口动画的比例因子。<br/>值为0，表示禁用窗口动画。 | 50| DISPLAY_INVERSION_STATUS | string | 是 | 是 | 是否启用显示颜色反转。<br/>值为1，表示启用显示颜色反转；<br/>值为0，表示不启用显示颜色反转。 | 51 52## general 53 54提供设置设备常规信息的数据项。 55 56### 属性 57 58**系统能力：** SystemCapability.Applications.settings.Core 59 60| 名称 | 类型 | 可读 | 可写 | 说明 | 61| -------------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ | 62| SETUP_WIZARD_FINISHED | string | 是 | 是 | 是否已运行启动向导。<br>值为0，表示启动向导尚未运行；<br/>值不是0，表示启动向导已运行。 | 63| END_BUTTON_ACTION | string | 是 | 是 | 在用户不在呼叫中时，用户按下呼叫结束按钮会发生的情况。<br/>值为0，表示没有任何反应；<br/>值为1，表示显示主屏幕；<br/>值为2，表示设备进入睡眠状态，屏幕锁定；<br/>值为3，表示显示主屏幕。如果用户已在主屏幕上，设备将进入睡眠状态。 | 64| ACCELEROMETER_ROTATION_STATUS | string | 是 | 是 | 是否使用加速计更改屏幕方向，即是否启用自动旋转。<br>值为1，表示启用加速度计；<br/>值为0，表示不启用加速计。 | 65| AIRPLANE_MODE_STATUS | string | 是 | 是 | 是否启用飞行模式。<br>值为1，表示启用飞行模式；<br/>值为0，表示不启用飞行模式。 | 66| DEVICE_PROVISION_STATUS | string | 是 | 是 | 是否预配设备。<br>在具有单个系统用户的多用户设备上，当值为true时，屏幕可能会被锁定。此外，其他功能无法在系统用户上启动，除非它们被标记为在屏幕锁定上显示。 | 67| HDC_STATUS | string | 是 | 是 | 是否启用USB设备上的硬盘控制器（HDC）。<br>值为true，表示启用HDC；<br/>值为false，表示不启用HDC。 | 68| BOOT_COUNTING | string | 是 | 是 | 设备开机后的启动操作数。 | 69| CONTACT_METADATA_SYNC_STATUS | string | 是 | 是 | 是否启用联系人元数据同步。<br>值为true，表示启用同步；<br/>值为false，表示不启用同步。 | 70| DEVELOPMENT_SETTINGS_STATUS | string | 是 | 是 | 是否启用开发人员选项。<br>值为true，表示启用开发人员选项；<br/>值为false，表示不启用开发人员选项。 | 71| DEVICE_NAME | string | 是 | 是 | 设备名称。 | 72| USB_STORAGE_STATUS | string | 是 | 是 | 是否启用USB大容量存储。<br>值为true，表示启用USB大容量存储；<br/>值为false，表示不启用USB大容量存储。 | 73| DEBUGGER_WAITING | string | 是 | 是 | 设备在启动应用程序进行调试时是否等待调试器进行调试。<br>值为1，表示设备等待调试器；<br/>值为0，表示系统不会等待调试器，因此应用程序会正常运行。 | 74| DEBUG_APP_PACKAGE | string | 是 | 是 | 要调试的应用程序的bundle name。 | 75| ACCESSIBILITY_STATUS | string | 是 | 是 | 是否启用辅助功能。<br>值为1，表示启用辅助功能；<br/>值为0，表示不启用辅助功能。 | 76| ACTIVATED_ACCESSIBILITY_SERVICES | string | 是 | 是 | 已激活的辅助功能的列表。 | 77| GEOLOCATION_ORIGINS_ALLOWED | string | 是 | 是 | 浏览器可以使用的默认地理位置。多个地理位置由空格分隔。 | 78| SKIP_USE_HINTS | string | 是 | 是 | 应用程序是否应在首次启动时尝试跳过所有介绍性提示。这适用于临时用户或熟悉环境的用户。<br>值为1，表示应用程序将尝试在第一次启动时跳过所有介绍性提示；<br/>值为0，表示应用程序不会在首次启动时跳过介绍性提示。 | 79| TOUCH_EXPLORATION_STATUS | string | 是 | 是 | 是否启用触摸浏览。<br>值为1，表示启用触摸浏览；<br/>值为0，表示不启用触摸浏览。 | 80 81## input 82 83提供设置有关输入法信息的数据项。 84 85### 属性 86 87**系统能力：** SystemCapability.Applications.settings.Core 88 89| 名称 | 类型 | 可读 | 可写 | 说明 | 90| ------------------------------------ | ------ | ---- | ---- | ------------------------------------------------------------ | 91| DEFAULT_INPUT_METHOD | string | 是 | 是 | 默认输入法及其ID。 | 92| ACTIVATED_INPUT_METHOD_SUB_MODE | string | 是 | 是 | 默认输入法键盘类型及其ID。 | 93| ACTIVATED_INPUT_METHODS | string | 是 | 是 | 已激活的输入法的列表。<br>该列表是一个字符串，由已激活的输入法的ID和输入法键盘类型组成。输入法ID后添加冒号':'连接，输入法的键盘类型后添加分号';'连接。用ima代表输入法ID，keyboardType代表键盘类型，示例格式是ima0:keyboardType0;keyboardType1;ima1:ima2:keyboardTypes0。 | 94| SELECTOR_VISIBILITY_FOR_INPUT_METHOD | string | 是 | 是 | 输入法选择器是否可见。<br>值为1，表示输入法选择器可见；<br/>值为0，表示输入法选择器不可见。 | 95| AUTO_CAPS_TEXT_INPUT | string | 是 | 是 | 是否为文本编辑器启用自动大写。<br>值为0，表示不启用自动大写；<br/>值为1，表示启用自动大写。 | 96| AUTO_PUNCTUATE_TEXT_INPUT | string | 是 | 是 | 是否为文本编辑器启用自动标点符号。自动标点符号使文本编辑器能够将两个空格转换为句点'.'和空格。<br>值为0，表示不启用自动标点符号；<br/>值为1，表示启用自动标点符号。 | 97| AUTO_REPLACE_TEXT_INPUT | string | 是 | 是 | 是否为文本编辑器启用自动更正。自动更正使文本编辑器能够更正拼写错误。<br>值为0，表示不启用自动更正；<br/>值为1，表示启用自动更正。 | 98| SHOW_PASSWORD_TEXT_INPUT | string | 是 | 是 | 是否在文本编辑器中启用密码显示。密码显示使文本编辑器能够在用户键入密码字符时显示密码字符。<br>值为0，表示不启用密码显示；<br/>值为1，表示启用密码显示。 | 99 100## network 101 102提供设置网络信息的数据项。 103 104### 属性 105 106**系统能力：** SystemCapability.Applications.settings.Core 107 108| 名称 | 类型 | 可读 | 可写 | 说明 | 109| ------------------------ | ------ | ---- | ---- | ------------------------------------------------------------ | 110| DATA_ROAMING_STATUS | string | 是 | 是 | 是否启用数据漫游。<br>值为true，表示启用数据漫游；<br/>值为false，表示不启用数据漫游。 | 111| HTTP_PROXY_CFG | string | 是 | 是 | 全局 HTTP 代理的主机名和端口号。主机名和端口号由冒号':'分隔。 | 112| NETWORK_PREFERENCE_USAGE | string | 是 | 是 | 要使用的网络的用户首选项。 | 113 114## phone 115 116提供设置来电和去电接听方式的数据项。 117 118### 属性 119 120**系统能力：** SystemCapability.Applications.settings.Core 121 122| 名称 | 类型 | 可读 | 可写 | 说明 | 123| ------------------ | ------ | ---- | ---- | ------------------------------------------------------------ | 124| RTT_CALLING_STATUS | string | 是 | 是 | 是否启用实时文本 (RTT) 呼叫。启用，来电和去电在设备和运营商支持时作为 RTT 呼叫应答。 <br> 值为1，表示启用RTT 呼叫； <br/> 值为0，表示不启用 RTT 呼叫。 | 125 126## sound 127 128提供设置声音效果的数据项。 129 130### 属性 131 132**系统能力：** SystemCapability.Applications.settings.Core 133 134| 名称 | 类型 | 可读 | 可写 | 说明 | 135| ---------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ | 136| VIBRATE_WHILE_RINGING | string | 是 | 是 | 设备在来电响铃时是否振动。此属性将由电话和设置应用程序使用。 该值是布尔类型，仅影响设备因来电而响铃的情况，不影响任何其他应用程序或场景。 | 137| DEFAULT_ALARM_ALERT | string | 是 | 是 | 系统默认告警的存储区域。 | 138| DTMF_TONE_TYPE_WHILE_DIALING | string | 是 | 是 | 拨号时播放的双音多频 (DTMF) 音的类型。 <br>值为0表示常规的短音效，<br/>值为1表示长音效。 | 139| DTMF_TONE_WHILE_DIALING | string | 是 | 是 | 拨号时是否播放 DTMF 音。<br>值为1，表示播放 DTMF 音；<br/>值为0，表示不播放。 | 140| AFFECTED_MODE_RINGER_STREAMS | string | 是 | 是 | 哪些音频流受振铃模式和请勿打扰 (DND) 模式更改的影响。希望特定的音频流受到振铃模式和 DDN 模式变化的影响，请将对应比特位设置为1。 | 141| AFFECTED_MUTE_STREAMS | string | 是 | 是 | 受静音模式影响的音频流。希望特定音频流在静音模式下保持静音，请将相应位设置为1。 | 142| DEFAULT_NOTIFICATION_SOUND | string | 是 | 是 | 系统默认通知音的存储区域。 | 143| DEFAULT_RINGTONE | string | 是 | 是 | 系统默认铃声的存储区域。 | 144| SOUND_EFFECTS_STATUS | string | 是 | 是 | 声音功能是否可用。<br>值为0表示不可用； <br/>值为1表示可用 | 145| VIBRATE_STATUS | string | 是 | 是 | 设备是否为事件振动。该参数在系统内部使用。 <br>值为1，表示设备会因事件而振动； <br/>值为0，表示设备不因事件振动。 | 146| HAPTIC_FEEDBACK_STATUS | string | 是 | 是 | 设备是否启用触觉反馈。<br/>值为true，表示启用触觉反馈；<br/>值为false，表示不启用触觉反馈。 | 147 148## TTS 149 150提供设置文本到语音 (TTS) 转换信息的数据项。 151 152### 属性 153 154**系统能力：** SystemCapability.Applications.settings.Core 155 156| 名称 | 类型 | 可读 | 可写 | 说明 | 157| ------------------- | ------ | ---- | ---- | ------------------------------------------------------------ | 158| DEFAULT_TTS_PITCH | string | 是 | 是 | 文本转语音 (TTS) 引擎的默认音高。<br>其中100=1x，该值设置为200，表示频率是正常声音频率的两倍。 | 159| DEFAULT_TTS_RATE | string | 是 | 是 | TTS 引擎的默认语速。<br>其中100=1x。 | 160| DEFAULT_TTS_SYNTH | string | 是 | 是 | 默认TTS引擎。 | 161| ENABLED_TTS_PLUGINS | string | 是 | 是 | 用于TTS的已激活插件包列表， 多个插件包以空格分隔。 | 162 163 164## wireless 165 166提供设置无线网络信息的数据项。 167 168### 属性 169 170**系统能力：** SystemCapability.Applications.settings.Core 171 172| 名称 | 类型 | 可读 | 可写 | 说明 | 173| --------------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ | 174| BLUETOOTH_DISCOVER_ABILITY_STATUS | string | 是 | 是 | 设备是否可以被其他设备通过蓝牙发现或连接。<br>值为0表示设备不可以被连接或发现；<br/>值为1表示设备可以被连接但不可以被发现；<br/>值为2表示设备可以被连接和发现。 | 175| BLUETOOTH_DISCOVER_TIMEOUT | string | 是 | 是 | 可以通过蓝牙发现设备的持续时间（以秒为单位）。<br>这段时间之后，设备不可以被蓝牙搜寻到。 | 176| AIRPLANE_MODE_RADIOS | string | 是 | 是 | 启用飞行模式时要禁用的无线电信号列表。 <br>多个无线电信号用逗号 (,) 分隔。取值包括以下常量：BLUETOOTH_RADIO、 CELL_RADIO、 NFC_RADIO、 WIFI_RADIO。 | 177| BLUETOOTH_RADIO | string | 是 | 否 | 常量，作为AIRPLANE_MODE_RADIOS的取值时表示蓝牙在飞行模式下禁用。 | 178| CELL_RADIO | string | 是 | 否 | 常量，作为AIRPLANE_MODE_RADIOS的取值时表示蜂窝无线电在飞行模式下禁用。 | 179| NFC_RADIO | string | 是 | 否 | 常量，作为AIRPLANE_MODE_RADIOS的取值时表示NFC在飞行模式下禁用。 | 180| WIFI_RADIO | string | 是 | 否 | 常量，作为AIRPLANE_MODE_RADIOS的取值时表示Wi-Fi在飞行模式下禁用。 | 181| BLUETOOTH_STATUS | string | 是 | 是 | 蓝牙是否可用。 <br>值为true表示蓝牙可用；<br/>值为false表示蓝牙不可用。 | 182| OWNER_LOCKDOWN_WIFI_CFG | string | 是 | 是 | 是否应锁定由设备所有者的应用程序创建的Wi-Fi配置。<br>值为true表示Wi-Fi配置应该被锁定；<br/>值为false表示不应该被锁定。 | 183| WIFI_DHCP_MAX_RETRY_COUNT | string | 是 | 是 | 尝试从DHCP服务器获取 IP 地址的最大次数。 | 184| WIFI_TO_MOBILE_DATA_AWAKE_TIMEOUT | string | 是 | 是 | Wi-Fi连接断开后等待移动数据连接建立时保持唤醒锁的最长时间。 | 185| WIFI_STATUS | string | 是 | 是 | Wi-Fi是否可用。<br>值为true表示Wi-Fi可用；<br/>值为false表示Wi-Fi不可用。 | 186| WIFI_WATCHDOG_STATUS | string | 是 | 是 | Wi-Fi的WatchDog是否可用。 <br>值为true表示可用；<br/>值为false表示不可用。 | 187 188 189## settings.setValue 190 191setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object, callback: AsyncCallback\<boolean>): void 192 193将数据项名称及数据项的值保存到数据库中。使用callback异步回调。 194 195**系统接口**：此接口为系统接口。 196 197**系统能力**：SystemCapability.Applications.settings.Core 198 199**参数**： 200 201| 参数名 | 类型 | 必填 | 说明 | 202| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | 203| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | 204| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 205| value | object | 是 | 数据项值。取值范围随业务变动。 | 206| callback | AsyncCallback\<boolean> | 是 | 回调函数。返回true表示操作成功，否则操作失败。 | 207 208**示例**： 209 210```js 211import featureAbility from '@ohos.ability.featureAbility'; 212 213//更新数据项亮度的值（该数据项在数据库中已存在，故setValue方法将更新该数据项的值） 214let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); 215let helper = featureAbility.acquireDataAbilityHelper(uri); 216//@ts-ignore 217//此处数据项值的类型为string 218settings.setValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100', (status) => { 219 console.log('Callback return whether value is set.'); 220}); 221``` 222 223## settings.setValue 224 225setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object): Promise\<boolean> 226 227将数据项名称及数据项的值保存到数据库中。使用Promise异步回调。 228 229**系统接口**：此接口为系统接口。 230 231**系统能力**：SystemCapability.Applications.settings.Core 232 233**参数**： 234 235| 参数名 | 类型 | 必填 | 说明 | 236| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | 237| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | 238| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 239| value | object | 是 | 数据项值。取值范围随业务变动。 | 240 241**返回值**： 242 243| 类型 | 说明 | 244| ----------------- | -------------------------------------------------- | 245| Promise\<boolean> | Promise对象。返回true表示操作成功，否则返回false。 | 246 247**示例**： 248 249```js 250import featureAbility from '@ohos.ability.featureAbility'; 251 252//更新数据项亮度的值（该数据项在数据库中已存在，故setValue方法将更新该数据项的值） 253let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); 254let helper = featureAbility.acquireDataAbilityHelper(uri); 255//@ts-ignore 256//此处数据项值的类型为string 257settings.setValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100').then((status) => { 258 console.log('Callback return whether value is set.'); 259}); 260``` 261 262## settings.enableAirplaneMode 263 264enableAirplaneMode(enable: boolean, callback: AsyncCallback\<void>): void 265 266启用或禁用飞行模式。使用callback异步回调。 267 268**系统能力**：SystemCapability.Applications.settings.Core 269 270**参数**： 271 272| 参数名 | 类型 | 必填 | 说明 | 273| -------- | -------------------- | ---- | ----------------------------------------------- | 274| enable | boolean | 是 | 是否开启飞行模式。true表示开启，false表示禁用。 | 275| callback | AsyncCallback\<void> | 是 | 回调函数。 | 276 277**示例**： 278 279```js 280let isEnabled = true; 281settings.enableAirplaneMode(isEnabled, (err) => { 282 if (err) { 283 console.log('Failed to enable AirplaneMode.'); 284 return; 285 } 286 console.log('Return true if enable.'); 287}) 288``` 289 290## settings.enableAirplaneMode 291 292enableAirplaneMode(enable: boolean): Promise\<void> 293 294启用或禁用飞行模式。使用Promise异步回调。 295 296**系统能力**：SystemCapability.Applications.settings.Core 297 298**参数**： 299 300| 参数名 | 类型 | 必填 | 说明 | 301| ------ | ------- | ---- | ----------------------------------------------- | 302| enable | boolean | 是 | 是否开启飞行模式。true表示开启，false表示禁用。 | 303 304**返回值**： 305 306| 类型 | 说明 | 307| -------------- | ------------------------- | 308| Promise\<void> | 无返回结果的Promise对象。 | 309 310**示例**： 311 312```js 313let isEnabled = true; 314settings.enableAirplaneMode(isEnabled).then(() => { 315 console.log('Succeeded in enabling AirplaneMode.'); 316}).catch((err) => { 317 console.log(`Failed to enable AirplaneMode. Cause: ${err}`); 318}) 319``` 320 321## settings.canShowFloating 322 323canShowFloating(callback: AsyncCallback\<boolean>): void 324 325检查应用是否能够以悬浮窗形式显示。使用callback异步回调。 326 327**系统能力**：SystemCapability.Applications.settings.Core 328 329**参数**： 330 331| 参数名 | 类型 | 必填 | 说明 | 332| -------- | ----------------------- | ---- | ------------------------------------------------------------ | 333| callback | AsyncCallback\<boolean> | 是 | 回调函数。<br/>返回true，表示应用能够以悬浮窗形式显示；返回false，则表示不能。 | 334 335**示例**： 336 337```js 338settings.canShowFloating((status) => { 339 console.log('Checks whether a specified application can show as float window.'); 340}); 341``` 342 343## settings.canShowFloating 344 345canShowFloating(): Promise\<boolean> 346 347检查应用是否能够以悬浮窗形式显示。使用Promise异步回调。 348 349**系统能力**：SystemCapability.Applications.settings.Core 350 351**返回值**： 352 353| 类型 | 说明 | 354| ----------------- | ------------------------------------------------------------ | 355| Promise\<boolean> | Promise对象。<br/>返回true，表示应用能够以悬浮窗形式显示；返回false，则表示不能。 | 356 357**示例**： 358 359```js 360settings.canShowFloating().then((status) => { 361 console.log('Checks whether a specified application can show as float window.'); 362}); 363``` 364 365## settings.getUriSync<sup>8+</sup> 366 367getUriSync(name: string): string 368 369获取数据项的URI。 370 371**系统能力**：SystemCapability.Applications.settings.Core 372 373**参数**： 374 375| 参数名 | 类型 | 必填 | 说明 | 376| ------ | ------ | ---- | ------------------------------------------------------------ | 377| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 378 379**返回值**： 380 381| 类型 | 说明 | 382| ------ | ------------- | 383| string | 数据项的URI。 | 384 385**示例**： 386 387```js 388// 获取数据项的URI 389let urivar = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); 390``` 391 392## setting.getURI<sup>(deprecated)</sup> 393 394getURI(name: string, callback: AsyncCallback\<object>): void 395 396获取数据项的URI。使用callback异步回调。 397 398> **说明：** 399> 400> 从 API version 7开始支持，从API version 9开始废弃。 401 402**系统能力**：SystemCapability.Applications.settings.Core 403 404**参数**： 405 406| 参数名 | 类型 | 必填 | 说明 | 407| -------- | ---------------------- | ---- | ------------------------------------------------------------ | 408| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 409| callback | AsyncCallback\<object> | 是 | 回调函数。获取数据项的URI。 | 410 411**示例**： 412 413```js 414settings.getURI(settings.display.SCREEN_BRIGHTNESS_STATUS, (uri) => { 415 console.log(`callback:uri -> ${JSON.stringify(uri)}`) 416}) 417``` 418 419## setting.getURI<sup>(deprecated)</sup> 420 421getURI(name: string): Promise\<object> 422 423获取数据项的URI。使用Promise异步回调。 424 425> **说明：** 426> 427> 从 API version 7开始支持，从API version 9开始废弃。 428 429**系统能力**：SystemCapability.Applications.settings.Core 430 431**参数**： 432 433| 参数名 | 类型 | 必填 | 说明 | 434| ------ | ------ | ---- | ------------------------------------------------------------ | 435| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 436 437**返回值**： 438 439| 类型 | 说明 | 440| ---------------- | ------------------------------------ | 441| Promise\<object> | Promise对象。返回获取的数据项的URI。 | 442 443**示例**： 444 445```js 446settings.getURI(settings.display.SCREEN_BRIGHTNESS_STATUS).then((uri) => { 447 console.log(`promise:uri -> ${JSON.stringify(uri)}`) 448}) 449``` 450 451## setting.getValue<sup>(deprecated)</sup> 452 453getValue(dataAbilityHelper: DataAbilityHelper, name: string, callback: AsyncCallback\<object>): void 454 455获取数据库中指定数据项的值。使用callback异步回调。 456 457> **说明：** 458> 459> 从 API version 7开始支持，从API version 9开始废弃。 460 461**模型约束**：此接口仅可在FA模型下使用。 462 463**系统能力**：SystemCapability.Applications.settings.Core 464 465**参数**： 466 467| 参数名 | 类型 | 必填 | 说明 | 468| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | 469| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | 470| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 471| callback | AsyncCallback\<object> | 是 | 使用callback方式获取数据项的值。 | 472 473**示例**： 474 475```js 476import featureAbility from '@ohos.ability.featureAbility'; 477 478let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); 479let helper = featureAbility.acquireDataAbilityHelper(uri); 480settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, (err, value) => { 481 if (err) { 482 console.error(`Failed to get the setting. ${err.message} `); 483 return; 484 } 485 console.log(`callback:value -> ${JSON.stringify(value)}`) 486}); 487``` 488 489## setting.getValue<sup>(deprecated)</sup> 490 491getValue(dataAbilityHelper: DataAbilityHelper, name: string): Promise\<object> 492 493获取数据库中指定数据项的值。使用Promise异步回调。 494 495> **说明：** 496> 497> 从 API version 7开始支持，从API version 9开始废弃。 498 499**模型约束**：此接口仅可在FA模型下使用。 500 501**系统能力**：SystemCapability.Applications.settings.Core 502 503**参数**： 504 505| 参数名 | 类型 | 必填 | 说明 | 506| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | 507| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | 508| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 509 510**返回值**： 511 512| 类型 | 说明 | 513| ---------------- | ----------------------------------- | 514| Promise\<object> | Promise对象。返回获得的数据项的值。 | 515 516**示例**： 517 518```js 519import featureAbility from '@ohos.ability.featureAbility'; 520 521let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); 522let helper = featureAbility.acquireDataAbilityHelper(uri); 523settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS).then((value) => { 524 console.log(`promise:value -> ${JSON.stringify(value)}`) 525}); 526``` 527 528## settings.getValueSync<sup>(deprecated)</sup> 529 530getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: string): string 531 532获取数据项的值。此方法相较getValue为同步方法。 533 534> **说明：** 535> 536> 从 API version 8开始支持，从API version 9开始废弃。 537 538**模型约束**：此接口仅可在FA模型下使用。 539 540**系统能力**：SystemCapability.Applications.settings.Core 541 542**参数**： 543 544| 参数名 | 类型 | 必填 | 说明 | 545| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | 546| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | 547| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 548| defValue | string | 是 | 默认值。由开发者设置，当未从数据库中查询到该数据时，表示返回该默认值。 | 549 550**返回值**： 551 552| 类型 | 说明 | 553| ------ | ---------------- | 554| string | 返回数据项的值。 | 555 556**示例**： 557 558```js 559import featureAbility from '@ohos.ability.featureAbility'; 560 561//获取数据项亮度的值（该数据项在数据库中已存在） 562let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); 563let helper = featureAbility.acquireDataAbilityHelper(uri); 564let value = settings.getValueSync(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '10'); 565``` 566 567## settings.setValueSync<sup>(deprecated)</sup> 568 569setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string): boolean 570 571设置数据项的值。此方法相较setValue为同步方法。 572 573如果数据库中已经存在该数据项，则setValueSync方法将更新该数据项的值；如果数据库中尚未存在该数据项，则setValueSync方法将向数据库中插入该数据项。 574 575> **说明：** 576> 577> 从 API version 8开始支持，从API version 9开始废弃。 578 579**模型约束**：此接口仅可在FA模型下使用。 580 581**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS，仅系统应用可用。 582 583**系统能力**：SystemCapability.Applications.settings.Core 584 585**参数**： 586 587| 参数名 | 类型 | 必填 | 说明 | 588| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | 589| dataAbilityHelper | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | 590| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 | 591| value | string | 是 | 数据项的具体数值。取值范围随业务变动。 | 592 593**返回值**： 594 595| 类型 | 说明 | 596| ------- | ------------------------------------------------------------ | 597| boolean | 返回设置数据项的值是否成功的结果。true表示设置成功，false表示设置失败。 | 598 599**示例**： 600 601```js 602import featureAbility from '@ohos.ability.featureAbility'; 603 604//更新数据项亮度的值（该数据项在数据库中已存在，故setValueSync方法将更新该数据项的值） 605let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); 606let helper = featureAbility.acquireDataAbilityHelper(uri); 607let ret = settings.setValueSync(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100'); 608``` 609