Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 e661e610 编写于 作者: W weiyunxing 提交者： Gitee
浏览文件
操作

!5 settings apis update 

Merge pull request !5 from yansong/master
上级 902a507d 9054ecb1
显示空白变更内容
内联 并排
Showing with 168 addition and 191 deletion
zh-cn/application-dev/reference/apis/js-apis-settings.md
浏览文件 @ e661e610
......@@ -6,8 +6,6 @@
>
> 本模块首批接口从API version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 导入模块
```ts
......@@ -23,11 +21,11 @@ import settings from '@ohos.settings';
**系统能力：** SystemCapability.Applications.settings.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------- | ------ | ---- | ---- | ------------------------------------------------------------ |
| DATE_FORMAT | string | 是 | 否 | 日期格式<br/><ul> <li> mm/dd/yyyy <li> dd/mm/yyyy <li> yyyy/mm/dd </ul> |
| TIME_FORMAT | string | 是 | 否 | 时间是以 12 小时格式还是 24 小时格式显示。 |
| AUTO_GAIN_TIME | string | 是 | 否 | 是否自动从网络获取日期、时间和时区。 |
| AUTO_GAIN_TIME_ZONE | string | 是 | 否 | 是否自动从 NITZ 获取时区。 |
| ------------------- | ------ | --- | --- | --------------------------------------------------------------------------- |
| DATE_FORMAT | string | 是 | 否 | 日期格式。<br/>日期格式包括mm/dd/yyyy、dd/mm/yyyy和yyyy/mm/dd ，其中mm、dd和yyyy分别代表月份、日期和年份； |
| TIME_FORMAT | string | 是 | 否 | 时间是以 12 小时格式还是 24 小时格式显示。<br>该值为 “12” 表示12小时格式，值为 ”24“ 表示24小时格式。 |
| AUTO_GAIN_TIME | string | 是 | 否 | 是否自动从网络获取日期、时间和时区。 <br> true 表示自动从网络获取信息，false 表示不自动获取。 |
| AUTO_GAIN_TIME_ZONE | string | 是 | 否 | 是否自动从 NITZ 获取时区。 <br> true 表示自动获取，false 表示不自动获取。 |
## display
......@@ -38,18 +36,18 @@ import settings from '@ohos.settings';
**系统能力：** SystemCapability.Applications.settings.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ |
| ----------------------------- | ------ | --- | --- | ---------------------------------------------------------------------------------------------------------- |
| FONT_SCALE | string | 是 | 否 | 字体的比例因子，即浮点数。 |
| SCREEN_BRIGHTNESS_STATUS | string | 是 | 否 | 屏幕亮度。该值的范围从 0 到 255。 |
| AUTO_SCREEN_BRIGHTNESS | string | 是 | 否 | 是否启用自动屏幕亮度调整。<br/><ul> <li> 值为1 ，则启用自动调整。<li>值为 0 ，则禁用自动调整。</ul> |
| AUTO_SCREEN_BRIGHTNESS | string | 是 | 否 | 是否启用自动屏幕亮度调整。<br/>值为1 ，则启用自动调整；值为 0 ，则禁用自动调整。 |
| AUTO_SCREEN_BRIGHTNESS_MODE | number | 是 | 否 | 使用自动屏幕亮度调整时 AUTO_SCREEN_BRIGHTNESS 的值。 |
| MANUAL_SCREEN_BRIGHTNESS_MODE | number | 是 | 否 | 使用手动屏幕亮度调整时的 AUTO_SCREEN_BRIGHTNESS 值。 |
| SCREEN_OFF_TIMEOUT | string | 是 | 否 | 设备在一段时间不活动后<br/>进入睡眠状态的等待时间（以毫秒为单位）。 |
| DEFAULT_SCREEN_ROTATION | string | 是 | 否 | 没有其他策略可用时屏幕旋转。<br/> 启用自动旋转时，此常量无效。<br/>禁用自动旋转时，以下值可用：<br/> <ul> <li> 0 - 屏幕旋转 0 度。 <li> 1 - 屏幕旋转 90 度。 <li> 2 - 屏幕旋转 180 度。 <li> 3 - 屏幕旋转 270 度。 </ul> |
| ANIMATOR_DURATION_SCALE | string | 是 | 否 | 动画持续时间的比例因子。<br/>这会影响所有此类动画的开始延迟和持续时间。<br/>如果值为 0 ，则动画将立即结束，默认值为 1 。 |
| SCREEN_OFF_TIMEOUT | string | 是 | 否 | 设备在一段时间不活动后进入睡眠状态的等待时间（以毫秒为单位）。 |
| DEFAULT_SCREEN_ROTATION | string | 是 | 否 | 没有其他策略可用时屏幕旋转。<br/> 启用自动旋转时，此常量无效；禁用自动旋转时，以下值可用：0 - 屏幕旋转 0 度； 1 - 屏幕旋转 90 度；2 - 屏幕旋转 180 度；3 - 屏幕旋转 270 度。 |
| ANIMATOR_DURATION_SCALE | string | 是 | 否 | 动画持续时间的比例因子。<br/>这会影响所有此类动画的开始延迟和持续时间。如果值为 0 ，则动画将立即结束，默认值为 1 。 |
| TRANSITION_ANIMATION_SCALE | string | 是 | 否 | 过渡动画的比例因子。<br/>如果值为 0 ，则禁用过渡动画。 |
| WINDOW_ANIMATION_SCALE | string | 是 | 否 | 普通窗口动画的比例因子。<br/>如果值为 0 ，则禁用窗口动画。 |
| DISPLAY_INVERSION_STATUS | string | 是 | 否 | 是否启用显示颜色反转。<br/> <ul> <li> 1 ，则启用显示颜色反转。<li> 0 ，则禁用显示颜色反转。 </ul> |
| DISPLAY_INVERSION_STATUS | string | 是 | 否 | 是否启用显示颜色反转。<br/>该值为1 ，则启用显示颜色反转；值为0 ，则禁用显示颜色反转。 |
## general
......@@ -60,18 +58,18 @@ import settings from '@ohos.settings';
**系统能力：** SystemCapability.Applications.settings.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ |
| SETUP_WIZARD_FINISHED | string | 是 | 否 | 是否已运行启动向导。<br>如果值为 0 ，则启动向导尚未运行。如果该值不是 0 ，则启动向导已运行。 |
| END_BUTTON_ACTION | string | 是 | 否 | 在用户不在呼叫中时用户按下呼叫结束按钮后发生的情况。<br/> <ul> <li> 0 - 没有任何反应。 <li> 1 - 显示主屏幕。 <li> 2 - 设备进入睡眠状态，屏幕锁定。 <li> 3 - 显示主屏幕。如果用户已在主屏幕上，则设备将进入睡眠状态。 </ul> |
| -------------------------------- | ------ | --- | --- | ------------------------------------------------------------------------------------------------------------ |
| SETUP_WIZARD_FINISHED | string | 是 | 否 | 是否已运行启动向导。<br>如果值为 0 ，则启动向导尚未运行；如果该值不是 0 ，则启动向导已运行。 |
| END_BUTTON_ACTION | string | 是 | 否 | 在用户不在呼叫中时用户按下呼叫结束按钮后发生的情况。<br/>0 - 没有任何反应； 1 - 显示主屏幕；2 - 设备进入睡眠状态，屏幕锁定；3 - 显示主屏幕。如果用户已在主屏幕上，则设备将进入睡眠状态。 |
| ACCELEROMETER_ROTATION_STATUS | string | 是 | 否 | 是否使用加速计更改屏幕方向，即是否启用自动旋转。<br>值 1 表示默认情况下启用加速度计， 0 表示默认情况下禁用加速计。 |
| AIRPLANE_MODE_STATUS | string | 是 | 否 | 是否启用飞行模式。<br>如果值为 1 ，则启用飞行模式。如果值为 0 ，则禁用飞行模式。 |
| AIRPLANE_MODE_STATUS | string | 是 | 否 | 是否启用飞行模式。<br>如果值为 1 ，则启用飞行模式；如果值为 0 ，则禁用飞行模式。 |
| DEVICE_PROVISION_STATUS | string | 是 | 否 | 是否预配设备。<br>在具有单个系统用户的多用户设备上，当值为 true 时，屏幕可能会被锁定。此外，其他功能无法在系统用户上启动，除非它们被标记为在屏幕锁定上显示。 |
| HDC_STATUS | string | 是 | 否 | 是否启用 USB 设备上的硬盘控制器 （HDC）。<br>如果值为 true ，则启用 HDC。如果值为 false ，则禁用 HDC。 |
| BOOT_COUNTING | string | 是 | 否 | 设备开机后的启动操作数。 |
| CONTACT_METADATA_SYNC_STATUS | string | 是 | 否 | 是否启用联系人元数据同步。<br>如果值为 true ，则启用同步。如果值为 false ，则禁用同步。 |
| DEVELOPMENT_SETTINGS_STATUS | string | 是 | 否 | 是否启用开发人员选项。<br>如果值为 true ，则启用开发人员选项。如果值为 false ，则禁用开发人员选项。 |
| CONTACT_METADATA_SYNC_STATUS | string | 是 | 否 | 是否启用联系人元数据同步。<br>如果值为 true ，则启用同步；如果值为 false ，则禁用同步。 |
| DEVELOPMENT_SETTINGS_STATUS | string | 是 | 否 | 是否启用开发人员选项。<br>如果值为 true ，则启用开发人员选项；如果值为 false ，则禁用开发人员选项。 |
| DEVICE_NAME | string | 是 | 否 | 设备名称。 |
| USB_STORAGE_STATUS | string | 是 | 否 | 是否启用 USB 大容量存储。<br>如果值为 true ，则启用 USB 大容量存储。如果值为 false ，则禁用 USB 大容量存储。 |
| USB_STORAGE_STATUS | string | 是 | 否 | 是否启用 USB 大容量存储。<br>如果值为 true ，则启用 USB 大容量存储；如果值为 false ，则禁用 USB 大容量存储。 |
| DEBUGGER_WAITING | string | 是 | 否 | 设备在启动应用程序进行调试时是否等待调试器进行调试。<br>如果值为 1 ，则设备等待调试器。如果值为 0 ，则系统不会等待调试器，因此应用程序会正常运行。 |
| DEBUG_APP_PACKAGE | string | 是 | 否 | 要调试的应用程序的捆绑包名称。 |
| ACCESSIBILITY_STATUS | string | 是 | 否 | 是否启用任何辅助功能。<br>如果值为 1 ，则启用辅助功能。如果值为 0 ，则禁用辅助功能。 |
......@@ -88,17 +86,16 @@ import settings from '@ohos.settings';
**系统能力：** SystemCapability.Applications.settings.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------------------ | ------ | ---- | ---- | ------------------------------------------------------------ |
| ------------------------------------ | ------ | --- | --- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| DEFAULT_INPUT_METHOD | string | 是 | 否 | 默认输入法及其 ID。 |
| ACTIVATED_INPUT_METHOD_SUB_MODE | string | 是 | 否 | 默认输入法键盘类型及其 ID。 |
| ACTIVATED_INPUT_METHODS | string | 是 | 否 | 已激活的输入法的列表。<br>该列表是一个字符串，其中包含已激活输入法的 ID。ID 由冒号':'分隔，输入法的键盘类型由分号';'分隔。示例格式是 ima0: keyboardType0; keyboardType1; ima1: ima2: keyboardTypes0 。imaID 的类型是 ElementName，keyboard的类型是 int。 |
| SELECTOR_VISIBILITY_FOR_INPUT_METHOD | string | 是 | 否 | 输入法选择器是否可见。<br>如果值为 1 ，则输入法选择器可见。如果值为 0 ，则输入法选择器不可见。 |
| AUTO_CAPS_TEXT_INPUT | string | 是 | 否 | 是否为文本编辑器启用自动大写。<br>如果值为 0 ，则禁用自动大写。如果值为 1 ，则启用自动大写。 |
| AUTO_PUNCTUATE_TEXT_INPUT | string | 是 | 否 | 是否为文本编辑器启用自动标点符号。<br>自动标点符号使文本编辑器能够将两个空格转换为句点'.'和空格。如果值为 0 ，则禁用自动标点符号。如果值为 1 ，则启用自动标点符号。 |
| AUTO_REPLACE_TEXT_INPUT | string | 是 | 否 | 是否为文本编辑器启用自动更正。<br>自动更正使文本编辑器能够更正拼写错误。如果值为 0 ，则禁用自动更正。如果值为 1 ，则启用自动更正。 |
| SHOW_PASSWORD_TEXT_INPUT | string | 是 | 否 | 是否在文本编辑器中启用密码显示。<br>密码显示使文本编辑器能够在用户键入密码字符时显示密码字符。如果值为 0 ，则禁用密码显示。如果值为 1 ，则启用密码显示。 |
| AUTO_PUNCTUATE_TEXT_INPUT | string | 是 | 否 | 是否为文本编辑器启用自动标点符号。<br>自动标点符号使文本编辑器能够将两个空格转换为句点'.'和空格。如果值为 0 ，则禁用自动标点符号；如果值为 1 ，则启用自动标点符号。 |
| AUTO_REPLACE_TEXT_INPUT | string | 是 | 否 | 是否为文本编辑器启用自动更正。<br>自动更正使文本编辑器能够更正拼写错误。如果值为 0 ，则禁用自动更正；如果值为 1 ，则启用自动更正。 |
| SHOW_PASSWORD_TEXT_INPUT | string | 是 | 否 | 是否在文本编辑器中启用密码显示。<br>密码显示使文本编辑器能够在用户键入密码字符时显示密码字符。如果值为 0 ，则禁用密码显示；如果值为 1 ，则启用密码显示。 |
## network
......@@ -108,9 +105,8 @@ import settings from '@ohos.settings';
**系统能力：** SystemCapability.Applications.settings.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------ | ------ | ---- | ---- | ------------------------------------------------------------ |
| ------------------------ | ------ | --- | --- | ---------------------------------------------------- |
| DATA_ROAMING_STATUS | string | 是 | 否 | 是否启用数据漫游。<br>如果值为 true ，则启用数据漫游。如果值为 false ，则禁用数据漫游。 |
| HTTP_PROXY_CFG | string | 是 | 否 | 全局 HTTP 代理的主机名和端口号。主机名和端口号由冒号':'分隔。 |
| NETWORK_PREFERENCE_USAGE | string | 是 | 否 | 要使用的网络的用户首选项。 |
......@@ -120,20 +116,23 @@ import settings from '@ohos.settings';
提供设置来电和去电接听方式的数据项。
### 常量
**系统能力：** SystemCapability.Applications.settings.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------ | ------ | ----------- | --------------- | ------------------------------------------------------------ |
| RTT_CALLING_STATUS | string | 是 | 否 | 是否启用实时文本 (RTT) 呼叫。 <br>如果启用，来电和去电在设备和运营商支持时作为 RTT 呼叫应答。 如果值为 1 ，则 启用RTT 呼叫， 如果值为 0 ，则禁用 RTT 呼叫。 |
| ------------------ | ------ | --- | --- | ----------------------------------------------------------------------------------------------- |
| RTT_CALLING_STATUS | string | 是 | 否 | 是否启用实时文本 (RTT) 呼叫。 <br>如果启用，来电和去电在设备和运营商支持时作为 RTT 呼叫应答。 如果值为 1 ，则 启用RTT 呼叫； 如果值为 0 ，则禁用 RTT 呼叫。 |
## sound
提供设置声音效果的数据项。
### 常量
**系统能力：** SystemCapability.Applications.settings.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ---------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ |
| ---------------------------- | ------ | --- | --- | ------------------------------------------------------------------------------ |
| VIBRATE_WHILE_RINGING | string | 是 | 否 | 设备在来电响铃时是否振动。<br>此常量将由电话和设置应用程序使用。 该值是布尔类型，仅影响设备因来电而响铃的情况，不影响任何其他应用程序或场景。 |
| DEFAULT_ALARM_ALERT | string | 是 | 否 | 系统默认告警的存储区域。 |
| DTMF_TONE_TYPE_WHILE_DIALING | string | 是 | 否 | 拨号时播放的双音多频 (DTMF) 音的类型。 <br>0 表示常规的短音效， 1 表示长音效。 |
......@@ -142,45 +141,48 @@ import settings from '@ohos.settings';
| AFFECTED_MUTE_STREAMS | string | 是 | 否 | 受静音模式影响的音频流。<br>如果希望特定音频流在静音模式下保持静音，请将相应位设置为 1 。 |
| DEFAULT_NOTIFICATION_SOUND | string | 是 | 否 | 系统默认通知音的存储区域。 |
| DEFAULT_RINGTONE | string | 是 | 否 | 系统默认铃声的存储区域。 |
| SOUND_EFFECTS_STATUS | string | 是 | 否 | 声音功能是否可用。<br>0 表示不可用， 1 表示可用 |
| SOUND_EFFECTS_STATUS | string | 是 | 否 | 声音功能是否可用。<br>值为0 表示不可用， 1 表示可用 |
| VIBRATE_STATUS | string | 是 | 否 | 设备是否为事件振动。 <br>该参数在系统内部使用。如果值为 1 ，则设备会因事件而振动。 如果值为 0 ，则设备不因事件振动。 |
| HAPTIC_FEEDBACK_STATUS | string | 是 | 否 | 设备是否启用触觉反馈。 |
| HAPTIC_FEEDBACK_STATUS | string | 是 | 否 | 设备是否启用触觉反馈。该参数为boolean类型。 |
## TTS
提供设置文本到语音 (TTS) 转换信息的数据项。
### 常量
**系统能力：** SystemCapability.Applications.settings.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------- | ------ | ---- | ---- | ------------------------------------------------------------ |
| ------------------- | ------ | --- | --- | ------------------------------------------------------------ |
| DEFAULT_TTS_PITCH | string | 是 | 否 | 文本转语音 (TTS) 引擎的默认音高。<br>其中100=1x，如果该值设置为 200 ，则频率是正常声音频率的两倍。 |
| DEFAULT_TTS_RATE | string | 是 | 否 | TTS 引擎的默认语速，100=1x。 |
| DEFAULT_TTS_SYNTH | string | 是 | 否 | 默认TTS引擎 |
| DEFAULT_TTS_RATE | string | 是 | 否 | TTS 引擎的默认语速。<br>其中100=1x。 |
| DEFAULT_TTS_SYNTH | string | 是 | 否 | 默认TTS引擎。 |
| ENABLED_TTS_PLUGINS | string | 是 | 否 | 用于 TTS 的已激活插件包列表， 多个插件包以空格分隔。 |
## wireless
提供无线网络信息设置数据项。
### 常量
**系统能力：** SystemCapability.Applications.settings.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ---- | ---- | ---- | ---- | ---- |
| BLUETOOTH_DISCOVER_ABILITY_STATUS | string | 是 | 否 | 设备是否可以被其他设备通过蓝牙发现或连接。<br><ul><li> 0 表示设备不可以被连接或发现。</li><li> 1 表示设备可以被连接但不可以被发现。</li><li> 2 表示设备可以被连接和发现。</li> |
| BLUETOOTH_DISCOVER_TIMEOUT | string | 是 | 否 | 可以通过蓝牙发现设备的持续时间（以秒为单位）。<br这段时间之后，设备不可以被蓝牙搜寻到。 |
| AIRPLANE_MODE_RADIOS | string | 是 | 否 | 启用飞行模式时要禁用的无线电信号列表。 <br>多个无线电信号用逗号 (,) 分隔。取值包括 BLUETOOTH_RADIO 、 CELL_RADIO 、 NFC_RADIO 、 WIFI_RADIO 。 |
| BLUETOOTH_RADIO | string | 是 | 否 | 蓝牙在飞行模式下禁用 |
| CELL_RADIO | string | 是 | 否 | 蜂窝无线电在飞行模式下禁用 |
| NFC_RADIO | string | 是 | 否 | NFC在飞行模式下禁用 |
| WIFI_RADIO | string | 是 | 否 | Wi-Fi在飞行模式下禁用 |
| BLUETOOTH_STATUS | string | 是 | 否 | 蓝牙是否可用。 |
| OWNER_LOCKDOWN_WIFI_CFG | string | 是 | 否 | 是否应锁定由设备所有者的应用程序创建的 Wi-Fi 配置。 |
| --------------------------------- | ------ | --- | --- | ------------------------------------------------------------------------------------------------------ |
| BLUETOOTH_DISCOVER_ABILITY_STATUS | string | 是 | 否 | 设备是否可以被其他设备通过蓝牙发现或连接。<br>值为0 表示设备不可以被连接或发现；1 表示设备可以被连接但不可以被发现；2 表示设备可以被连接和发现。 |
| BLUETOOTH_DISCOVER_TIMEOUT | string | 是 | 否 | 可以通过蓝牙发现设备的持续时间（以秒为单位）。<br>这段时间之后，设备不可以被蓝牙搜寻到。 |
| AIRPLANE_MODE_RADIOS | string | 是 | 否 | 启用飞行模式时要禁用的无线电信号列表。 <br>多个无线电信号用逗号 (,) 分隔。取值包括以下常量：BLUETOOTH_RADIO、 CELL_RADIO、 NFC_RADIO、 WIFI_RADIO。 |
| BLUETOOTH_RADIO | string | 是 | 否 | 常量，用来表示蓝牙在飞行模式下禁用。 |
| CELL_RADIO | string | 是 | 否 | 常量，用来表示蜂窝无线电在飞行模式下禁用。 |
| NFC_RADIO | string | 是 | 否 | 常量，用来表示NFC在飞行模式下禁用。 |
| WIFI_RADIO | string | 是 | 否 | 常量，用来表示Wi-Fi在飞行模式下禁用。 |
| BLUETOOTH_STATUS | string | 是 | 否 | 蓝牙是否可用。 <br>true 表示蓝牙可用， false表示蓝牙禁用。 |
| OWNER_LOCKDOWN_WIFI_CFG | string | 是 | 否 | 是否应锁定由设备所有者的应用程序创建的 Wi-Fi 配置。<br> 取值为true表示Wi-Fi配置应该被锁定，否则不应该被锁定。 |
| WIFI_DHCP_MAX_RETRY_COUNT | string | 是 | 否 | 尝试从 DHCP 服务器获取 IP 地址的最大次数。 |
| WIFI_TO_MOBILE_DATA_AWAKE_TIMEOUT | string | 是 | 否 | Wi-Fi连接断开后等待移动数据连接建立时保持唤醒锁的最长时间。 |
| WIFI_STATUS | string | 是 | 否 | Wi-Fi是否可用。 |
| WIFI_WATCHDOG_STATUS | string | 是 | 否 | Wi-Fi的WatchDog是否可用。 |
| WIFI_STATUS | string | 是 | 否 | Wi-Fi是否可用。<br> true表示Wi-Fi可用，否则表示Wi-Fi禁用。 |
| WIFI_WATCHDOG_STATUS | string | 是 | 否 | Wi-Fi的WatchDog是否可用。 <br> true表示可用，否则表示禁用。 |
## setting.getURI
......@@ -193,19 +195,18 @@ getURI(name: string, callback: AsyncCallback\<object>): void
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| name | string | 是 | settings.display.SCREEN_BRIGHTNESS_STATUS：亮度数据项的名称；<br/>settings.date.TIME_FORMAT：时间格式数据项的名称。 |
| callback | AsyncCallback\<boolean> | 是 | 回调函数。返回true表示操作成功，否则操作失败 |
| -------- | ----------------------- | --- | ------------------------ |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
| callback | AsyncCallback\<boolean> | 是 | 回调函数。返回true表示操作成功，否则操作失败。 |
**示例**：
```ts
```ts
// 获取数据项的URI
settings.getUri(settings.display.SCREEN_BRIGHTNESS_STATUS, (urivar) => {
console.log(`$(urivar)`)
console.log(`$(urivar)`)
})
```
```
## setting.getURI
......@@ -218,26 +219,23 @@ getURI(name: string): Promise\<object>
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| name | string | 是 | settings.display.SCREEN_BRIGHTNESS_STATUS：亮度数据项的名称；<br/>settings.date.TIME_FORMAT：时间格式数据项的名称。 |
| ---- | ------ | --- | ----------- |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
**返回值**：
| 类型 | 说明 |
| ---------------- | ---------------------------- |
| ---------------- | ------------------- |
| Promise\<object> | 使用promise获取数据项的URI。 |
**示例**：
```ts
```ts
// 获取数据项的URI
settings.getUri(settings.display.SCREEN_BRIGHTNESS_STATUS).then((urivar) => {
console.log(`$(urivar)`)
console.log(`$(urivar)`)
})
```
```
## setting.getValue
......@@ -250,15 +248,14 @@ getValue(dataAbilityHelper: DataAbilityHelper, name: string, callback: AsyncCall
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| ----------------- | ------------------------------------------------- | --- | ----------------------- |
| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br/> <ul><li>数据库中已存在的数据项，包括：<br/></li> <ul><li>亮度：settings.display.SCREEN_BRIGHTNESS_STATUS <br/> </li> <li> 时间格式：settings.date.TIME_FORMAT <br/> </li></ul> <li>开发者自行添加的数据项。</li></ul> |
| callback | AsyncCallback\<object> | 是 | 使用callback方式获取数据库中字符串的值 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
| callback | AsyncCallback\<object> | 是 | 使用callback方式获取数据库中字符串的值。 |
**示例**：
```ts
```ts
// 获取数据项的URI
settings.getValue(dataAbilityHelper, name, (err, value) => {
if (err) {
......@@ -267,9 +264,7 @@ getValue(dataAbilityHelper: DataAbilityHelper, name: string, callback: AsyncCall
}
console.log(`$(value)`)
});
```
```
## setting.getValue
......@@ -282,29 +277,24 @@ getValue(dataAbilityHelper: DataAbilityHelper, name: string): Promise\<object>
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| ----------------- | ------------------------------------------------- | --- | ----------- |
| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br/> <ul><li>数据库中已存在的数据项，包括：<br/></li> <ul><li>亮度：settings.display.SCREEN_BRIGHTNESS_STATUS <br/> </li> <li> 时间格式：settings.date.TIME_FORMAT <br/> </li></ul> <li>开发者自行添加的数据项。</li></ul> |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
**返回值**：
| 类型 | 说明 |
| ---------------- | --------------------------------------- |
| ---------------- | --------------------- |
| Promise\<object> | 使用promise获取数据库中字符串的值。 |
**示例**：
```ts
```ts
// 获取数据项的URI
settings.getUri(dataAbilityHelper, name).then((value) => {
console.log(`$(value)`)
console.log(`$(value)`)
})
```
```
## settings.setValue
......@@ -317,11 +307,11 @@ setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object, call
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------- | ---- | -------------------------------------------- |
| ----------------- | ------------------------------------------------- | --- | ------------------------ |
| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 |
| name | string | 是 | 数据项名称。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
| value | object | 是 | 数据项值。取值范围随业务变动。 |
| callback | AsyncCallback\<boolean> | 是 | 回调函数。返回true表示操作成功，否则操作失败 |
| callback | AsyncCallback\<boolean> | 是 | 回调函数。返回true表示操作成功，否则操作失败。 |
**示例**：
......@@ -336,10 +326,6 @@ settings.setValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100', (sta
});
```
## settings.setValue
setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object): Promise\<boolean>
......@@ -351,15 +337,15 @@ setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object): Pro
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ----------------- | ---- | ---------------- |
| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类 |
| name | string | 是 | 字符串名称。 |
| value | object | 是 | 字符串值。 |
| ----------------- | ------------------------------------------------- | --- | --------------- |
| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
| value | object | 是 | 数据项值。取值范围随业务变动。 |
**返回值**：
| 类型 | 说明 |
| ----------------- | -------------------------------------------------- |
| ----------------- | --------------------------------- |
| Promise\<boolean> | Promise对象。返回true表示操作成功，否则返回false。 |
**示例**：
......@@ -375,8 +361,6 @@ settings.setValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100').then
});
```
## settings.enableAirplaneMode
enableAirplaneMode(enable: boolean, callback: AsyncCallback\<void>): void
......@@ -388,7 +372,7 @@ enableAirplaneMode(enable: boolean, callback: AsyncCallback\<void>): void
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------------------------------------ |
| -------- | -------------------- | --- | ----------------------------------------------- |
| enable | boolean | 是 | 是否开启飞行模式。true表示开启，false表示禁用。 |
| callback | AsyncCallback\<void> | 是 | 回调函数。当具体的操作（视具体接口功能描述）成功，err为undefined，否则为错误对象。 |
......@@ -405,8 +389,6 @@ enableAirplaneMode(isEnabled, (err) => {
})
```
## settings.enableAirplaneMode
enableAirplaneMode(enable: boolean): Promise<void>
......@@ -418,13 +400,13 @@ enableAirplaneMode(enable: boolean): Promise<void>
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | --------------------------------------------------- |
| ------ | ------- | --- | ---------------------------- |
| enable | boolean | 是 | 是否开启飞行模式。true表示开启，false表示禁用。 |
**返回值**：
| 类型 | 说明 |
| -------------- | -------------------------------------- |
| -------------- | -------------------------- |
| Promise\<void> | Promise对象。无返回结果的Promise对象。 |
**示例**：
......@@ -440,8 +422,6 @@ enableAirplaneMode(isEnabled).then((err) => {
});
```
## settings.canShowFloating
canShowFloating(callback: AsyncCallback\<boolean>): void
......@@ -453,7 +433,7 @@ canShowFloating(callback: AsyncCallback\<boolean>): void
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ------------------------------------------------------------ |
| -------- | ----------------------- | --- | ----------------------------------------------------------------- |
| callback | AsyncCallback\<boolean> | 是 | 回调函数。当具体的操作（视具体接口功能描述）成功，err为undefined，data为获取到的boolean值；否则为错误对象。 |
**示例**：
......@@ -464,8 +444,6 @@ canShowFloating((status) => {
});
```
## settings.canShowFloating
canShowFloating(): Promise\<boolean>
......@@ -477,7 +455,7 @@ canShowFloating(): Promise\<boolean>
**返回值**：
| 类型 | 说明 |
| ---------------- | ------------------------------------------------------------ |
| ----------------- | ------------------------------------------- |
| Promise\<boolean> | Promise对象。返回true表示应用程序可以覆盖其他应用程序，否则返回false。 |
**示例**：
......@@ -497,10 +475,9 @@ getUriSync(name: string): string
**系统能力**：SystemCapability.Applications.settings.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| settings.display.SCREEN_BRIGHTNESS_STATUS | string | 是 | 亮度数据项的名称。|
| settings.date.TIME_FORMAT | string | 是 | 时间格式数据项的名称。|
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | --- | ----------- |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> - 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
**返回值**：
| 类型 | 说明 |
......@@ -508,11 +485,11 @@ getUriSync(name: string): string
| string | 数据项的URI。 |
**示例**：
```ts
```ts
// 获取数据项的URI
let urivar = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS);
```
```
## settings.getValueSync<sup>8+</sup>
......@@ -526,7 +503,7 @@ getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: strin
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> <ul><li>数据库中已存在的数据项，包括：<br></li> <ul><li>亮度：settings.display.SCREEN_BRIGHTNESS_STATUS <br> </li> <li> 时间格式：settings.date.TIME_FORMAT <br> </li></ul> <li>开发者自行添加的数据项。</li></ul> |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
| defValue | string | 是 | 默认值。由开发者设置，当未从数据库中查询到该数据时，则返回该默认值。 |
**返回值**：
......@@ -536,15 +513,14 @@ getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: strin
**示例**：
```ts
```ts
import featureAbility from '@ohos.ability.featureAbility';
//获取数据项亮度的值（该数据项在数据库中已存在）
let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS);
let helper = featureAbility.acquireDataAbilityHelper(uri);
let value = settings.getValueSync(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '10');
```
```
## settings.setValueSync<sup>8+</sup>
......@@ -561,7 +537,7 @@ setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string):
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br> <ul><li>数据库中已存在的数据项，包括：<br></li> <ul><li>亮度：settings.display.SCREEN_BRIGHTNESS_STATUS <br> </li> <li> 时间格式：settings.date.TIME_FORMAT <br> </li></ul> <li>开发者自行添加的数据项。</li></ul> |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种：<br>- 上述任意一个数据库中已存在的数据项。<br>- 开发者自行添加的数据项。 |
| value | string | 是 | 数据项的具体数值。取值范围随业务变动。 |
**返回值**：
......@@ -570,11 +546,12 @@ setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string):
| boolean | 返回设置数据项的值是否成功的结果。true表示设置成功，false则表示设置失败。 |
**示例**：
```ts
```ts
import featureAbility from '@ohos.ability.featureAbility';
//更新数据项亮度的值（该数据项在数据库中已存在，故setValueSync方法将更新该数据项的值）
let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS);
let helper = featureAbility.acquireDataAbilityHelper(uri);
let ret = settings.setValueSync(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100');
```
```
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或