提交 1d95374f 编写于 作者: Z zengyawen

update docs

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 4025dd33
...@@ -51,16 +51,16 @@ Ability类拥有context属性,context属性为AbilityContext类,AbilityConte ...@@ -51,16 +51,16 @@ Ability类拥有context属性,context属性为AbilityContext类,AbilityConte
**表3** AbilityContext API接口功能介绍 **表3** AbilityContext API接口功能介绍
|接口名|描述| |接口名|描述|
|:------|:------| |:------|:------|
|void startAbility(want: Want, callback: AsyncCallback<void>)|启动Ability。| |void startAbility(want: Want, callback: AsyncCallback\<void>)|启动Ability。|
|void startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void>)|启动Ability。| |void startAbility(want: Want, options: StartOptions, callback: AsyncCallback\<void>)|启动Ability。|
|void startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback<void>)|带AccountId启动Ability。| |void startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\<void>)|带AccountId启动Ability。|
|void startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback<void>)|带AccountId启动Ability。| |void startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback\<void>)|带AccountId启动Ability。|
|void startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>)|带返回结果启动Ability。| |void startAbilityForResult(want: Want, callback: AsyncCallback\<AbilityResult>)|带返回结果启动Ability。|
|void startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback<AbilityResult>)|带返回结果启动Ability。| |void startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback\<AbilityResult>)|带返回结果启动Ability。|
|void startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncCallback<AbilityResult>)|带返回结果及AccountId启动Ability。| |void startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncCallback\<AbilityResult>)|带返回结果及AccountId启动Ability。|
|void startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback<void>)|带返回结果及AccountId启动Ability。| |void startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback\<void>)|带返回结果及AccountId启动Ability。|
|void terminateSelf(callback: AsyncCallback<void>)|销毁当前的Page Ability。| |void terminateSelf(callback: AsyncCallback\<void>)|销毁当前的Page Ability。|
|void terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback<void>)|带返回结果销毁当前的Page Ability。| |void terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>)|带返回结果销毁当前的Page Ability。|
## 开发步骤 ## 开发步骤
### 创建Page Ability应用 ### 创建Page Ability应用
......
...@@ -14,11 +14,11 @@ Caller及Callee功能如下:具体的API详见[接口文档](../reference/apis ...@@ -14,11 +14,11 @@ Caller及Callee功能如下:具体的API详见[接口文档](../reference/apis
**表1** Call API接口功能介绍 **表1** Call API接口功能介绍
|接口名|描述| |接口名|描述|
|:------|:------| |:------|:------|
|Promise<Caller> startAbilityByCall(want: Want)|获取指定通用组件的Caller通信接口,拉起指定通用组件并将其切换到后台。| |Promise\<Caller> startAbilityByCall(want: Want)|获取指定通用组件的Caller通信接口,拉起指定通用组件并将其切换到后台。|
|void on(method: string, callback: CalleeCallBack)|Callee.on,通用组件Callee注册method对应的callback方法。| |void on(method: string, callback: CalleeCallBack)|Callee.on,通用组件Callee注册method对应的callback方法。|
|void off(method: string)|Callee.off,通用组件Callee去注册method的callback方法。| |void off(method: string)|Callee.off,通用组件Callee去注册method的callback方法。|
|Promise<void> call(method: string, data: rpc.Sequenceable)|Caller.call,向通用组件Callee发送约定序列化数据。| |Promise\<void> call(method: string, data: rpc.Sequenceable)|Caller.call,向通用组件Callee发送约定序列化数据。|
|Promise<rpc.MessageParcel> callWithResult(method: string, data: rpc.Sequenceable)|Caller.callWithResult,向通用组件Callee发送约定序列化数据, 并将返回的约定序列化数据带回。| |Promise\<rpc.MessageParcel> callWithResult(method: string, data: rpc.Sequenceable)|Caller.callWithResult,向通用组件Callee发送约定序列化数据, 并将返回的约定序列化数据带回。|
|void release()|Caller.release,释放通用组件的Caller通信接口。| |void release()|Caller.release,释放通用组件的Caller通信接口。|
|void onRelease(callback: OnReleaseCallBack)|Caller.onRelease,注册通用组件通信断开监听通知。| |void onRelease(callback: OnReleaseCallBack)|Caller.onRelease,注册通用组件通信断开监听通知。|
......
...@@ -81,7 +81,7 @@ ...@@ -81,7 +81,7 @@
| 类名 | 接口名 | 描述 | | 类名 | 接口名 | 描述 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| RdbPredicates |inDevices(devices: Array<string>): RdbPredicates | 同步分布式数据库时指定组网内的远程设备。<br/>-&nbsp;devices:组网内指定的远程设备ID。<br/>-&nbsp;RdbPredicates:返回与指定字段匹配的谓词。 | | RdbPredicates |inDevices(devices: Array\<string>): RdbPredicates | 同步分布式数据库时指定组网内的远程设备。<br/>-&nbsp;devices:组网内指定的远程设备ID。<br/>-&nbsp;RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates |inAllDevices(): RdbPredicates | 同步分布式数据库时连接到组网内的所有远程设备。<br/>-&nbsp;RdbPredicates:返回与指定字段匹配的谓词。 | | RdbPredicates |inAllDevices(): RdbPredicates | 同步分布式数据库时连接到组网内的所有远程设备。<br/>-&nbsp;RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | equalTo(field:&nbsp;string,&nbsp;value:&nbsp;ValueType):&nbsp;RdbPredicates | 配置谓词以匹配数据字段为ValueType且值等于指定值的字段。<br/>-&nbsp;field:数据库表中的列名。<br/>-&nbsp;value:指示要与谓词匹配的值。<br/>-&nbsp;RdbPredicates:返回与指定字段匹配的谓词。 | | RdbPredicates | equalTo(field:&nbsp;string,&nbsp;value:&nbsp;ValueType):&nbsp;RdbPredicates | 配置谓词以匹配数据字段为ValueType且值等于指定值的字段。<br/>-&nbsp;field:数据库表中的列名。<br/>-&nbsp;value:指示要与谓词匹配的值。<br/>-&nbsp;RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | notEqualTo(field:&nbsp;string,&nbsp;value:&nbsp;ValueType):&nbsp;RdbPredicates | 配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。<br/>-&nbsp;field:数据库表中的列名。<br/>-&nbsp;value:指示要与谓词匹配的值。<br/>-&nbsp;RdbPredicates:返回与指定字段匹配的谓词。 | | RdbPredicates | notEqualTo(field:&nbsp;string,&nbsp;value:&nbsp;ValueType):&nbsp;RdbPredicates | 配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。<br/>-&nbsp;field:数据库表中的列名。<br/>-&nbsp;value:指示要与谓词匹配的值。<br/>-&nbsp;RdbPredicates:返回与指定字段匹配的谓词。 |
...@@ -147,8 +147,8 @@ ...@@ -147,8 +147,8 @@
| 类名 | 接口名 | 描述 | | 类名 | 接口名 | 描述 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| RdbStore | setDistributedTables(tables: Array<string>, callback: AsyncCallback<void>): void;| 设置分布式列表,结果以callback形式返回。<br/>-&nbsp;tables:要设置的分布式列表表名。<br/>-&nbsp;callback:指定callback回调函数。 | | RdbStore | setDistributedTables(tables: Array\<string>, callback: AsyncCallback\<void>): void; | 设置分布式列表,结果以callback形式返回。<br/>-&nbsp;tables:要设置的分布式列表表名。<br/>-&nbsp;callback:指定callback回调函数。 |
| RdbStore | setDistributedTables(tables: Array<string>): Promise<void>; | 设置分布式列表,结果以Promise形式返回。<br/>-&nbsp;tables:要设置的分布式列表表名。 | | RdbStore | setDistributedTables(tables: Array\<string>): Promise\<void>; | 设置分布式列表,结果以Promise形式返回。<br/>-&nbsp;tables:要设置的分布式列表表名。 |
**根据本地表名获取指定远程设备的分布式表名** **根据本地表名获取指定远程设备的分布式表名**
...@@ -158,8 +158,8 @@ ...@@ -158,8 +158,8 @@
| 类名 | 接口名 | 描述 | | 类名 | 接口名 | 描述 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| RdbStore | obtainDistributedTableName(device: string, table: string, callback: AsyncCallback<string>): void; | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时,需要使用分布式表名, 结果以callback形式返回。<br/>-&nbsp;device:远程设备。<br/>-&nbsp;table:本地表名。<br/>-&nbsp;callback:指定的callback回调函数,如果操作成功,返回远程设备的分布式表名。 | | RdbStore | obtainDistributedTableName(device: string, table: string, callback: AsyncCallback\<string>): void; | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时,需要使用分布式表名, 结果以callback形式返回。<br/>-&nbsp;device:远程设备。<br/>-&nbsp;table:本地表名。<br/>-&nbsp;callback:指定的callback回调函数,如果操作成功,返回远程设备的分布式表名。 |
| RdbStore | obtainDistributedTableName(device: string, table: string): Promise<string>; | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时,需要使用分布式表名,结果以Promise形式返回。<br/>-&nbsp;device:远程设备。<br/>-&nbsp;table:本地表名。 | | RdbStore | obtainDistributedTableName(device: string, table: string): Promise\<string>; | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时,需要使用分布式表名,结果以Promise形式返回。<br/>-&nbsp;device:远程设备。<br/>-&nbsp;table:本地表名。 |
**在设备之间同步数据** **在设备之间同步数据**
...@@ -176,7 +176,7 @@ ...@@ -176,7 +176,7 @@
| 类名 | 接口名 | 描述 | | 类名 | 接口名 | 描述 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| RdbStore |on(event: 'dataChange', type: SubscribeType, observer: Callback<Array<string>>): void;| 注册数据库的观察者。当分布式数据库中的数据发生更改时,将调用回调。<br/>-&nbsp;type:指在{@code SubscribeType}中定义的订阅类型;SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。<br/>-&nbsp;observer:指分布式数据库中数据更改事件的观察者。 | | RdbStore |on(event: 'dataChange', type: SubscribeType, observer: Callback<Array\<string>>): void;| 注册数据库的观察者。当分布式数据库中的数据发生更改时,将调用回调。<br/>-&nbsp;type:指在{@code SubscribeType}中定义的订阅类型;SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。<br/>-&nbsp;observer:指分布式数据库中数据更改事件的观察者。 |
**从数据库中删除指定类型的指定观察者** **从数据库中删除指定类型的指定观察者**
...@@ -184,7 +184,7 @@ ...@@ -184,7 +184,7 @@
| 类名 | 接口名 | 描述 | | 类名 | 接口名 | 描述 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| RdbStore |off(event:'dataChange', type: SubscribeType, observer: Callback<Array<string>>): void;| 从数据库中删除指定类型的指定观察者,结果以callback形式返回。<br/>-&nbsp;type:指在{@code SubscribeType}中定义的订阅类型;SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。<br/>-&nbsp;observer:指已注册的数据更改观察者。 | | RdbStore |off(event:'dataChange', type: SubscribeType, observer: Callback<Array\<string>>): void;| 从数据库中删除指定类型的指定观察者,结果以callback形式返回。<br/>-&nbsp;type:指在{@code SubscribeType}中定义的订阅类型;SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。<br/>-&nbsp;observer:指已注册的数据更改观察者。 |
## 开发步骤 ## 开发步骤
......
...@@ -2,5 +2,5 @@ ...@@ -2,5 +2,5 @@
- [公共事件与通知概述](notification-brief.md) - [公共事件与通知概述](notification-brief.md)
- [公共事件开发指导](common-event.md) - [公共事件开发指导](common-event.md)
- [通知开发指导](notification.md) - [通知开发指导](notification-guidelines.md)
- [调试助手使用指导](assistant-guidelines.md) - [调试助手使用指导](assistant-guidelines.md)
...@@ -34,8 +34,8 @@ OpenHarmony通过ANS(Advanced Notification Service,通知系统服务)对 ...@@ -34,8 +34,8 @@ OpenHarmony通过ANS(Advanced Notification Service,通知系统服务)对
| 接口名 | 描述 | | 接口名 | 描述 |
| ------------------------------------------------------------ | ---------------- | | ------------------------------------------------------------ | ---------------- |
| isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback<boolean>): void | 查询通知使能开关 | | isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback\<boolean>): void | 查询通知使能开关 |
| enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback<void>): void | 设置使能开关 | | enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void>): void | 设置使能开关 |
用于查询和设置通知使能开关,若某个应用的通知使能关闭状态,则无法发送通知。 用于查询和设置通知使能开关,若某个应用的通知使能关闭状态,则无法发送通知。
...@@ -45,9 +45,9 @@ OpenHarmony通过ANS(Advanced Notification Service,通知系统服务)对 ...@@ -45,9 +45,9 @@ OpenHarmony通过ANS(Advanced Notification Service,通知系统服务)对
| 接口名 | 描述 | | 接口名 | 描述 |
| ------------------------------------------------------------ | ---------------- | | ------------------------------------------------------------ | ---------------- |
| subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback<void>): void | 订阅指定应用通知 | | subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback\<void>): void | 订阅指定应用通知 |
| subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback<void>): void | 订阅所有通知 | | subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void>): void | 订阅所有通知 |
| unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback<void>): void | 取消订阅通知 | | unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void>): void | 取消订阅通知 |
订阅接口有支持订阅所有通知、或订阅某些应用的通知。 订阅接口有支持订阅所有通知、或订阅某些应用的通知。
...@@ -69,9 +69,9 @@ OpenHarmony通过ANS(Advanced Notification Service,通知系统服务)对 ...@@ -69,9 +69,9 @@ OpenHarmony通过ANS(Advanced Notification Service,通知系统服务)对
| 接口名 | 描述 | | 接口名 | 描述 |
| ------------------------------------------------------------ | ------------------------ | | ------------------------------------------------------------ | ------------------------ |
| publish(request: NotificationRequest, callback: AsyncCallback<void>): void | 发布通知 | | publish(request: NotificationRequest, callback: AsyncCallback\<void>): void | 发布通知 |
| publish(request: NotificationRequest, userId: number, callback: AsyncCallback<void>): void | 指定用户发布通知 | | publish(request: NotificationRequest, userId: number, callback: AsyncCallback\<void>): void | 指定用户发布通知 |
| cancel(id: number, label: string, callback: AsyncCallback<void>): void | 取消指定的通知 | | cancel(id: number, label: string, callback: AsyncCallback\<void>): void | 取消指定的通知 |
| cancelAll(callback: AsyncCallback<void>): void; | 取消所有该应用发布的通知 | | cancelAll(callback: AsyncCallback<void>): void; | 取消所有该应用发布的通知 |
携带userId的publish接口,可以指定向该用户下订阅者发布通知。 携带userId的publish接口,可以指定向该用户下订阅者发布通知。
......
...@@ -925,9 +925,9 @@ Hap模块信息 ...@@ -925,9 +925,9 @@ Hap模块信息
| iconId | number | 是 | 否 | 模块图标ID | | iconId | number | 是 | 否 | 模块图标ID |
| backgroundImg | string | 是 | 否 | 模块背景图片 | | backgroundImg | string | 是 | 否 | 模块背景图片 |
| supportedModes | number | 是 | 否 | 模块支持的模式 | | supportedModes | number | 是 | 否 | 模块支持的模式 |
| reqCapabilities | Array<string> | 是 | 否 | 模块运行需要的能力 | | reqCapabilities | Array\<string> | 是 | 否 | 模块运行需要的能力 |
| deviceTypes | Array<string> | 是 | 否 | 支持运行的设备类型 | | deviceTypes | Array\<string> | 是 | 否 | 支持运行的设备类型 |
| abilityInfo | Array<AbilityInfo> | 是 | 否 | Ability信息 | | abilityInfo | Array\<AbilityInfo> | 是 | 否 | Ability信息 |
| moduleName | string | 是 | 否 | 模块名 | | moduleName | string | 是 | 否 | 模块名 |
| mainAbilityName | string | 是 | 否 | 入口Ability名称 | | mainAbilityName | string | 是 | 否 | 入口Ability名称 |
| installationFree | boolean | 是 | 否 | 是否支持免安装 | | installationFree | boolean | 是 | 否 | 是否支持免安装 |
......
...@@ -668,7 +668,7 @@ this.context.connectAbility(want, accountId, options) { ...@@ -668,7 +668,7 @@ this.context.connectAbility(want, accountId, options) {
## disconnectAbility ## disconnectAbility
disconnectAbility(connection: number, callback:AsyncCallback<void>): void disconnectAbility(connection: number, callback:AsyncCallback\<void>): void
断开Ability连接(callback形式)。 断开Ability连接(callback形式)。
...@@ -692,7 +692,7 @@ this.context.disconnectAbility(connection, () => { ...@@ -692,7 +692,7 @@ this.context.disconnectAbility(connection, () => {
## disconnectAbility ## disconnectAbility
disconnectAbility(connection: number): Promise<void> disconnectAbility(connection: number): Promise\<void>
断开Ability连接(Promise形式)。 断开Ability连接(Promise形式)。
......
...@@ -160,7 +160,7 @@ getAppMemorySize(callback: AsyncCallback\<number>): void; ...@@ -160,7 +160,7 @@ getAppMemorySize(callback: AsyncCallback\<number>): void;
``` ```
## appManager.getProcessRunningInfos<sup>8+</sup> ## appManager.getProcessRunningInfos<sup>8+</sup>
getProcessRunningInfos(): Promise<Array\<ProcessRunningInfo>>; getProcessRunningInfos(): Promise\<Array\<ProcessRunningInfo>>;
获取有关运行进程的信息。 获取有关运行进程的信息。
...@@ -168,9 +168,9 @@ getProcessRunningInfos(): Promise<Array\<ProcessRunningInfo>>; ...@@ -168,9 +168,9 @@ getProcessRunningInfos(): Promise<Array\<ProcessRunningInfo>>;
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise<Array\<ProcessRunningInfo>> | 获取有关运行进程的信息。 | | Promise\<Array\<ProcessRunningInfo>> | 获取有关运行进程的信息。 |
**示例:** **示例:**
...@@ -184,7 +184,7 @@ getProcessRunningInfos(): Promise<Array\<ProcessRunningInfo>>; ...@@ -184,7 +184,7 @@ getProcessRunningInfos(): Promise<Array\<ProcessRunningInfo>>;
## appManager.getProcessRunningInfos<sup>8+</sup> ## appManager.getProcessRunningInfos<sup>8+</sup>
getProcessRunningInfos(callback: AsyncCallback<Array\<ProcessRunningInfo>>): void; getProcessRunningInfos(callback: AsyncCallback\<Array\<ProcessRunningInfo>>): void;
获取有关运行进程的信息。 获取有关运行进程的信息。
...@@ -192,9 +192,9 @@ getProcessRunningInfos(callback: AsyncCallback<Array\<ProcessRunningInfo>>): voi ...@@ -192,9 +192,9 @@ getProcessRunningInfos(callback: AsyncCallback<Array\<ProcessRunningInfo>>): voi
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback<Array\<ProcessRunningInfo>> | 否 | 获取有关运行进程的信息。 | | callback | AsyncCallback\<Array\<ProcessRunningInfo>> | 否 | 获取有关运行进程的信息。 |
**示例:** **示例:**
......
...@@ -544,7 +544,7 @@ audio.createAudioRenderer(audioCapturerOptions).then((data) => { ...@@ -544,7 +544,7 @@ audio.createAudioRenderer(audioCapturerOptions).then((data) => {
| ---------- | ------------------------------------------- | ---- | ------------------------------------------------------------ | | ---------- | ------------------------------------------- | ---- | ------------------------------------------------------------ |
| actionType | [InterruptActionType](#interruptactiontype) | 是 | 事件返回类型。TYPE_ACTIVATED为焦点触发事件,TYPE_INTERRUPT为音频打断事件。 | | actionType | [InterruptActionType](#interruptactiontype) | 是 | 事件返回类型。TYPE_ACTIVATED为焦点触发事件,TYPE_INTERRUPT为音频打断事件。 |
| type | [InterruptType](#interrupttype) | 否 | 打断事件类型。 | | type | [InterruptType](#interrupttype) | 否 | 打断事件类型。 |
| hint | [InterruptHint](interrupthint) | 否 | 打断事件提示。 | | hint | [InterruptHint](#interrupthint) | 否 | 打断事件提示。 |
| activated | boolean | 否 | 获得/释放焦点。true表示焦点获取/释放成功,false表示焦点获得/释放失败。 | | activated | boolean | 否 | 获得/释放焦点。true表示焦点获取/释放成功,false表示焦点获得/释放失败。 |
## VolumeEvent<sup>8+</sup> ## VolumeEvent<sup>8+</sup>
......
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## **导入模块** ## 导入模块
``` ```
import cardEmulation from '@ohos.nfc.cardEmulation'; import cardEmulation from '@ohos.nfc.cardEmulation';
......
...@@ -869,7 +869,7 @@ DAHelper.query( ...@@ -869,7 +869,7 @@ DAHelper.query(
## DataAbilityHelper.call ## DataAbilityHelper.call
call(uri: string, method: string, arg: string, extras: PacMap): Promise<PacMap> call(uri: string, method: string, arg: string, extras: PacMap): Promise\<PacMap>
调用DataAbility的扩展接口,使用Promise方式作为异步方法。 调用DataAbility的扩展接口,使用Promise方式作为异步方法。
...@@ -888,7 +888,7 @@ call(uri: string, method: string, arg: string, extras: PacMap): Promise<PacMap> ...@@ -888,7 +888,7 @@ call(uri: string, method: string, arg: string, extras: PacMap): Promise<PacMap>
| 类型 | 说明 | | 类型 | 说明 |
|------ | ------- | |------ | ------- |
|Promise<[PacMap](#pacmap)> | 调用的返回值。 | |Promise\<[PacMap](#pacmap)> | 调用的返回值。 |
**示例:** **示例:**
...@@ -905,7 +905,7 @@ dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", " ...@@ -905,7 +905,7 @@ dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", "
## DataAbilityHelper.call ## DataAbilityHelper.call
call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCallback<PacMap>): void call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCallback\<PacMap>): void
调用DataAbility的扩展接口,使用callback方式作为异步方法。 调用DataAbility的扩展接口,使用callback方式作为异步方法。
...@@ -919,7 +919,7 @@ call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCa ...@@ -919,7 +919,7 @@ call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCa
| method | string | 是 | 被调用的方法名。 | | method | string | 是 | 被调用的方法名。 |
| arg | string | 是 |需传入的参数。 | | arg | string | 是 |需传入的参数。 |
| extras | [PacMap](#pacmap) | 是 | 键值对参数。 | | extras | [PacMap](#pacmap) | 是 | 键值对参数。 |
| callback | AsyncCallback<[PacMap](#pacmap)> | 是 | 返回值。 | | callback | AsyncCallback\<[PacMap](#pacmap)> | 是 | 返回值。 |
**示例:** **示例:**
......
...@@ -52,7 +52,7 @@ export default { ...@@ -52,7 +52,7 @@ export default {
## inputDevice.getDeviceIds ## inputDevice.getDeviceIds
function getDeviceIds(): Promise<Array<number>> function getDeviceIds(): Promise<Array\<number>>
获取所有输入设备的id列表,使用Promise方式作为异步方法。 获取所有输入设备的id列表,使用Promise方式作为异步方法。
...@@ -60,9 +60,9 @@ function getDeviceIds(): Promise<Array<number>> ...@@ -60,9 +60,9 @@ function getDeviceIds(): Promise<Array<number>>
**返回值:** **返回值:**
| 参数 | 说明 | | 参数 | 说明 |
| ---------------------- | ------------------ | | ------------------------ | ----------------------------- |
| Promise<Array<number>> | Promise实例,用于异步获取结果 | | Promise\<Array\<number>> | Promise实例,用于异步获取结果 |
**示例:** **示例:**
...@@ -123,7 +123,7 @@ export default { ...@@ -123,7 +123,7 @@ export default {
## inputDevice.getDevice ## inputDevice.getDevice
function getDevice(deviceId: number): Promise<InputDeviceData> function getDevice(deviceId: number): Promise\<InputDeviceData>
获取输入设备的描述信息,使用Promise方式作为异步方法。 获取输入设备的描述信息,使用Promise方式作为异步方法。
...@@ -131,9 +131,9 @@ function getDevice(deviceId: number): Promise<InputDeviceData> ...@@ -131,9 +131,9 @@ function getDevice(deviceId: number): Promise<InputDeviceData>
**返回值:** **返回值:**
| 参数 | 说明 | | 参数 | 说明 |
| ------------------------ | ------------------ | | ------------------------- | ----------------------------- |
| Promise<InputDeviceData> | Promise实例,用于异步获取结果 | | Promise\<InputDeviceData> | Promise实例,用于异步获取结果 |
**示例:** **示例:**
...@@ -189,12 +189,12 @@ export default { ...@@ -189,12 +189,12 @@ export default {
**系统能力:** 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice **系统能力:** 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 | | 名称 | 参数类型 | 说明 |
| ------ | ------------------------- | -------- | | ------ | ------------------------- | ---------------- |
| source | [SourceType](#sourcetype) | 轴的输入源类型。 | | source | [SourceType](#sourcetype) | 轴的输入源类型。 |
| axis | [AxisType](axistype) | 轴的类型 | | axis | [AxisType](#axistype) | 轴的类型 |
| max | number | 轴上报的最大值 | | max | number | 轴上报的最大值 |
| min | number | 轴上报的最小值 | | min | number | 轴上报的最小值 |
......
...@@ -119,7 +119,7 @@ createAudioRecorder(): AudioRecorder ...@@ -119,7 +119,7 @@ createAudioRecorder(): AudioRecorder
**示例:** **示例:**
```js ```js
let audiorecorder = media.createAudioRecorder(); let audioRecorder = media.createAudioRecorder();
``` ```
## media.createVideoRecorder<sup>9+</sup> ## media.createVideoRecorder<sup>9+</sup>
...@@ -718,9 +718,9 @@ setDisplaySurface(surfaceId: string): Promise\<void> ...@@ -718,9 +718,9 @@ setDisplaySurface(surfaceId: string): Promise\<void>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------- | ------------------------------ | | -------------- | ------------------------------ |
| Promise<void> | 设置SurfaceId的Promise返回值。 | | Promise\<void> | 设置SurfaceId的Promise返回值。 |
**示例:** **示例:**
......
...@@ -1947,7 +1947,7 @@ async function example() { ...@@ -1947,7 +1947,7 @@ async function example() {
实体相册 实体相册
### **属性** ### 属性
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core **系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
......
...@@ -208,7 +208,7 @@ showActionMenu(options: ActionMenuOptions, callback: AsyncCallback&lt;ActionMenu ...@@ -208,7 +208,7 @@ showActionMenu(options: ActionMenuOptions, callback: AsyncCallback&lt;ActionMenu
## prompt.showActionMenu ## prompt.showActionMenu
showActionMenu(options: ActionMenuOptions): Promise<ActionMenuSuccessResponse> showActionMenu(options: ActionMenuOptions): Promise\<ActionMenuSuccessResponse>
创建并显示操作菜单,菜单响应后同步返回结果。 创建并显示操作菜单,菜单响应后同步返回结果。
......
...@@ -360,7 +360,7 @@ this.context.connectAbility(want, accountId, options) { ...@@ -360,7 +360,7 @@ this.context.connectAbility(want, accountId, options) {
## disconnectAbility ## disconnectAbility
disconnectAbility(connection: number, callback:AsyncCallback<void>): void disconnectAbility(connection: number, callback:AsyncCallback\<void>): void
断开Ability连接(callback形式)。 断开Ability连接(callback形式)。
...@@ -384,7 +384,7 @@ this.context.disconnectAbility(connection, () => { ...@@ -384,7 +384,7 @@ this.context.disconnectAbility(connection, () => {
## disconnectAbility ## disconnectAbility
disconnectAbility(connection: number): Promise<void> disconnectAbility(connection: number): Promise\<void>
断开Ability连接(Promise形式)。 断开Ability连接(Promise形式)。
......
...@@ -920,7 +920,7 @@ WantAgent.equal(wantAgent1, wantAgent2).then((data) => { ...@@ -920,7 +920,7 @@ WantAgent.equal(wantAgent1, wantAgent2).then((data) => {
## WantAgent.getOperationType<sup>9+</sup> ## WantAgent.getOperationType<sup>9+</sup>
getOperationType(agent: WantAgent, callback: AsyncCallback<number>): void getOperationType(agent: WantAgent, callback: AsyncCallback\<number>): void
获取一个WantAgent的OperationType信息(callback形式)。 获取一个WantAgent的OperationType信息(callback形式)。
...@@ -981,7 +981,7 @@ WantAgent.getOperationType(wantAgent, (OperationType) => { ...@@ -981,7 +981,7 @@ WantAgent.getOperationType(wantAgent, (OperationType) => {
## WantAgent.getOperationType<sup>9+</sup> ## WantAgent.getOperationType<sup>9+</sup>
getOperationType(agent: WantAgent): Promise<number> getOperationType(agent: WantAgent): Promise\<number>
获取一个WantAgent的OperationType信息(Promise形式)。 获取一个WantAgent的OperationType信息(Promise形式)。
......
...@@ -9,7 +9,7 @@ import zlib from '@ohos.zlib'; ...@@ -9,7 +9,7 @@ import zlib from '@ohos.zlib';
``` ```
## zlib.zipFile ## zlib.zipFile
zipFile(inFile:string, outFile:string, options: Options): Promise<void>; zipFile(inFile:string, outFile:string, options: Options): Promise\<void>
压缩接口(Promise形式)。 压缩接口(Promise形式)。
**系统能力:** SystemCapability.BundleManager.Zlib **系统能力:** SystemCapability.BundleManager.Zlib
...@@ -78,7 +78,7 @@ zlib.zipFile(inFile , unzipDir, options).then((data) => { ...@@ -78,7 +78,7 @@ zlib.zipFile(inFile , unzipDir, options).then((data) => {
## zlib.unzipFile ## zlib.unzipFile
unzipFile(inFile:string, outFile:string, options: Options): Promise<void>; unzipFile(inFile:string, outFile:string, options: Options): Promise\<void>
解压文件,解压完成返回执行结果(Promise形式)。 解压文件,解压完成返回执行结果(Promise形式)。
......
...@@ -22,13 +22,13 @@ JS FA应用的JS模块(entry/src/main/js/module)的典型开发目录结构如 ...@@ -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目录用于存放所有组件页面。 - pages目录用于存放所有组件页面。
- common目录用于存放公共资源文件,比如:媒体资源,自定义组件和JS文件。 - common目录用于存放公共资源文件,比如:媒体资源,自定义组件和JS文件。
- resources目录用于存放资源配置文件,比如:多分辨率加载等配置文件,详见[资源限定与访问](../ui/js-framework-resource-restriction.md)章节。 - resources目录用于存放资源配置文件,比如:多分辨率加载等配置文件,详见[资源限定与访问](js-framework-resource-restriction.md)章节。
- share目录用于配置多个实例共享的资源内容,比如:share中的图片和JSON文件可被default1和default2实例共享。 - share目录用于配置多个实例共享的资源内容,比如:share中的图片和JSON文件可被default1和default2实例共享。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册