# 设置数据项名称
本模块提供设置数据项的访问功能相关接口的说明及示例。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 导入模块
```ts
import settings from '@ohos.settings';
```
## date
提供用于设置时间和日期格式的方法。
### 属性
**系统能力:** SystemCapability.Setting.Core。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------- | ------ | ---- | ---- | ------------------------------------------------------------ |
| DATE_FORMAT | string | 是 | 否 | 日期格式
- mm/dd/yyyy
- dd/mm/yyyy
- yyyy/mm/dd
|
| TIME_FORMAT | string | 是 | 否 | 时间是以 12 小时格式还是 24 小时格式显示。 |
| AUTO_GAIN_TIME | string | 是 | 否 | 是否自动从网络获取日期、时间和时区。 |
| AUTO_GAIN_TIME_ZONE | string | 是 | 否 | 是否自动从 NITZ 获取时区。 |
## display
提供设置显示效果的方法,包括字体大小、屏幕亮度、屏幕旋转、动画系数和显示颜色。
### 属性
**系统能力:** SystemCapability.Setting.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ |
| FONT_SCALE | string | 是 | 否 | 字体的比例因子,即浮点数。 |
| SCREEN_BRIGHTNESS_STATUS | string | 是 | 否 | 屏幕亮度。该值的范围从 0 到 255。 |
| AUTO_SCREEN_BRIGHTNESS | string | 是 | 否 | 是否启用自动屏幕亮度调整。
- 值为1 ,则启用自动调整。
- 值为 0 ,则禁用自动调整。
|
| AUTO_SCREEN_BRIGHTNESS_MODE | number | 是 | 否 | 使用自动屏幕亮度调整时 AUTO_SCREEN_BRIGHTNESS 的值。 |
| MANUAL_SCREEN_BRIGHTNESS_MODE | number | 是 | 否 | 使用手动屏幕亮度调整时的 AUTO_SCREEN_BRIGHTNESS 值。 |
| SCREEN_OFF_TIMEOUT | string | 是 | 否 | 设备在一段时间不活动后
进入睡眠状态的等待时间(以毫秒为单位)。 |
| DEFAULT_SCREEN_ROTATION | string | 是 | 否 | 没有其他策略可用时屏幕旋转。
启用自动旋转时,此常量无效。
禁用自动旋转时,以下值可用:
- 0 - 屏幕旋转 0 度。
- 1 - 屏幕旋转 90 度。
- 2 - 屏幕旋转 180 度。
- 3 - 屏幕旋转 270 度。
|
| ANIMATOR_DURATION_SCALE | string | 是 | 否 | 动画持续时间的比例因子。
这会影响所有此类动画的开始延迟和持续时间。
如果值为 0 ,则动画将立即结束,默认值为 1 。 |
| TRANSITION_ANIMATION_SCALE | string | 是 | 否 | 过渡动画的比例因子。
如果值为 0 ,则禁用过渡动画。 |
| WINDOW_ANIMATION_SCALE | string | 是 | 否 | 普通窗口动画的比例因子。
如果值为 0 ,则禁用窗口动画。 |
| DISPLAY_INVERSION_STATUS | string | 是 | 否 | 是否启用显示颜色反转。
- 1 ,则启用显示颜色反转。
- 0 ,则禁用显示颜色反转。
|
## general
提供用于设置设备常规信息的方法,包括设备名称、启动向导、飞行模式、调试信息、辅助功能开关和触摸浏览状态。
### 属性
**系统能力:** SystemCapability.Setting.Core。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ |
| SETUP_WIZARD_FINISHED | string | 是 | 否 | 是否已运行启动向导。
如果值为 0 ,则启动向导尚未运行。如果该值不是 0 ,则启动向导已运行。 |
| END_BUTTON_ACTION | string | 是 | 否 | 在用户不在呼叫中时用户按下呼叫结束按钮后发生的情况。
- 0 - 没有任何反应。
- 1 - 显示主屏幕。
- 2 - 设备进入睡眠状态,屏幕锁定。
- 3 - 显示主屏幕。如果用户已在主屏幕上,则设备将进入睡眠状态。
|
| ACCELEROMETER_ROTATION_STATUS | string | 是 | 否 | 是否使用加速计更改屏幕方向,即是否启用自动旋转。
值 1 表示默认情况下启用加速度计, 0 表示默认情况下禁用加速计。 |
| AIRPLANE_MODE_STATUS | string | 是 | 否 | 是否启用飞行模式。
如果值为 1 ,则启用飞行模式。如果值为 0 ,则禁用飞行模式。 |
| DEVICE_PROVISION_STATUS | string | 是 | 否 | 是否预配设备。
在具有单个系统用户的多用户设备上,当值为 true 时,屏幕可能会被锁定。此外,其他功能无法在系统用户上启动,除非它们被标记为在屏幕锁定上显示。 |
| HDC_STATUS | string | 是 | 否 | 是否启用 USB 设备上的硬盘控制器 (HDC)。
如果值为 true ,则启用 HDC。如果值为 false ,则禁用 HDC。 |
| BOOT_COUNTING | string | 是 | 否 | 设备开机后的启动操作数。 |
| CONTACT_METADATA_SYNC_STATUS | string | 是 | 否 | 是否启用联系人元数据同步。
如果值为 true ,则启用同步。如果值为 false ,则禁用同步。 |
| DEVELOPMENT_SETTINGS_STATUS | string | 是 | 否 | 是否启用开发人员选项。
如果值为 true ,则启用开发人员选项。如果值为 false ,则禁用开发人员选项。 |
| DEVICE_NAME | string | 是 | 否 | 设备名称。 |
| USB_STORAGE_STATUS | string | 是 | 否 | 是否启用 USB 大容量存储。
如果值为 true ,则启用 USB 大容量存储。如果值为 false ,则禁用 USB 大容量存储。 |
| DEBUGGER_WAITING | string | 是 | 否 | 设备在启动应用程序进行调试时是否等待调试器进行调试。
如果值为 1 ,则设备等待调试器。如果值为 0 ,则系统不会等待调试器,因此应用程序会正常运行。 |
| DEBUG_APP_PACKAGE | string | 是 | 否 | 要调试的应用程序的捆绑包名称。 |
| ACCESSIBILITY_STATUS | string | 是 | 否 | 是否启用任何辅助功能。
如果值为 1 ,则启用辅助功能。如果值为 0 ,则禁用辅助功能。 |
| ACTIVATED_ACCESSIBILITY_SERVICES | string | 是 | 否 | 已激活的辅助功能的列表。 |
| GEOLOCATION_ORIGINS_ALLOWED | string | 是 | 否 | 浏览器可以使用的默认地理位置。多个地理位置由空格分隔。 |
| SKIP_USE_HINTS | string | 是 | 否 | 应用程序是否应在首次启动时尝试跳过所有介绍性提示。
这适用于临时用户或熟悉环境的用户。如果值为 1 ,则应用程序将尝试在第一次启动时跳过所有介绍性提示。如果值为 0 ,则应用程序不会在首次启动时跳过介绍性提示。 |
| TOUCH_EXPLORATION_STATUS | string | 是 | 否 | 是否启用触摸浏览。
如果值为 1 ,则启用触摸浏览。如果值为 0 ,则禁用触摸浏览。 |
## input
提供用于设置有关输入法的信息的方法,包括自动大写、自动标点符号、自动更正、密码显示、输入法引擎和输入法子类型。
### 属性
**系统能力:** SystemCapability.Setting.Core。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------------------ | ------ | ---- | ---- | ------------------------------------------------------------ |
| DEFAULT_INPUT_METHOD | string | 是 | 否 | 默认输入法及其 ID。 |
| ACTIVATED_INPUT_METHOD_SUB_MODE | string | 是 | 否 | 默认输入法键盘类型及其 ID。 |
| ACTIVATED_INPUT_METHODS | string | 是 | 否 | 已激活的输入法的列表。
该列表是一个字符串,其中包含已激活输入法的 ID。ID 由冒号':'分隔,输入法的键盘类型由分号';'分隔。示例格式是 ima0: keyboardType0; keyboardType1; ima1: ima2: keyboardTypes0 。imaID 的类型是 ElementName,keyboard的类型是 int。 |
| SELECTOR_VISIBILITY_FOR_INPUT_METHOD | string | 是 | 否 | 输入法选择器是否可见。
如果值为 1 ,则输入法选择器可见。如果值为 0 ,则输入法选择器不可见。 |
| AUTO_CAPS_TEXT_INPUT | string | 是 | 否 | 是否为文本编辑器启用自动大写。
如果值为 0 ,则禁用自动大写。如果值为 1 ,则启用自动大写。 |
| AUTO_PUNCTUATE_TEXT_INPUT | string | 是 | 否 | 是否为文本编辑器启用自动标点符号。
自动标点符号使文本编辑器能够将两个空格转换为句点'.'和空格。如果值为 0 ,则禁用自动标点符号。如果值为 1 ,则启用自动标点符号。 |
| AUTO_REPLACE_TEXT_INPUT | string | 是 | 否 | 是否为文本编辑器启用自动更正。
自动更正使文本编辑器能够更正拼写错误。如果值为 0 ,则禁用自动更正。如果值为 1 ,则启用自动更正。 |
| SHOW_PASSWORD_TEXT_INPUT | string | 是 | 否 | 是否在文本编辑器中启用密码显示。
密码显示使文本编辑器能够在用户键入密码字符时显示密码字符。如果值为 0 ,则禁用密码显示。如果值为 1 ,则启用密码显示。 |
## network
提供用于设置网络信息的方法,包括数据漫游状态、HTTP 代理配置和首选网络。
### 属性
**系统能力:** SystemCapability.Setting.Core。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------ | ------ | ---- | ---- | ------------------------------------------------------------ |
| DATA_ROAMING_STATUS | string | 是 | 否 | 是否启用数据漫游。
如果值为 true ,则启用数据漫游。如果值为 false ,则禁用数据漫游。 |
| HTTP_PROXY_CFG | string | 是 | 否 | 全局 HTTP 代理的主机名和端口号。主机名和端口号由冒号':'分隔。 |
| NETWORK_PREFERENCE_USAGE | string | 是 | 否 | 要使用的网络的用户首选项。 |
## phone
提供设置来电和去电接听方式的方法。
### 属性
**系统能力:** SystemCapability.Applications.settings.core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------ | ------ | ----------- | --------------- | ------------------------------------------------------------ |
| RTT_CALLING_STATUS | string | 是 | 否 | 是否启用实时文本 (RTT) 呼叫。
如果启用,来电和去电在设备和运营商支持时作为 RTT 呼叫应答。 如果值为 1 ,则 启用RTT 呼叫, 如果值为 0 ,则禁用 RTT 呼叫。 |
## sound
提供设置声音效果的方法,包括铃声、拨号音、闹钟声音、通知音和触觉反馈。
### 属性
**系统能力:** SystemCapability.Applications.settings.core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ---------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ |
| VIBRATE_WHILE_RINGING | string | 是 | 否 | 设备在来电响铃时是否振动。
此常量将由电话和设置应用程序使用。 该值是布尔类型,仅影响设备因来电而响铃的情况,不影响任何其他应用程序或场景。 |
| DEFAULT_ALARM_ALERT | string | 是 | 否 | 系统默认告警的存储区域。 |
| DTMF_TONE_TYPE_WHILE_DIALING | string | 是 | 否 | 拨号时播放的双音多频 (DTMF) 音的类型。
0 表示常规的短音效, 1 表示长音效。 |
| DTMF_TONE_WHILE_DIALING | string | 是 | 否 | 拨号时是否播放 DTMF 音。
如果值为 1 ,则播放 DTMF 音。 如果值为 0 ,则不播放。 |
| AFFECTED_MODE_RINGER_STREAMS | string | 是 | 否 | 哪些音频流受振铃模式和请勿打扰 (DND) 模式更改的影响。
如果希望特定的音频流受到振铃模式和 DDN 模式变化的影响,请将对应比特位设置为 1 。 |
| AFFECTED_MUTE_STREAMS | string | 是 | 否 | 受静音模式影响的音频流。
如果希望特定音频流在静音模式下保持静音,请将相应位设置为 1 。 |
| DEFAULT_NOTIFICATION_SOUND | string | 是 | 否 | 系统默认通知音的存储区域。 |
| DEFAULT_RINGTONE | string | 是 | 否 | 系统默认铃声的存储区域。 |
| SOUND_EFFECTS_STATUS | string | 是 | 否 | 声音功能是否可用。
0 表示不可用, 1 表示可用 |
| VIBRATE_STATUS | string | 是 | 否 | 设备是否为事件振动。
该参数在系统内部使用。如果值为 1 ,则设备会因事件而振动。 如果值为 0 ,则设备不因事件振动。 |
| HAPTIC_FEEDBACK_STATUS | string | 是 | 否 | 设备是否启用触觉反馈。 |
## TTS
提供设置文本到语音 (TTS) 转换信息的方法,包括音高、语速、引擎和插件。
### 属性
**系统能力:** SystemCapability.Applications.settings.core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------- | ------ | ---- | ---- | ------------------------------------------------------------ |
| DEFAULT_TTS_PITCH | string | 是 | 否 | 文本转语音 (TTS) 引擎的默认音高。
其中100=1x,如果该值设置为 200 ,则频率是正常声音频率的两倍。 |
| DEFAULT_TTS_RATE | string | 是 | 否 | TTS 引擎的默认语速,100=1x。 |
| DEFAULT_TTS_SYNTH | string | 是 | 否 | 默认TTS引擎 |
| ENABLED_TTS_PLUGINS | string | 是 | 否 | 用于 TTS 的已激活插件包列表, 多个插件包以空格分隔。 |
## wireless
提供无线网络信息设置方法,包括蓝牙、Wi-Fi、NFC、飞行模式等信息。
### 属性
**系统能力:** SystemCapability.Applications.settings.core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ---- | ---- | ---- | ---- | ---- |
| BLUETOOTH_DISCOVER_ABILITY_STATUS | string | 是 | 否 | 设备是否可以被其他设备通过蓝牙发现或连接。
- 0 表示设备不可以被连接或发现。
- 1 表示设备可以被连接但不可以被发现。
- 2 表示设备可以被连接和发现。
|
| BLUETOOTH_DISCOVER_TIMEOUT | string | 是 | 否 | 可以通过蓝牙发现设备的持续时间(以秒为单位)。
多个无线电信号用逗号 (,) 分隔。取值包括 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 配置。 |
| 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是否可用。 |
## setting.getURI
getURI(name: string, callback: AsyncCallback\