diff --git a/zh-cn/application-dev/reference/apis/js-apis-settings.md b/zh-cn/application-dev/reference/apis/js-apis-settings.md index cb9aabd4edc89e73ce20af336e70b547daeb2644..276e4c39eb119c5d5257dc47c54057ee1bd39f13 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-settings.md +++ b/zh-cn/application-dev/reference/apis/js-apis-settings.md @@ -1,11 +1,10 @@ # 设置数据项名称 -本模块提供设置数据项的访问功能相关接口的说明及示例。 - -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> 本模块首批接口从API version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 - +本模块提供访问设置数据项的能力。 +> **说明：** +> +> 本模块首批接口从API version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 ## 导入模块 @@ -13,94 +12,554 @@ import settings from '@ohos.settings'; ``` +## date + +提供设置时间和日期格式的数据项。 + +### 属性 + +**系统能力：** SystemCapability.Applications.settings.Core + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------------------- | ------ | ---- | ---- | ------------------------------------------------------------ | +| DATE_FORMAT | string | 是 | 是 | 日期格式。
日期格式包括mm/dd/yyyy、dd/mm/yyyy和yyyy/mm/dd ，其中mm、dd和yyyy分别代表月份、日期和年份。 | +| TIME_FORMAT | string | 是 | 是 | 时间是以12小时格式还是24小时格式显示。
值为 “12” 表示12小时格式；
值为 ”24“ 表示24小时格式。 | +| AUTO_GAIN_TIME | string | 是 | 是 | 是否自动从网络获取日期、时间和时区。
值为true表示自动从网络获取信息；
值为false表示不自动获取。 | +| AUTO_GAIN_TIME_ZONE | string | 是 | 是 | 是否自动从NITZ获取时区。
值为true表示自动获取；
值为false表示不自动获取。 | + +## display + +提供设置显示效果的数据项。 + +### 属性 + +**系统能力：** SystemCapability.Applications.settings.Core + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ----------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ | +| FONT_SCALE | string | 是 | 是 | 字体的比例因子，值为浮点数。 | +| SCREEN_BRIGHTNESS_STATUS | string | 是 | 是 | 屏幕亮度。该值的范围从0到255。 | +| AUTO_SCREEN_BRIGHTNESS | string | 是 | 是 | 是否启用屏幕亮度自动调整。
值为AUTO_SCREEN_BRIGHTNESS_MODE，表示启用自动调整；
值为MANUAL_SCREEN_BRIGHTNESS_MODE，表示不启用自动调整。 | +| AUTO_SCREEN_BRIGHTNESS_MODE | number | 是 | 是 | 使用屏幕亮度自动调整时AUTO_SCREEN_BRIGHTNESS的值。 | +| MANUAL_SCREEN_BRIGHTNESS_MODE | number | 是 | 是 | 使用屏幕亮度手动调整时的AUTO_SCREEN_BRIGHTNESS值。 | +| SCREEN_OFF_TIMEOUT | string | 是 | 是 | 设备在一段时间不活动后进入睡眠状态的等待时间（单位：ms）。 | +| 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.Applications.settings.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 | 是 | 是 | 要调试的应用程序的bundle name。 | +| 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.Applications.settings.Core + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------------------------------------ | ------ | ---- | ---- | ------------------------------------------------------------ | +| DEFAULT_INPUT_METHOD | string | 是 | 是 | 默认输入法及其ID。 | +| ACTIVATED_INPUT_METHOD_SUB_MODE | string | 是 | 是 | 默认输入法键盘类型及其ID。 | +| ACTIVATED_INPUT_METHODS | string | 是 | 是 | 已激活的输入法的列表。
该列表是一个字符串，由已激活的输入法的ID和输入法键盘类型组成。输入法ID后添加冒号':'连接，输入法的键盘类型后添加分号';'连接。用ima代表输入法ID，keyboardType代表键盘类型，示例格式是ima0:keyboardType0;keyboardType1;ima1:ima2:keyboardTypes0。 | +| 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 + +提供设置网络信息的数据项。 + +### 属性 + +**系统能力：** SystemCapability.Applications.settings.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 | 是 | 是 | 设备是否启用触觉反馈。
值为true，表示启用触觉反馈；
值为false，表示不启用触觉反馈。 | + +## 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 + +提供设置无线网络信息的数据项。 + +### 属性 + +**系统能力：** SystemCapability.Applications.settings.Core + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| --------------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ | +| BLUETOOTH_DISCOVER_ABILITY_STATUS | string | 是 | 是 | 设备是否可以被其他设备通过蓝牙发现或连接。
值为0表示设备不可以被连接或发现；
值为1表示设备可以被连接但不可以被发现；
值为2表示设备可以被连接和发现。 | +| BLUETOOTH_DISCOVER_TIMEOUT | string | 是 | 是 | 可以通过蓝牙发现设备的持续时间（以秒为单位）。
这段时间之后，设备不可以被蓝牙搜寻到。 | +| AIRPLANE_MODE_RADIOS | string | 是 | 是 | 启用飞行模式时要禁用的无线电信号列表。
多个无线电信号用逗号 (,) 分隔。取值包括以下常量：BLUETOOTH_RADIO、 CELL_RADIO、 NFC_RADIO、 WIFI_RADIO。 | +| BLUETOOTH_RADIO | string | 是 | 否 | 常量，作为AIRPLANE_MODE_RADIOS的取值时表示蓝牙在飞行模式下禁用。 | +| CELL_RADIO | string | 是 | 否 | 常量，作为AIRPLANE_MODE_RADIOS的取值时表示蜂窝无线电在飞行模式下禁用。 | +| NFC_RADIO | string | 是 | 否 | 常量，作为AIRPLANE_MODE_RADIOS的取值时表示NFC在飞行模式下禁用。 | +| WIFI_RADIO | string | 是 | 否 | 常量，作为AIRPLANE_MODE_RADIOS的取值时表示Wi-Fi在飞行模式下禁用。 | +| BLUETOOTH_STATUS | string | 是 | 是 | 蓝牙是否可用。
值为true表示蓝牙可用；
值为false表示蓝牙不可用。 | +| OWNER_LOCKDOWN_WIFI_CFG | string | 是 | 是 | 是否应锁定由设备所有者的应用程序创建的Wi-Fi配置。
值为true表示Wi-Fi配置应该被锁定；
值为false表示不应该被锁定。 | +| WIFI_DHCP_MAX_RETRY_COUNT | string | 是 | 是 | 尝试从DHCP服务器获取 IP 地址的最大次数。 | +| WIFI_TO_MOBILE_DATA_AWAKE_TIMEOUT | string | 是 | 是 | Wi-Fi连接断开后等待移动数据连接建立时保持唤醒锁的最长时间。 | +| WIFI_STATUS | string | 是 | 是 | Wi-Fi是否可用。
值为true表示Wi-Fi可用；
值为false表示Wi-Fi不可用。 | +| WIFI_WATCHDOG_STATUS | string | 是 | 是 | Wi-Fi的WatchDog是否可用。
值为true表示可用；
值为false表示不可用。 | + +## setting.getURI + +getURI(name: string, callback: AsyncCallback\): void + +获取数据项的URI。使用callback异步回调。 + +**系统能力**：SystemCapability.Applications.settings.Core + +**参数**： + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | ------------------------------------------------------------ | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | +| callback | AsyncCallback\ | 是 | 回调函数。获取数据项的URI。 | + +**示例**： + +```js + settings.getUri(settings.display.SCREEN_BRIGHTNESS_STATUS, (uri) => { + console.log(`callback:uri -> ${JSON.stringify(uri)}`) + }) +``` + +## setting.getURI + +getURI(name: string): Promise\ + +获取数据项的URI。使用Promise异步回调。 + +**系统能力**：SystemCapability.Applications.settings.Core + +**参数**： + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | + +**返回值**： + +| 类型 | 说明 | +| ---------------- | ------------------------------------ | +| Promise\ | Promise对象。返回获取的数据项的URI。 | + +**示例**： + +```js + settings.getUri(settings.display.SCREEN_BRIGHTNESS_STATUS).then((uri) => { + console.log(`promise:uri -> ${JSON.stringify(uri)}`) + }) +``` + +## setting.getValue + +getValue(dataAbilityHelper: DataAbilityHelper, name: string, callback: AsyncCallback\): void + +获取数据库中指定数据项的值。使用callback异步回调。 + +**系统能力**：SystemCapability.Applications.settings.Core + +**参数**： + +| 参数名 | 类型 | 必填 | 说明 | +| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | +| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | +| callback | AsyncCallback\ | 是 | 使用callback方式获取数据项的值。 | + +**示例**： + +```js + let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); + let helper = featureAbility.acquireDataAbilityHelper(uri); + settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, (err, value) => { + if (err) { + console.error(`Failed to get the setting. ${err.message} `); + return; + } + console.log(`callback:value -> ${JOSN.stringify(value)}`) + }); +``` + +## setting.getValue + +getValue(dataAbilityHelper: DataAbilityHelper, name: string): Promise\ + +获取数据库中指定数据项的值。使用Promise异步回调。 + +**系统能力**：SystemCapability.Applications.settings.Core + +**参数**： + +| 参数名 | 类型 | 必填 | 说明 | +| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | +| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | + +**返回值**： + +| 类型 | 说明 | +| ---------------- | ----------------------------------- | +| Promise\ | Promise对象。返回获得的数据项的值。 | + +**示例**： + +```js + let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); + let helper = featureAbility.acquireDataAbilityHelper(uri); + settings.getValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS).then((value) => { + console.log(`promise:value -> ${JOSN.stringify(value)}`) + }); +``` + +## settings.setValue + +setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object, callback: AsyncCallback\): void + +将数据项名称及数据项的值保存到数据库中。使用callback异步回调。 + +**系统能力**：SystemCapability.Applications.settings.Core + +**参数**： + +| 参数名 | 类型 | 必填 | 说明 | +| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | +| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | +| value | object | 是 | 数据项值。取值范围随业务变动。 | +| callback | AsyncCallback\ | 是 | 回调函数。返回true表示操作成功，否则操作失败。 | + +**示例**： + +```js + import featureAbility from '@ohos.ability.featureAbility'; + + //更新数据项亮度的值（该数据项在数据库中已存在，故setValue方法将更新该数据项的值） + let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); + let helper = featureAbility.acquireDataAbilityHelper(uri); + settings.setValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100', (status) => { + console.log('Callback return whether value is set.'); + }); +``` + +## settings.setValue + +setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object): Promise\ + +将数据项名称及数据项的值保存到数据库中。使用Promise异步回调。 + +**系统能力**：SystemCapability.Applications.settings.Core + +**参数**： + +| 参数名 | 类型 | 必填 | 说明 | +| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | +| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | +| value | object | 是 | 数据项值。取值范围随业务变动。 | + +**返回值**： + +| 类型 | 说明 | +| ----------------- | -------------------------------------------------- | +| Promise\ | Promise对象。返回true表示操作成功，否则返回false。 | + +**示例**： + +```js + import featureAbility from '@ohos.ability.featureAbility'; + + //更新数据项亮度的值（该数据项在数据库中已存在，故setValue方法将更新该数据项的值） + let uri = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); + let helper = featureAbility.acquireDataAbilityHelper(uri); + settings.setValue(helper, settings.display.SCREEN_BRIGHTNESS_STATUS, '100').then((status) => { + console.log('Callback return whether value is set.'); + }); +``` + +## settings.enableAirplaneMode + +enableAirplaneMode(enable: boolean, callback: AsyncCallback\): void + +启用或禁用飞行模式。使用callback异步回调。 + +**系统能力**：SystemCapability.Applications.settings.Core + +**参数**： + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ----------------------------------------------- | +| enable | boolean | 是 | 是否开启飞行模式。true表示开启，false表示禁用。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | + +**示例**： + +```js + isEnabled =true; + enableAirplaneMode(isEnabled, (err) => { + if(err) { + console.log('Failed to enable AirplaneMode.'); + return; + } + console.log('Return true if enable.'); + }) +``` + +## settings.enableAirplaneMode + +enableAirplaneMode(enable: boolean): Promise +启用或禁用飞行模式。使用Promise异步回调。 -## settings.getUriSync +**系统能力**：SystemCapability.Applications.settings.Core + +**参数**： + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------- | ---- | ----------------------------------------------- | +| enable | boolean | 是 | 是否开启飞行模式。true表示开启，false表示禁用。 | + +**返回值**： + +| 类型 | 说明 | +| -------------- | ------------------------- | +| Promise\ | 无返回结果的Promise对象。 | + +**示例**： + +```js + isEnabled =true; + enableAirplaneMode(isEnabled).then((err) => { + if(err) { + console.log('Failed to enable AirplaneMode.'); + return; + } + console.log('Return true if enable.'); + }); +``` + +## settings.canShowFloating + +canShowFloating(callback: AsyncCallback\): void + +检查应用是否能够以悬浮窗形式显示。使用callback异步回调。 + +**系统能力**：SystemCapability.Applications.settings.Core + +**参数**： + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------- | ---- | ------------------------------------------------------------ | +| callback | AsyncCallback\ | 是 | 回调函数。
返回true，表示应用能够以悬浮窗形式显示；返回false，则表示不能。 | + +**示例**： + +```js + canShowFloating((status) => { + console.log('Checks whether a specified application can show as float window.'); + }); +``` + +## settings.canShowFloating + +canShowFloating(): Promise\ + +检查应用是否能够以悬浮窗形式显示。使用Promise异步回调。 + +**系统能力**：SystemCapability.Applications.settings.Core + +**返回值**： + +| 类型 | 说明 | +| ----------------- | ------------------------------------------------------------ | +| Promise\ | Promise对象。
返回true，表示应用能够以悬浮窗形式显示；返回false，则表示不能。 | + +**示例**： + +```js + canShowFloating().then((status) => { + console.log('Checks whether a specified application can show as float window.'); + }); +``` + +## settings.getUriSync8+ getUriSync(name: string): string 获取数据项的URI。 -**系统能力**：SystemCapability.Applications.settings.Core。 +**系统能力**：SystemCapability.Applications.settings.Core **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | settings.display.SCREEN_BRIGHTNESS_STATUS | string | 是 | 亮度数据项的名称。| - | settings.date.TIME_FORMAT | string | 是 | 时间格式数据项的名称。| + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | string | 数据项的URI。 | + +| 类型 | 说明 | +| ------ | ------------- | +| string | 数据项的URI。 | **示例**： - ```ts - // 获取数据项的URI - let urivar = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); - ``` +```js + // 获取数据项的URI + let urivar = settings.getUriSync(settings.display.SCREEN_BRIGHTNESS_STATUS); +``` -## settings.getValueSync +## settings.getValueSync8+ getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: string): string -获取数据项的值。 +获取数据项的值。此方法相较getValue为同步方法。 -**系统能力**：SystemCapability.Applications.settings.Core。 +**系统能力**：SystemCapability.Applications.settings.Core **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | - | name | string | 是 | 数据项的名称。数据项名称分为以下两种：
  • 数据库中已存在的数据项，包括：
    • 亮度：settings.display.SCREEN_BRIGHTNESS_STATUS
    • 时间格式：settings.date.TIME_FORMAT
  • 开发者自行添加的数据项。
