From 7834b82ea5138214af0a944363ed5f9009a5e2f5 Mon Sep 17 00:00:00 2001 From: zengyawen Date: Tue, 14 Jun 2022 15:03:00 +0800 Subject: [PATCH] update docs Signed-off-by: zengyawen --- .../application-dev/ability/stage-ability.md | 28 ++++++++--------- zh-cn/application-dev/ability/stage-call.md | 6 ++-- .../database-relational-guidelines.md | 18 +++++------ .../application-dev/notification/Readme-CN.md | 2 +- ...fication.md => notification-guidelines.md} | 20 ++++++------- .../reference/apis/js-apis-Context.md | 6 ++-- .../reference/apis/js-apis-audio.md | 2 +- .../reference/apis/js-apis-bluetooth.md | 10 +++---- .../reference/apis/js-apis-cardEmulation.md | 2 +- .../apis/js-apis-dataAbilityHelper.md | 4 +-- .../reference/apis/js-apis-inputdevice.md | 20 ++++++------- .../reference/apis/js-apis-media.md | 6 ++-- .../reference/apis/js-apis-medialibrary.md | 2 +- .../reference/apis/js-apis-prompt.md | 2 +- zh-cn/application-dev/ui/js-framework-file.md | 4 +-- .../work-scheduler-dev-guide.md | 30 +++++++++---------- 16 files changed, 80 insertions(+), 82 deletions(-) rename zh-cn/application-dev/notification/{notification.md => notification-guidelines.md} (92%) diff --git a/zh-cn/application-dev/ability/stage-ability.md b/zh-cn/application-dev/ability/stage-ability.md index 35afcbc9dc..373d4100cc 100644 --- a/zh-cn/application-dev/ability/stage-ability.md +++ b/zh-cn/application-dev/ability/stage-ability.md @@ -78,29 +78,29 @@ Ability功能如下（Ability类，具体的API详见[接口文档](../reference onCreate(want, launchParam) { console.log("MainAbility onCreate") } - + onDestroy() { console.log("MainAbility onDestroy") } - + onWindowStageCreate(windowStage) { console.log("MainAbility onWindowStageCreate") - + windowStage.loadContent("pages/index").then((data) => { console.log("MainAbility load content succeed with data: " + JSON.stringify(data)) }).catch((error) => { console.error("MainAbility load content failed with error: " + JSON.stringify(error)) }) } - + onWindowStageDestroy() { console.log("MainAbility onWindowStageDestroy") } - + onForeground() { console.log("MainAbility onForeground") } - + onBackground() { console.log("MainAbility onBackground") } @@ -210,14 +210,14 @@ Ability类拥有context属性，context属性为AbilityContext类，AbilityConte **表3** AbilityContext API接口功能介绍 |接口名|描述| |:------|:------| -|startAbility(want: Want, callback: AsyncCallback): void|启动Ability。| -|startAbility(want: Want, options?: StartOptions): Promise|启动Ability。| -|startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback): void|带AccountId启动Ability。| -|startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): Promise|带AccountId启动Ability。| -|startAbilityForResult(want: Want, callback: AsyncCallback): void|带返回结果启动Ability。| -|startAbilityForResult(want: Want, options?: StartOptions): Promise|带返回结果启动Ability。| -|startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncCallback): void|带返回结果及AccountId启动Ability。| -|startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartOptions): Promise|带返回结果及AccountId启动Ability。| +|startAbility(want: Want, callback: AsyncCallback\): void|启动Ability。| +|startAbility(want: Want, options?: StartOptions): Promise\|启动Ability。| +|startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\): void|带AccountId启动Ability。| +|startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): Promise\|带AccountId启动Ability。| +|startAbilityForResult(want: Want, callback: AsyncCallback\): void|带返回结果启动Ability。| +|startAbilityForResult(want: Want, options?: StartOptions): Promise\|带返回结果启动Ability。| +|startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncCallback\): void|带返回结果及AccountId启动Ability。| +|startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartOptions): Promise\|带返回结果及AccountId启动Ability。| ### 相同设备启动Ability 应用可以通过`this.context`获取Ability实例的上下文，进而使用AbilityContext中的StartAbility相关接口启动Ability。启动Ability可指定Want、StartOptions、accountId，通过callback形式或promise形式实现。具体示例代码如下： ```ts diff --git a/zh-cn/application-dev/ability/stage-call.md b/zh-cn/application-dev/ability/stage-call.md index fcd2bd8eaf..70a004b2da 100644 --- a/zh-cn/application-dev/ability/stage-call.md +++ b/zh-cn/application-dev/ability/stage-call.md @@ -18,11 +18,11 @@ Caller及Callee功能如下：具体的API详见[接口文档](../reference/apis **表1** Call API接口功能介绍 |接口名|描述| |:------|:------| -|startAbilityByCall(want: Want): Promise|获取指定通用组件的Caller通信接口，拉起指定通用组件并将其切换到后台。| +|startAbilityByCall(want: Want): Promise\|获取指定通用组件的Caller通信接口，拉起指定通用组件并将其切换到后台。| |on(method: string, callback: CaleeCallBack): void|通用组件Callee注册method对应的callback方法。| |off(method: string): void|通用组件Callee去注册method的callback方法。| -|call(method: string, data: rpc.Sequenceable): Promise|向通用组件Callee发送约定序列化数据。| -|callWithResult(method: string, data: rpc.Sequenceable): Promise|向通用组件Callee发送约定序列化数据, 并将返回的约定序列化数据带回。| +|call(method: string, data: rpc.Sequenceable): Promise\|向通用组件Callee发送约定序列化数据。| +|callWithResult(method: string, data: rpc.Sequenceable): Promise\|向通用组件Callee发送约定序列化数据, 并将返回的约定序列化数据带回。| |release(): void|释放通用组件的Caller通信接口。| |onRelease(callback: OnReleaseCallBack): void|注册通用组件通信断开监听通知。| diff --git a/zh-cn/application-dev/database/database-relational-guidelines.md b/zh-cn/application-dev/database/database-relational-guidelines.md index 4f138c04f8..6c8fd5d914 100644 --- a/zh-cn/application-dev/database/database-relational-guidelines.md +++ b/zh-cn/application-dev/database/database-relational-guidelines.md @@ -81,7 +81,7 @@ | 类名 | 接口名 | 描述 | | -------- | -------- | -------- | -| RdbPredicates |inDevices(devices: Array): RdbPredicates | 同步分布式数据库时指定组网内的远程设备。
- devices：组网内指定的远程设备ID。
- RdbPredicates：返回与指定字段匹配的谓词。 | +| RdbPredicates |inDevices(devices: Array\): RdbPredicates | 同步分布式数据库时指定组网内的远程设备。
- devices：组网内指定的远程设备ID。
- RdbPredicates：返回与指定字段匹配的谓词。 | | RdbPredicates |inAllDevices(): RdbPredicates | 同步分布式数据库时连接到组网内的所有远程设备。
- RdbPredicates：返回与指定字段匹配的谓词。 | | RdbPredicates | equalTo(field: string, value: ValueType): RdbPredicates | 配置谓词以匹配数据字段为ValueType且值等于指定值的字段。
- field：数据库表中的列名。
- value：指示要与谓词匹配的值。
- RdbPredicates：返回与指定字段匹配的谓词。 | | RdbPredicates | notEqualTo(field: string, value: ValueType): RdbPredicates | 配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。
- field：数据库表中的列名。
- value：指示要与谓词匹配的值。
- RdbPredicates：返回与指定字段匹配的谓词。 | @@ -149,8 +149,8 @@ | 类名 | 接口名 | 描述 | | -------- | -------- | -------- | -| RdbStore | setDistributedTables(tables: Array, callback: AsyncCallback): void;| 设置分布式列表，结果以callback形式返回。
- tables：要设置的分布式列表表名。
- callback：指定callback回调函数。 | -| RdbStore | setDistributedTables(tables: Array): Promise; | 设置分布式列表，结果以Promise形式返回。
- tables：要设置的分布式列表表名。 | +| RdbStore | setDistributedTables(tables: Array\, callback: AsyncCallback\): void; | 设置分布式列表，结果以callback形式返回。
- tables：要设置的分布式列表表名。
- callback：指定callback回调函数。 | +| RdbStore | setDistributedTables(tables: Array\): Promise\; | 设置分布式列表，结果以Promise形式返回。
- tables：要设置的分布式列表表名。 | **根据本地表名获取指定远程设备的分布式表名** @@ -160,8 +160,8 @@ | 类名 | 接口名 | 描述 | | -------- | -------- | -------- | -| RdbStore | obtainDistributedTableName(device: string, table: string, callback: AsyncCallback): void; | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名, 结果以callback形式返回。
- device：远程设备。
- table：本地表名。
- callback：指定的callback回调函数，如果操作成功，返回远程设备的分布式表名。 | -| RdbStore | obtainDistributedTableName(device: string, table: string): Promise; | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名，结果以Promise形式返回。
- device：远程设备。
- table：本地表名。 | +| RdbStore | obtainDistributedTableName(device: string, table: string, callback: AsyncCallback\): void; | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名, 结果以callback形式返回。
- device：远程设备。
- table：本地表名。
- callback：指定的callback回调函数，如果操作成功，返回远程设备的分布式表名。 | +| RdbStore | obtainDistributedTableName(device: string, table: string): Promise\; | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名，结果以Promise形式返回。
- device：远程设备。
- table：本地表名。 | **在设备之间同步数据** @@ -169,8 +169,8 @@ | 类名 | 接口名 | 描述 | | -------- | -------- | -------- | -| RdbStore | sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback>): void;| 在设备之间同步数据，结果以callback形式返回。
- mode：指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备；SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。
- predicates：约束同步数据和设备。
- callback：指定的callback回调函数，string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 | -| RdbStore | sync(mode: SyncMode, predicates: RdbPredicates): Promise>;| 在设备之间同步数据，结果以Promise形式返回。
- mode：指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备；SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。
- predicates：约束同步数据和设备。 | +| RdbStore | sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback\>): void; | 在设备之间同步数据，结果以callback形式返回。
- mode：指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备；SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。
- predicates：约束同步数据和设备。
- callback：指定的callback回调函数，string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 | +| RdbStore | sync(mode: SyncMode, predicates: RdbPredicates): Promise\>; | 在设备之间同步数据，结果以Promise形式返回。
- mode：指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备；SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。
- predicates：约束同步数据和设备。 | **注册数据库的观察者** @@ -178,7 +178,7 @@ | 类名 | 接口名 | 描述 | | -------- | -------- | -------- | -| RdbStore |on(event: 'dataChange', type: SubscribeType, observer: Callback>): void;| 注册数据库的观察者。当分布式数据库中的数据发生更改时，将调用回调。
- type：指在{@code SubscribeType}中定义的订阅类型；SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。
- observer：指分布式数据库中数据更改事件的观察者。 | +| RdbStore |on(event: 'dataChange', type: SubscribeType, observer: Callback\>): void;| 注册数据库的观察者。当分布式数据库中的数据发生更改时，将调用回调。
- type：指在{@code SubscribeType}中定义的订阅类型；SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。
- observer：指分布式数据库中数据更改事件的观察者。 | **从数据库中删除指定类型的指定观察者** @@ -186,7 +186,7 @@ | 类名 | 接口名 | 描述 | | -------- | -------- | -------- | -| RdbStore |off(event:'dataChange', type: SubscribeType, observer: Callback>): void;| 从数据库中删除指定类型的指定观察者，结果以callback形式返回。
- type：指在{@code SubscribeType}中定义的订阅类型；SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。
- observer：指已注册的数据更改观察者。 | +| RdbStore |off(event:'dataChange', type: SubscribeType, observer: Callback\>): void;| 从数据库中删除指定类型的指定观察者，结果以callback形式返回。
- type：指在{@code SubscribeType}中定义的订阅类型；SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。
- observer：指已注册的数据更改观察者。 | ## 开发步骤 diff --git a/zh-cn/application-dev/notification/Readme-CN.md b/zh-cn/application-dev/notification/Readme-CN.md index e6770f56e7..02b3a06e41 100644 --- a/zh-cn/application-dev/notification/Readme-CN.md +++ b/zh-cn/application-dev/notification/Readme-CN.md @@ -2,5 +2,5 @@ - [公共事件与通知概述](notification-brief.md) - [公共事件开发指导](common-event.md) -- [通知开发指导](notification.md) +- [通知开发指导](notification-guidelines.md) - [调试助手使用指导](assistant-guidelines.md) \ No newline at end of file diff --git a/zh-cn/application-dev/notification/notification.md b/zh-cn/application-dev/notification/notification-guidelines.md similarity index 92% rename from zh-cn/application-dev/notification/notification.md rename to zh-cn/application-dev/notification/notification-guidelines.md index 98e57bbccd..063b0e3cc7 100644 --- a/zh-cn/application-dev/notification/notification.md +++ b/zh-cn/application-dev/notification/notification-guidelines.md @@ -1,6 +1,6 @@ -# Notification开发指导 +# 通知开发指导 ## 场景简介 @@ -34,8 +34,8 @@ OpenHarmony通过ANS（Advanced Notification Service，通知系统服务）对 | 接口名 | 描述 | | ------------------------------------------------------------ | ---------------- | -| isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback): void | 查询通知使能开关 | -| enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback): void | 设置使能开关 | +| isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback\): void | 查询通知使能开关 | +| enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback\): void | 设置使能开关 | 用于查询和设置通知使能开关，若某个应用的通知使能关闭状态，则无法发送通知。 @@ -45,9 +45,9 @@ OpenHarmony通过ANS（Advanced Notification Service，通知系统服务）对 | 接口名 | 描述 | | ------------------------------------------------------------ | ---------------- | -| subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback): void | 订阅指定应用通知 | -| subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback): void | 订阅所有通知 | -| unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback): void | 取消订阅通知 | +| subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback\): void | 订阅指定应用通知 | +| subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\): void | 订阅所有通知 | +| unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\): void | 取消订阅通知 | 订阅接口有支持订阅所有通知、或订阅某些应用的通知。 @@ -69,10 +69,10 @@ OpenHarmony通过ANS（Advanced Notification Service，通知系统服务）对 | 接口名 | 描述 | | ------------------------------------------------------------ | ------------------------ | -| publish(request: NotificationRequest, callback: AsyncCallback): void | 发布通知 | -| publish(request: NotificationRequest, userId: number, callback: AsyncCallback): void | 指定用户发布通知 | -| cancel(id: number, label: string, callback: AsyncCallback): void | 取消指定的通知 | -| cancelAll(callback: AsyncCallback): void; | 取消所有该应用发布的通知 | +| publish(request: NotificationRequest, callback: AsyncCallback\): void | 发布通知 | +| publish(request: NotificationRequest, userId: number, callback: AsyncCallback\): void | 指定用户发布通知 | +| cancel(id: number, label: string, callback: AsyncCallback\): void | 取消指定的通知 | +| cancelAll(callback: AsyncCallback\): void; | 取消所有该应用发布的通知 | 携带userId的publish接口，可以指定向该用户下订阅者发布通知。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-Context.md b/zh-cn/application-dev/reference/apis/js-apis-Context.md index 102dfcfbff..55a083dbbd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-Context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-Context.md @@ -931,9 +931,9 @@ Hap模块信息 | iconId | number | 是 | 否 | 模块图标ID。 | | backgroundImg | string | 是 | 否 | 模块背景图片。 | | supportedModes | number | 是 | 否 | 模块支持的模式。 | -| reqCapabilities | Array | 是 | 否 | 模块运行需要的能力。 | -| deviceTypes | Array | 是 | 否 | 支持运行的设备类型。 | -| abilityInfo | Array | 是 | 否 | Ability信息。 | +| reqCapabilities | Array\ | 是 | 否 | 模块运行需要的能力。 | +| deviceTypes | Array\ | 是 | 否 | 支持运行的设备类型。 | +| abilityInfo | Array\ | 是 | 否 | Ability信息。 | | moduleName | string | 是 | 否 | 模块名。 | | mainAbilityName | string | 是 | 否 | 入口Ability名称。 | | installationFree | boolean | 是 | 否 | 是否支持免安装。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-audio.md b/zh-cn/application-dev/reference/apis/js-apis-audio.md index 36c8c33285..2dd90c67ae 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-audio.md +++ b/zh-cn/application-dev/reference/apis/js-apis-audio.md @@ -542,7 +542,7 @@ audio.createAudioCapturer(audioCapturerOptions).then((data) => { | ---------- | ------------------------------------------- | ---- | ------------------------------------------------------------ | | actionType | [InterruptActionType](#interruptactiontype) | 是 | 事件返回类型。TYPE_ACTIVATED为焦点触发事件，TYPE_INTERRUPT为音频打断事件。 | | type | [InterruptType](#interrupttype) | 否 | 打断事件类型。 | -| hint | [InterruptHint](interrupthint) | 否 | 打断事件提示。 | +| hint | [InterruptHint](#interrupthint) | 否 | 打断事件提示。 | | activated | boolean | 否 | 获得/释放焦点。true表示焦点获取/释放成功，false表示焦点获得/释放失败。 | ## VolumeEvent8+ diff --git a/zh-cn/application-dev/reference/apis/js-apis-bluetooth.md b/zh-cn/application-dev/reference/apis/js-apis-bluetooth.md index c14aec4b23..a0dfb7d276 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bluetooth.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bluetooth.md @@ -720,7 +720,7 @@ bluetooth.off('stateChange', onReceiveEvent); ``` -## bluetooth.sppListen8+ +## bluetooth.sppListen8+ sppListen(name: string, option: SppOption, callback: AsyncCallback<number>): void @@ -1330,7 +1330,7 @@ let ret = a2dpSrc.getDeviceState('XX:XX:XX:XX:XX:XX'); 使用A2dpSourceProfile方法之前需要创建该类的实例进行操作，通过getProfile()方法构造此实例。 -### connect8+ +### connect8+ connect(device: string): boolean @@ -1360,7 +1360,7 @@ let ret = a2dpSrc.connect('XX:XX:XX:XX:XX:XX'); ``` -### disconnect8+ +### disconnect8+ disconnect(device: string): boolean @@ -1484,7 +1484,7 @@ let state = a2dpSrc.getPlayingState('XX:XX:XX:XX:XX:XX'); 使用HandsFreeAudioGatewayProfile方法之前需要创建该类的实例进行操作，通过getProfile()方法构造此实例。 -### connect8+ +### connect8+ connect(device: string): boolean @@ -1514,7 +1514,7 @@ let ret = hfpAg.connect('XX:XX:XX:XX:XX:XX'); ``` -### disconnect8+ +### disconnect8+ disconnect(device: string): boolean diff --git a/zh-cn/application-dev/reference/apis/js-apis-cardEmulation.md b/zh-cn/application-dev/reference/apis/js-apis-cardEmulation.md index 94eab26a01..26d43c3715 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-cardEmulation.md +++ b/zh-cn/application-dev/reference/apis/js-apis-cardEmulation.md @@ -6,7 +6,7 @@ > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -## **导入模块** +## 导入模块 ``` import cardEmulation from '@ohos.nfc.cardEmulation'; diff --git a/zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md b/zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md index 6c45b1da71..a18629eaec 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md +++ b/zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md @@ -891,7 +891,7 @@ call(uri: string, method: string, arg: string, extras: PacMap): Promise\ | 类型 | 说明 | |------ | ------- | -|Promise<[PacMap](#pacmap)> | 调用的返回值。 | +|Promise\<[PacMap](#pacmap)> | 调用的返回值。 | **示例：** @@ -922,7 +922,7 @@ call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCa | method | string | 是 | 被调用的方法名。 | | arg | string | 是 |需传入的参数。 | | extras | [PacMap](#pacmap) | 是 | 键值对参数。 | -| callback | AsyncCallback<[PacMap](#pacmap)> | 是 | 返回值。 | +| callback | AsyncCallback\<[PacMap](#pacmap)> | 是 | 返回值。 | **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md b/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md index eb03a50e85..d1b12cce4c 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md @@ -104,7 +104,7 @@ inputDevice.getDeviceIds((ids)=>{ ## inputDevice.getDeviceIds -function getDeviceIds(): Promise<<Array<number>> +getDeviceIds(): Promise<Array<number>> 获取所有输入设备的id列表，使用Promise方式作为异步方法。 @@ -150,7 +150,7 @@ inputDevice.getDevice(1, (inputDevice)=>{ ## inputDevice.getDevice -function getDevice(deviceId: number): Promise<InputDeviceData> +getDevice(deviceId: number): Promise<InputDeviceData> 获取输入设备的描述信息，使用Promise方式作为异步方法。 @@ -333,15 +333,15 @@ inputDevice.getKeyboardType(1).then((ret)=>{ **系统能力**： 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice -| 名称 | 参数类型 | 说明 | -| ----------------------- | ------------------------- | -------- | +| 名称 | 参数类型 | 说明 | +| ----------------------- | ------------------------- | ---------------- | | source | [SourceType](#sourcetype) | 轴的输入源类型。 | -| axis | [AxisType](axistype) | 轴的类型。 | -| max | number | 轴的最大值。 | -| min | number | 轴的最小值。 | -| fuzz9+ | number | 轴的模糊值。 | -| flat9+ | number | 轴的基准值。 | -| resolution9+ | number | 轴的分辨率。 | +| axis | [AxisType](#axistype) | 轴的类型。 | +| max | number | 轴的最大值。 | +| min | number | 轴的最小值。 | +| fuzz9+ | number | 轴的模糊值。 | +| flat9+ | number | 轴的基准值。 | +| resolution9+ | number | 轴的分辨率。 | ## SourceType diff --git a/zh-cn/application-dev/reference/apis/js-apis-media.md b/zh-cn/application-dev/reference/apis/js-apis-media.md index 0898dfb598..72ad650db4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-media.md +++ b/zh-cn/application-dev/reference/apis/js-apis-media.md @@ -716,9 +716,9 @@ setDisplaySurface(surfaceId: string): Promise\ **返回值：** -| 类型 | 说明 | -| ------------- | ------------------------------ | -| Promise | 设置SurfaceId的Promise返回值。 | +| 类型 | 说明 | +| -------------- | ------------------------------ | +| Promise\ | 设置SurfaceId的Promise返回值。 | **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md index e6cf83e6a4..8986ce0dba 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -1956,7 +1956,7 @@ async function example() { 实体相册 -### **属性** +### 属性 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core diff --git a/zh-cn/application-dev/reference/apis/js-apis-prompt.md b/zh-cn/application-dev/reference/apis/js-apis-prompt.md index 1523a09d8b..475fd483ad 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-prompt.md +++ b/zh-cn/application-dev/reference/apis/js-apis-prompt.md @@ -208,7 +208,7 @@ showActionMenu(options: ActionMenuOptions, callback: AsyncCallback<ActionMenu ## prompt.showActionMenu -showActionMenu(options: ActionMenuOptions): Promise +showActionMenu(options: ActionMenuOptions): Promise\ 创建并显示操作菜单，菜单响应后同步返回结果。 diff --git a/zh-cn/application-dev/ui/js-framework-file.md b/zh-cn/application-dev/ui/js-framework-file.md index 37a9ceb6e5..983b0f4bf4 100644 --- a/zh-cn/application-dev/ui/js-framework-file.md +++ b/zh-cn/application-dev/ui/js-framework-file.md @@ -22,13 +22,13 @@ JS FA应用的JS模块(entry/src/main/js/module)的典型开发目录结构如 各个文件夹的作用： -- app.js文件用于全局JavaScript逻辑和应用生命周期管理，详见[app.js](../ui/js-framework-js-file.md)。 +- app.js文件用于全局JavaScript逻辑和应用生命周期管理，详见[app.js](js-framework-js-file.md)。 - pages目录用于存放所有组件页面。 - common目录用于存放公共资源文件，比如：媒体资源，自定义组件和JS文件。 -- resources目录用于存放资源配置文件，比如：多分辨率加载等配置文件，详见[资源限定与访问](../ui/js-framework-resource-restriction.md)章节。 +- resources目录用于存放资源配置文件，比如：多分辨率加载等配置文件，详见[资源限定与访问](js-framework-resource-restriction.md)章节。 - share目录用于配置多个实例共享的资源内容，比如：share中的图片和JSON文件可被default1和default2实例共享。 diff --git a/zh-cn/application-dev/work-scheduler/work-scheduler-dev-guide.md b/zh-cn/application-dev/work-scheduler/work-scheduler-dev-guide.md index 487c4df11b..37f7435c0c 100644 --- a/zh-cn/application-dev/work-scheduler/work-scheduler-dev-guide.md +++ b/zh-cn/application-dev/work-scheduler/work-scheduler-dev-guide.md @@ -22,15 +22,15 @@ import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility'; 接口名 | 接口描述 ---------------------------------------------------------|----------------------------------------- -function startWork(work: WorkInfo): boolean; | 延迟调度任务申请 -function stopWork(work: WorkInfo, needCancel?: boolean): boolean; | 延迟调度任务取消 -function getWorkStatus(workId: number, callback: AsyncCallback): void;| 获取延迟调度任务状态（Callback形式） -function getWorkStatus(workId: number): Promise; | 获取延迟调度任务状态（Promise形式） -function obtainAllWorks(callback: AsyncCallback): Array;| 获取所有延迟调度任务（Callback形式） -function obtainAllWorks(): Promise>;| 获取所有延迟调度任务（Promise形式） -function stopAndClearWorks(): boolean;| 停止并清除任务 -function isLastWorkTimeOut(workId: number, callback: AsyncCallback): boolean;| 获取上次任务是否超时（针对RepeatWork，Callback形式） -function isLastWorkTimeOut(workId: number): Promise;| 获取上次任务是否超时（针对RepeatWork，Promise形式） +startWork(work: WorkInfo): boolean; | 延迟调度任务申请 +stopWork(work: WorkInfo, needCancel?: boolean): boolean; | 延迟调度任务取消 +getWorkStatus(workId: number, callback: AsyncCallback\): void;| 获取延迟调度任务状态（Callback形式） +getWorkStatus(workId: number): Promise\; | 获取延迟调度任务状态（Promise形式） +obtainAllWorks(callback: AsyncCallback\): Array\;| 获取所有延迟调度任务（Callback形式） +obtainAllWorks(): Promise>;| 获取所有延迟调度任务（Promise形式） +stopAndClearWorks(): boolean;| 停止并清除任务 +isLastWorkTimeOut(workId: number, callback: AsyncCallback\): boolean;| 获取上次任务是否超时（针对RepeatWork，Callback形式） +isLastWorkTimeOut(workId: number): Promise\;| 获取上次任务是否超时（针对RepeatWork，Promise形式） **表2** WorkInfo包含参数 @@ -53,15 +53,15 @@ repeatCount |循环次数| number 接口名 | 接口描述 ---------------------------------------------------------|----------------------------------------- -function onWorkStart(work: WorkInfo): void; | 延迟调度任务开始回调 -function onWorkStop(work: WorkInfo): void; | 延迟调度任务结束回调 +onWorkStart(work: WorkInfo): void; | 延迟调度任务开始回调 +onWorkStop(work: WorkInfo): void; | 延迟调度任务结束回调 ### 开发步骤 **开发对应的Extension** import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility'; - + export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility { onWorkStart(workInfo) { console.log('MyWorkSchedulerExtensionAbility onWorkStart' + JSON.stringify(workInfo)); @@ -74,10 +74,8 @@ function onWorkStop(work: WorkInfo): void; | 延迟调度任务结束回调 **注册延迟任务** - - import workScheduler from '@ohos.workScheduler'; - + let workInfo = { workId: 1, batteryLevel:50, @@ -95,7 +93,7 @@ function onWorkStop(work: WorkInfo): void; | 延迟调度任务结束回调 import workScheduler from '@ohos.workScheduler'; - + let workInfo = { workId: 1, batteryLevel:50, -- GitLab