Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
提交 7834b82e 编写于 作者: Z zengyawen
浏览文件
操作

update docs 

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 5b7f9753
隐藏空白更改
内联 并排
Showing with 80 addition and 82 deletion
zh-cn/application-dev/ability/stage-ability.md
浏览文件 @ 7834b82e
...@@ -78,29 +78,29 @@ Ability功能如下（Ability类，具体的API详见[接口文档](../reference ...@@ -78,29 +78,29 @@ Ability功能如下（Ability类，具体的API详见[接口文档](../reference
onCreate(want, launchParam) { onCreate(want, launchParam) {
console.log("MainAbility onCreate") console.log("MainAbility onCreate")
} }
onDestroy() { onDestroy() {
console.log("MainAbility onDestroy") console.log("MainAbility onDestroy")
} }
onWindowStageCreate(windowStage) { onWindowStageCreate(windowStage) {
console.log("MainAbility onWindowStageCreate") console.log("MainAbility onWindowStageCreate")
windowStage.loadContent("pages/index").then((data) => { windowStage.loadContent("pages/index").then((data) => {
console.log("MainAbility load content succeed with data: " + JSON.stringify(data)) console.log("MainAbility load content succeed with data: " + JSON.stringify(data))
}).catch((error) => { }).catch((error) => {
console.error("MainAbility load content failed with error: " + JSON.stringify(error)) console.error("MainAbility load content failed with error: " + JSON.stringify(error))
}) })
} }
onWindowStageDestroy() { onWindowStageDestroy() {
console.log("MainAbility onWindowStageDestroy") console.log("MainAbility onWindowStageDestroy")
} }
onForeground() { onForeground() {
console.log("MainAbility onForeground") console.log("MainAbility onForeground")
} }
onBackground() { onBackground() {
console.log("MainAbility onBackground") console.log("MainAbility onBackground")
} }
...@@ -210,14 +210,14 @@ Ability类拥有context属性，context属性为AbilityContext类，AbilityConte ...@@ -210,14 +210,14 @@ Ability类拥有context属性，context属性为AbilityContext类，AbilityConte
**表3** AbilityContext API接口功能介绍 **表3** AbilityContext API接口功能介绍
|接口名|描述| |接口名|描述|
|:------|:------| |:------|:------|
|startAbility(want: Want, callback: AsyncCallback<void>): void|启动Ability。| |startAbility(want: Want, callback: AsyncCallback\<void>): void|启动Ability。|
|startAbility(want: Want, options?: StartOptions): Promise<void>|启动Ability。| |startAbility(want: Want, options?: StartOptions): Promise\<void>|启动Ability。|
|startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback<void>): void|带AccountId启动Ability。| |startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\<void>): void|带AccountId启动Ability。|
|startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): Promise<void>|带AccountId启动Ability。| |startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): Promise\<void>|带AccountId启动Ability。|
|startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>): void|带返回结果启动Ability。| |startAbilityForResult(want: Want, callback: AsyncCallback\<AbilityResult>): void|带返回结果启动Ability。|
|startAbilityForResult(want: Want, options?: StartOptions): Promise<AbilityResult>|带返回结果启动Ability。| |startAbilityForResult(want: Want, options?: StartOptions): Promise\<AbilityResult>|带返回结果启动Ability。|
|startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncCallback<AbilityResult>): void|带返回结果及AccountId启动Ability。| |startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncCallback\<AbilityResult>): void|带返回结果及AccountId启动Ability。|
|startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartOptions): Promise<AbilityResult>|带返回结果及AccountId启动Ability。| |startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartOptions): Promise\<AbilityResult>|带返回结果及AccountId启动Ability。|
### 相同设备启动Ability ### 相同设备启动Ability
应用可以通过`this.context`获取Ability实例的上下文，进而使用AbilityContext中的StartAbility相关接口启动Ability。启动Ability可指定Want、StartOptions、accountId，通过callback形式或promise形式实现。具体示例代码如下： 应用可以通过`this.context`获取Ability实例的上下文，进而使用AbilityContext中的StartAbility相关接口启动Ability。启动Ability可指定Want、StartOptions、accountId，通过callback形式或promise形式实现。具体示例代码如下：
```ts ```ts
......
zh-cn/application-dev/ability/stage-call.md
浏览文件 @ 7834b82e
...@@ -18,11 +18,11 @@ Caller及Callee功能如下：具体的API详见[接口文档](../reference/apis ...@@ -18,11 +18,11 @@ Caller及Callee功能如下：具体的API详见[接口文档](../reference/apis
**表1** Call API接口功能介绍 **表1** Call API接口功能介绍
|接口名|描述| |接口名|描述|
|:------|:------| |:------|:------|
|startAbilityByCall(want: Want): Promise<Caller>|获取指定通用组件的Caller通信接口，拉起指定通用组件并将其切换到后台。| |startAbilityByCall(want: Want): Promise\<Caller>|获取指定通用组件的Caller通信接口，拉起指定通用组件并将其切换到后台。|
|on(method: string, callback: CaleeCallBack): void|通用组件Callee注册method对应的callback方法。| |on(method: string, callback: CaleeCallBack): void|通用组件Callee注册method对应的callback方法。|
|off(method: string): void|通用组件Callee去注册method的callback方法。| |off(method: string): void|通用组件Callee去注册method的callback方法。|
|call(method: string, data: rpc.Sequenceable): Promise<void>|向通用组件Callee发送约定序列化数据。| |call(method: string, data: rpc.Sequenceable): Promise\<void>|向通用组件Callee发送约定序列化数据。|
|callWithResult(method: string, data: rpc.Sequenceable): Promise<rpc.MessageParcel>|向通用组件Callee发送约定序列化数据, 并将返回的约定序列化数据带回。| |callWithResult(method: string, data: rpc.Sequenceable): Promise\<rpc.MessageParcel>|向通用组件Callee发送约定序列化数据, 并将返回的约定序列化数据带回。|
|release(): void|释放通用组件的Caller通信接口。| |release(): void|释放通用组件的Caller通信接口。|
|onRelease(callback: OnReleaseCallBack): void|注册通用组件通信断开监听通知。| |onRelease(callback: OnReleaseCallBack): void|注册通用组件通信断开监听通知。|
......
zh-cn/application-dev/database/database-relational-guidelines.md
浏览文件 @ 7834b82e
...@@ -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：返回与指定字段匹配的谓词。 |
...@@ -149,8 +149,8 @@ ...@@ -149,8 +149,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：要设置的分布式列表表名。 |
**根据本地表名获取指定远程设备的分布式表名** **根据本地表名获取指定远程设备的分布式表名**
...@@ -160,8 +160,8 @@ ...@@ -160,8 +160,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：本地表名。 |
**在设备之间同步数据** **在设备之间同步数据**
...@@ -169,8 +169,8 @@ ...@@ -169,8 +169,8 @@
| 类名 | 接口名 | 描述 | | 类名 | 接口名 | 描述 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| RdbStore | sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback<Array<[string, number]>>): void;| 在设备之间同步数据，结果以callback形式返回。<br/>-&nbsp;mode：指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备；SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。<br/>-&nbsp;predicates：约束同步数据和设备。<br/>-&nbsp;callback：指定的callback回调函数，string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 | | RdbStore | sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback\<Array\<[string, number]>>): void; | 在设备之间同步数据，结果以callback形式返回。<br/>-&nbsp;mode：指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备；SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。<br/>-&nbsp;predicates：约束同步数据和设备。<br/>-&nbsp;callback：指定的callback回调函数，string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 |
| RdbStore | sync(mode: SyncMode, predicates: RdbPredicates): Promise<Array<[string, number]>>;| 在设备之间同步数据，结果以Promise形式返回。<br/>-&nbsp;mode：指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备；SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。<br/>-&nbsp;predicates：约束同步数据和设备。 | | RdbStore | sync(mode: SyncMode, predicates: RdbPredicates): Promise\<Array\<[string, number]>>; | 在设备之间同步数据，结果以Promise形式返回。<br/>-&nbsp;mode：指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备；SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。<br/>-&nbsp;predicates：约束同步数据和设备。 |
**注册数据库的观察者** **注册数据库的观察者**
...@@ -178,7 +178,7 @@ ...@@ -178,7 +178,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：指分布式数据库中数据更改事件的观察者。 |
**从数据库中删除指定类型的指定观察者** **从数据库中删除指定类型的指定观察者**
...@@ -186,7 +186,7 @@ ...@@ -186,7 +186,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：指已注册的数据更改观察者。 |
## 开发步骤 ## 开发步骤
......
zh-cn/application-dev/notification/Readme-CN.md
浏览文件 @ 7834b82e
...@@ -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)
\ No newline at end of file
zh-cn/application-dev/notification/notification.md → zh-cn/application-dev/notification/notification-guidelines.md
浏览文件 @ 7834b82e
# Notification开发指导 # 通知开发指导
## 场景简介 ## 场景简介
...@@ -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,10 +69,10 @@ OpenHarmony通过ANS（Advanced Notification Service，通知系统服务）对 ...@@ -69,10 +69,10 @@ 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接口，可以指定向该用户下订阅者发布通知。
......
zh-cn/application-dev/reference/apis/js-apis-Context.md
浏览文件 @ 7834b82e
...@@ -931,9 +931,9 @@ Hap模块信息 ...@@ -931,9 +931,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 | 是 | 否 | 是否支持免安装。 |
......
zh-cn/application-dev/reference/apis/js-apis-audio.md
浏览文件 @ 7834b82e
...@@ -542,7 +542,7 @@ audio.createAudioCapturer(audioCapturerOptions).then((data) => { ...@@ -542,7 +542,7 @@ audio.createAudioCapturer(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>
......
zh-cn/application-dev/reference/apis/js-apis-bluetooth.md
浏览文件 @ 7834b82e
...@@ -720,7 +720,7 @@ bluetooth.off('stateChange', onReceiveEvent); ...@@ -720,7 +720,7 @@ bluetooth.off('stateChange', onReceiveEvent);
``` ```
## bluetooth.sppListen<sup>8+</sup><a name="sppListen<"></a> ## bluetooth.sppListen<sup>8+</sup><a name="sppListen"></a>
sppListen(name: string, option: SppOption, callback: AsyncCallback&lt;number&gt;): void sppListen(name: string, option: SppOption, callback: AsyncCallback&lt;number&gt;): void
...@@ -1330,7 +1330,7 @@ let ret = a2dpSrc.getDeviceState('XX:XX:XX:XX:XX:XX'); ...@@ -1330,7 +1330,7 @@ let ret = a2dpSrc.getDeviceState('XX:XX:XX:XX:XX:XX');
使用A2dpSourceProfile方法之前需要创建该类的实例进行操作，通过getProfile()方法构造此实例。 使用A2dpSourceProfile方法之前需要创建该类的实例进行操作，通过getProfile()方法构造此实例。
### connect<sup>8+</sup><a name="connect"></a> ### connect<sup>8+</sup><a name="a2dp-connect"></a>
connect(device: string): boolean connect(device: string): boolean
...@@ -1360,7 +1360,7 @@ let ret = a2dpSrc.connect('XX:XX:XX:XX:XX:XX'); ...@@ -1360,7 +1360,7 @@ let ret = a2dpSrc.connect('XX:XX:XX:XX:XX:XX');
``` ```
### disconnect<sup>8+</sup><a name="disconnect"></a> ### disconnect<sup>8+</sup><a name="a2dp-disconnect"></a>
disconnect(device: string): boolean disconnect(device: string): boolean
...@@ -1484,7 +1484,7 @@ let state = a2dpSrc.getPlayingState('XX:XX:XX:XX:XX:XX'); ...@@ -1484,7 +1484,7 @@ let state = a2dpSrc.getPlayingState('XX:XX:XX:XX:XX:XX');
使用HandsFreeAudioGatewayProfile方法之前需要创建该类的实例进行操作，通过getProfile()方法构造此实例。 使用HandsFreeAudioGatewayProfile方法之前需要创建该类的实例进行操作，通过getProfile()方法构造此实例。
### connect<sup>8+</sup><a name="connect"></a> ### connect<sup>8+</sup><a name="hfp-connect"></a>
connect(device: string): boolean connect(device: string): boolean
...@@ -1514,7 +1514,7 @@ let ret = hfpAg.connect('XX:XX:XX:XX:XX:XX'); ...@@ -1514,7 +1514,7 @@ let ret = hfpAg.connect('XX:XX:XX:XX:XX:XX');
``` ```
### disconnect<sup>8+</sup><a name="disconnect"></a> ### disconnect<sup>8+</sup><a name="hfp-disconnect"></a>
disconnect(device: string): boolean disconnect(device: string): boolean
......
zh-cn/application-dev/reference/apis/js-apis-cardEmulation.md
浏览文件 @ 7834b82e
...@@ -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';
......
zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md
浏览文件 @ 7834b82e
...@@ -891,7 +891,7 @@ call(uri: string, method: string, arg: string, extras: PacMap): Promise\<PacMap> ...@@ -891,7 +891,7 @@ call(uri: string, method: string, arg: string, extras: PacMap): Promise\<PacMap>
| 类型 | 说明 | | 类型 | 说明 |
|------ | ------- | |------ | ------- |
|Promise<[PacMap](#pacmap)> | 调用的返回值。 | |Promise\<[PacMap](#pacmap)> | 调用的返回值。 |
**示例：** **示例：**
...@@ -922,7 +922,7 @@ call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCa ...@@ -922,7 +922,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)> | 是 | 返回值。 |
**示例：** **示例：**
......
zh-cn/application-dev/reference/apis/js-apis-inputdevice.md
浏览文件 @ 7834b82e
...@@ -104,7 +104,7 @@ inputDevice.getDeviceIds((ids)=>{ ...@@ -104,7 +104,7 @@ inputDevice.getDeviceIds((ids)=>{
## inputDevice.getDeviceIds ## inputDevice.getDeviceIds
function getDeviceIds(): Promise&lt;&lt;Array&lt;number&gt;&gt; getDeviceIds(): Promise&lt;Array&lt;number&gt;&gt;
获取所有输入设备的id列表，使用Promise方式作为异步方法。 获取所有输入设备的id列表，使用Promise方式作为异步方法。
...@@ -150,7 +150,7 @@ inputDevice.getDevice(1, (inputDevice)=>{ ...@@ -150,7 +150,7 @@ inputDevice.getDevice(1, (inputDevice)=>{
## inputDevice.getDevice ## inputDevice.getDevice
function getDevice(deviceId: number): Promise&lt;InputDeviceData&gt; getDevice(deviceId: number): Promise&lt;InputDeviceData&gt;
获取输入设备的描述信息，使用Promise方式作为异步方法。 获取输入设备的描述信息，使用Promise方式作为异步方法。
...@@ -333,15 +333,15 @@ inputDevice.getKeyboardType(1).then((ret)=>{ ...@@ -333,15 +333,15 @@ inputDevice.getKeyboardType(1).then((ret)=>{
**系统能力**： 以下各项对应的系统能力均为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 | 轴的最小值。 |
| fuzz<sup>9+</sup> | number | 轴的模糊值。 | | fuzz<sup>9+</sup> | number | 轴的模糊值。 |
| flat<sup>9+</sup> | number | 轴的基准值。 | | flat<sup>9+</sup> | number | 轴的基准值。 |
| resolution<sup>9+</sup> | number | 轴的分辨率。 | | resolution<sup>9+</sup> | number | 轴的分辨率。 |
## SourceType ## SourceType
......
zh-cn/application-dev/reference/apis/js-apis-media.md
浏览文件 @ 7834b82e
...@@ -716,9 +716,9 @@ setDisplaySurface(surfaceId: string): Promise\<void> ...@@ -716,9 +716,9 @@ setDisplaySurface(surfaceId: string): Promise\<void>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------- | ------------------------------ | | -------------- | ------------------------------ |
| Promise<void> | 设置SurfaceId的Promise返回值。 | | Promise\<void> | 设置SurfaceId的Promise返回值。 |
**示例：** **示例：**
......
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
浏览文件 @ 7834b82e
...@@ -1956,7 +1956,7 @@ async function example() { ...@@ -1956,7 +1956,7 @@ async function example() {
实体相册 实体相册
### **属性** ### 属性
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core **系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
......
zh-cn/application-dev/reference/apis/js-apis-prompt.md
浏览文件 @ 7834b82e
...@@ -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>
创建并显示操作菜单，菜单响应后同步返回结果。 创建并显示操作菜单，菜单响应后同步返回结果。
......
zh-cn/application-dev/ui/js-framework-file.md
浏览文件 @ 7834b82e
...@@ -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实例共享。
......
zh-cn/application-dev/work-scheduler/work-scheduler-dev-guide.md
浏览文件 @ 7834b82e
...@@ -22,15 +22,15 @@ import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility'; ...@@ -22,15 +22,15 @@ import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility';
接口名 | 接口描述 接口名 | 接口描述
---------------------------------------------------------|----------------------------------------- ---------------------------------------------------------|-----------------------------------------
function startWork(work: WorkInfo): boolean; | 延迟调度任务申请 startWork(work: WorkInfo): boolean; | 延迟调度任务申请
function stopWork(work: WorkInfo, needCancel?: boolean): boolean; | 延迟调度任务取消 stopWork(work: WorkInfo, needCancel?: boolean): boolean; | 延迟调度任务取消
function getWorkStatus(workId: number, callback: AsyncCallback<WorkInfo>): void;| 获取延迟调度任务状态（Callback形式） getWorkStatus(workId: number, callback: AsyncCallback\<WorkInfo>): void;| 获取延迟调度任务状态（Callback形式）
function getWorkStatus(workId: number): Promise<WorkInfo>; | 获取延迟调度任务状态（Promise形式） getWorkStatus(workId: number): Promise\<WorkInfo>; | 获取延迟调度任务状态（Promise形式）
function obtainAllWorks(callback: AsyncCallback<void>): Array<WorkInfo>;| 获取所有延迟调度任务（Callback形式） obtainAllWorks(callback: AsyncCallback\<void>): Array\<WorkInfo>;| 获取所有延迟调度任务（Callback形式）
function obtainAllWorks(): Promise<Array<WorkInfo>>;| 获取所有延迟调度任务（Promise形式） obtainAllWorks(): Promise<Array\<WorkInfo>>;| 获取所有延迟调度任务（Promise形式）
function stopAndClearWorks(): boolean;| 停止并清除任务 stopAndClearWorks(): boolean;| 停止并清除任务
function isLastWorkTimeOut(workId: number, callback: AsyncCallback<void>): boolean;| 获取上次任务是否超时（针对RepeatWork，Callback形式） isLastWorkTimeOut(workId: number, callback: AsyncCallback\<void>): boolean;| 获取上次任务是否超时（针对RepeatWork，Callback形式）
function isLastWorkTimeOut(workId: number): Promise<boolean>;| 获取上次任务是否超时（针对RepeatWork，Promise形式） isLastWorkTimeOut(workId: number): Promise\<boolean>;| 获取上次任务是否超时（针对RepeatWork，Promise形式）
**表2** WorkInfo包含参数 **表2** WorkInfo包含参数
...@@ -53,15 +53,15 @@ repeatCount |循环次数| number ...@@ -53,15 +53,15 @@ repeatCount |循环次数| number
接口名 | 接口描述 接口名 | 接口描述
---------------------------------------------------------|----------------------------------------- ---------------------------------------------------------|-----------------------------------------
function onWorkStart(work: WorkInfo): void; | 延迟调度任务开始回调 onWorkStart(work: WorkInfo): void; | 延迟调度任务开始回调
function onWorkStop(work: WorkInfo): void; | 延迟调度任务结束回调 onWorkStop(work: WorkInfo): void; | 延迟调度任务结束回调
### 开发步骤 ### 开发步骤
**开发对应的Extension** **开发对应的Extension**
import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility'; import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility';
export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility { export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility {
onWorkStart(workInfo) { onWorkStart(workInfo) {
console.log('MyWorkSchedulerExtensionAbility onWorkStart' + JSON.stringify(workInfo)); console.log('MyWorkSchedulerExtensionAbility onWorkStart' + JSON.stringify(workInfo));
...@@ -74,10 +74,8 @@ function onWorkStop(work: WorkInfo): void; | 延迟调度任务结束回调 ...@@ -74,10 +74,8 @@ function onWorkStop(work: WorkInfo): void; | 延迟调度任务结束回调
**注册延迟任务** **注册延迟任务**
import workScheduler from '@ohos.workScheduler'; import workScheduler from '@ohos.workScheduler';
let workInfo = { let workInfo = {
workId: 1, workId: 1,
batteryLevel:50, batteryLevel:50,
...@@ -95,7 +93,7 @@ function onWorkStop(work: WorkInfo): void; | 延迟调度任务结束回调 ...@@ -95,7 +93,7 @@ function onWorkStop(work: WorkInfo): void; | 延迟调度任务结束回调
import workScheduler from '@ohos.workScheduler'; import workScheduler from '@ohos.workScheduler';
let workInfo = { let workInfo = {
workId: 1, workId: 1,
batteryLevel:50, batteryLevel:50,
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或