| - | defValue | string | 是 | 默认值。由开发者设置，当未从数据库中查询到该数据时，则返回该默认值。 | + +| 参数名 | 类型 | 必填 | 说明 | +| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | +| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | +| defValue | string | 是 | 默认值。由开发者设置，当未从数据库中查询到该数据时，表示返回该默认值。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | string | 返回数据项的值。 | + +| 类型 | 说明 | +| ------ | ---------------- | +| string | 返回数据项的值。 | **示例**： - ```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'); - ``` +```js + 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 +## settings.setValueSync8+ setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string): boolean -设置数据项的值。 +设置数据项的值。此方法相较setValue为同步方法。 + 如果数据库中已经存在该数据项，则setValueSync方法将更新该数据项的值；如果数据库中尚未存在该数据项，则setValueSync方法将向数据库中插入该数据项。 -**需要权限**：ohos.permission.MODIFY_SETTINGS。 +**需要权限**：ohos.permission.MANAGE_SECUER_SETTINGS，仅系统应用可用。 -**系统能力**：SystemCapability.Applications.settings.Core。 +**系统能力**：SystemCapability.Applications.settings.Core **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | - | name | string | 是 | 数据项的名称。数据项名称分为以下两种：
  • 数据库中已存在的数据项，包括：
    • 亮度：settings.display.SCREEN_BRIGHTNESS_STATUS
    • 时间格式：settings.date.TIME_FORMAT
  • 开发者自行添加的数据项。
| - | value | string | 是 | 数据项的具体数值，取值范围随业务变动。 | + +| 参数名 | 类型 | 必填 | 说明 | +| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | +| dataAbilityHelper | [DataAbilityHelper](js-apis-dataAbilityHelper.md) | 是 | 数据管理辅助类。 | +| name | string | 是 | 数据项的名称。数据项名称分为以下两种：
- 上述任意一个数据库中已存在的数据项。
- 开发者自行添加的数据项。 | +| value | string | 是 | 数据项的具体数值。取值范围随业务变动。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | boolean | 返回设置数据项的值是否成功的结果。true表示设置成功，false则表示设置失败。 | + +| 类型 | 说明 | +| ------- | ------------------------------------------------------------ | +| boolean | 返回设置数据项的值是否成功的结果。true表示设置成功，false表示设置失败。 | **示例**： - ```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'); - ``` + +```js + 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'); +```