diff --git a/zh-cn/application-dev/Readme-CN.md b/zh-cn/application-dev/Readme-CN.md index 29c190d3fc62cba8415a36339d3dcb828f2931d2..81c318bb63b1bf39f2be220f8587d77a13f61074 100644 --- a/zh-cn/application-dev/Readme-CN.md +++ b/zh-cn/application-dev/Readme-CN.md @@ -3,6 +3,7 @@ - [应用开发导读](application-dev-guide.md) - 了解OpenHarmony - [了解OpenHarmony开源项目](../OpenHarmony-Overview_zh.md) + - [了解OpenHarmony系统](../readme) - [术语](../device-dev/glossary/glossary.md) - [版本说明](../release-notes/Readme.md) - 快速开始 diff --git a/zh-cn/application-dev/ability/ability-assistant-guidelines.md b/zh-cn/application-dev/ability/ability-assistant-guidelines.md index 2c7ad62bc8b8af6639c9cfe31185ef60eca31dcf..63a4fce86047786abb863efdec81a4885de991da 100644 --- a/zh-cn/application-dev/ability/ability-assistant-guidelines.md +++ b/zh-cn/application-dev/ability/ability-assistant-guidelines.md @@ -40,7 +40,7 @@ Ability assistant（Ability助手，简称为aa）是实现应用、原子化服 当成功启动Ability时，返回“start ability successfully.”；当启动失败时，返回“error: failed to start ability.”。 - 使用方法： + **使用方法：** ``` aa start [-d ] -a -b [-D] @@ -61,7 +61,7 @@ Ability assistant（Ability助手，简称为aa）是实现应用、原子化服 当成功停止Service Ability时，返回“stop service ability successfully.”；当停止失败时，返回“error: failed to stop service ability.”。 - 使用方法： + **使用方法：** ``` aa stop-service [-d ] -a -b @@ -71,16 +71,17 @@ Ability assistant（Ability助手，简称为aa）是实现应用、原子化服 用于打印Ability的相关信息。 - | 参数 | 参数说明 | - | ---------------------- | -------------------------------------- | - | -h/--help | 帮助信息。 | - | -a/--all | 打印所有mission内的Ability。 | - | -s/--stack \ | 打印指定mission stack内的Ability。 | - | -m/--mission \ | 打印指定mission内的Ability。 | - | -l/--stack-list | 打印每个mission stack内的mission列表。 | - | -u/--ui | 打印system ui Ability。 | - | -e/--serv | 打印Service Ability。 | - | -d/--data | 打印Data Ability。 | + | 参数 | 二级参数 | 参数说明 | + | ----------------- | -------------------- | ------------------------------------------------------------ | + | -h/--help | - | 帮助信息。 | + | -a/--all | - | 打印所有mission内的Ability。 | + | -l/--mission-list | type（缺省打印全部） | 打印任务栈信息。
type：
NORMAL
DEFAULT_STANDARD
DEFAULT_SINGLE
LAUNCHER | + | -e/--extension | elementName | 打印扩展组件信息。 | + | -u/--userId | UserId | 打印指定UserId的栈信息，需要和其他参数组合使用，例如 aa dump -a -u 100、aa dump -d -u 100、 | + | -d/--data | | 打印Data Ability。 | + | -i/--ability | AbilityRecord ID | 打印指定Ability详细信息 | + | -c/--client | | 打印Ability详细信息，需要和其他参数组合使用，例如 aa dump -a -c、aa dump -i 21 -c、 | + **使用方法：** diff --git a/zh-cn/application-dev/ability/fa-brief.md b/zh-cn/application-dev/ability/fa-brief.md index 5fcef0a959160ad924f1fe4b5589b094e3837f1a..d175367c19901aba9d7aedc864a9a0205cd26781 100644 --- a/zh-cn/application-dev/ability/fa-brief.md +++ b/zh-cn/application-dev/ability/fa-brief.md @@ -1 +1,22 @@ -# FA模型综述 \ No newline at end of file +# FA模型综述 + +## 整体架构 +鸿蒙用户程序的开发本质上就是开发Ability，OpenHarmony系统也是通过调度Ability，通过系统提供的一致性调度契约对Ability进行生命周期管理，从而实现对用户程序的调度。FA模型中Ability分为PageAbility、ServiceAbility和DataAbility三种类型。其中PageAbility具备ArkUI的Ability，是用户具体可见并可以交互的Ability实例；ServiceAbility也是Ability一种，但是没有UI，提供其他Ability调用自定义的服务，在后台运行；DataAbility也是没有UI，提供其他Ability进行数据的增删查服务，在后台运行。 + +## 应用包结构 +**应用包结构如下图所示：** +![fa-package-info](figures/fa-package-info.png) + +## 生命周期 + +**pageAbility生命周期回调如下图所示：** + +![fa-pageAbility-lifecycle](figures/fa-pageAbility-lifecycle.png) + +开发者可以在 app.js/app.ets 中重写生命周期函数，在对应的生命周期函数内处理应用相应逻辑。 + + +## 进程线程模型 +应用独享独立进程，Ability独享独立线程，应用进程在Ability第一次启动时创建，并为启动的Ability创建线程，应用启动后再启动应用内其他Ability，会为每一个Ability创建相应的线程。每个Ability绑定一个独立的JSRuntime实例，因此Ability之间是隔离的。 + +![fa-threading-nodel](figures/fa-threading-model.png) \ No newline at end of file diff --git a/zh-cn/application-dev/ability/fa-pageability.md b/zh-cn/application-dev/ability/fa-pageability.md index ba42ed13dcbd273b82aa6d3bd5b00d19f94a20f1..8433c7604ef2fd9250d976c972a0bdaa431c8f2e 100644 --- a/zh-cn/application-dev/ability/fa-pageability.md +++ b/zh-cn/application-dev/ability/fa-pageability.md @@ -27,19 +27,19 @@ Page模板（以下简称“Page”）是FA唯一支持的模板，用于提供 **PageAbility类型Ability生命周期回调如下图所示：** -![PageAbility-Lifecycel-Callbacks](figures/page-ability-lifecycle-callbacks.png) +![fa-pageAbility-lifecycle](figures/fa-pageAbility-lifecycle.png) ## 启动本地PageAbility - 导入模块 + * 导入模块 ``` import featureAbility from '@ohos.ability.featureAbility' ``` ``` - FeatureAbility.startAbility(parameter: StartAbilityParameter, callback: AsyncCallback) + featureAbility.startAbility(parameter: StartAbilityParameter, callback: AsyncCallback) ``` * 接口说明 @@ -50,61 +50,75 @@ import featureAbility from '@ohos.ability.featureAbility' ```javascript import featureAbility from '@ohos.ability.featureAbility' -featureAbility.startAbility( - { - want: - { - action: "", - entities: [""], - type: "", - options: { - // indicates the grant to perform read operations on the URI - authReadUriPermission: true, - // indicates the grant to perform write operations on the URI - authWriteUriPermission: true, - // support forward intent result to origin ability - abilityForwardResult: true, - // used for marking the ability start-up is triggered by continuation - abilityContinuation: true, - // specifies whether a component does not belong to ohos - notOhosComponent: true, - // specifies whether an ability is started - abilityFormEnabled: true, - // indicates the grant for possible persisting on the URI. - authPersistableUriPermission: true, - // indicates the grant for possible persisting on the URI. - authPrefixUriPermission: true, - // support distributed scheduling system start up multiple devices - abilitySliceMultiDevice: true, - // indicates that an ability using the service template is started regardless of whether the - // host application has been started. - startForegroundAbility: true, - // install the specified ability if it's not installed. - installOnDemand: true, - // return result to origin ability slice - abilitySliceForwardResult: true, - // install the specified ability with background mode if it's not installed. - installWithBackgroundMode: true - }, - deviceId: "", - bundleName: "com.example.startability", - abilityName: "com.example.startability.MainAbility", - uri: "" - }, +featureAbility.startAbility({ + want: + { + action: "", + entities: [""], + type: "", + options: { + // indicates the grant to perform read operations on the URI + authReadUriPermission: true, + // indicates the grant to perform write operations on the URI + authWriteUriPermission: true, + // support forward intent result to origin ability + abilityForwardResult: true, + // used for marking the ability start-up is triggered by continuation + abilityContinuation: true, + // specifies whether a component does not belong to ohos + notOhosComponent: true, + // specifies whether an ability is started + abilityFormEnabled: true, + // indicates the grant for possible persisting on the URI. + authPersistableUriPermission: true, + // indicates the grant for possible persisting on the URI. + authPrefixUriPermission: true, + // support distributed scheduling system start up multiple devices + abilitySliceMultiDevice: true, + // indicates that an ability using the service template is started regardless of whether the + // host application has been started. + startForegroundAbility: true, + // install the specified ability if it's not installed. + installOnDemand: true, + // return result to origin ability slice + abilitySliceForwardResult: true, + // install the specified ability with background mode if it's not installed. + installWithBackgroundMode: true }, - ); -) + deviceId: "", + bundleName: "com.example.startability", + abilityName: "com.example.startability.MainAbility", + uri: "" + }, +}, +); +``` +want参数也可以使用parameters参数，使用key-value的方式输入。 +* 示例 +```javascript +import featureAbility from '@ohos.ability.featureAbility' +featureAbility.startAbility({ + want: + { + bundleName: "com.example.startability", + uri: "", + parameters: { + abilityName: "com.example.startability.MainAbility" + } + }, +}, +); ``` ## 启动远程PageAbility - 导入模块 +* 导入模块 ``` import featureAbility from '@ohos.ability.featureAbility' ``` ``` -FeatureAbility.startAbility(parameter: StartAbilityParameter) +featureAbility.startAbility(parameter: StartAbilityParameter) ``` * 接口说明 @@ -114,14 +128,13 @@ FeatureAbility.startAbility(parameter: StartAbilityParameter) * 示例 ```javascript - var promise = await ability.startAbility( - { - want: - { - deviceId: this.deviceId, - bundleName: "com.example.test", - abilityName: "com.example.test.MainAbility", - }, - } - ); +var promise = await featureAbility.startAbility({ + want: + { + deviceId: this.deviceId, + bundleName: "com.example.test", + abilityName: "com.example.test.MainAbility", + }, +} +); ``` \ No newline at end of file diff --git a/zh-cn/application-dev/ability/figures/fa-package-info.png b/zh-cn/application-dev/ability/figures/fa-package-info.png new file mode 100644 index 0000000000000000000000000000000000000000..7b660dce47e3873279f9bdf587b1bd290384843b Binary files /dev/null and b/zh-cn/application-dev/ability/figures/fa-package-info.png differ diff --git a/zh-cn/application-dev/ability/figures/fa-pageAbility-lifecycle.png b/zh-cn/application-dev/ability/figures/fa-pageAbility-lifecycle.png new file mode 100644 index 0000000000000000000000000000000000000000..269d06b73dde7c952b56cd76f1842a856dde3c01 Binary files /dev/null and b/zh-cn/application-dev/ability/figures/fa-pageAbility-lifecycle.png differ diff --git a/zh-cn/application-dev/ability/figures/fa-threading-model.png b/zh-cn/application-dev/ability/figures/fa-threading-model.png new file mode 100644 index 0000000000000000000000000000000000000000..db1102837790330e536bd43062852bf04d505ee1 Binary files /dev/null and b/zh-cn/application-dev/ability/figures/fa-threading-model.png differ diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index 698d8fdaeb8b9ab83941265d765b6cf9b7e31b83..ff67949950f6b13b004b7be97cb5da316b074f49 100644 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -25,8 +25,7 @@ - [访问控制](js-apis-abilityAccessCtrl.md) - [通用密钥库系统](js-apis-huks.md) - 数据管理 - - [轻量级存储9+](js-apis-data-preferences.md) - - [轻量级存储](js-apis-data-storage.md) + - [轻量级存储](js-apis-data-preferences.md) - [分布式数据管理](js-apis-distributed-data.md) - [关系型数据库](js-apis-data-rdb.md) - [结果集](js-apis-data-resultset.md) @@ -77,15 +76,17 @@ - [USB管理](js-apis-usb.md) - [位置服务](js-apis-geolocation.md) - 基本功能 + - [应用上下文](js-apis-basic-features-app-context.md) + - [日志打印](js-apis-basic-features-logs.md) - [页面路由](js-apis-basic-features-routes.md) - [弹窗](js-apis-basic-features-pop-up.md) + - [应用配置](js-apis-basic-features-configuration.md) - [定时器](js-apis-basic-features-timer.md) - [锁屏管理](js-apis-screen-lock.md) - [设置系统时间](js-apis-system-time.md) - [壁纸](js-apis-wallpaper.md) - [剪贴板](js-apis-pasteboard.md) - [动画](js-apis-basic-features-animator.md) - - [媒体查询](js-apis-mediaquery.md) - [WebGL](js-apis-webgl.md) - [WebGL2](js-apis-webgl2.md) - [屏幕截图](js-apis-screenshot.md) diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-context.md b/zh-cn/application-dev/reference/apis/js-apis-ability-context.md index bf66918245d740b1e39604bb5c7c76d99e043660..e1ab57aed3064d616732a18fc49d5e6b22670e8a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-context.md @@ -10,10 +10,10 @@ Ability的上下文环境，继承自Context。 ## 使用说明 -在使用AbilityContext的功能前，需要通过Ability子类实例获取。 - +​在使用AbilityContext的功能前，需要通过Ability子类实例获取。 + ```js import Ability from '@ohos.application.Ability' class MainAbility extends Ability { @@ -42,10 +42,10 @@ startAbility(want: Want, callback: AsyncCallback<void>): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| want | [Want](js-apis-featureAbility.md#want) | 是 | 启动Ability的want信息。 | -| callback | AsyncCallback<void> | 是 | callback形式返回启动结果 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | + | callback | AsyncCallback<void> | 是 | callback形式返回启动结果 | **示例：** @@ -71,11 +71,11 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void& **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| want | [Want](js-apis-featureAbility.md#want) | 是 | 启动Ability的want信息。 | -| options | StartOptions | 是 | 启动Ability所携带的参数。 | -| callback | AsyncCallback<void> | 是 | callback形式返回启动结果。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | + | options | StartOptions | 是 | 启动Ability所携带的参数。 | + | callback | AsyncCallback<void> | 是 | callback形式返回启动结果。 | **示例：** @@ -96,7 +96,7 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void& ## AbilityContext.startAbility -startAbility(want: Want, options: StartOptions): Promise<void> +startAbility(want: Want, options: StartOptions): Promise<void>; 启动Ability。通过Promise返回结果。 @@ -104,10 +104,10 @@ startAbility(want: Want, options: StartOptions): Promise<void> **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| want | [Want](js-apis-featureAbility.md#want) | 是 | 启动Ability的want信息。 | -| options | StartOptions | 是 | 启动Ability所携带的参数。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | + | options | StartOptions | 是 | 启动Ability所携带的参数。 | **返回值：** @@ -145,10 +145,10 @@ startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>): **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| want |[Want](js-apis-featureAbility.md#want) | 是 | 启动Ability的want信息。 | -| callback | AsyncCallback<[AbilityResult](js-apis-featureAbility.md#abilityresult)> | 是 | 执行结果回调函数。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want |[Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | + | callback | AsyncCallback<[AbilityResult](js-apis-featureAbility.md#abilityresult)> | 是 | 执行结果回调函数。 | **示例：** @@ -173,11 +173,11 @@ startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| want |[Want](js-apis-featureAbility.md#want) | 是 | 启动Ability的want信息。 | -| options | StartOptions | 是 | 启动Ability所携带的参数。 | -| callback | AsyncCallback<[AbilityResult](js-apis-featureAbility.md#abilityresult)> | 是 | 执行结果回调函数。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want |[Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | + | options | StartOptions | 是 | 启动Ability所携带的参数。 | + | callback | AsyncCallback<[AbilityResult](js-apis-featureAbility.md#abilityresult)> | 是 | 执行结果回调函数。 | **示例：** @@ -206,10 +206,10 @@ startAbilityForResult(want: Want, options: StartOptions): Promise<AbilityResu **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| want | [Want](js-apis-featureAbility.md#want) | 是 | 启动Ability的want信息。 | -| options | StartOptions | 是 | 启动Ability所携带的参数。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | + | options | StartOptions | 是 | 启动Ability所携带的参数。 | **返回值：** @@ -353,9 +353,9 @@ startAbilityByCall(want: Want): Promise<Caller>; **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| want | [Want](js-apis-featureAbility.md#want) | 是 | 传入需要启动的ability的信息，包含ability名称、包名、设备ID，设备ID缺省或为空表示启动本地ability。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 传入需要启动的ability的信息，包含ability名称、包名、设备ID，设备ID缺省或为空表示启动本地ability。 | **返回值：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-basic-features-app-context.md b/zh-cn/application-dev/reference/apis/js-apis-basic-features-app-context.md new file mode 100644 index 0000000000000000000000000000000000000000..be16b12372a636aa23a991b595c4a800f1c4261f --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-basic-features-app-context.md @@ -0,0 +1,79 @@ +# 应用上下文 + + +## 导入模块 + +``` +import app from '@system.app'; +``` + +## 权限列表 + +无 + + +## app.getInfo + +getInfo(): <AppResponse> + +获取当前应用配置文件中声明的信息。 + +- 返回值 + **表1** AppResponse + + | | | | + | -------- | -------- | -------- | + | 参数名 | 类型 | 说明 | + | appID6+ | string | 表示应用的包名，用于标识应用的唯一性。 | + | appName | string | 表示应用的名称。 | + | versionName | string | 表示应用的版本名称。 | + | versionCode | number | 表示应用的版本号。 | + +- 示例 + ``` + export default { + getInfo(){ + var info = app.getInfo(); + console.log(JSON.stringify(info)); + } + } + ``` + + +## app.terminate + +terminate(): void + +退出当前Ability + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 从API Version 7 开始，推荐使用新接口['@ohos.ability.featureAbility'](js-apis-featureAbility.md)。 + +- 示例 + ``` + export default { + terminate(){ + app.terminate(); + }} + ``` + +## app.requestFullWindow + +requestFullWindow(duration: number): void + +请求应用以全窗口运行，FA在某些场景下（如半模态FA）会以非全窗口运行，调用该接口会从非全窗口切换为全窗口运行，如果已经以全窗口运行则该接口调用无效。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | duration | number | 否 | 请求全屏时，设定非全屏到全屏的过渡时间，单位为毫秒，默认时间与非全屏到全屏的距离成正比。 | + +- 示例 + ``` + export default { + requestFullWindow(){ + app.requestFullWindow({ + duration: 200}); + } + } + ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-basic-features-configuration.md b/zh-cn/application-dev/reference/apis/js-apis-basic-features-configuration.md new file mode 100644 index 0000000000000000000000000000000000000000..d9602902ca3e575a737f08f4edc22f30ef61f06b --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-basic-features-configuration.md @@ -0,0 +1,44 @@ +# 应用配置 + + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> - 从API Version 7 开始，该接口不再维护，推荐使用新接口['@ohos.i18n'](js-apis-i18n.md)和['@ohos.intl'](js-apis-intl.md)。 +> + + +## 导入模块 + +``` +import configuration from '@system.configuration'; +``` + +## 权限列表 + +无 + + +## configuration.getLocale + +getLocale(): <LocaleResponse> + +获取应用当前的语言和地区。默认与系统的语言和地区同步。 + +- 返回值 + **表1** LocaleResponse + + | 参数名 | 类型 | 说明 | + | -------- | -------- | -------- | + | language | string | 语言。例如：zh。 | + | countryOrRegion | string | 国家或地区。例如：CN。 | + | dir | string | 文字布局方向。取值范围：
- ltr：从左到右；
- rtl：从右到左。 | + | $unicodeSetting^{5+}$ | string | 语言环境定义的Unicode语言环境键集，如果此语言环境没有特定键集，则返回空集。
例如：{"nu":"arab"}，表示当前环境下的数字采用阿拉伯语的数字。 | + +- 示例 + ``` + export default { + getLocale() { + const localeInfo = configuration.getLocale(); + console.info(localeInfo.language); + } + } + ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-basic-features-logs.md b/zh-cn/application-dev/reference/apis/js-apis-basic-features-logs.md index 00ecf318420eda9d2d11734b638e4518ecef5771..0c6afae60d9aed4e0b2e8873510279255bb25928 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-basic-features-logs.md +++ b/zh-cn/application-dev/reference/apis/js-apis-basic-features-logs.md @@ -5,6 +5,10 @@ 无需导入。 +## 权限列表 + +无 + ## console.debug diff --git a/zh-cn/application-dev/reference/apis/js-apis-fileio.md b/zh-cn/application-dev/reference/apis/js-apis-fileio.md index b01a673db10bf796345bfd13f374f06bab9e7c34..1e6def6533c67181588eed4a966acda87a8f4311 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-fileio.md +++ b/zh-cn/application-dev/reference/apis/js-apis-fileio.md @@ -1432,7 +1432,7 @@ lstat(path:string, callback:AsyncCallback<Stat>): void ```js fileio.lstat(path, function (err, stat) { // do something - )); + }); ``` @@ -1827,7 +1827,7 @@ chown(path: string, uid: number, gid: number): Promise<void> - 示例： ```js let stat = fileio.statSync(path); - fileio.chown(path, stat.uid, stat.gid)).then(function(){ + fileio.chown(path, stat.uid, stat.gid).then(function(){ console.info("chown successfully"); }).catch(function(err){ console.info("chown failed with error:"+ err); @@ -2127,7 +2127,7 @@ fdopenStream(fd: number, mode: string): Promise<Stream> - 示例： ```js fileio.fdopenStream(fd, mode).then(function(stream){ - console.info("openStream successfully"+); + console.info("openStream successfully"); }).catch(function(err){ console.info("openStream failed with error:"+ err); }); diff --git a/zh-cn/application-dev/reference/apis/js-apis-formprovider.md b/zh-cn/application-dev/reference/apis/js-apis-formprovider.md new file mode 100644 index 0000000000000000000000000000000000000000..b6f721e33bb056b29d08d0cd45e6d36dd32a4000 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-formprovider.md @@ -0,0 +1,128 @@ +# FormProvider + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + +卡片提供方相关接口。 + +## 导入模块 + +``` +import formProvider from '@ohos.application.formProvider'; +``` + +## 权限 + +无 + +## setFormNextRefreshTime + +setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback): void; + +设置指定卡片的下一次更新时间。 + +**系统能力：** + +SystemCapability.Ability.Form + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | ------------------------------------- | + | formId | string | 是 | 卡片标识 | + | minute | number | 是 | 指定多久之后更新，单位分钟，大于等于5 | + +**示例：** + + ```js + var formId = "12400633174999288"; + formProvider.setFormNextRefreshTime(formId, 5, (error, data) => { + if (error) { + console.log('formProvider setFormNextRefreshTime, error:' + error.code); + } + }); + ``` + +## setFormNextRefreshTime + +setFormNextRefreshTime(formId: string, minute: number): Promise; + +设置指定卡片的下一次更新时间，以promise方式返回。 + +**系统能力：** + +SystemCapability.Ability.Form + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | ------------------------------------- | + | formId | string | 是 | 卡片标识 | + | minute | number | 是 | 指定多久之后更新，单位分钟，大于等于5 | + +**示例：** + + ```js + var formId = "12400633174999288"; + formProvider.setFormNextRefreshTime(formId, 5).catch((error) => { + console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error)); + }); + ``` + +## updateForm + +updateForm(formId: string, formBindingData: formBindingData.FormBindingData, callback: AsyncCallback): void; + +更新指定的卡片。 + +**系统能力：** + +SystemCapability.Ability.Form + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | ------ | ---------------------------------------------------------------------- | ---- | ---------------- | + | formId | string | 是 | 请求更新的卡片标识 | + | formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据 | + +**示例：** + + ```js + import formBindingData from '@ohos.application.formBindingData'; + var formId = "12400633174999288"; + let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); + formProvider.updateForm(formId, obj, (error, data) => { + if (error) { + console.log('formProvider updateForm, error:' + error.code); + } + }); + ``` + +## updateForm + +updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Promise; + +更新指定的卡片，以promise方式返回。 + +**系统能力：** + +SystemCapability.Ability.Form + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | ------ | ---------------------------------------------------------------------- | ---- | ---------------- | + | formId | string | 是 | 请求更新的卡片标识 | + | formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据 | + +**示例：** + + ```js + import formBindingData from '@ohos.application.formBindingData'; + var formId = "12400633174999288"; + let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); + formProvider.updateForm(formId, obj).catch((error) => { + console.log('formProvider updateForm, error:' + JSON.stringify(error)); + }); + ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-geolocation.md b/zh-cn/application-dev/reference/apis/js-apis-geolocation.md index bbb22b733f8579c06149cd6f9bd32f54a480f306..32255634797b229d1751b45b1d70832368f233d8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-geolocation.md +++ b/zh-cn/application-dev/reference/apis/js-apis-geolocation.md @@ -27,11 +27,11 @@ on(type: 'locationChange', request: LocationRequest, callback: Callback<Locat 开启位置变化订阅，并发起定位请求。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 | - | request | LocationRequest | 是 | 设置位置请求参数。 | - | callback | Callback<[Location](#location)> | 是 | 接收位置变化状态变化监听。 | + | type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 | + | request | LocationRequest | 是 | 设置位置请求参数。 | + | callback | Callback<[Location](#location)> | 是 | 接收位置变化状态变化监听。 | - 示例： @@ -51,10 +51,10 @@ off(type: 'locationChange', callback?: Callback<Location>) : void 关闭位置变化订阅，并删除对应的定位请求。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 | - | callback | Callback<[Location](#location)> | 否 | 接收位置变化状态变化监听。 | + | type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 | + | callback | Callback<[Location](#location)> | 否 | 接收位置变化状态变化监听。 | - 示例： @@ -75,10 +75,10 @@ on(type: 'locationServiceState', callback: Callback<boolean>) : void 订阅位置服务状态变化。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“locationServiceState”，表示位置服务状态。 | - | callback | Callback<boolean> | 是 | 接收位置服务状态变化监听。 | + | type | string | 是 | 设置事件类型。type为“locationServiceState”，表示位置服务状态。 | + | callback | Callback<boolean> | 是 | 接收位置服务状态变化监听。 | - 示例： @@ -97,10 +97,10 @@ off(type: 'locationServiceState', callback?: Callback<boolean>) : void; 取消订阅位置服务状态变化。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“locationServiceState”，表示位置服务状态。 | - | callback | Callback<boolean> | 否 | 接收位置服务状态变化监听。 | + | type | string | 是 | 设置事件类型。type为“locationServiceState”，表示位置服务状态。 | + | callback | Callback<boolean> | 否 | 接收位置服务状态变化监听。 | - 示例： @@ -120,11 +120,11 @@ on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, ca 订阅缓存GNSS定位结果上报事件。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsReporting”，表示GNSS缓存定位结果上报。 | - | request | CachedGnssLocationsRequest | 是 | GNSS缓存功能配置参数 | - | callback | Callback<boolean> | 是 | 接收GNSS缓存位置上报。 | + | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsReporting”，表示GNSS缓存定位结果上报。 | + | request | CachedGnssLocationsRequest | 是 | GNSS缓存功能配置参数 | + | callback | Callback<boolean> | 是 | 接收GNSS缓存位置上报。 | - 示例： @@ -144,10 +144,10 @@ off(type: 'cachedGnssLocationsReporting', callback?: Callback<Array<Locati 取消订阅缓存GNSS定位结果上报事件。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsReporting”，表示GNSS缓存定位结果上报。 | - | callback | Callback<boolean> | 否 | 接收GNSS缓存位置上报。 | + | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsReporting”，表示GNSS缓存定位结果上报。 | + | callback | Callback<boolean> | 否 | 接收GNSS缓存位置上报。 | - 示例： @@ -168,10 +168,10 @@ on(type: 'gnssStatusChange', callback: Callback<SatelliteStatusInfo>) : vo 订阅GNSS卫星状态信息上报事件。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“gnssStatusChange”，表示订阅GNSS卫星状态信息上报。 | - | callback | Callback<SatelliteStatusInfo> | 是 | 接收GNSS卫星状态信息上报。 | + | type | string | 是 | 设置事件类型。type为“gnssStatusChange”，表示订阅GNSS卫星状态信息上报。 | + | callback | Callback<SatelliteStatusInfo> | 是 | 接收GNSS卫星状态信息上报。 | - 示例： @@ -190,10 +190,10 @@ off(type: 'gnssStatusChange', callback?: Callback<SatelliteStatusInfo>) : 取消订阅GNSS卫星状态信息上报事件。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“gnssStatusChange”，表示订阅GNSS卫星状态信息上报。 | - | callback | Callback<SatelliteStatusInfo> | 否 | 接收GNSS卫星状态信息上报。 | + | type | string | 是 | 设置事件类型。type为“gnssStatusChange”，表示订阅GNSS卫星状态信息上报。 | + | callback | Callback<SatelliteStatusInfo> | 否 | 接收GNSS卫星状态信息上报。 | - 示例： @@ -213,10 +213,10 @@ on(type: 'nmeaMessageChange', callback: Callback<string>) : void; 订阅GNSS NMEA信息上报事件。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“nmeaMessageChange”，表示订阅GNSS NMEA信息上报。 | - | callback | Callback<string> | 是 | 接收GNSS NMEA信息上报。 | + | type | string | 是 | 设置事件类型。type为“nmeaMessageChange”，表示订阅GNSS NMEA信息上报。 | + | callback | Callback<string> | 是 | 接收GNSS NMEA信息上报。 | - 示例： @@ -235,10 +235,10 @@ off(type: 'nmeaMessageChange', callback?: Callback<string>) : void; 取消订阅GNSS NMEA信息上报事件。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“nmeaMessageChange”，表示订阅GNSS NMEA信息上报。 | - | callback | Callback<string> | 否 | 接收GNSS NMEA信息上报。 | + | type | string | 是 | 设置事件类型。type为“nmeaMessageChange”，表示订阅GNSS NMEA信息上报。 | + | callback | Callback<string> | 否 | 接收GNSS NMEA信息上报。 | - 示例： @@ -258,11 +258,11 @@ on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent) : void; 添加一个围栏，并订阅地理围栏事件。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“fenceStatusChange”，表示订阅围栏事件上报。 | - | request | GeofenceRequest | 是 | 围栏的配置参数。 | - | want | WantAgent | 是 | 用于接收地理围栏事件上报（进出围栏）。 | + | type | string | 是 | 设置事件类型。type为“fenceStatusChange”，表示订阅围栏事件上报。 | + | request | GeofenceRequest | 是 | 围栏的配置参数。 | + | want | WantAgent | 是 | 用于接收地理围栏事件上报（进出围栏）。 | - 示例： @@ -320,11 +320,11 @@ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent) : void 删除一个围栏，并取消订阅该围栏事件。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“fenceStatusChange”，表示订阅围栏事件上报。 | - | request | GeofenceRequest | 是 | 围栏的配置参数。 | - | want | WantAgent | 是 | 用于接收地理围栏事件上报（进出围栏）。 | + | type | string | 是 | 设置事件类型。type为“fenceStatusChange”，表示订阅围栏事件上报。 | + | request | GeofenceRequest | 是 | 围栏的配置参数。 | + | want | WantAgent | 是 | 用于接收地理围栏事件上报（进出围栏）。 | - 示例： @@ -385,10 +385,10 @@ getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<L - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | request | [CurrentLocationRequest](#currentlocationrequest) | 否 | 设置位置请求参数。 | - | callback | AsyncCallback<[Location](#location)> | 是 | 用来接收位置信息的回调。 | + | request | [CurrentLocationRequest](#currentlocationrequest) | 否 | 设置位置请求参数。 | + | callback | AsyncCallback<[Location](#location)> | 是 | 用来接收位置信息的回调。 | - 示例： @@ -411,14 +411,14 @@ getCurrentLocation(request?: CurrentLocationRequest) : Promise<Location> - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | request | [CurrentLocationRequest](#currentlocationrequest) | 否 | 设置位置请求参数。 | + | request | [CurrentLocationRequest](#currentlocationrequest) | 否 | 设置位置请求参数。 | - 返回值： - | 参数名 | 说明 | + | 参数名 | 说明 | | -------- | -------- | - | Promise<[Location](#location)> | 返回位置信息。 | + | Promise<[Location](#location)> | 返回位置信息。 | - 示例： @@ -437,9 +437,9 @@ getLastLocation(callback: AsyncCallback<Location>) : void 获取上一次位置，使用callback回调异步返回结果。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[Location](#location)> | 是 | 用来接收上次位置的回调。 | + | callback | AsyncCallback<[Location](#location)> | 是 | 用来接收上次位置的回调。 | - 示例： @@ -457,9 +457,9 @@ getLastLocation() : Promise<Location> 获取上一次位置，使用Promise方式异步返回结果。 - 返回值： - | 参数名 | 说明 | + | 参数名 | 说明 | | -------- | -------- | - | Promise<[Location](#location)> | 返回上次位置信息。 | + | Promise<[Location](#location)> | 返回上次位置信息。 | - 示例： @@ -479,9 +479,9 @@ isLocationEnabled(callback: AsyncCallback<boolean>) : void - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<boolean> | 是 | 用来接收位置服务状态的回调。 | + | callback | AsyncCallback<boolean> | 是 | 用来接收位置服务状态的回调。 | - 示例： @@ -499,9 +499,9 @@ isLocationEnabled() : Promise<boolean> 判断位置服务是否已经开启，使用Promise方式异步返回结果。 - 返回值： - | 参数名 | 说明 | + | 参数名 | 说明 | | -------- | -------- | - | Promise<boolean> | 返回位置服务是否可用的状态。 | + | Promise<boolean> | 返回位置服务是否可用的状态。 | - 示例： @@ -521,9 +521,9 @@ requestEnableLocation(callback: AsyncCallback<boolean>) : void - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<boolean> | 是 | 用来接收位置服务状态的回调。 | + | callback | AsyncCallback<boolean> | 是 | 用来接收位置服务状态的回调。 | - 示例： @@ -541,9 +541,9 @@ requestEnableLocation() : Promise<boolean> 请求打开位置服务，使用Promise方式异步返回结果。 - 返回值： - | 参数名 | 说明 | + | 参数名 | 说明 | | -------- | -------- | - | Promise<boolean> | 返回位置服务是否可用。 | + | Promise<boolean> | 返回位置服务是否可用。 | - 示例： @@ -561,9 +561,9 @@ isGeoServiceAvailable(callback: AsyncCallback<boolean>) : void 判断（逆）地理编码服务状态，使用callback回调异步返回结果。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<boolean> | 是 | 用来接收地理编码服务状态的回调。 | + | callback | AsyncCallback<boolean> | 是 | 用来接收地理编码服务状态的回调。 | - 示例： @@ -581,9 +581,9 @@ isGeoServiceAvailable() : Promise<boolean> 判断（逆）地理编码服务状态，使用Promise方式异步返回结果。 - 返回值： - | 参数名 | 说明 | + | 参数名 | 说明 | | -------- | -------- | - | Promise<boolean> | 返回地理编码服务是否可用的状态。 | + | Promise<boolean> | 返回地理编码服务是否可用的状态。 | - 示例： @@ -602,10 +602,10 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback 调用逆地理编码服务，将坐标转换为地理描述，使用callback回调异步返回结果。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 | - | callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | 是 | 设置接收逆地理编码请求的回调参数。 | + | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 | + | callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | 是 | 设置接收逆地理编码请求的回调参数。 | - 示例： @@ -624,14 +624,14 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest) : Promise<Array<G 调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 | + | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 | - 返回值： - | 参数名 | 说明 | + | 参数名 | 说明 | | -------- | -------- | - | Promise<Array<[GeoAddress](#geoaddress)>> | 返回地理描述信息。 | + | Promise<Array<[GeoAddress](#geoaddress)>> | 返回地理描述信息。 | - 示例： @@ -650,10 +650,10 @@ getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback< 调用地理编码服务，将地理描述转换为具体坐标，使用callback回调异步返回结果。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 | - | callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | 是 | 设置接收地理编码请求的回调参数。 | + | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 | + | callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | 是 | 设置接收地理编码请求的回调参数。 | - 示例： @@ -672,14 +672,14 @@ getAddressesFromLocationName(request: GeoCodeRequest) : Promise<Array<GeoA 调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 | + | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 | - 返回值： - | 参数名 | 说明 | + | 参数名 | 说明 | | -------- | -------- | - | Promise<Array<[GeoAddress](#geoaddress)>> | 设置接收地理编码请求的回调参数。 | + | Promise<Array<[GeoAddress](#geoaddress)>> | 设置接收地理编码请求的回调参数。 | - 示例： @@ -699,9 +699,9 @@ getCachedGnssLocationsSize(callback: AsyncCallback<number>) : void; 获取GNSS芯片缓存位置的个数。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<number> | 是 | 用来接收GNSS芯片缓存位置个数的回调。 | + | callback | AsyncCallback<number> | 是 | 用来接收GNSS芯片缓存位置个数的回调。 | - 示例： @@ -719,9 +719,9 @@ getCachedGnssLocationsSize() : Promise<number>; 获取GNSS芯片缓存位置的个数。 - 返回值： - | 参数名 | 说明 | + | 参数名 | 说明 | | -------- | -------- | - | Promise<number> | 返回GNSS缓存位置的个数。 | + | Promise<number> | 返回GNSS缓存位置的个数。 | - 示例： @@ -739,9 +739,9 @@ flushCachedGnssLocations(callback: AsyncCallback<boolean>) : void; 读取并清空GNSS芯片所有缓存位置。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<boolean> | 是 | 用来接收清空GNSS芯片缓存位置操作的结果。 | + | callback | AsyncCallback<boolean> | 是 | 用来接收清空GNSS芯片缓存位置操作的结果。 | - 示例： @@ -759,9 +759,9 @@ flushCachedGnssLocations() : Promise<boolean>; 读取并清空GNSS芯片所有缓存位置。 - 返回值： - | 参数名 | 说明 | + | 参数名 | 说明 | | -------- | -------- | - | Promise<boolean> | 清空所有GNSS缓存位置是否成功。 | + | Promise<boolean> | 清空所有GNSS缓存位置是否成功。 | - 示例： @@ -779,10 +779,10 @@ sendCommand(command: LocationCommand, callback: AsyncCallback<boolean>) : 给位置服务子系统的各个部件发送扩展命令。只有系统应用才能调用。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | command | LocationCommand | 是 | 指定目标场景，和将要发送的命令（字符串）。 | - | callback | AsyncCallback<boolean> | 是 | 用来接收命令发送的结果。 | + | command | LocationCommand | 是 | 指定目标场景，和将要发送的命令（字符串）。 | + | callback | AsyncCallback<boolean> | 是 | 用来接收命令发送的结果。 | - 示例： @@ -801,14 +801,14 @@ sendCommand(command: LocationCommand) : Promise<boolean>; 给位置服务子系统的各个部件发送扩展命令。只有系统应用才能调用。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | command | LocationCommand | 是 | 指定目标场景，和将要发送的命令（字符串）。 | + | command | LocationCommand | 是 | 指定目标场景，和将要发送的命令（字符串）。 | - 返回值： - | 参数名 | 说明 | + | 参数名 | 说明 | | -------- | -------- | - | Promise<boolean> | 表示命令发送成功或失败。 | + | Promise<boolean> | 表示命令发送成功或失败。 | - 示例： @@ -827,10 +827,10 @@ isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback&l 查询用户是否同意定位服务隐私申明，是否同意启用定位服务。只有系统应用才能调用。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | LocationPrivacyType | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | - | callback | AsyncCallback<boolean> | 是 | 表示用户是否同意定位服务隐私申明。 | + | type | LocationPrivacyType | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | + | callback | AsyncCallback<boolean> | 是 | 表示用户是否同意定位服务隐私申明。 | - 示例： @@ -848,14 +848,14 @@ isLocationPrivacyConfirmed(type : LocationPrivacyType,) : Promise<boolean> 查询用户是否同意定位服务隐私申明，是否同意启用定位服务。只有系统应用才能调用。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | LocationPrivacyType | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | + | type | LocationPrivacyType | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | - 返回值： - | 参数名 | 说明 | + | 参数名 | 说明 | | -------- | -------- | - | Promise<boolean> | 表示用户是否同意定位服务隐私申明。 | + | Promise<boolean> | 表示用户是否同意定位服务隐私申明。 | - 示例： @@ -873,11 +873,11 @@ setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed: boolean 设置用户勾选定位服务隐私申明的状态，记录用户是否同意启用定位服务。只有系统应用才能调用。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | LocationPrivacyType | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | - | isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 | - | callback | AsyncCallback<boolean> | 是 | 表示操作是否成功。 | + | type | LocationPrivacyType | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | + | isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 | + | callback | AsyncCallback<boolean> | 是 | 表示操作是否成功。 | - 示例： @@ -895,15 +895,15 @@ setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolea 设置用户勾选定位服务隐私申明的状态，记录用户是否同意启用定位服务。只有系统应用才能调用。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | LocationPrivacyType | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | - | isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 | + | type | LocationPrivacyType | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | + | isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 | - 返回值： - | 参数名 | 说明 | + | 参数名 | 说明 | | -------- | -------- | - | Promise<boolean> | 表示操作是否成功。 | + | Promise<boolean> | 表示操作是否成功。 | - 示例： @@ -919,201 +919,201 @@ setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolea 位置请求中位置信息优先级设置。 - | 名称 | 默认值 | 说明 | +| 名称 | 默认值 | 说明 | | -------- | -------- | -------- | -| UNSET | 0x200 | 表示未设置优先级。 | -| ACCURACY | 0x201 | 表示精度优先。 | -| LOW_POWER | 0x202 | 表示低功耗优先。 | -| FIRST_FIX | 0x203 | 表示快速获取位置优先，如果应用希望快速拿到1个位置，可以将优先级设置为该字段。 | +| UNSET | 0x200 | 表示未设置优先级。 | +| ACCURACY | 0x201 | 表示精度优先。 | +| LOW_POWER | 0x202 | 表示低功耗优先。 | +| FIRST_FIX | 0x203 | 表示快速获取位置优先，如果应用希望快速拿到1个位置，可以将优先级设置为该字段。 | ## LocationRequestScenario 位置请求中定位场景设置。 - | 名称 | 默认值 | 说明 | +| 名称 | 默认值 | 说明 | | -------- | -------- | -------- | -| UNSET | 0x300 | 表示未设置场景信息。 | -| NAVIGATION | 0x301 | 表示导航场景。 | -| TRAJECTORY_TRACKING | 0x302 | 表示运动轨迹记录场景。 | -| CAR_HAILING | 0x303 | 表示打车场景。 | -| DAILY_LIFE_SERVICE | 0x304 | 表示日常服务使用场景。 | -| NO_POWER | 0x305 | 表示无功耗功场景，这种场景下不会主动触发定位，会在其他应用定位时，才给当前应用返回位置。 | +| UNSET | 0x300 | 表示未设置场景信息。 | +| NAVIGATION | 0x301 | 表示导航场景。 | +| TRAJECTORY_TRACKING | 0x302 | 表示运动轨迹记录场景。 | +| CAR_HAILING | 0x303 | 表示打车场景。 | +| DAILY_LIFE_SERVICE | 0x304 | 表示日常服务使用场景。 | +| NO_POWER | 0x305 | 表示无功耗功场景，这种场景下不会主动触发定位，会在其他应用定位时，才给当前应用返回位置。 | ## GeoLocationErrorCode 位置服务中的错误码信息。 - | 名称 | 默认值 | 说明 | +| 名称 | 默认值 | 说明 | | -------- | -------- | -------- | -| INPUT_PARAMS_ERROR | 101 | 表示输入参数错误。 | -| REVERSE_GEOCODE_ERROR | 102 | 表示逆地理编码接口调用失败。 | -| GEOCODE_ERROR | 103 | 表示地理编码接口调用失败。 | -| LOCATOR_ERROR | 104 | 表示定位失败。 | -| LOCATION_SWITCH_ERROR | 105 | 表示定位开关。 | -| LAST_KNOWN_LOCATION_ERROR | 106 | 表示获取上次位置失败。 | -| LOCATION_REQUEST_TIMEOUT_ERROR | 107 | 表示单次定位，没有在指定时间内返回位置。 | +| INPUT_PARAMS_ERROR | 101 | 表示输入参数错误。 | +| REVERSE_GEOCODE_ERROR | 102 | 表示逆地理编码接口调用失败。 | +| GEOCODE_ERROR | 103 | 表示地理编码接口调用失败。 | +| LOCATOR_ERROR | 104 | 表示定位失败。 | +| LOCATION_SWITCH_ERROR | 105 | 表示定位开关。 | +| LAST_KNOWN_LOCATION_ERROR | 106 | 表示获取上次位置失败。 | +| LOCATION_REQUEST_TIMEOUT_ERROR | 107 | 表示单次定位，没有在指定时间内返回位置。 | ## ReverseGeoCodeRequest 逆地理编码请求接口。 - | 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| locale | string | 否 | 指定位置描述信息的语言，“zh”代表中文，“en”代表英文。 | -| latitude | number | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 | -| longitude | number | 是 | 表示经度信息，正值表示东经，负值表示西经。 | -| maxItems | number | 否 | 指定返回位置信息的最大个数。 | +| locale | string | 否 | 指定位置描述信息的语言，“zh”代表中文，“en”代表英文。 | +| latitude | number | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 | +| longitude | number | 是 | 表示经度信息，正值表示东经，负值表示西经。 | +| maxItems | number | 否 | 指定返回位置信息的最大个数。 | ## GeoCodeRequest 地理编码请求接口。 - | 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| locale | string | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 | -| description | number | 是 | 表示位置信息描述，如“上海市浦东新区xx路xx号”。 | -| maxItems | number | 否 | 表示返回位置信息的最大个数。 | -| minLatitude | number | 否 | 表示最小纬度信息，与下面三个参数一起，表示一个经纬度范围。 | -| minLongitude | number | 否 | 表示最小经度信息。 | -| maxLatitude | number | 否 | 表示最大纬度信息。 | -| maxLongitude | number | 否 | 表示最大经度信息。 | +| locale | string | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 | +| description | number | 是 | 表示位置信息描述，如“上海市浦东新区xx路xx号”。 | +| maxItems | number | 否 | 表示返回位置信息的最大个数。 | +| minLatitude | number | 否 | 表示最小纬度信息，与下面三个参数一起，表示一个经纬度范围。 | +| minLongitude | number | 否 | 表示最小经度信息。 | +| maxLatitude | number | 否 | 表示最大纬度信息。 | +| maxLongitude | number | 否 | 表示最大经度信息。 | ## GeoAddress 地理编码类型。 - | 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| latitude | number | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。 | -| longitude | number | 否 | 表示经度信息，正值表示东经，负值表是西经。 | -| locale | string | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 | -| placeName | string | 否 | 表示地区信息。 | -| countryCode | string | 否 | 表示国家码信息。 | -| countryName | string | 否 | 表示国家信息。 | -| administrativeArea | string | 否 | 表示省份区域信息。 | -| subAdministrativeArea | string | 否 | 表示表示子区域信息。 | -| locality | string | 否 | 表示城市信息。 | -| subLocality | string | 否 | 表示子城市信息。 | -| roadName | string | 否 | 表示路名信息。 | -| subRoadName | string | 否 | 表示子路名信息。 | -| premises | string | 否 | 表示门牌号信息。 | -| postalCode | string | 否 | 表示邮政编码信息。 | -| phoneNumber | string | 否 | 表示联系方式信息。 | -| addressUrl | string | 否 | 表示位置信息附件的网址信息。 | -| descriptions | Array<string> | 否 | 表示附加的描述信息。 | -| descriptionsSize | number | 否 | 表示附加的描述信息数量。 | +| latitude | number | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。 | +| longitude | number | 否 | 表示经度信息，正值表示东经，负值表是西经。 | +| locale | string | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 | +| placeName | string | 否 | 表示地区信息。 | +| countryCode | string | 否 | 表示国家码信息。 | +| countryName | string | 否 | 表示国家信息。 | +| administrativeArea | string | 否 | 表示省份区域信息。 | +| subAdministrativeArea | string | 否 | 表示表示子区域信息。 | +| locality | string | 否 | 表示城市信息。 | +| subLocality | string | 否 | 表示子城市信息。 | +| roadName | string | 否 | 表示路名信息。 | +| subRoadName | string | 否 | 表示子路名信息。 | +| premises | string | 否 | 表示门牌号信息。 | +| postalCode | string | 否 | 表示邮政编码信息。 | +| phoneNumber | string | 否 | 表示联系方式信息。 | +| addressUrl | string | 否 | 表示位置信息附件的网址信息。 | +| descriptions | Array<string> | 否 | 表示附加的描述信息。 | +| descriptionsSize | number | 否 | 表示附加的描述信息数量。 | ## LocationRequest 位置信息请求类型。 - | 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| priority | [LocationRequestPriority](#locationrequestpriority) | 否 | 表示优先级信息。 | -| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 表示场景信息。 | -| timeInterval | number | 否 | 表示上报位置信息的时间间隔。 | -| distanceInterval | number | 否 | 表示上报位置信息的距离间隔。 | -| maxAccuracy | number | 否 | 表示精度信息。 | +| priority | [LocationRequestPriority](#locationrequestpriority) | 否 | 表示优先级信息。 | +| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 表示场景信息。 | +| timeInterval | number | 否 | 表示上报位置信息的时间间隔。 | +| distanceInterval | number | 否 | 表示上报位置信息的距离间隔。 | +| maxAccuracy | number | 否 | 表示精度信息。 | ## CurrentLocationRequest 当前位置信息请求类型。 - | 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| priority | [LocationRequestPriority](#locationrequestpriority) | 否 | 表示优先级信息。 | -| scenario | [LocationRequestScenario](#locationrequestscenario) | 否 | 表示场景信息。 | -| maxAccuracy | number | 否 | 表示精度信息，单位是米。 | -| timeoutMs | number | 否 | 表示超时时间，单位是毫秒，最小为1000毫秒。 | +| priority | [LocationRequestPriority](#locationrequestpriority) | 否 | 表示优先级信息。 | +| scenario | [LocationRequestScenario](#locationrequestscenario) | 否 | 表示场景信息。 | +| maxAccuracy | number | 否 | 表示精度信息，单位是米。 | +| timeoutMs | number | 否 | 表示超时时间，单位是毫秒，最小为1000毫秒。 | ## SatelliteStatusInfo 卫星状态信息。 - | 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| satellitesNumber | number | 是 | 表示卫星个数。 | -| satelliteIds | Array<number> | 是 | 表示每个卫星的ID，数组类型。 | -| carrierToNoiseDensitys | Array<number> | 是 | 表示载波噪声功率谱密度比，即cn0。 | -| altitudes | Array<number> | 是 | 表示高程信息。 | -| azimuths | Array<number> | 是 | 表示方位角。 | -| carrierFrequencies | Array<number> | 是 | 表示载波频率。 | +| satellitesNumber | number | 是 | 表示卫星个数。 | +| satelliteIds | Array<number> | 是 | 表示每个卫星的ID，数组类型。 | +| carrierToNoiseDensitys | Array<number> | 是 | 表示载波噪声功率谱密度比，即cn0。 | +| altitudes | Array<number> | 是 | 表示高程信息。 | +| azimuths | Array<number> | 是 | 表示方位角。 | +| carrierFrequencies | Array<number> | 是 | 表示载波频率。 | ## CachedGnssLocationsRequest 请求订阅GNSS缓存位置上报功能接口的配置参数。 - | 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| reportingPeriodSec | number | 是 | 表示GNSS缓存位置上报的周期，单位是毫秒。 | -| wakeUpCacheQueueFull | boolean | 是 | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片，并把缓存位置上报给应用。
false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片，会把缓存位置直接丢弃。 | +| reportingPeriodSec | number | 是 | 表示GNSS缓存位置上报的周期，单位是毫秒。 | +| wakeUpCacheQueueFull | boolean | 是 | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片，并把缓存位置上报给应用。
false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片，会把缓存位置直接丢弃。 | ## Geofence GNSS围栏的配置参数。目前只支持圆形围栏。 - | 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| latitude | number | 是 | 表示纬度。 | -| longitude | number | 是 | 表示经度。 | -| radius | number | 是 | 表示圆形围栏的半径。 | -| expiration | number | 是 | 围栏存活的时间，单位是毫秒。 | +| latitude | number | 是 | 表示纬度。 | +| longitude | number | 是 | 表示经度。 | +| radius | number | 是 | 表示圆形围栏的半径。 | +| expiration | number | 是 | 围栏存活的时间，单位是毫秒。 | ## GeofenceRequest 请求添加GNSS围栏消息中携带的参数，包括定位优先级、定位场景和围栏信息。 - | 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| priority | LocationRequestPriority | 是 | 表示位置信息优先级。 | -| scenario | LocationRequestScenario | 是 | 表示定位场景。 | -| geofence | Geofence | 是 | 表示围栏信息。 | +| priority | LocationRequestPriority | 是 | 表示位置信息优先级。 | +| scenario | LocationRequestScenario | 是 | 表示定位场景。 | +| geofence | Geofence | 是 | 表示围栏信息。 | ## LocationPrivacyType 定位服务隐私协议类型。 - | 名称 | 默认值 | 说明 | +| 名称 | 默认值 | 说明 | | -------- | -------- | -------- | -| OTHERS | 0 | 其他场景。 | -| STARTUP | 1 | 开机向导场景下的隐私协议。 | -| CORE_LOCATION | 2 | 开启网络定位时弹出的隐私协议。 | +| OTHERS | 0 | 其他场景。 | +| STARTUP | 1 | 开机向导场景下的隐私协议。 | +| CORE_LOCATION | 2 | 开启网络定位时弹出的隐私协议。 | ## LocationCommand 扩展命令结构体。 - | 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| scenario | LocationRequestScenario | 是 | 表示定位场景。 | -| command | string | 是 | 扩展命令字符串。 | +| scenario | LocationRequestScenario | 是 | 表示定位场景。 | +| command | string | 是 | 扩展命令字符串。 | ## Location 位置信息类型。 - | 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| latitude | number | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 | -| longitude | number | 是 | 表示经度信息，正值表示东经，负值表是西经。 | -| altitude | number | 是 | 表示高度信息，单位米。 | -| accuracy | number | 是 | 表示精度信息，单位米。 | -| speed | number | 是 | 表示速度信息，单位米每秒。 | -| timeStamp | number | 是 | 表示位置时间戳，UTC格式。 | -| direction | number | 是 | 表示航向信息。 | -| timeSinceBoot | number | 是 | 表示位置时间戳，开机时间格式。 | -| additions | Array<string> | 否 | 附加信息。 | -| additionSize | number | 否 | 附加信息数量。 | +| latitude | number | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 | +| longitude | number | 是 | 表示经度信息，正值表示东经，负值表是西经。 | +| altitude | number | 是 | 表示高度信息，单位米。 | +| accuracy | number | 是 | 表示精度信息，单位米。 | +| speed | number | 是 | 表示速度信息，单位米每秒。 | +| timeStamp | number | 是 | 表示位置时间戳，UTC格式。 | +| direction | number | 是 | 表示航向信息。 | +| timeSinceBoot | number | 是 | 表示位置时间戳，开机时间格式。 | +| additions | Array<string> | 否 | 附加信息。 | +| additionSize | number | 否 | 附加信息数量。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-request.md b/zh-cn/application-dev/reference/apis/js-apis-request.md index 4a7f928077f178e713b4b021975780efad122e5f..b853b07257218d22fba3b6b2067109942c6b5dc5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-request.md +++ b/zh-cn/application-dev/reference/apis/js-apis-request.md @@ -1,4 +1,4 @@ -# 上传下载 +# 上传下载(新) > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-configuration.md b/zh-cn/application-dev/reference/apis/js-apis-system-configuration.md index d7543663552ae46b61a584e939b6a426253e5795..d1a5500065c2132b722ad901faf03c2c569f40e6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-configuration.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-configuration.md @@ -1,7 +1,7 @@ # 应用配置 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> - 从API Version 7 开始，该接口不再维护，推荐使用新接口['@ohos.i18n'](js-apis-i18n.md)和['@ohos.intl'](js-apis-intl.md)。 +> - 从API Version 7 开始，该接口不再维护，推荐使用新接口['@ohos.i18n'](https://developer.harmonyos.com/cn/docs/documentation/doc-references/js-apis-i18n-0000001155058572)和['@ohos.intl'](https://developer.harmonyos.com/cn/docs/documentation/doc-references/js-apis-intl-0000001200978209)。 > > > - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-time.md b/zh-cn/application-dev/reference/apis/js-apis-system-time.md index f19a8fb1cfb80abbf91af7a5e1721cc7a7f563f3..b2389c5b57ddc4471e5c53894b49eb2771fef593 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-time.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-time.md @@ -6,7 +6,7 @@ ## 导入模块 - + ``` import systemTime from '@ohos.systemTime'; ``` @@ -29,7 +29,7 @@ setTime(time : number, callback : AsyncCallback<void>) : void | callback | AsyncCallback<void> | 是 | 回调函数，可以在回调函数中处理接口返回值。 | - 示例： - + ``` // time对应的时间为2021-01-20 02:36:25 var time = 1611081385000; @@ -64,7 +64,7 @@ setTime(time : number) : Promise<void> | Promise<void> | 返回的异步回调函数。 | - 示例： - + ``` // time对应的时间为2021-01-20 02:36:25 var time = 1611081385000; @@ -91,7 +91,7 @@ getCurrentTime(isNano?: boolean, callback: AsyncCallback<number>): void | callback | AsyncCallback<number> | 是 | 回调函数，返回自 Unix 纪元以来经过的时间。 | - 示例： - + ``` systemTime.getCurrentTime(true, (error, data) => { if (error) { @@ -122,7 +122,7 @@ getCurrentTime(isNano?: boolean): Promise<number> | Promise<number> | 以Promise形式返回结果，返回自 Unix 纪元以来经过的时间。 | - 示例： - + ``` systemTime.getCurrentTime().then((data) => { console.log(`systemTime.getCurrentTime success data : ` + JSON.stringify(data)); @@ -147,7 +147,7 @@ getRealActiveTime(isNano?: boolean, callback: AsyncCallback<number>): void | callback | AsyncCallback<number> | 是 | 回调函数，返回自系统启动以来但不包括度睡眠时间经过的时间。 | - 示例： - + ``` systemTime.getRealActiveTime(true, (error, data) => { if (error) { @@ -178,7 +178,7 @@ getRealActiveTime(isNano?: boolean): Promise<number> | Promise<number> | 以Promise形式返回结果，返回自系统启动以来但不包括度睡眠时间经过的时间。 | - 示例： - + ``` systemTime.getCurrentTime().then((data) => { console.log(`systemTime.getRealActiveTime success data : ` + JSON.stringify(data)); @@ -203,7 +203,7 @@ getRealTime(callback: AsyncCallback<number>): void | callback | AsyncCallback<number> | 是 | 回调函数，返回自系统启动以来包括深度睡眠时间经过的毫秒数。 | - 示例： - + ``` systemTime.getRealTime(true, (error, data) => { if (error) { @@ -234,7 +234,7 @@ getRealTime(): Promise<number> | Promise<number> | 以Promise形式返回结果，返回自系统启动以来包括深度睡眠时间经过的时间。 | - 示例： - + ``` systemTime.getRealTime().then((data) => { console.log(`systemTime.getRealTime success data: ` + JSON.stringify(data)); @@ -261,7 +261,7 @@ setDate(date: Date, callback: AsyncCallback<void>): void | callback | AsyncCallback<void> | 是 | 回调函数，可以在回调函数中处理接口返回值。 | - 示例： - + ``` var data = new Date("October 13, 2020 11:13:00"); systemTime.setDate(data,(error, data) => { @@ -295,7 +295,7 @@ setDate(date: Date): Promise<void> | Promise<void> | 返回的异步回调函数。 | - 示例： - + ``` var data = new Date("October 13, 2020 11:13:00"); systemTime.setDate(data).then((value) => { @@ -320,7 +320,7 @@ getDate(callback: AsyncCallback<Date>): void | callback | AsyncCallback<Date> | 是 | 回调函数，返回当前系统日期。 | - 示例： - + ``` systemTime.getDate((error, data) => { if (error) { @@ -346,7 +346,7 @@ getDate(): Promise<Date> | Promise<Date> | 以Promise形式返回结果，返回当前系统日期。 | - 示例： - + ``` systemTime.getDate().then((data) => { console.log(`systemTime.getDate success data : ` + JSON.stringify(data)); @@ -373,7 +373,7 @@ setTimezone(timezone: string, callback: AsyncCallback<void>): void | callback | AsyncCallback<void> | 是 | 回调函数，可以在回调函数中处理接口返回值。 | - 示例： - + ``` systemTime.setTimezone('Asia/Shanghai', (error, data) => { if (error) { @@ -406,7 +406,7 @@ setTimezone(timezone: string): Promise<void> | Promise<void> | 返回的异步回调函数。 | - 示例： - + ``` systemTime.setTimezone('Asia/Shanghai').then((data) => { console.log(`systemTime.setTimezone success data : ` + JSON.stringify(data)); @@ -430,7 +430,7 @@ getTimeZone(callback: AsyncCallback<string>): void | callback | AsyncCallback<string> | 是 | 回调函数，返回系统时区。 | - 示例： - + ``` systemTime.getTimeZone((error, data) => { if (error) { @@ -456,7 +456,7 @@ getTimeZone(): Promise<string> | Promise<string> | 以Promise形式返回结果，返回系统时区。 | - 示例： - + ``` systemTime.getDate().then((data) => { console.log(`systemTime.getTimeZone success data : ` + JSON.stringify(data)); diff --git a/zh-cn/application-dev/reference/apis/js-apis-volumemanager.md b/zh-cn/application-dev/reference/apis/js-apis-volumemanager.md index a11bb17eb929dde989a6f221f364ba9fcbb25e7c..55913343e0462c816c5592d07d09cc5b5d78cff5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-volumemanager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-volumemanager.md @@ -174,6 +174,6 @@ unmount(volumeId: string, callback:AsyncCallback<boolean>):void | id9+ | number | 卷id | | uuid9+ | string | 卷uuid | | description9+ | string | 卷相关描述 | -| removeAble9+ | boolean | 是否为可移动存储设备 | +| removable9+ | boolean | 是否为可移动存储设备 | | state9+ | int | 当前卷状态 | | path9+ | string | 卷的挂载地址 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md b/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md index 8224175b470f7c8538e2975274aa4c2a5a91046a..b2b623dc6f9c8018aeabb4528af605b5fb96730c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md +++ b/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md @@ -269,7 +269,6 @@ isLastWorkTimeOut(workId: number): Promise\ .catch(err => { console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.data); }); - }) ``` ## WorkInfo diff --git a/zh-cn/application-dev/reference/arkui-js/figures/transition.gif b/zh-cn/application-dev/reference/arkui-js/figures/transition.gif new file mode 100644 index 0000000000000000000000000000000000000000..1b1aacbf3092a0ed946ce477251e60a41b365774 Binary files /dev/null and b/zh-cn/application-dev/reference/arkui-js/figures/transition.gif differ diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-common-transition.md b/zh-cn/application-dev/reference/arkui-js/js-components-common-transition.md index bbf7ca807f64b5a8206a8f865dd8dcdda7bf6b06..8aefd3c4353327c655fe5bd0adcfa1ef8b5c32a9 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-common-transition.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-common-transition.md @@ -48,10 +48,8 @@ PageA跳转到PageB，跳转的共享元素为image， shareid为“shareImage
-
- - Click on picture to Jump to ths details -
+ + Click on picture to Jump to ths details
@@ -237,3 +235,145 @@ export default { b. back场景下：退出页面栈的Page2.js应用transition-enter描述的动画配置，并进行倒播；从页面栈第二位置进入栈顶位置的Page1.js应用transition-exit描述的动画配置，并进行倒播。 ![zh-cn_image_0000001238184345](figures/zh-cn_image_0000001238184345.png) + +### 示例 + +Page1有一个不透明盒子，点击盒子会跳转到Page2，当点击Page2中的盒子，会回退到Page1页面。 + +1. Page1 + + ``` + +
+ index +
+
+ ``` + + ``` + + import router from '@system.router'; + export default { + data: { + + }, + jump() { + router.push({ + uri:'pages/transition2/transition2' + }) + } + } + ``` + + ``` + + .container { + flex-direction: column; + justify-content: center; + align-items: center; + width: 100%; + height: 100%; + } + .move_page { + width: 100px; + height: 100px; + background-color: #72d3fa; + transition-enter: go_page; + transition-exit: exit_page; + transition-duration: 5s; + transition-timing-function: friction; + } + + @keyframes go_page { + from { + opacity: 0; + transform: translate(0px) rotate(60deg) scale(1.0); + } + + to { + opacity: 1; + transform: translate(100px) rotate(360deg) scale(1.0); + } + } + @keyframes exit_page { + from { + opacity: 1; + transform: translate(200px) rotate(60deg) scale(2); + } + + to { + opacity: 0; + transform: translate(200px) rotate(360deg) scale(2); + } + } + ``` + + + +2. Page2 + + ``` + +
+ transition +
+
+ import router from '@system.router'; + export default { + data: { + + }, + jumpBack() { + router.back() + } + } + ``` + + ``` + + .container { + flex-direction: column; + justify-content: center; + align-items: center; + width: 100%; + height: 100%; + } + + .move_page { + width: 100px; + height: 100px; + background-color: #f172fa; + transition-enter: go_page; + transition-exit: exit_page; + transition-duration: 5s; + transition-timing-function: ease; + } + + @keyframes go_page { + from { + opacity: 0; + transform:translate(100px) rotate(0deg) scale(1.0); + } + to { + opacity: 1; + transform:translate(100px) rotate(180deg) scale(2.0); + } + } + + @keyframes exit_page { + from { + opacity: 1; + transform: translate(0px) rotate(60deg) scale(1); + } + to { + opacity: 0; + transform: translate(0px) rotate(360deg) scale(1); + } + } + ``` + + ![transition](figures/transition.gif) diff --git a/zh-cn/application-dev/reference/arkui-ts/Readme-CN.md b/zh-cn/application-dev/reference/arkui-ts/Readme-CN.md index cfd6f34071a5c5a828d3c26f2f358292132103f1..fac811e748ba045bd78f38a530618f3aa24c10df 100644 --- a/zh-cn/application-dev/reference/arkui-ts/Readme-CN.md +++ b/zh-cn/application-dev/reference/arkui-ts/Readme-CN.md @@ -132,6 +132,7 @@ - [插值计算](ts-interpolation-calculation.md) - 全局UI方法 - [图片缓存](ts-methods-image-cache.md) + - [媒体查询](ts-methods-media-query.md) - 弹窗 - [警告弹窗](ts-methods-alert-dialog-box.md) - [列表选择弹窗](ts-methods-action-sheet.md) diff --git a/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md b/zh-cn/application-dev/reference/arkui-ts/ts-methods-media-query.md similarity index 100% rename from zh-cn/application-dev/reference/apis/js-apis-mediaquery.md rename to zh-cn/application-dev/reference/arkui-ts/ts-methods-media-query.md