Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
(_灬幸福相伴
Docs
提交
08ae9ec0
D
Docs
项目概览
(_灬幸福相伴
/
Docs
与 Fork 源项目一致
Fork自
OpenHarmony / Docs
通知
1
Star
1
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
08ae9ec0
编写于
12月 14, 2022
作者:
N
ningning
提交者:
Gitee
12月 14, 2022
浏览文件
操作
浏览文件
下载
差异文件
Merge branch 'master' of gitee.com:openharmony/docs into master
Signed-off-by:
N
ningning
<
3248127340@qq.com
>
上级
3844425f
b6319e19
变更
86
隐藏空白更改
内联
并排
Showing
86 changed file
with
544 addition
and
530 deletion
+544
-530
zh-cn/application-dev/application-models/widget-development-stage.md
...cation-dev/application-models/widget-development-stage.md
+69
-28
zh-cn/application-dev/file-management/Readme-CN.md
zh-cn/application-dev/file-management/Readme-CN.md
+2
-1
zh-cn/application-dev/file-management/filepicker-guidelines.md
.../application-dev/file-management/filepicker-guidelines.md
+68
-0
zh-cn/application-dev/reference/apis/js-apis-EnterpriseAdminExtensionAbility.md
...reference/apis/js-apis-EnterpriseAdminExtensionAbility.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-accessibility-GesturePath.md
...n-dev/reference/apis/js-apis-accessibility-GesturePath.md
+3
-3
zh-cn/application-dev/reference/apis/js-apis-accessibility-GesturePoint.md
...-dev/reference/apis/js-apis-accessibility-GesturePoint.md
+3
-3
zh-cn/application-dev/reference/apis/js-apis-accessibility-config.md
...cation-dev/reference/apis/js-apis-accessibility-config.md
+4
-3
zh-cn/application-dev/reference/apis/js-apis-accessibility.md
...n/application-dev/reference/apis/js-apis-accessibility.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-appAccount.md
zh-cn/application-dev/reference/apis/js-apis-appAccount.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-application-accessibilityExtensionAbility.md
...apis/js-apis-application-accessibilityExtensionAbility.md
+3
-3
zh-cn/application-dev/reference/apis/js-apis-battery-info.md
zh-cn/application-dev/reference/apis/js-apis-battery-info.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-batteryStatistics.md
...plication-dev/reference/apis/js-apis-batteryStatistics.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-bluetooth.md
zh-cn/application-dev/reference/apis/js-apis-bluetooth.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-brightness.md
zh-cn/application-dev/reference/apis/js-apis-brightness.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-cardEmulation.md
...n/application-dev/reference/apis/js-apis-cardEmulation.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-configPolicy.md
zh-cn/application-dev/reference/apis/js-apis-configPolicy.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-connectedTag.md
zh-cn/application-dev/reference/apis/js-apis-connectedTag.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-cooperate.md
zh-cn/application-dev/reference/apis/js-apis-cooperate.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-device-info.md
zh-cn/application-dev/reference/apis/js-apis-device-info.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-device-manager.md
.../application-dev/reference/apis/js-apis-device-manager.md
+1
-4
zh-cn/application-dev/reference/apis/js-apis-distributed-account.md
...ication-dev/reference/apis/js-apis-distributed-account.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-enterprise-adminManager.md
...ion-dev/reference/apis/js-apis-enterprise-adminManager.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-enterprise-dateTimeManager.md
...-dev/reference/apis/js-apis-enterprise-dateTimeManager.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceInfo.md
...ation-dev/reference/apis/js-apis-enterprise-deviceInfo.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-faultLogger.md
zh-cn/application-dev/reference/apis/js-apis-faultLogger.md
+4
-2
zh-cn/application-dev/reference/apis/js-apis-geoLocationManager.md
...lication-dev/reference/apis/js-apis-geoLocationManager.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-hichecker.md
zh-cn/application-dev/reference/apis/js-apis-hichecker.md
+2
-1
zh-cn/application-dev/reference/apis/js-apis-hidebug.md
zh-cn/application-dev/reference/apis/js-apis-hidebug.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-hilog.md
zh-cn/application-dev/reference/apis/js-apis-hilog.md
+2
-1
zh-cn/application-dev/reference/apis/js-apis-hisysevent.md
zh-cn/application-dev/reference/apis/js-apis-hisysevent.md
+2
-1
zh-cn/application-dev/reference/apis/js-apis-hitracechain.md
zh-cn/application-dev/reference/apis/js-apis-hitracechain.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-hitracemeter.md
zh-cn/application-dev/reference/apis/js-apis-hitracemeter.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-hiviewdfx-hiappevent.md
...cation-dev/reference/apis/js-apis-hiviewdfx-hiappevent.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-http.md
zh-cn/application-dev/reference/apis/js-apis-http.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-inner-application-accessibilityExtensionContext.md
...s-apis-inner-application-accessibilityExtensionContext.md
+2
-1
zh-cn/application-dev/reference/apis/js-apis-inputconsumer.md
...n/application-dev/reference/apis/js-apis-inputconsumer.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-inputdevice.md
zh-cn/application-dev/reference/apis/js-apis-inputdevice.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-inputevent.md
zh-cn/application-dev/reference/apis/js-apis-inputevent.md
+2
-1
zh-cn/application-dev/reference/apis/js-apis-inputeventclient.md
...pplication-dev/reference/apis/js-apis-inputeventclient.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-ability.md
...v/reference/apis/js-apis-inputmethod-extension-ability.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md
...v/reference/apis/js-apis-inputmethod-extension-context.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-inputmethod-subtype.md
...ication-dev/reference/apis/js-apis-inputmethod-subtype.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
+4
-4
zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md
...plication-dev/reference/apis/js-apis-inputmethodengine.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md
zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-keycode.md
zh-cn/application-dev/reference/apis/js-apis-keycode.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-keyevent.md
zh-cn/application-dev/reference/apis/js-apis-keyevent.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-logs.md
zh-cn/application-dev/reference/apis/js-apis-logs.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-mouseevent.md
zh-cn/application-dev/reference/apis/js-apis-mouseevent.md
+2
-1
zh-cn/application-dev/reference/apis/js-apis-net-connection.md
.../application-dev/reference/apis/js-apis-net-connection.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-net-ethernet.md
zh-cn/application-dev/reference/apis/js-apis-net-ethernet.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-net-sharing.md
zh-cn/application-dev/reference/apis/js-apis-net-sharing.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-nfcController.md
...n/application-dev/reference/apis/js-apis-nfcController.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-nfcTag.md
zh-cn/application-dev/reference/apis/js-apis-nfcTag.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-nfctech.md
zh-cn/application-dev/reference/apis/js-apis-nfctech.md
+4
-3
zh-cn/application-dev/reference/apis/js-apis-osAccount.md
zh-cn/application-dev/reference/apis/js-apis-osAccount.md
+119
-35
zh-cn/application-dev/reference/apis/js-apis-pasteboard.md
zh-cn/application-dev/reference/apis/js-apis-pasteboard.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-pointer.md
zh-cn/application-dev/reference/apis/js-apis-pointer.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-power.md
zh-cn/application-dev/reference/apis/js-apis-power.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-request.md
zh-cn/application-dev/reference/apis/js-apis-request.md
+6
-4
zh-cn/application-dev/reference/apis/js-apis-rpc.md
zh-cn/application-dev/reference/apis/js-apis-rpc.md
+4
-2
zh-cn/application-dev/reference/apis/js-apis-runninglock.md
zh-cn/application-dev/reference/apis/js-apis-runninglock.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-screen-lock.md
zh-cn/application-dev/reference/apis/js-apis-screen-lock.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-sensor.md
zh-cn/application-dev/reference/apis/js-apis-sensor.md
+2
-1
zh-cn/application-dev/reference/apis/js-apis-settings.md
zh-cn/application-dev/reference/apis/js-apis-settings.md
+118
-335
zh-cn/application-dev/reference/apis/js-apis-socket.md
zh-cn/application-dev/reference/apis/js-apis-socket.md
+3
-4
zh-cn/application-dev/reference/apis/js-apis-stationary.md
zh-cn/application-dev/reference/apis/js-apis-stationary.md
+2
-1
zh-cn/application-dev/reference/apis/js-apis-system-capability.md
...plication-dev/reference/apis/js-apis-system-capability.md
+2
-1
zh-cn/application-dev/reference/apis/js-apis-system-parameterV9.md
...lication-dev/reference/apis/js-apis-system-parameterV9.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-system-time.md
zh-cn/application-dev/reference/apis/js-apis-system-time.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-system-timer.md
zh-cn/application-dev/reference/apis/js-apis-system-timer.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-tagSession.md
zh-cn/application-dev/reference/apis/js-apis-tagSession.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-thermal.md
zh-cn/application-dev/reference/apis/js-apis-thermal.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-timer.md
zh-cn/application-dev/reference/apis/js-apis-timer.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-touchevent.md
zh-cn/application-dev/reference/apis/js-apis-touchevent.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-update.md
zh-cn/application-dev/reference/apis/js-apis-update.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-usb.md
zh-cn/application-dev/reference/apis/js-apis-usb.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-vibrator.md
zh-cn/application-dev/reference/apis/js-apis-vibrator.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-wallpaper.md
zh-cn/application-dev/reference/apis/js-apis-wallpaper.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-webSocket.md
zh-cn/application-dev/reference/apis/js-apis-webSocket.md
+4
-3
zh-cn/application-dev/reference/apis/js-apis-webview.md
zh-cn/application-dev/reference/apis/js-apis-webview.md
+2
-1
zh-cn/application-dev/reference/apis/js-apis-wifi.md
zh-cn/application-dev/reference/apis/js-apis-wifi.md
+4
-2
zh-cn/application-dev/reference/apis/js-apis-wifiext.md
zh-cn/application-dev/reference/apis/js-apis-wifiext.md
+4
-2
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md
...ation-dev/reference/arkui-ts/ts-basic-components-image.md
+1
-1
zh-cn/device-dev/subsystems/subsys-build-gn-hap-compilation-guide.md
...e-dev/subsystems/subsys-build-gn-hap-compilation-guide.md
+1
-1
zh-cn/release-notes/OpenHarmony-v3.1.4-release.md
zh-cn/release-notes/OpenHarmony-v3.1.4-release.md
+1
-1
未找到文件。
zh-cn/application-dev/application-models/widget-development-stage.md
浏览文件 @
08ae9ec0
...
...
@@ -70,25 +70,25 @@ FormExtensionAbility类拥有如下API接口,具体的API介绍详见[接口
FormExtensionAbility类还拥有成员context,为FormExtensionContext类,具体的API介绍详见
[
接口文档
](
../reference/apis/js-apis-inner-application-formExtensionContext.md
)
。
| 接口名 | 描述 |
| 接口名 | 描述 |
| -------- | -------- |
| startAbility(want:
Want,
callback:
AsyncCallback
<
void
>
):
void | 回调形式拉起一个卡片所属应用的UIAbility(系统接口,三方应用不支持调用,需申请后台拉起权限)。 |
| startAbility(want:
Want):
Promise
<
void
>
| Promise形式拉起一个卡片所属应用的UIAbility(系统接口,三方应用不支持调用,需申请后台拉起权限)。 |
| startAbility(want:
Want,
callback:
AsyncCallback
<
void
>
):
void | 回调形式拉起一个卡片所属应用的UIAbility(系统接口,三方应用不支持调用,需申请后台拉起权限)。 |
| startAbility(want:
Want):
Promise
<
void
>
| Promise形式拉起一个卡片所属应用的UIAbility(系统接口,三方应用不支持调用,需申请后台拉起权限)。 |
formProvider类有如下API接口,具体的API介绍详见
[
接口文档
](
../reference/apis/js-apis-app-form-formProvider.md
)
。
| 接口名 | 描述 |
| 接口名 | 描述 |
| -------- | -------- |
| setFormNextRefreshTime(formId:
string,
minute:
number,
callback:
AsyncCallback
<
void
>
):
void; | 设置指定卡片的下一次更新时间。 |
| setFormNextRefreshTime(formId:
string,
minute:
number):
Promise
<
void
>
; | 设置指定卡片的下一次更新时间,以promise方式返回。 |
| updateForm(formId:
string,
formBindingData:
FormBindingData,
callback:
AsyncCallback
<
void
>
):
void; | 更新指定的卡片。 |
| updateForm(formId:
string,
formBindingData:
FormBindingData):
Promise
<
void
>
; | 更新指定的卡片,以promise方式返回。 |
| setFormNextRefreshTime(formId:
string,
minute:
number,
callback:
AsyncCallback
<
void
>
):
void; | 设置指定卡片的下一次更新时间。 |
| setFormNextRefreshTime(formId:
string,
minute:
number):
Promise
<
void
>
; | 设置指定卡片的下一次更新时间,以promise方式返回。 |
| updateForm(formId:
string,
formBindingData:
FormBindingData,
callback:
AsyncCallback
<
void
>
):
void; | 更新指定的卡片。 |
| updateForm(formId:
string,
formBindingData:
FormBindingData):
Promise
<
void
>
; | 更新指定的卡片,以promise方式返回。 |
formBindingData类有如下API接口,具体的API介绍详见
[
接口文档
](
../reference/apis/js-apis-app-form-formBindingData.md
)
。
| 接口名 | 描述 |
| 接口名 | 描述 |
| -------- | -------- |
| createFormBindingData(obj?:
Object
\|
string):
FormBindingData | 创建一个FormBindingData对象。 |
| createFormBindingData(obj?:
Object
\|
string):
FormBindingData | 创建一个FormBindingData对象。 |
## 开发步骤
...
...
@@ -208,22 +208,22 @@ Stage卡片开发,即基于[Stage模型](stage-model-development-overview.md)
2.
卡片的具体配置信息。在上述FormExtensionAbility的元信息("metadata"配置项)中,可以指定卡片具体配置信息的资源索引。例如当resource指定为$profile:form_config时,会使用开发视图的resources/base/profile/目录下的form_config.json作为卡片profile配置文件。内部字段结构说明如下表所示。
**表1**
卡片profile配置文件
| 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| -------- | -------- | -------- | -------- |
| name | 表示卡片的类名,字符串最大长度为127字节。 | 字符串 | 否 |
| description | 表示卡片的描述。取值可以是描述性内容,也可以是对描述性内容的资源索引,以支持多语言。字符串最大长度为255字节。 | 字符串 | 可缺省,缺省为空。 |
| src | 表示卡片对应的UI代码的完整路径。 | 字符串 | 否 |
| window | 用于定义与显示窗口相关的配置。 | 对象 | 可缺省 |
| isDefault | 表示该卡片是否为默认卡片,每个Ability有且只有一个默认卡片。
<br/>
true:默认卡片。
<br/>
false:非默认卡片。 | 布尔值 | 否 |
| colorMode | 表示卡片的主题样式,取值范围如下:
<br/>
auto:自适应。
<br/>
dark:深色主题。
<br/>
light:浅色主题。 | 字符串 | 可缺省,缺省值为“auto”。 |
| supportDimensions | 表示卡片支持的外观规格,取值范围:
<br/>
1
\*
2:表示1行2列的二宫格。
<br/>
2
\*
2:表示2行2列的四宫格。
<br/>
2
\*
4:表示2行4列的八宫格。
<br/>
4
\*
4:表示4行4列的十六宫格。 | 字符串数组 | 否 |
| defaultDimension | 表示卡片的默认外观规格,取值必须在该卡片supportDimensions配置的列表中。 | 字符串 | 否 |
| updateEnabled | 表示卡片是否支持周期性刷新,取值范围:
<br/>
true:表示支持周期性刷新,可以在定时刷新(updateDuration)和定点刷新(scheduledUpdateTime)两种方式任选其一,优先选择定时刷新。
<br/>
false:表示不支持周期性刷新。 | 布尔类型 | 否 |
| scheduledUpdateTime | 表示卡片的定点刷新的时刻,采用24小时制,精确到分钟。
<br/>
updateDuration参数优先级高于scheduledUpdateTime,两者同时配置时,以updateDuration配置的刷新时间为准。 | 字符串 | 可缺省,缺省值为“0:0”。 |
| updateDuration | 表示卡片定时刷新的更新周期,单位为30分钟,取值为自然数。
<br/>
当取值为0时,表示该参数不生效。
<br/>
当取值为正整数N时,表示刷新周期为30
\*
N分钟。
<br/>
updateDuration参数优先级高于scheduledUpdateTime,两者同时配置时,以updateDuration配置的刷新时间为准。 | 数值 | 可缺省,缺省值为“0”。 |
| formConfigAbility | 表示卡片的配置跳转链接,采用URI格式。 | 字符串 | 可缺省,缺省值为空。 |
| formVisibleNotify | 标识是否允许卡片使用卡片可见性通知。 | 字符串 | 可缺省,缺省值为空。 |
| metaData | 表示卡片的自定义信息,包含customizeData数组标签。 | 对象 | 可缺省,缺省值为空。 |
| name | 表示卡片的类名,字符串最大长度为127字节。 | 字符串 | 否 |
| description | 表示卡片的描述。取值可以是描述性内容,也可以是对描述性内容的资源索引,以支持多语言。字符串最大长度为255字节。 | 字符串 | 可缺省,缺省为空。 |
| src | 表示卡片对应的UI代码的完整路径。 | 字符串 | 否 |
| window | 用于定义与显示窗口相关的配置。 | 对象 | 可缺省 |
| isDefault | 表示该卡片是否为默认卡片,每个Ability有且只有一个默认卡片。
<br/>
true:默认卡片。
<br/>
false:非默认卡片。 | 布尔值 | 否 |
| colorMode | 表示卡片的主题样式,取值范围如下:
<br/>
auto:自适应。
<br/>
dark:深色主题。
<br/>
light:浅色主题。 | 字符串 | 可缺省,缺省值为“auto”。 |
| supportDimensions | 表示卡片支持的外观规格,取值范围:
<br/>
1
\*
2:表示1行2列的二宫格。
<br/>
2
\*
2:表示2行2列的四宫格。
<br/>
2
\*
4:表示2行4列的八宫格。
<br/>
4
\*
4:表示4行4列的十六宫格。 | 字符串数组 | 否 |
| defaultDimension | 表示卡片的默认外观规格,取值必须在该卡片supportDimensions配置的列表中。 | 字符串 | 否 |
| updateEnabled | 表示卡片是否支持周期性刷新,取值范围:
<br/>
true:表示支持周期性刷新,可以在定时刷新(updateDuration)和定点刷新(scheduledUpdateTime)两种方式任选其一,优先选择定时刷新。
<br/>
false:表示不支持周期性刷新。 | 布尔类型 | 否 |
| scheduledUpdateTime | 表示卡片的定点刷新的时刻,采用24小时制,精确到分钟。
<br/>
updateDuration参数优先级高于scheduledUpdateTime,两者同时配置时,以updateDuration配置的刷新时间为准。 | 字符串 | 可缺省,缺省值为“0:0”。 |
| updateDuration | 表示卡片定时刷新的更新周期,单位为30分钟,取值为自然数。
<br/>
当取值为0时,表示该参数不生效。
<br/>
当取值为正整数N时,表示刷新周期为30
\*
N分钟。
<br/>
updateDuration参数优先级高于scheduledUpdateTime,两者同时配置时,以updateDuration配置的刷新时间为准。 | 数值 | 可缺省,缺省值为“0”。 |
| formConfigAbility | 表示卡片的配置跳转链接,采用URI格式。 | 字符串 | 可缺省,缺省值为空。 |
| formVisibleNotify | 标识是否允许卡片使用卡片可见性通知。 | 字符串 | 可缺省,缺省值为空。 |
| metaData | 表示卡片的自定义信息,包含customizeData数组标签。 | 对象 | 可缺省,缺省值为空。 |
配置示例如下:
...
...
@@ -452,7 +452,7 @@ onUpdateForm(formId) {
### 开发卡片事件
卡片支持为组件设置交互事件(action),包括
router事件和message
事件,其中router事件用于Ability跳转,message事件用于卡片开发人员自定义点击事件。
卡片支持为组件设置交互事件(action),包括
**router**
事件和
**message**
事件,其中router事件用于Ability跳转,message事件用于卡片开发人员自定义点击事件。
关键步骤说明如下:
...
...
@@ -539,19 +539,60 @@ onUpdateForm(formId) {
"action"
:
"router"
,
"abilityName"
:
"EntryAbility"
,
"params"
:
{
"message"
:
"add detail"
"info"
:
"router info"
,
"message"
:
"router message"
}
},
"messageEvent"
:
{
"action"
:
"message"
,
"params"
:
{
"
message"
:
"add
detail"
"
detail"
:
"message
detail"
}
}
}
}
```
-
在UIAbility中接收router事件并获取参数
```
ts
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
export
default
class
EntryAbility
extends
UIAbility
{
onCreate
(
want
,
launchParam
)
{
// 获取router事件中传递的info参数
if
(
want
.
parameters
.
info
===
"
router info
"
)
{
// do something
// console.log("router info:" + want.parameters.info)
}
// 获取router事件中传递的message参数
if
(
want
.
parameters
.
message
===
"
router message
"
)
{
// do something
// console.log("router message:" + want.parameters.message)
}
}
// ...
};
```
-
在FormExtensionAbility中接收message事件并获取参数
```
ts
import
FormExtension
from
'
@ohos.app.form.FormExtensionAbility
'
;
export
default
class
FormAbility
extends
FormExtension
{
// ...
onFormEvent
(
formId
,
message
)
{
// 获取message事件中传递的detail参数
let
msg
=
JSON
.
parse
(
message
)
if
(
msg
.
params
.
detail
===
"
message detail
"
)
{
// do something
// console.log("message info:" + msg.params.detail)
}
}
// ...
};
```
## 相关实例
...
...
zh-cn/application-dev/file-management/Readme-CN.md
浏览文件 @
08ae9ec0
...
...
@@ -6,4 +6,5 @@
-
[
相册资源使用指导
](
medialibrary-album-guidelines.md
)
-
文件访问框架
-
[
用户公共文件访问框架概述
](
file-access-framework-overview.md
)
\ No newline at end of file
-
[
用户公共文件访问框架概述
](
file-access-framework-overview.md
)
-
[
文件选择器使用指导
](
filepicker-guidelines.md
)
\ No newline at end of file
zh-cn/application-dev/file-management/filepicker-guidelines.md
0 → 100644
浏览文件 @
08ae9ec0
# 文件选择器使用指导
文件选择器(FilePicker)是OpenHarmony中预置的系统应用,为用户提供文件选择及保存功能。具体实现可以参考
[
FilePicker代码仓库
](
https://gitee.com/openharmony/applications_filepicker
)
。
应用可以通过FilePicker的两种模式实现文件选择和文件保存的功能。
-
choose模式(文件选择):当应用需要选择并上传、发送设备中的文件(包括图片、音视频等媒体资源)时,可以选择该模式。拉起FilePicker的choose模式窗口,系统将弹出弹框供用户选择具体文件。用户通过界面选择目标文件并点击“上传”按钮,应用将接收到FilePicker传回的目标文件uri。
-
save模式(文件保存):当应用需要下载保存文件(包括图片、音视频等媒体资源)时,可以选择该模式。拉起FilePicker的save模式窗口,系统将弹出弹框供用户选择保存文件的目标路径。用户通过界面选择目标路径并点击“保存”按钮,应用将接收到FilePicker传回的已保存文件uri。
## 开发指导
> **说明:**
> FilePicker仅支持基于Stage模型开发的应用拉起。<br/>
> Stage模型介绍请参考[应用模型解读](../application-models/application-model-description.md)。
使用不同的参数调用
[
AbilityContext.startAbilityForResult(want, options)
](
../reference/apis/js-apis-ability-context.md##abilitycontextstartabilityforresult-1
)
可以拉起FilePicker不同模式的窗口。
开发者需要通过
[
Want
](
../reference/apis/js-apis-application-want.md
)
指定"bundleName"和"abilityName"来拉起FilePicker,具体写法可参见下方的示例代码。
同时,开发者还需要设置属性Want.parameters,来指定FilePicker拉起的模式以及文件保存的名称:
-
文件选择:仅需要设置FilePicker拉起的窗口模式为
`'startMode': 'choose'`
。
-
文件保存:除了设置FilePicker拉起的窗口模式为
`'startMode': 'save'`
,还需要设置文件保存名称
`'saveFile'`
。
可以通过设置类型为
[
StartOptions
](
../reference/apis/js-apis-app-ability-startOptions.md
)
的入参options来指定弹出窗口样式,推荐设置为
`windowMode: 102`
,即自由悬浮形式窗口。
> **注意:**
> 1. save模式下,用户保存路径根据保存文件名执行强校验,用户保存路径参考[公共目录路径支持的文件格式](medialibrary-filepath-guidelines.md)。
> 2. 用户选择目标文件保存路径后,如存在同名文件,FilePicker将弹窗提醒用户是否覆盖原文件。
ArkTS语言示例代码如下:
```
ts
// 拉起FilePicker选择文件
globalThis
.
context
.
startAbilityForResult
(
{
bundleName
:
"
com.ohos.filepicker
"
,
abilityName
:
"
MainAbility
"
,
parameters
:
{
'
startMode
'
:
'
choose
'
,
//choose or save
}
},
{
windowMode
:
102
}
)
// 拉起FilePicker保存文件
globalThis
.
context
.
startAbilityForResult
(
{
bundleName
:
"
com.ohos.filepicker
"
,
abilityName
:
"
MainAbility
"
,
parameters
:
{
'
startMode
'
:
'
save
'
,
//choose or save
'
saveFile
'
:
'
test.jpg
'
,
}
},
{
windowMode
:
102
}
)
// FilePicker返回给startAbilityForResult的数据
var
abilityResult
=
{
resultCode
:
resultCode
,
want
:
{
parameters
:
{
'
startMode
'
:
startMode
,
'
result
'
:
result
}
}
}
globalThis
.
context
.
terminateSelfWithResult
(
abilityResult
)
```
zh-cn/application-dev/reference/apis/js-apis-EnterpriseAdminExtensionAbility.md
浏览文件 @
08ae9ec0
#
EnterpriseAdminExtensionAbility
#
@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)
本模块提供企业管理员应用拓展能力。
...
...
zh-cn/application-dev/reference/apis/js-apis-accessibility-GesturePath.md
浏览文件 @
08ae9ec0
#
手势路径
#
@ohos.accessibility.GesturePath (手势路径)
GesturePath表示手势路径信息。
本模块用于创建辅助功能注入手势所需的手势路径信息。
>
![icon-note.gif](public_sys-resources/icon-note.gif)
**说明:**
> **说明:**
>
>本模块首批接口从API version 9开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
本模块首批接口从API version 9开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-accessibility-GesturePoint.md
浏览文件 @
08ae9ec0
#
手势触摸点
#
@ohos.accessibility.GesturePoint (手势触摸点)
GesturePoint表示手势触摸点。
本模块用于创建辅助功能注入手势所需的手势路径的触摸点信息。
>
![icon-note.gif](public_sys-resources/icon-note.gif)
**说明:**
> **说明:**
>
>本模块首批接口从API version 9开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
本模块首批接口从API version 9开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-accessibility-config.md
浏览文件 @
08ae9ec0
#
系统辅助功能配置
#
@ohos.accessibility.config (系统辅助功能配置)
本模块提供系统辅助功能的配置,包括辅助扩展的启用与关闭、高对比度文字显示、鼠标键、无障碍字幕配置等。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从 API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> **说明:**
>
> - 本模块首批接口从 API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块接口为系统接口。
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-accessibility.md
浏览文件 @
08ae9ec0
#
辅助功能
#
@ohos.accessibility (辅助功能)
本模块提供辅助功能查询能力,包括获取辅助应用列表、辅助应用启用状态、无障碍字幕配置等。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从 API version 7 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-appAccount.md
浏览文件 @
08ae9ec0
#
应用帐号管理
#
@ohos.account.appAccount (应用帐号管理)
本模块提供应用帐号信息的添加、删除、修改和查询基础能力,并支持应用间鉴权和分布式数据同步功能。
>
![icon-note.gif](public_sys-resources/icon-note.gif)
**说明:**
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-application-accessibilityExtensionAbility.md
浏览文件 @
08ae9ec0
#
辅助功能扩展能力
#
@ohos.application.AccessibilityExtensionAbility (辅助功能扩展能力)
**AccessibilityExtensionAbility**
基于ExtensionAbility框架,提供辅助功能业务的能力。
>
![icon-note.gif](public_sys-resources/icon-note.gif)
**说明:**
> **说明:**
>
>本模块首批接口从API version 9开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
本模块首批接口从API version 9开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-battery-info.md
浏览文件 @
08ae9ec0
#
电量信息
#
@ohos.batteryInfo (电量信息)
该模块主要提供电池状态和充放电状态的查询接口。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-batteryStatistics.md
浏览文件 @
08ae9ec0
#
耗电统计
#
@ohos.batteryStatistics (耗电统计)
该模块提供软硬件耗电统计信息的查询接口。
>
![icon-note.gif](public_sys-resources/icon-note.gif)
**说明:**
> **说明:**
>
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
...
...
zh-cn/application-dev/reference/apis/js-apis-bluetooth.md
浏览文件 @
08ae9ec0
#
蓝牙
#
@ohos.bluetooth (蓝牙)
蓝牙模块提供了基础的传统蓝牙能力以及BLE的扫描、广播等功能。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-brightness.md
浏览文件 @
08ae9ec0
#
屏幕亮度
#
@ohos.brightness (屏幕亮度)
该模块提供屏幕亮度的设置接口。
>
![icon-note.gif](public_sys-resources/icon-note.gif)
**说明:**
> **说明:**
>
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
...
...
zh-cn/application-dev/reference/apis/js-apis-cardEmulation.md
浏览文件 @
08ae9ec0
#
标准NFC-cardEmulation
#
@ohos.nfc.cardEmulation (标准NFC-cardEmulation)
本模块主要提供NFC卡模拟业务,包括判断支持哪种卡模拟类型,HCE卡模拟的业务实现等。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-configPolicy.md
浏览文件 @
08ae9ec0
#
配置策略
#
@ohos.configPolicy (配置策略)
配置策略提供按预先定义的定制配置层级获取对应定制配置目录和文件路径的能力。
...
...
zh-cn/application-dev/reference/apis/js-apis-connectedTag.md
浏览文件 @
08ae9ec0
#
有源标签
#
@ohos.connectedTag (有源标签)
本模块提供有源标签的使用,包括初始化有源标签芯片、读取有源标签内容、写入内容到有源标签等。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-cooperate.md
浏览文件 @
08ae9ec0
#
键鼠穿越
#
@ohos.multimodalInput.inputDeviceCooperate (键鼠穿越)
键鼠穿越功能模块,提供两台或多台设备组网协同后键鼠共享能力,实现键鼠输入设备的跨设备协同操作。
...
...
zh-cn/application-dev/reference/apis/js-apis-device-info.md
浏览文件 @
08ae9ec0
#
设备信息
#
@ohos.deviceInfo (设备信息)
本模块提供产品信息。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-device-manager.md
浏览文件 @
08ae9ec0
# 设备管理
# @ohos.distributedHardware.deviceManager (设备管理)
本模块提供分布式设备管理能力。
...
...
zh-cn/application-dev/reference/apis/js-apis-distributed-account.md
浏览文件 @
08ae9ec0
#
分布式帐号管理
#
@ohos.account.distributedAccount (分布式帐号管理)
本模块提供管理分布式帐号的一些基础功能,主要包括查询和更新帐号登录状态。
>
![icon-note.gif](public_sys-resources/icon-note.gif)
**说明:**
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-enterprise-adminManager.md
浏览文件 @
08ae9ec0
#
企业设备管理
#
@ohos.enterprise.adminManager (企业设备管理)
本模块提供企业设备管理能力,使设备具备企业场景下所需的定制能力。
...
...
zh-cn/application-dev/reference/apis/js-apis-enterprise-dateTimeManager.md
浏览文件 @
08ae9ec0
#
系统时间管理
#
@ohos.enterprise.dateTimeManager (系统时间管理)
本模块提供系统时间管理能力。仅企业设备管理员应用才能调用。
...
...
zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceInfo.md
浏览文件 @
08ae9ec0
#
设备信息管理
#
@ohos.enterprise.deviceInfo(设备信息管理)
本模块提供企业设备信息管理能力,包括获取设备序列号等。仅企业设备管理员应用才能调用。
...
...
zh-cn/application-dev/reference/apis/js-apis-faultLogger.md
浏览文件 @
08ae9ec0
# 故障日志获取
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
# @ohos.faultLogger (故障日志获取)
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-geoLocationManager.md
浏览文件 @
08ae9ec0
# @ohos.geo
location
(位置服务)
# @ohos.geo
LocationManager
(位置服务)
位置服务提供GNSS定位、网络定位、地理编码、逆地理编码、国家码和地理围栏等基本功能。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 申请权限
...
...
zh-cn/application-dev/reference/apis/js-apis-hichecker.md
浏览文件 @
08ae9ec0
#
检测模式
#
@ohos.hichecker (检测模式)
HiChecker可以作为应用开发阶段使用的检测工具,用于检测代码运行过程中部分易忽略的问题,如应用线程出现耗时调用、应用进程中Ability资源泄露等问题。开发者可以通过日志记录或进程crash等形式查看具体问题并进行修改,提升应用的使用体验。
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-hidebug.md
浏览文件 @
08ae9ec0
#
Debug调试
#
@ohos.hidebug (Debug调试)
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
使用hidebug,可以获取应用内存的使用情况,包括应用进程的静态堆内存(native heap)信息、应用进程内存占用PSS(Proportional Set Size)信息等;可以完成虚拟机内存切片导出,虚拟机CPU Profiling采集等操作。
...
...
zh-cn/application-dev/reference/apis/js-apis-hilog.md
浏览文件 @
08ae9ec0
#
Hilog日志打印
#
@ohos.hilog (HiLog日志打印)
hilog日志系统,使应用/服务可以按照指定级别、标识和格式字符串输出日志内容,帮助开发者了解应用/服务的运行状态,更好地调试程序。
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-hisysevent.md
浏览文件 @
08ae9ec0
#
系统事件打点
#
@ohos.hiSysEvent (系统事件打点)
本模块提供了系统事件打点能力,包括系统事件的埋点、落盘系统事件的订阅及已落盘的系统事件的查询能力。
> **说明:**
>
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块的接口为系统接口。
...
...
zh-cn/application-dev/reference/apis/js-apis-hitracechain.md
浏览文件 @
08ae9ec0
#
分布式跟踪
#
@ohos.hiTraceChain (分布式跟踪)
本模块提供了端侧业务流程调用链跟踪的打点能力,包括业务流程跟踪的启动、结束、信息埋点等能力。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-hitracemeter.md
浏览文件 @
08ae9ec0
#
性能打点
#
@ohos.hiTraceMeter (性能打点)
本模块提供了跟踪进程轨迹,度量程序执行性能的打点能力。本模块打点的数据供hiTraceMeter工具分析使用。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-hiviewdfx-hiappevent.md
浏览文件 @
08ae9ec0
#
应用事件打点
#
@ohos.hiviewdfx.hiAppEvent (应用事件打点)
本模块提供了应用事件打点能力,包括应用事件落盘、应用事件订阅、应用事件清理、打点功能配置等功能。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-http.md
浏览文件 @
08ae9ec0
#
数据请求
#
@ohos.net.http (数据请求)
本模块提供HTTP数据请求能力。应用可以通过HTTP发起一个数据请求,支持常见的GET、POST、OPTIONS、HEAD、PUT、DELETE、TRACE、CONNECT方法。
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-application-accessibilityExtensionContext.md
浏览文件 @
08ae9ec0
#
辅助功能扩展上下文
#
AccessibilityExtensionContext (辅助功能扩展上下文)
AccessibilityExtensionContext是AccessibilityExtensionAbility上下文环境,继承自ExtensionContext。
...
...
@@ -7,6 +7,7 @@ AccessibilityExtensionContext是AccessibilityExtensionAbility上下文环境,
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 本模块接口仅可在Stage模型下使用。
## 使用说明
...
...
zh-cn/application-dev/reference/apis/js-apis-inputconsumer.md
浏览文件 @
08ae9ec0
#
组合按键
#
@ohos.multimodalInput.inputConsumer (组合按键)
组合按键订阅模块,用于处理组合按键的订阅。
...
...
zh-cn/application-dev/reference/apis/js-apis-inputdevice.md
浏览文件 @
08ae9ec0
#
输入设备
#
@ohos.multimodalInput.inputDevice (输入设备)
输入设备管理模块,用于监听输入设备连接和断开状态,查询输入设备相关信息。
...
...
zh-cn/application-dev/reference/apis/js-apis-inputevent.md
浏览文件 @
08ae9ec0
#
输入事件
#
@ohos.multimodalInput.inputEvent (输入事件)
设备上报的基本事件。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-inputeventclient.md
浏览文件 @
08ae9ec0
#
按键注入
#
@ohos.multimodalInput.inputEventClient (按键注入)
按键注入模块,提供按键注入能力。
...
...
zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-ability.md
浏览文件 @
08ae9ec0
#
InputMethodExtensionAbility
#
@ohos.inputmethodextensionability (InputMethodExtensionAbility)
开发者可通过继承本模块开发自己的输入法应用并管理输入法应用生命周期。
...
...
zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md
浏览文件 @
08ae9ec0
#
InputMethodExtensionContext
#
@ohos.inputmethodextensioncontext (InputMethodExtensionContext)
InputMethodExtensionContext模块是InputMethodExtensionAbility的上下文环境,继承自ExtensionContext。
...
...
zh-cn/application-dev/reference/apis/js-apis-inputmethod-subtype.md
浏览文件 @
08ae9ec0
#
输入法子类型
#
@ohos.inputmethodsubtype (输入法子类型)
本模块提供对输入法子类型的属性管理。输入法应用子类型的含义,如:输入法的中文版、英文版、大写模式、小写模式等都属于输入法的子类型。
...
...
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
浏览文件 @
08ae9ec0
#
输入法框架
#
@ohos.inputmethod (输入法框架)
本模块提供对输入法框架的管理,包括隐藏输入法、查询已安装的输入法列表和显示输入法选择对话框。
>**说明:**
>
**说明:**
>
>本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
```
js
import
inputMethod
from
'
@ohos.inputmethod
'
;
```
...
...
zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md
浏览文件 @
08ae9ec0
#
输入法服务
#
@ohos.inputmethodengine (输入法服务)
本模块的作用是拉通输入法应用和其他三方应用(联系人、微信等),功能包括:将三方应用与输入法应用的服务进行绑定、三方应用通过输入法应用进行文本输入、三方应用对输入法应用进行显示键盘请求和隐藏键盘请求、三方应用对输入法应用当前状态进行监听等。
...
...
zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md
浏览文件 @
08ae9ec0
#
输入监听
#
@ohos.multimodalInput.inputMonitor (输入监听)
输入监听模块,提供了监听输入设备事件(当前支持触摸屏和鼠标)的能力。
...
...
zh-cn/application-dev/reference/apis/js-apis-keycode.md
浏览文件 @
08ae9ec0
#
键值
#
@ohos.multimodalInput.keyCode (键值)
按键设备键值。
...
...
zh-cn/application-dev/reference/apis/js-apis-keyevent.md
浏览文件 @
08ae9ec0
#
按键输入事件
#
@ohos.multimodalInput.keyEvent (按键输入事件)
设备上报的按键事件。
...
...
zh-cn/application-dev/reference/apis/js-apis-logs.md
浏览文件 @
08ae9ec0
#
日志打印
#
console (日志打印)
本模块提供基础的日志打印能力,支持按照日志级别打印日志信息。
...
...
zh-cn/application-dev/reference/apis/js-apis-mouseevent.md
浏览文件 @
08ae9ec0
#
鼠标输入事件
#
@ohos.multimodalInput.mouseEvent (鼠标输入事件)
设备上报的鼠标事件。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-net-connection.md
浏览文件 @
08ae9ec0
#
网络连接管理
#
@ohos.net.connection (网络连接管理)
网络连接管理提供管理网络一些基础能力,包括获取默认激活的数据网络、获取所有激活数据网络列表、开启关闭飞行模式、获取网络能力信息等功能。
...
...
zh-cn/application-dev/reference/apis/js-apis-net-ethernet.md
浏览文件 @
08ae9ec0
#
以太网连接管理
#
@ohos.net.ethernet (以太网连接管理)
以太网连接管理主要提供有线网络能力,提供设置有线网络的IP地址,子网掩码,网关,DNS等信息
...
...
zh-cn/application-dev/reference/apis/js-apis-net-sharing.md
浏览文件 @
08ae9ec0
#
网络共享管理
#
@ohos.net.sharing (网络共享管理)
网络共享管理分享设备已有网络给其他连接设备,支持Wi-Fi热点共享和蓝牙共享,同时提供网络共享状态、共享流量查询功能。
...
...
zh-cn/application-dev/reference/apis/js-apis-nfcController.md
浏览文件 @
08ae9ec0
#
标准NFC
#
@ohos.nfc.controller (标准NFC)
本模块主要用于管理NFC状态,包括打开和关闭NFC,读取NFC的状态等。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## **导入模块**
...
...
zh-cn/application-dev/reference/apis/js-apis-nfcTag.md
浏览文件 @
08ae9ec0
#
标准NFC-Tag
#
@ohos.nfc.tag (标准NFC-Tag)
本模块主要用于操作及管理NFC Tag。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## **声明技术**
...
...
zh-cn/application-dev/reference/apis/js-apis-nfctech.md
浏览文件 @
08ae9ec0
#
标准NFC-Tag Nfc 技术
#
nfctech (标准NFC-Tag Nfc 技术)
本模块主要用于采用不同Nfc技术的Tag的读写操作。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
##
**导入模块**
##
导入模块
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
...
...
zh-cn/application-dev/reference/apis/js-apis-osAccount.md
浏览文件 @
08ae9ec0
#
系统帐号管理
#
@ohos.account.osAccount (系统帐号管理)
本模块提供管理系统帐号的基础能力,包括系统帐号的添加、删除、查询、设置、订阅、启动等功能。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
@@ -4243,7 +4244,7 @@ cancelAuth(contextID: Uint8Array): void;
## PINAuth<sup>8+</sup>
P
in码认证功能
基类。
P
IN码认证
基类。
**系统接口:**
此接口为系统接口。
...
...
@@ -4251,7 +4252,7 @@ Pin码认证功能基类。
constructor()
创建P
in
码认证的实例。
创建P
IN
码认证的实例。
**系统接口:**
此接口为系统接口。
...
...
@@ -4280,17 +4281,12 @@ registerInputer(inputer: IInputer): void;
| ----------| ----------------------- | --- | -------------------------- |
| inputer |
[
IInputer
](
#iinputer8
)
| 是 | PIN码输入器,用于获取PIN码。 |
**返回值:**
| 类型 | 说明 |
| :------ | :-------------------------------------------- |
| boolean | 返回布尔值,true表示注册成功,false表示注册失败。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | --------------------------- |
| 12300001 | System service exception. |
| 12300102 | Invalid inputer. |
| 12300103 | Inputer already registered. |
**示例:**
...
...
@@ -4299,8 +4295,8 @@ registerInputer(inputer: IInputer): void;
let
password
=
new
Uint8Array
([
0
,
0
,
0
,
0
,
0
]);
try
{
let
result
=
pinAuth
.
registerInputer
({
onGetData
:
(
pin
SubType
,
callback
)
=>
{
callback
.
onSetData
(
pin
SubType
,
password
);
onGetData
:
(
auth
SubType
,
callback
)
=>
{
callback
.
onSetData
(
auth
SubType
,
password
);
}
});
console
.
log
(
'
registerInputer result =
'
+
result
);
...
...
@@ -4327,6 +4323,91 @@ unregisterInputer(): void;
pinAuth
.
unregisterInputer
();
```
### InputerManager <sup>10+</sup>
凭据输入管理器。
### registerInputer<sup>10+</sup>
registerInputer(authType: AuthType, inputer: IInputer): void;
注册凭据输入器。
**系统接口:**
此接口为系统接口。
**系统能力:**
SystemCapability.Account.OsAccount
**需要权限:**
ohos.permission.ACCESS_USER_AUTH_INTERNAL 或 ohos.permission.MANAGE_USER_IDM
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------| ----------------------- | --- | -------------------------- |
| authType |
[
AuthType
](
#authtype8
)
| 是 | 认证类型。 |
| inputer |
[
IInputer
](
#iinputer8
)
| 是 | 凭据输入器,用于获取凭据。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | --------------------------- |
| 12300001 | System service exception. |
| 12300102 | Invalid authType or inputer. |
| 12300103 | The credential inputer has been registered. |
| 12300106 | Unsupported authType. |
**示例:**
```
js
let
inputerMgr
=
new
account_osAccount
.
InputerManager
();
let
authType
=
account_osAccount
.
AuthType
.
DOMAIN
;
let
password
=
new
Uint8Array
([
0
,
0
,
0
,
0
,
0
]);
try
{
InputerMgr
.
registerInputer
(
authType
,
{
onGetData
:
(
authSubType
,
callback
)
=>
{
callback
.
onSetData
(
authSubType
,
password
);
}
});
console
.
log
(
'
registerInputer success.
'
);
}
catch
(
e
)
{
console
.
log
(
'
registerInputer exception =
'
+
JSON
.
stringify
(
e
));
}
```
### unregisterInputer<sup>10+</sup>
unregisterInputer(authType: AuthType): void;
解注册凭据输入器。
**系统接口:**
此接口为系统接口。
**系统能力:**
SystemCapability.Account.OsAccount
**需要权限:**
ohos.permission.ACCESS_USER_AUTH_INTERNAL 或 ohos.permission.MANAGE_USER_IDM
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------| ----------------------- | --- | -------------------------- |
| authType |
[
AuthType
](
#authtype8
)
| 是 | 认证类型。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | --------------------------- |
| 12300002 | Invalid authType. |
**示例:**
```
js
let
inputerMgr
=
new
account_osAccount
.
InputerManager
();
let
authType
=
account_osAccount
.
AuthType
.
DOMAIN
;
try
{
inputerMgr
.
unregisterInputer
(
authType
);
console
.
log
(
'
unregisterInputer success.
'
);
}
catch
(
err
)
{
console
.
log
(
"
unregisterInputer err:
"
+
JSON
.
stringify
(
err
));
}
```
## UserIdentityManager<sup>8+</sup>
获取用户身份管理类。
...
...
@@ -4456,8 +4537,8 @@ addCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;
let
password
=
new
Uint8Array
([
0
,
0
,
0
,
0
,
0
,
0
]);
let
pinAuth
=
new
account_osAccount
.
PINAuth
();
pinAuth
.
registerInputer
({
onGetData
:
(
pin
SubType
,
callback
)
=>
{
callback
.
onSetData
(
pin
SubType
,
password
);
onGetData
:
(
auth
SubType
,
callback
)
=>
{
callback
.
onSetData
(
auth
SubType
,
password
);
}
});
let
credentialInfo
=
{
...
...
@@ -4470,12 +4551,12 @@ addCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;
try
{
userIDM
.
addCredential
(
credentialInfo
,
{
onResult
:
(
result
,
extraInfo
)
=>
{
console
.
log
(
'
update
Credential result =
'
+
result
);
console
.
log
(
'
update
Credential extraInfo =
'
+
extraInfo
);
console
.
log
(
'
add
Credential result =
'
+
result
);
console
.
log
(
'
add
Credential extraInfo =
'
+
extraInfo
);
}
});
}
catch
(
e
)
{
console
.
log
(
'
update
Credential exception =
'
+
JSON
.
stringify
(
e
));
console
.
log
(
'
add
Credential exception =
'
+
JSON
.
stringify
(
e
));
}
});
```
...
...
@@ -4520,8 +4601,8 @@ updateCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;
token
:
null
};
pinAuth
.
registerInputer
({
onGetData
:
(
pin
SubType
,
callback
)
=>
{
callback
.
onSetData
(
pin
SubType
,
password
);
onGetData
:
(
auth
SubType
,
callback
)
=>
{
callback
.
onSetData
(
auth
SubType
,
password
);
}
});
userIDM
.
openSession
((
err
,
challenge
)
=>
{
...
...
@@ -4820,7 +4901,7 @@ getAuthInfo(authType?: AuthType): Promise<Array<EnrolledCredInfo>>;
### onSetData<sup>8+</sup>
onSetData: (
pin
SubType: AuthSubType, data: Uint8Array) => void;
onSetData: (
auth
SubType: AuthSubType, data: Uint8Array) => void;
**系统接口:**
此接口为系统接口。
...
...
@@ -4832,7 +4913,7 @@ onSetData: (pinSubType: AuthSubType, data: Uint8Array) => void;
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ---------------------------------------- | ---- | ----------------------------------------------- |
|
pin
SubType |
[
AuthSubType
](
#authsubtype8
)
| 是 | 用于认证的凭据子类型。 |
|
auth
SubType |
[
AuthSubType
](
#authsubtype8
)
| 是 | 用于认证的凭据子类型。 |
| data | Uint8Array | 是 | 要设置的数据是凭据,用来在认证、添加、修改凭据操作。 |
**示例:**
...
...
@@ -4840,11 +4921,11 @@ onSetData: (pinSubType: AuthSubType, data: Uint8Array) => void;
let
password
=
new
Uint8Array
([
0
,
0
,
0
,
0
,
0
,
0
]);
let
passwordNumber
=
new
Uint8Array
([
1
,
2
,
3
,
4
]);
let
inputer
=
{
onGetData
:
(
pin
SubType
,
callback
)
=>
{
if
(
pin
SubType
==
account_osAccount
.
AuthSubType
.
PIN_NUMBER
)
{
callback
.
onSetData
(
pin
SubType
,
passwordNumber
);
onGetData
:
(
auth
SubType
,
callback
)
=>
{
if
(
auth
SubType
==
account_osAccount
.
AuthSubType
.
PIN_NUMBER
)
{
callback
.
onSetData
(
auth
SubType
,
passwordNumber
);
}
else
{
callback
.
onSetData
(
pin
SubType
,
password
);
callback
.
onSetData
(
auth
SubType
,
password
);
}
}
};
...
...
@@ -4852,13 +4933,13 @@ onSetData: (pinSubType: AuthSubType, data: Uint8Array) => void;
## IInputer<sup>8+</sup>
密码输入框
回调。
凭据输入器
回调。
**系统接口:**
此接口为系统接口。
### onGetData<sup>8+</sup>
onGetData: (
pin
SubType: AuthSubType, callback: IInputData) => void;
onGetData: (
auth
SubType: AuthSubType, callback: IInputData) => void;
通知获取数据。
...
...
@@ -4877,11 +4958,11 @@ onGetData: (pinSubType: AuthSubType, callback: IInputData) => void;
let
password
=
new
Uint8Array
([
0
,
0
,
0
,
0
,
0
,
0
]);
let
passwordNumber
=
new
Uint8Array
([
1
,
2
,
3
,
4
]);
let
inputer
=
{
onGetData
:
(
pin
SubType
,
callback
)
=>
{
if
(
pin
SubType
==
account_osAccount
.
AuthSubType
.
PIN_NUMBER
)
{
callback
.
onSetData
(
pin
SubType
,
passwordNumber
);
onGetData
:
(
auth
SubType
,
callback
)
=>
{
if
(
auth
SubType
==
account_osAccount
.
AuthSubType
.
PIN_NUMBER
)
{
callback
.
onSetData
(
auth
SubType
,
passwordNumber
);
}
else
{
callback
.
onSetData
(
pin
SubType
,
password
);
callback
.
onSetData
(
auth
SubType
,
password
);
}
}
};
...
...
@@ -5155,8 +5236,10 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;
| 名称 | 值 | 说明 |
| ----- | ----- | ---------------- |
| PIN | 1 | 指示PIN认证类型。 |
| FACE | 2 | 指示脸部认证类型。|
| PIN | 1 | 表示PIN认证类型。 |
| FACE | 2 | 表示脸部认证类型。|
| FINGERPRINT
<sup>
10+
</sup>
| 4 | 表示指纹认证类型。 |
| DOMAIN
<sup>
10+
</sup>
| 1024 | 表示域认证类型。|
## AuthSubType<sup>8+</sup>
...
...
@@ -5171,8 +5254,9 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;
| PIN_SIX | 10000 | 表示6位凭证。 |
| PIN_NUMBER | 10001 | 表示自定义数字凭证。 |
| PIN_MIXED | 10002 | 表示自定义混合凭据。 |
| FACE_2D | 20000 | 指示2D 人脸凭证。 |
| FACE_3D | 20001 | 指示3D 人脸凭证。 |
| FACE_2D | 20000 | 表示2D 人脸凭证。 |
| FACE_3D | 20001 | 表示3D 人脸凭证。 |
| DOMAIN_MIXED
<sup>
10+
</sup>
| 10240001 | 表示域认证混合凭证。 |
## AuthTrustLevel<sup>8+</sup>
...
...
zh-cn/application-dev/reference/apis/js-apis-pasteboard.md
浏览文件 @
08ae9ec0
#
剪贴板
#
@ohos.pasteboard (剪贴板)
本模块主要提供管理系统剪贴板的能力,为系统复制、粘贴功能提供支持。系统剪贴板支持对文本、HTML、URI、Want、PixelMap等内容的操作。
...
...
zh-cn/application-dev/reference/apis/js-apis-pointer.md
浏览文件 @
08ae9ec0
#
鼠标指针
#
@ohos.multimodalInput.pointer (鼠标指针)
鼠标指针管理模块,用于查询和设置鼠标指针相关属性。
...
...
zh-cn/application-dev/reference/apis/js-apis-power.md
浏览文件 @
08ae9ec0
#
系统电源管理
#
@ohos.power (系统电源管理)
该模块主要提供重启、关机、查询屏幕状态等接口。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-request.md
浏览文件 @
08ae9ec0
#
上传下载
#
@ohos.request (上传下载)
request部件主要给应用提供上传下载文件、后台传输代理的基础能力。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
@@ -336,7 +337,8 @@ upload(context: BaseContext, config: UploadConfig, callback: AsyncCallback<Up
## UploadTask
上传任务,使用下列方法前,需要先获取UploadTask对象。
上传任务,使用下列方法前,需要先获取UploadTask对象,promise形式通过
[
request.uploadFile<sup>9+</sup>
](
#requestuploadfile9
)
获取,callback形式通过
[
request.uploadFile<sup>9+</sup>
](
#requestuploadfile9-1
)
获取。
### on('progress')
...
...
@@ -968,7 +970,7 @@ download(context: BaseContext, config: DownloadConfig, callback: AsyncCallback&l
## DownloadTask
下载任务。
下载任务
,使用下列方法前,需要先获取DownloadTask对象,promise形式通过
[
request.downloadFile<sup>9+</sup>
](
#requestdownloadfile9
)
获取,callback形式通过
[
request.downloadFile<sup>9+</sup>
](
#requestdownloadfile9-1
)
获取
。
### on('progress')
...
...
zh-cn/application-dev/reference/apis/js-apis-rpc.md
浏览文件 @
08ae9ec0
#
RPC通信
#
@ohos.rpc (RPC通信)
本模块提供进程间通信能力,包括设备内的进程间通信(IPC)和设备间的进程间通信(RPC),前者基于Binder驱动,后者基于软总线驱动。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 本模块从API version 9开始支持异常返回功能。
...
...
zh-cn/application-dev/reference/apis/js-apis-runninglock.md
浏览文件 @
08ae9ec0
#
RunningLock锁
#
@ohos.runningLock (Runninglock锁)
该模块主要提供RunningLock锁相关操作的接口,包括创建、查询、持锁、释放锁等操作。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-screen-lock.md
浏览文件 @
08ae9ec0
#
锁屏管理
#
@ohos.screenLock (锁屏管理)
锁屏管理服务是OpenHarmony中的系统服务,为锁屏应用提供注册亮屏、灭屏、开启屏幕、结束休眠、退出动画、请求解锁结果监听,并提供回调结果给锁屏应用。锁屏管理服务向三方应用提供请求解锁、查询锁屏状态、查询是否设置锁屏密码的能力。
...
...
zh-cn/application-dev/reference/apis/js-apis-sensor.md
浏览文件 @
08ae9ec0
#
传感器
#
@ohos.sensor (传感器)
sensor模块提供了获取传感器数据的能力,包括获取传感器属性列表,订阅传感器数据,以及一些通用的传感器算法。
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-settings.md
浏览文件 @
08ae9ec0
#
设置数据项名称
#
@ohos.settings (设置数据项名称)
本模块提供访问设置数据项的能力。
...
...
@@ -35,8 +35,6 @@ import settings from '@ohos.settings';
**系统能力:**
SystemCapability.Applications.settings.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ |
| FONT_SCALE | string | 是 | 是 | 字体的比例因子,值为浮点数。 |
...
...
@@ -187,112 +185,9 @@ import settings from '@ohos.settings';
| WIFI_STATUS | string | 是 | 是 | Wi-Fi是否可用。
<br>
值为true表示Wi-Fi可用;
<br/>
值为false表示Wi-Fi不可用。 |
| WIFI_WATCHDOG_STATUS | string | 是 | 是 | Wi-Fi的WatchDog是否可用。
<br>
值为true表示可用;
<br/>
值为false表示不可用。 |
## settings.enableAirplaneMode
enableAirplaneMode(enable: boolean, callback: AsyncCallback
\<
void>): void
启用或禁用飞行模式。使用callback异步回调。
**系统能力**
:SystemCapability.Applications.settings.Core
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ----------------------------------------------- |
| enable | boolean | 是 | 是否开启飞行模式。true表示开启,false表示禁用。 |
| callback | AsyncCallback
\<
void> | 是 | 回调函数。 |
**示例**
:
```
js
let
isEnabled
=
true
;
settings
.
enableAirplaneMode
(
isEnabled
,
(
err
)
=>
{
if
(
err
)
{
console
.
log
(
'
Failed to enable AirplaneMode.
'
);
return
;
}
console
.
log
(
'
Return true if enable.
'
);
})
```
## settings.enableAirplaneMode
enableAirplaneMode(enable: boolean): Promise
\<
void>
启用或禁用飞行模式。使用Promise异步回调。
**系统能力**
:SystemCapability.Applications.settings.Core
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | ----------------------------------------------- |
| enable | boolean | 是 | 是否开启飞行模式。true表示开启,false表示禁用。 |
**返回值**
:
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise
\<
void> | 无返回结果的Promise对象。 |
**示例**
:
```
js
let
isEnabled
=
true
;
settings
.
enableAirplaneMode
(
isEnabled
).
then
(()
=>
{
console
.
log
(
'
Succeeded in enabling AirplaneMode.
'
);
}).
catch
((
err
)
=>
{
console
.
log
(
`Failed to enable AirplaneMode. Cause:
${
err
}
`
);
})
```
## settings.canShowFloating
canShowFloating(callback: AsyncCallback
\<
boolean>): void
检查应用是否能够以悬浮窗形式显示。使用callback异步回调。
**系统能力**
:SystemCapability.Applications.settings.Core
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback
\<
boolean> | 是 | 回调函数。
<br/>
返回true,表示应用能够以悬浮窗形式显示;返回false,则表示不能。 |
**示例**
:
```
js
settings
.
canShowFloating
((
result
)
=>
{
console
.
log
(
'
Checks whether a specified application can show as float window.
'
);
});
```
## settings.canShowFloating
canShowFloating(): Promise
\<
boolean>
检查应用是否能够以悬浮窗形式显示。使用Promise异步回调。
**系统能力**
:SystemCapability.Applications.settings.Core
**返回值**
:
| 类型 | 说明 |
| ----------------- | ------------------------------------------------------------ |
| Promise
\<
boolean> | Promise对象。
<br/>
返回true,表示应用能够以悬浮窗形式显示;返回false,则表示不能。 |
**示例**
:
```
js
settings
.
canShowFloating
().
then
((
result
)
=>
{
console
.
log
(
'
Checks whether a specified application can show as float window.
'
);
});
```
## setting.getURI
getURI(name: string, callback: AsyncCallback
\<
string
>): void
getURI(name: string, callback: AsyncCallback
\<
object
>): void
获取数据项的URI。使用callback异步回调。
...
...
@@ -303,7 +198,7 @@ getURI(name: string, callback: AsyncCallback\<string>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
<br>
- 上述任意一个数据库中已存在的数据项。
<br>
- 开发者自行添加的数据项。 |
| callback | AsyncCallback
\<
string
> | 是 | 回调函数。获取数据项的URI。 |
| callback | AsyncCallback
\<
object
> | 是 | 回调函数。获取数据项的URI。 |
**示例**
:
...
...
@@ -315,7 +210,7 @@ settings.getURI(settings.display.SCREEN_BRIGHTNESS_STATUS, (uri) => {
## setting.getURI
getURI(name: string): Promise
\<
string
>
getURI(name: string): Promise
\<
object
>
获取数据项的URI。使用Promise异步回调。
...
...
@@ -331,7 +226,7 @@ getURI(name: string): Promise\<string>
| 类型 | 说明 |
| ---------------- | ------------------------------------ |
| Promise
\<
string
> | Promise对象。返回获取的数据项的URI。 |
| Promise
\<
object
> | Promise对象。返回获取的数据项的URI。 |
**示例**
:
...
...
@@ -341,55 +236,30 @@ settings.getURI(settings.display.SCREEN_BRIGHTNESS_STATUS).then((uri) => {
})
```
## settings.getUriSync<sup>8+</sup>
getUriSync(name: string): string
获取数据项的URI。
**系统能力**
:SystemCapability.Applications.settings.Core
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
<br>
- 上述任意一个数据库中已存在的数据项。
<br>
- 开发者自行添加的数据项。 |
**返回值**
:
| 类型 | 说明 |
| ------ | ------------- |
| string | 数据项的URI。 |
**示例**
:
```
js
// 获取数据项的URI
let
urivar
=
settings
.
getUriSync
(
settings
.
display
.
SCREEN_BRIGHTNESS_STATUS
);
```
## setting.getValue<sup>9+</sup>
## setting.getValue
getValue(
context: Context, name: string, callback: AsyncCallback
\<
string
>): void
getValue(
dataAbilityHelper: DataAbilityHelper, name: string, callback: AsyncCallback
\<
object
>): void
获取数据库中指定数据项的值。使用callback异步回调。
**系统能力**
:SystemCapability.Applications.settings.Core
**模型约束**
:此接口仅可在Stage模型下使用。
**参数**
:
| 参数名
| 类型
| 必填 | 说明 |
| --------
|
---------------------- | ---- | ------------------------------------------------------------ |
|
context | Context | 是 | 上下文内容。
|
| name
| string
| 是 | 数据项的名称。数据项名称分为以下两种:
<br>
- 上述任意一个数据库中已存在的数据项。
<br>
- 开发者自行添加的数据项。 |
| callback
| AsyncCallback
\<
string>
| 是 | 使用callback方式获取数据项的值。 |
| 参数名
| 类型
| 必填 | 说明 |
| --------
--------- | ---------------------------
---------------------- | ---- | ------------------------------------------------------------ |
|
dataAbilityHelper |
[
DataAbilityHelper
](
js-apis-inner-ability-dataAbilityHelper.md
)
| 是 | 数据管理辅助类。
|
| name
| string
| 是 | 数据项的名称。数据项名称分为以下两种:
<br>
- 上述任意一个数据库中已存在的数据项。
<br>
- 开发者自行添加的数据项。 |
| callback
| AsyncCallback
\<
object>
| 是 | 使用callback方式获取数据项的值。 |
**示例**
:
```
js
settings
.
getValue
(
this
.
context
,
settings
.
display
.
SCREEN_BRIGHTNESS_STATUS
,
(
err
,
value
)
=>
{
import
featureAbility
from
'
@ohos.ability.featureAbility
'
;
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
;
...
...
@@ -398,117 +268,88 @@ settings.getValue(this.context, settings.display.SCREEN_BRIGHTNESS_STATUS, (err,
});
```
## setting.getValue
<sup>9+</sup>
## setting.getValue
getValue(
context: Context, name: string): Promise
\<
string
>
getValue(
dataAbilityHelper: DataAbilityHelper, name: string): Promise
\<
object
>
获取数据库中指定数据项的值。使用Promise异步回调。
**系统能力**
:SystemCapability.Applications.settings.Core
**模型约束**
:此接口仅可在Stage模型下使用。
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
|
context | Context | 是 | 上下文内容。
|
|
dataAbilityHelper |
[
DataAbilityHelper
](
js-apis-inner-ability-dataAbilityHelper.md
)
| 是 | 数据管理辅助类。
|
| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
<br>
- 上述任意一个数据库中已存在的数据项。
<br>
- 开发者自行添加的数据项。 |
**返回值**
:
| 类型 | 说明 |
| ---------------- | ----------------------------------- |
| Promise
\<
string
> | Promise对象。返回获得的数据项的值。 |
| Promise
\<
object
> | Promise对象。返回获得的数据项的值。 |
**示例**
:
```
js
settings
.
getValue
(
this
.
context
,
settings
.
display
.
SCREEN_BRIGHTNESS_STATUS
)
.
then
((
value
)
=>
{
import
featureAbility
from
'
@ohos.ability.featureAbility
'
;
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 ->
${
JSON
.
stringify
(
value
)}
`
)
});
```
## settings.
getValueSync<sup>9+</sup>
## settings.
setValue
getValueSync(context: Context, name: string, defValue: string): string
获取数据项的值。此方法相较getValue为同步方法。
**系统能力**
:SystemCapability.Applications.settings.Core
**模型约束**
:此接口仅可在Stage模型下使用。
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 上下文内容。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
<br>
- 上述任意一个数据库中已存在的数据项。
<br>
- 开发者自行添加的数据项。 |
| defValue | string | 是 | 默认值。由开发者设置,当未从数据库中查询到该数据时,表示返回该默认值。 |
**返回值**
:
| 类型 | 说明 |
| ------ | ---------------- |
| string | 返回数据项的值。 |
**示例**
:
```
js
//获取数据项亮度的值(该数据项在数据库中已存在)
let
value
=
settings
.
getValueSync
(
this
.
context
,
settings
.
display
.
SCREEN_BRIGHTNESS_STATUS
,
'
10
'
);
```
## settings.setValue<sup>9+</sup>
setValue(context: Context, name: string, value: string, callback: AsyncCallback
\<
boolean>): void
setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object, callback: AsyncCallback
\<
boolean>): void
将数据项名称及数据项的值保存到数据库中。使用callback异步回调。
**
需要权限**
:ohos.permission.MANAGE_SECURE_SETTINGS,仅系统应用可用
。
**
系统接口**
:此接口为系统接口
。
**系统能力**
:SystemCapability.Applications.settings.Core
**模型约束**
:此接口仅可在Stage模型下使用。
**参数**
:
| 参数名
| 类型
| 必填 | 说明 |
| --------
|
----------------------- | ---- | ------------------------------------------------------------ |
|
context | Context | 是 | 上下文内容。
|
| name
| string
| 是 | 数据项的名称。数据项名称分为以下两种:
<br>
- 上述任意一个数据库中已存在的数据项。
<br>
- 开发者自行添加的数据项。 |
| value
| string
| 是 | 数据项值。取值范围随业务变动。 |
| callback
| AsyncCallback
\<
boolean>
| 是 | 回调函数。返回true表示操作成功,否则操作失败。 |
| 参数名
| 类型
| 必填 | 说明 |
| --------
--------- | --------------------------
----------------------- | ---- | ------------------------------------------------------------ |
|
dataAbilityHelper |
[
DataAbilityHelper
](
js-apis-inner-ability-dataAbilityHelper.md
)
| 是 | 数据管理辅助类。
|
| name
| string
| 是 | 数据项的名称。数据项名称分为以下两种:
<br>
- 上述任意一个数据库中已存在的数据项。
<br>
- 开发者自行添加的数据项。 |
| value
| object
| 是 | 数据项值。取值范围随业务变动。 |
| callback
| AsyncCallback
\<
boolean>
| 是 | 回调函数。返回true表示操作成功,否则操作失败。 |
**示例**
:
```
js
settings
.
setValue
(
this
.
context
,
settings
.
display
.
SCREEN_BRIGHTNESS_STATUS
,
'
100
'
,
(
result
)
=>
{
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
<sup>9+</sup>
## settings.setValue
setValue(
context: Context, name: string, value: string
): Promise
\<
boolean>
setValue(
dataAbilityHelper: DataAbilityHelper, name: string, value: object
): Promise
\<
boolean>
将数据项名称及数据项的值保存到数据库中。使用Promise异步回调。
**
需要权限**
:ohos.permission.MANAGE_SECURE_SETTINGS,仅系统应用可用
。
**
系统接口**
:此接口为系统接口
。
**系统能力**
:SystemCapability.Applications.settings.Core
**模型约束**
:此接口仅可在Stage模型下使用。
**参数**
:
| 参数名
| 类型
| 必填 | 说明 |
| -------
|
------- | ---- | ------------------------------------------------------------ |
|
context | Context | 是 | 上下文内容。
|
| name
| string
| 是 | 数据项的名称。数据项名称分为以下两种:
<br>
- 上述任意一个数据库中已存在的数据项。
<br>
- 开发者自行添加的数据项。 |
| value
| string
| 是 | 数据项值。取值范围随业务变动。 |
| 参数名
| 类型
| 必填 | 说明 |
| -------
---------- | ------------------------------------------
------- | ---- | ------------------------------------------------------------ |
|
dataAbilityHelper |
[
DataAbilityHelper
](
js-apis-inner-ability-dataAbilityHelper.md
)
| 是 | 数据管理辅助类。
|
| name
| string
| 是 | 数据项的名称。数据项名称分为以下两种:
<br>
- 上述任意一个数据库中已存在的数据项。
<br>
- 开发者自行添加的数据项。 |
| value
| object
| 是 | 数据项值。取值范围随业务变动。 |
**返回值**
:
...
...
@@ -519,199 +360,147 @@ setValue(context: Context, name: string, value: string): Promise\<boolean>
**示例**
:
```
js
settings
.
setValue
(
helper
,
settings
.
display
.
SCREEN_BRIGHTNESS_STATUS
,
'
100
'
).
then
((
result
)
=>
{
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.setValueSync<sup>9+</sup>
setValueSync(context: Context, name: string, value: string): boolean
设置数据项的值。此方法相较setValue为同步方法。
## settings.enableAirplaneMode
如果数据库中已经存在该数据项,则setValueSync方法将更新该数据项的值;如果数据库中尚未存在该数据项,则setValueSync方法将向数据库中插入该数据项。
enableAirplaneMode(enable: boolean, callback: AsyncCallback
\<
void>): void
**需要权限**
:ohos.permission.MANAGE_SECURE_SETTINGS,仅系统应用可用
。
启用或禁用飞行模式。使用callback异步回调
。
**系统能力**
:SystemCapability.Applications.settings.Core
**模型约束**
:此接口仅可在Stage模型下使用。
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 上下文内容。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
<br>
- 上述任意一个数据库中已存在的数据项。
<br>
- 开发者自行添加的数据项。 |
| value | string | 是 | 数据项的具体数值。取值范围随业务变动。 |
**返回值**
:
| 类型 | 说明 |
| ------- | ------------------------------------------------------------ |
| boolean | 返回设置数据项的值是否成功的结果。true表示设置成功,false表示设置失败。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ----------------------------------------------- |
| enable | boolean | 是 | 是否开启飞行模式。true表示开启,false表示禁用。 |
| callback | AsyncCallback
\<
void> | 是 | 回调函数。 |
**示例**
:
```
js
//更新数据项亮度的值(该数据项在数据库中已存在,故setValueSync方法将更新该数据项的值)
let
ret
=
settings
.
setValueSync
(
this
.
context
,
settings
.
display
.
SCREEN_BRIGHTNESS_STATUS
,
'
100
'
);
let
isEnabled
=
true
;
settings
.
enableAirplaneMode
(
isEnabled
,
(
err
)
=>
{
if
(
err
)
{
console
.
log
(
'
Failed to enable AirplaneMode.
'
);
return
;
}
console
.
log
(
'
Return true if enable.
'
);
})
```
## setting.getValue<sup>(deprecated)</sup>
> 从API version 7开始支持,从API version 9开始废弃,推荐使用[getValue()](#settinggetvalue9)。
## settings.enableAirplaneMode
getValue(dataAbilityHelper: DataAbilityHelper, name: string, callback: AsyncCallback
\<
string>): void
enableAirplaneMode(enable: boolean): Promise
\<
void>
获取数据库中指定数据项的值。使用callback
异步回调。
启用或禁用飞行模式。使用Promise
异步回调。
**系统能力**
:SystemCapability.Applications.settings.Core
**模型约束**
:此接口仅可在FA模型下使用。
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| dataAbilityHelper |
[
DataAbilityHelper
](
js-apis-inner-ability-dataAbilityHelper.md
)
| 是 | 数据管理辅助类。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
<br>
- 上述任意一个数据库中已存在的数据项。
<br>
- 开发者自行添加的数据项。 |
| callback | AsyncCallback
\<
string> | 是 | 使用callback方式获取数据项的值。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | ----------------------------------------------- |
| enable | boolean | 是 | 是否开启飞行模式。true表示开启,false表示禁用。 |
**返回值**
:
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise
\<
void> | 无返回结果的Promise对象。 |
**示例**
:
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
;
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 ->
${
JSON
.
stringify
(
value
)}
`
)
});
let
isEnabled
=
true
;
settings
.
enableAirplaneMode
(
isEnabled
).
then
(()
=>
{
console
.
log
(
'
Succeeded in enabling AirplaneMode.
'
);
}).
catch
((
err
)
=>
{
console
.
log
(
`Failed to enable AirplaneMode. Cause:
${
err
}
`
);
})
```
## setting.getValue<sup>(deprecated)</sup>
> 从API version 7开始支持,从API version 9开始废弃,推荐使用[getValue()](#settinggetvalue9-1)。
## settings.canShowFloating
getValue(dataAbilityHelper: DataAbilityHelper, name: string): Promise
\<
string>
canShowFloating(callback: AsyncCallback
\<
boolean>): void
获取数据库中指定数据项的值。使用Promise
异步回调。
检查应用是否能够以悬浮窗形式显示。使用callback
异步回调。
**系统能力**
:SystemCapability.Applications.settings.Core
**模型约束**
:此接口仅可在FA模型下使用。
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| dataAbilityHelper |
[
DataAbilityHelper
](
js-apis-inner-ability-dataAbilityHelper.md
)
| 是 | 数据管理辅助类。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
<br>
- 上述任意一个数据库中已存在的数据项。
<br>
- 开发者自行添加的数据项。 |
**返回值**
:
| 类型 | 说明 |
| ---------------- | ----------------------------------- |
| Promise
\<
string> | Promise对象。返回获得的数据项的值。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback
\<
boolean> | 是 | 回调函数。
<br/>
返回true,表示应用能够以悬浮窗形式显示;返回false,则表示不能。 |
**示例**
:
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
;
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 ->
${
JSON
.
stringify
(
value
)}
`
)
settings
.
canShowFloating
((
status
)
=>
{
console
.
log
(
'
Checks whether a specified application can show as float window.
'
);
});
```
## settings.setValue<sup>(deprecated)</sup>
> 从API version 7开始支持,从API version 9开始废弃,推荐使用[setValue()](#settingssetvalue9)。
setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: string, callback: AsyncCallback
\<
boolean>): void
## settings.canShowFloating
将数据项名称及数据项的值保存到数据库中。使用callback异步回调。
canShowFloating(): Promise
\<
boolean>
**系统接口**
:此接口为系统接口
。
检查应用是否能够以悬浮窗形式显示。使用Promise异步回调
。
**系统能力**
:SystemCapability.Applications.settings.Core
**模型约束**
:此接口仅可在FA模型下使用。
**参数**
:
**返回值**
:
| 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| dataAbilityHelper |
[
DataAbilityHelper
](
js-apis-inner-ability-dataAbilityHelper.md
)
| 是 | 数据管理辅助类。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
<br>
- 上述任意一个数据库中已存在的数据项。
<br>
- 开发者自行添加的数据项。 |
| value | string | 是 | 数据项值。取值范围随业务变动。 |
| callback | AsyncCallback
\<
boolean> | 是 | 回调函数。返回true表示操作成功,否则操作失败。 |
| 类型 | 说明 |
| ----------------- | ------------------------------------------------------------ |
| Promise
\<
boolean> | Promise对象。
<br/>
返回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
'
,
(
result
)
=>
{
console
.
log
(
'
Callback return whether value is set.
'
);
settings
.
canShowFloating
().
then
((
status
)
=>
{
console
.
log
(
'
Checks whether a specified application can show as float window.
'
);
});
```
## settings.setValue<sup>(deprecated)</sup>
> 从API version 7开始支持,从API version 9开始废弃,推荐使用[setValue()](#settingssetvalue9-1)。
setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: string): Promise
\<
boolean>
## settings.getUriSync<sup>8+</sup>
将数据项名称及数据项的值保存到数据库中。使用Promise异步回调。
getUriSync(name: string): string
**系统接口**
:此接口为系统接口
。
获取数据项的URI
。
**系统能力**
:SystemCapability.Applications.settings.Core
**模型约束**
:此接口仅可在FA模型下使用。
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| dataAbilityHelper |
[
DataAbilityHelper
](
js-apis-inner-ability-dataAbilityHelper.md
)
| 是 | 数据管理辅助类。 |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
<br>
- 上述任意一个数据库中已存在的数据项。
<br>
- 开发者自行添加的数据项。 |
| value | string | 是 | 数据项值。取值范围随业务变动。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| name | string | 是 | 数据项的名称。数据项名称分为以下两种:
<br>
- 上述任意一个数据库中已存在的数据项。
<br>
- 开发者自行添加的数据项。 |
**返回值**
:
| 类型
| 说明
|
| ------
----------- | -------------------------------------
------------- |
|
Promise
\<
boolean> | Promise对象。返回true表示操作成功,否则返回false
。 |
| 类型
| 说明
|
| ------
|
------------- |
|
string | 数据项的URI
。 |
**示例**
:
```
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
((
result
)
=>
{
console
.
log
(
'
Callback return whether value is set.
'
);
});
// 获取数据项的URI
let
urivar
=
settings
.
getUriSync
(
settings
.
display
.
SCREEN_BRIGHTNESS_STATUS
);
```
## settings.getValueSync<sup>(deprecated)</sup>
> 从API version 8开始支持,从API version 9开始废弃,推荐使用[getValueSync()](#settingsgetvaluesync9)。
## settings.getValueSync<sup>8+</sup>
getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: string): string
...
...
@@ -719,8 +508,6 @@ getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: strin
**系统能力**
:SystemCapability.Applications.settings.Core
**模型约束**
:此接口仅可在FA模型下使用。
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
...
...
@@ -746,9 +533,7 @@ let helper = featureAbility.acquireDataAbilityHelper(uri);
let
value
=
settings
.
getValueSync
(
helper
,
settings
.
display
.
SCREEN_BRIGHTNESS_STATUS
,
'
10
'
);
```
## settings.setValueSync<sup>(deprecated)</sup>
> 从API version 8开始支持,从API version 9开始废弃,推荐使用[setValueSync()](#settingssetvaluesync9)。
## settings.setValueSync<sup>8+</sup>
setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string): boolean
...
...
@@ -760,8 +545,6 @@ setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string):
**系统能力**
:SystemCapability.Applications.settings.Core
**模型约束**
:此接口仅可在FA模型下使用。
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
...
...
zh-cn/application-dev/reference/apis/js-apis-socket.md
浏览文件 @
08ae9ec0
#
Socket连接
#
@ohos.net.socket (Socket连接)
>![](public_sys-resources/icon-note.gif) **说明:**
>
>本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-stationary.md
浏览文件 @
08ae9ec0
#
设备状态感知框架
#
@ohos.stationary (设备状态感知框架)
设备状态感知框架提供设备状态感知能力,包括绝对静止和相对静止。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-system-capability.md
浏览文件 @
08ae9ec0
#
系统能力
#
@ohos.systemCapability (系统能力)
系统能力(SystemCapability,简称SysCap),指操作系统中每一个相对独立的特性。不同的设备对应不同的系统能力集,每个系统能力对应多个接口。开发者可根据系统能力来判断是否可以使用某接口。本模块提供接口可查询系统能力的集合。
> **说明:**
>
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块接口为系统接口。
...
...
zh-cn/application-dev/reference/apis/js-apis-system-parameterV9.md
浏览文件 @
08ae9ec0
#
系统参数
#
@ohos.systemParameterV9 (系统属性)
系统参数(SystemParameter)是为各系统服务提供的简单易用的键值对访问接口,各个系统服务可以定义系统参数来描述该服务的状态信息,或者通过系统参数来改变系统服务的行为。其基本操作原语为get和set,通过get可以查询系统参数的值,通过set可以修改系统参数的值。
详细的系统参数设计原理及定义可参考
[
系统参数
](
../../../device-dev/subsystems/subsys-boot-init-sysparam.md
)
。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块接口为系统接口。
> - 由于系统参数都是各个系统服务的内部信息和控制参数,每个系统参数都有各自不同的DAC和MAC访问控制权限,三方应用不能使用此类接口。
...
...
zh-cn/application-dev/reference/apis/js-apis-system-time.md
浏览文件 @
08ae9ec0
#
系统时间、时区
#
@ohos.systemTime (系统时间、时区)
本模块主要由系统时间和系统时区功能组成。开发者可以设置、获取系统时间及系统时区。
...
...
zh-cn/application-dev/reference/apis/js-apis-system-timer.md
浏览文件 @
08ae9ec0
#
系统定时器
#
@ohos.systemTimer (系统定时器)
本模块主要由系统定时器功能组成。开发者可以使用定时功能实现定时服务,如闹钟等。
...
...
zh-cn/application-dev/reference/apis/js-apis-tagSession.md
浏览文件 @
08ae9ec0
#
标准NFC-Tag TagSession
#
tagSession (标准NFC-Tag TagSession)
本模块是对NFC TagSession的使用说明。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## **导入模块**
...
...
zh-cn/application-dev/reference/apis/js-apis-thermal.md
浏览文件 @
08ae9ec0
#
热管理
#
@ohos.thermal (热管理)
该模块提供热管理相关的接口,包括热档位查询及注册回调等功能。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-timer.md
浏览文件 @
08ae9ec0
#
定时器
#
Timer (定时器)
本模块提供基础的定时器能力,支持按照指定的时间执行对应函数。
...
...
zh-cn/application-dev/reference/apis/js-apis-touchevent.md
浏览文件 @
08ae9ec0
#
触摸输入事件
#
@ohos.multimodalInput.touchEvent (触摸输入事件)
设备上报的触屏事件。
...
...
zh-cn/application-dev/reference/apis/js-apis-update.md
浏览文件 @
08ae9ec0
#
升级
#
@ohos.update (升级)
升级范围:升级整个系统,包括内置的资源、预置应用;第三方的应用不在升级的范围。
...
...
zh-cn/application-dev/reference/apis/js-apis-usb.md
浏览文件 @
08ae9ec0
#
USB管理
#
@ohos.usbV9 (USB管理)
本模块主要提供管理USB设备的相关功能,包括主设备上查询USB设备列表、批量数据传输、控制命令传输、权限控制等;从设备上端口管理、功能切换及查询等。
...
...
zh-cn/application-dev/reference/apis/js-apis-vibrator.md
浏览文件 @
08ae9ec0
#
振动
#
@ohos.vibrator (振动)
vibrator模块提供控制马达振动启、停的能力。
...
...
zh-cn/application-dev/reference/apis/js-apis-wallpaper.md
浏览文件 @
08ae9ec0
#
壁纸
#
@ohos.wallpaper (壁纸)
壁纸管理服务是OpenHarmony中系统服务,是主题框架的部分组成,主要为系统提供壁纸管理服务能力,支持系统显示、设置、切换壁纸等功能。
...
...
zh-cn/application-dev/reference/apis/js-apis-webSocket.md
浏览文件 @
08ae9ec0
#
WebSocket连接
#
@ohos.net.webSocket (WebSocket连接)
>![](public_sys-resources/icon-note.gif) **说明:**
>本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> **说明:**
>
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
使用WebSocket建立服务器与客户端的双向连接,需要先通过
[
createWebSocket
](
#websocketcreatewebsocket
)
方法创建
[
WebSocket
](
#websocket
)
对象,然后通过
[
connect
](
#connect
)
方法连接到服务器。当连接成功后,客户端会收到
[
open
](
#onopen
)
事件的回调,之后客户端就可以通过
[
send
](
#send
)
方法与服务器进行通信。当服务器发信息给客户端时,客户端会收到
[
message
](
#onmessage
)
事件的回调。当客户端不要此连接时,可以通过调用
[
close
](
#close
)
方法主动断开连接,之后客户端会收到
[
close
](
#onclose
)
事件的回调。
...
...
zh-cn/application-dev/reference/apis/js-apis-webview.md
浏览文件 @
08ae9ec0
#
Webview
#
@ohos.web.webview (Webview)
提供web控制能力。
...
...
@@ -11,6 +11,7 @@
> - 示例效果请以真机运行为准,当前IDE预览器不支持。
## 需要权限
访问在线网页时需添加网络权限:ohos.permission.INTERNET,具体申请方式请参考
[
权限申请声明
](
../../security/accesstoken-guidelines.md
)
。
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-wifi.md
浏览文件 @
08ae9ec0
# WLAN
# @ohos.wifi (WLAN)
该模块主要提供WLAN基础功能、P2P(peer-to-peer)功能和WLAN消息通知的相应服务,让应用可以通过WLAN和其他设备互联互通。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-wifiext.md
浏览文件 @
08ae9ec0
# WLAN扩展接口
# @ohos.wifiext (WLAN扩展接口)
该模块主要提供WLAN扩展接口,供非通用类型产品使用。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
该文档中的接口只供非通用类型产品使用,如路由器等,对于常规类型产品,不应该使用这些接口。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md
浏览文件 @
08ae9ec0
...
...
@@ -37,7 +37,7 @@ Image(src: string | PixelMap | Resource)
| --------------------- | ------------------------------------------------------- | ------------------------------------------------------------ |
| alt | string
\|
[
Resource
](
ts-types.md#resource类型
)
| 加载时显示的占位图,支持本地图片。 |
| objectFit |
[
ImageFit
](
ts-appendix-enums.md#imagefit
)
| 设置图片的缩放类型。
<br/>
默认值:ImageFit.Cover |
| objectRepeat |
[
ImageRepeat
](
ts-appendix-enums.md#imagerepeat
)
| 设置图片的重复样式。
<br/>
默认值:NoRepeat
<br/>
**说明:**
<br/>
svg类型图源不支持该属性。 |
| objectRepeat |
[
ImageRepeat
](
ts-appendix-enums.md#imagerepeat
)
| 设置图片的重复样式。
<br/>
默认值:
ImageRepeat.
NoRepeat
<br/>
**说明:**
<br/>
svg类型图源不支持该属性。 |
| interpolation |
[
ImageInterpolation
](
#imageinterpolation
)
| 设置图片的插值效果,即减轻低清晰度图片在放大显示的时候出现的锯齿问题,仅针对图片放大插值。
<br/>
默认值:ImageInterpolation.None
<br/>
**说明:**
<br/>
svg类型图源不支持该属性。
<br/>
PixelMap资源不支持该属性。 |
| renderMode |
[
ImageRenderMode
](
#imagerendermode
)
| 设置图片渲染的模式。
<br/>
默认值:ImageRenderMode.Original
<br/>
**说明:**
<br/>
svg类型图源不支持该属性。 |
| sourceSize | {
<br/>
width:
number,
<br/>
height:
number
<br/>
} | 设置图片裁剪尺寸,将原始图片解码成pixelMap,指定尺寸的图片,单位为px。
<br/>
**说明:**
<br/>
PixelMap资源不支持该属性。 |
...
...
zh-cn/device-dev/subsystems/subsys-build-gn-hap-compilation-guide.md
浏览文件 @
08ae9ec0
...
...
@@ -9,7 +9,7 @@
| Ability | 应用的重要组成部分,是应用所具备能力的抽象。Ability是系统调度应用的最小单元,是能够完成一个独立功能的组件,一个应用可以包含一个或多个Ability。 |
| FA | Feature Ability,是FA模型的Ability框架下具有UI界面的Ability类型,用于与用户进行交互。Feature Ability唯一对应一种模板,即Page模板(Page Ability)。 |
| PA | Particle Ability,是在FA模型的Ability框架下无界面的Ability,主要为Feature Ability提供服务与支持,例如作为后台服务提供计算能力,或作为数据仓库提供数据访问能力。Particle Ability有三种模板,分别为Service模板(Service Ability)、Data模板(Data Ability)、以及Form模板(Form Ability)。 |
| FA模型 | 两种Ability框架模型结构的其中一种。是Ability框架在API 8及更早版本采用FA模型。FA模型将Ability分为FA(Feature Ability)和PA(Particle Ability)两种类型,其中FA支持Page Ability模板,PA支持Service ability、Data ability、以及Form ability模板。详情可参考
[
FA模型综述
](
../../application-dev/ability/fa-brief.md
)
。 |
| FA模型 | 两种Ability框架模型结构的其中一种。是Ability框架在API 8及更早版本采用FA模型。FA模型将Ability分为FA(Feature Ability)和PA(Particle Ability)两种类型,其中FA支持Page Ability模板,PA支持Service ability、Data ability、以及Form ability模板。详情可参考
[
FA模型综述
](
../../application-dev/ability
-deprecated
/fa-brief.md
)
。 |
| Stage模型 | 两种Ability框架模型结构的其中一种。从API 9开始支持。Stage模型将Ability分为Ability和ExtensionAbility两大类,其中ExtensionAbility又被扩展为ServiceExtensionAbility、FormExtensionAbility、DataShareExtensionAbility等等一系列ExtensionAbility。 |
### 功能简介
...
...
zh-cn/release-notes/OpenHarmony-v3.1.4-release.md
浏览文件 @
08ae9ec0
...
...
@@ -75,7 +75,7 @@ repo forall -c 'git lfs pull'
| 版本源码 |
**版本信息**
|
**下载站点**
|
**SHA256校验码**
|
| -------- | -------- | -------- | -------- |
| 全量代码(标准、轻量和小型系统) | 3.1.4
Release |
[
站点
](
https://mirrors.huaweicloud.com/openharmony/os/3.1.4/code-v3.1.4-Release
.tar.gz
)
|
[
SHA256校验码
](
https://mirrors.huaweicloud.com/openharmony/os/3.1.4/code-v3.1.4-Release
.tar.gz.sha256
)
|
| 全量代码(标准、轻量和小型系统) | 3.1.4
Release |
[
站点
](
https://mirrors.huaweicloud.com/openharmony/os/3.1.4/code-v3.1.4-Release
-2022-12-12.tar.gz
)
|
[
SHA256校验码
](
https://mirrors.huaweicloud.com/openharmony/os/3.1.4/code-v3.1.4-Release-2022-12-12
.tar.gz.sha256
)
|
| Hi3516标准系统解决方案(二进制) | 3.1.4
Release |
[
站点
](
https://mirrors.huaweicloud.com/openharmony/os/3.1.4/standard_hi3516.tar.gz
)
|
[
SHA256校验码
](
https://mirrors.huaweicloud.com/openharmony/os/3.1.4/standard_hi3516.tar.gz.sha256
)
|
| RK3568标准系统解决方案(二进制) | 3.1.4
Release |
[
站点
](
https://mirrors.huaweicloud.com/openharmony/os/3.1.4/standard_rk3568.tar.gz
)
|
[
SHA256校验码
](
https://mirrors.huaweicloud.com/openharmony/os/3.1.4/standard_rk3568.tar.gz.sha256
)
|
| Hi3861轻量系统解决方案(二进制) | 3.1.4
Release |
[
站点
](
https://mirrors.huaweicloud.com/openharmony/os/3.1.4/hispark_pegasus.tar.gz
)
|
[
SHA256校验码
](
https://mirrors.huaweicloud.com/openharmony/os/3.1.4/hispark_pegasus.tar.gz.sha256
)
|
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录