From d2936ad1f2c578a30b36787cbae3e73ee1640e84 Mon Sep 17 00:00:00 2001 From: zyjhandsome Date: Thu, 22 Dec 2022 15:40:55 +0800 Subject: [PATCH] =?UTF-8?q?=E5=BC=95=E7=94=A8=E4=BD=8D=E7=BD=AE=20js-apis-?= =?UTF-8?q?wantAgent.md=20=E4=BF=AE=E6=94=B9=E4=B8=BA=20js-apis-app-abilit?= =?UTF-8?q?y-wantAgent.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit start build Signed-off-by: zyjhandsome --- .../ability-deprecated/wantagent.md | 10 +++---- .../faqs/faqs-event-notification.md | 2 +- .../media/avsession-guidelines.md | 2 +- .../notification-with-wantagent.md | 8 +++--- .../reference/apis/js-apis-avsession.md | 26 +++++++++---------- .../apis/js-apis-backgroundTaskManager.md | 22 ++++++++-------- .../js-apis-inner-wantAgent-wantAgentInfo.md | 2 +- ...-resourceschedule-backgroundTaskManager.md | 4 +-- .../reference/apis/js-apis-system-timer.md | 14 +++++----- .../reference/apis/js-apis-wantAgent.md | 1 - .../continuous-task-dev-guide.md | 2 +- 11 files changed, 46 insertions(+), 47 deletions(-) diff --git a/zh-cn/application-dev/ability-deprecated/wantagent.md b/zh-cn/application-dev/ability-deprecated/wantagent.md index 5ce8f9a049..9e293023a2 100644 --- a/zh-cn/application-dev/ability-deprecated/wantagent.md +++ b/zh-cn/application-dev/ability-deprecated/wantagent.md @@ -14,13 +14,13 @@ WantAgent封装了一个行为意图信息，可以通过WantAgent.trigger接口 ## 开发步骤 1. 导入WantAgent模块。 - ``` + ```ts import wantAgent from '@ohos.wantAgent'; ``` 2. 创建拉起Ability的WantAgentInfo信息。详细的WantAgentInfo信息数据类型及包含的参数请见[WantAgentInfo文档](../reference/apis/js-apis-wantAgent.md#wantagentinfo)介绍。 - ``` + ```ts private wantAgentObj = null // 用于保存创建成功的wantAgent对象，后续使用其完成触发的动作。 // wantAgentInfo @@ -44,7 +44,7 @@ WantAgent封装了一个行为意图信息，可以通过WantAgent.trigger接口 3. 创建发布公共事件的WantAgentInfo信息。 - ``` + ```ts private wantAgentObj = null // 用于保存创建成功的WantAgent对象，后续使用其完成触发的动作。 // wantAgentInfo @@ -63,7 +63,7 @@ WantAgent封装了一个行为意图信息，可以通过WantAgent.trigger接口 4. 创建WantAgent，保存返回的WantAgent对象wantAgentObj，用于执行后续触发操作。 - ``` + ```ts // 创建WantAgent wantAgent.getWantAgent(wantAgentInfo, (err, wantAgentObj) => { if (err.code) { @@ -77,7 +77,7 @@ WantAgent封装了一个行为意图信息，可以通过WantAgent.trigger接口 5. 触发WantAgent。 - ``` + ```ts // 触发WantAgent。 var triggerInfo = { code:0 diff --git a/zh-cn/application-dev/faqs/faqs-event-notification.md b/zh-cn/application-dev/faqs/faqs-event-notification.md index a035a58908..8fb2332c18 100644 --- a/zh-cn/application-dev/faqs/faqs-event-notification.md +++ b/zh-cn/application-dev/faqs/faqs-event-notification.md @@ -12,7 +12,7 @@ emitter数据大小限制不超过10240。 通过配置Notification.publish发布通知接口的参数NotificationRequest中wantAgent属性实现 -参考文档：[Notification](../reference/apis/js-apis-notification.md#notificationpublish)、[WantAgent](../reference/apis/js-apis-wantAgent.md) +参考文档：[Notification](../reference/apis/js-apis-notification.md#notificationpublish)、[WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md) 示例： diff --git a/zh-cn/application-dev/media/avsession-guidelines.md b/zh-cn/application-dev/media/avsession-guidelines.md index 267802f1a4..41ab8c7dd4 100644 --- a/zh-cn/application-dev/media/avsession-guidelines.md +++ b/zh-cn/application-dev/media/avsession-guidelines.md @@ -50,7 +50,7 @@ avSession.createAVSession(context, "AudioAppSample", 'audio').then((session) => 3.设置AVSession会话信息，包括： - 设置会话元数据，除了媒体ID必选外，可选设置媒体标题、专辑信息、媒体作者、媒体时长、上一首/下一首媒体ID等。详细的会话元数据信息可参考API文档中的`AVMetadata`。 -- 设置启动Ability，通过`WantAgent`的接口实现。WantAgent一般用于封装行为意图信息，如果想要了解更多信息，可以查阅[WantAgent开发指导](../reference/apis/js-apis-wantAgent.md)。 +- 设置启动Ability，通过[WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md)的接口实现。WantAgent一般用于封装行为意图信息。 - 设置播放状态。 ```js // 设置会话元数据 diff --git a/zh-cn/application-dev/notification/notification-with-wantagent.md b/zh-cn/application-dev/notification/notification-with-wantagent.md index a511ca4d80..c137a122f9 100644 --- a/zh-cn/application-dev/notification/notification-with-wantagent.md +++ b/zh-cn/application-dev/notification/notification-with-wantagent.md @@ -1,8 +1,8 @@ # 为通知添加行为意图 -[WantAgent](../reference/apis/js-apis-wantAgent.md)提供了封装行为意图的能力，该行为意图是指拉起指定的应用组件及发布公共事件等能力。OpenHarmony支持以通知的形式，将[WantAgent](../reference/apis/js-apis-wantAgent.md)从发布方传递至接收方，从而在接收方触发[WantAgent](../reference/apis/js-apis-wantAgent.md)中指定的意图。例如在通知消息的发布者发布通知时，通常期望用户可以通过通知栏点击拉起目标应用组件。为了达成这一目标，开发者可以将[WantAgent](../reference/apis/js-apis-wantAgent.md)封装至通知消息中，当系统接收到[WantAgent](../reference/apis/js-apis-wantAgent.md)后，在用户点击通知栏时触发[WantAgent](../reference/apis/js-apis-wantAgent.md)的意图，从而拉起目标应用组件。 +[WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md)提供了封装行为意图的能力，该行为意图是指拉起指定的应用组件及发布公共事件等能力。OpenHarmony支持以通知的形式，将[WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md)从发布方传递至接收方，从而在接收方触发[WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md)中指定的意图。例如在通知消息的发布者发布通知时，通常期望用户可以通过通知栏点击拉起目标应用组件。为了达成这一目标，开发者可以将[WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md)封装至通知消息中，当系统接收到[WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md)后，在用户点击通知栏时触发[WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md)的意图，从而拉起目标应用组件。 -为通知添加行为意图的实现方式如下图所示：发布通知的应用向应用组件管理服务AMS（Ability Manager Service）申请[WantAgent](../reference/apis/js-apis-wantAgent.md)，然后随其他通知信息一起发送给桌面，当用户在桌面通知栏上点击通知时，触发[WantAgent](../reference/apis/js-apis-wantAgent.md)动作。 +为通知添加行为意图的实现方式如下图所示：发布通知的应用向应用组件管理服务AMS（Ability Manager Service）申请[WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md)，然后随其他通知信息一起发送给桌面，当用户在桌面通知栏上点击通知时，触发[WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md)动作。 **图1** 携带行为意图的通知运行机制 ![notification-with-wantagent](figures/notification-with-wantagent.png) @@ -10,7 +10,7 @@ ## 接口说明 -具体接口描述，详见[WantAgent接口文档](../reference/apis/js-apis-wantAgent.md)。 +具体接口描述，详见[WantAgent接口文档](../reference/apis/js-apis-app-ability-wantAgent.md)。 | | | | -------- | -------- | @@ -78,7 +78,7 @@ } ``` -4. 调用[getWantAgent()](../reference/apis/js-apis-wantAgent.md#wantagentgetwantagent)方法进行创建WantAgent。 +4. 调用[getWantAgent()](../reference/apis/js-apis-app-ability-wantAgent.md#wantagentgetwantagent)方法进行创建WantAgent。 ```typescript // 创建WantAgent diff --git a/zh-cn/application-dev/reference/apis/js-apis-avsession.md b/zh-cn/application-dev/reference/apis/js-apis-avsession.md index 2c34a02446..f57f581a35 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-avsession.md +++ b/zh-cn/application-dev/reference/apis/js-apis-avsession.md @@ -978,9 +978,9 @@ setLaunchAbility(ability: WantAgent): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | --------------------------------- | ---- | ----------------------------------------------------------- | -| ability | [WantAgent](js-apis-wantAgent.md) | 是 | 应用的相关属性信息，如bundleName，abilityName，deviceId等。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | --------------------------------------------- | ---- | ----------------------------------------------------------- | +| ability | [WantAgent](js-apis-app-ability-wantAgent.md) | 是 | 应用的相关属性信息，如bundleName，abilityName，deviceId等。 | **返回值：** @@ -1048,10 +1048,10 @@ setLaunchAbility(ability: WantAgent, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------- | ---- | ----------------------------------------------------------- | -| ability | [WantAgent](js-apis-wantAgent.md) | 是 | 应用的相关属性信息，如bundleName，abilityName，deviceId等。 | -| callback | AsyncCallback | 是 | 回调函数。当Ability设置成功，err为undefined，否则返回错误对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------------- | ---- | ------------------------------------------------------------ | +| ability | [WantAgent](js-apis-app-ability-wantAgent.md) | 是 | 应用的相关属性信息，如bundleName，abilityName，deviceId等。 | +| callback | AsyncCallback | 是 | 回调函数。当Ability设置成功，err为undefined，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[ohos.multimedia.avsession(多媒体会话)错误码](../errorcodes/errorcode-avsession.md)。 @@ -2204,9 +2204,9 @@ getLaunchAbility(): Promise\ **返回值：** -| 类型 | 说明 | -| ------------------------------------------- | ------------------------------------------------------------ | -| Promise<[WantAgent](js-apis-wantAgent.md)\> | Promise对象，返回在[setLaunchAbility](#setlaunchability)保存的对象，包括应用的相关属性信息，如bundleName，abilityName，deviceId等。 | +| 类型 | 说明 | +| ------------------------------------------------------- | ------------------------------------------------------------ | +| Promise<[WantAgent](js-apis-app-ability-wantAgent.md)\> | Promise对象，返回在[setLaunchAbility](#setlaunchability)保存的对象，包括应用的相关属性信息，如bundleName，abilityName，deviceId等。 | **错误码：** 以下错误码的详细介绍请参见[ohos.multimedia.avsession(多媒体会话)错误码](../errorcodes/errorcode-avsession.md)。 @@ -2239,9 +2239,9 @@ getLaunchAbility(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | -| callback | AsyncCallback<[WantAgent](js-apis-wantAgent.md)\> | 是 | 回调函数。返回在[setLaunchAbility](#setlaunchability)保存的对象，包括应用的相关属性信息，如bundleName，abilityName，deviceId等。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| callback | AsyncCallback<[WantAgent](js-apis-app-ability-wantAgent.md)\> | 是 | 回调函数。返回在[setLaunchAbility](#setlaunchability)保存的对象，包括应用的相关属性信息，如bundleName，abilityName，deviceId等。 | **错误码：** 以下错误码的详细介绍请参见[ohos.multimedia.avsession(多媒体会话)错误码](../errorcodes/errorcode-avsession.md)。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md b/zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md index 4b7b1d0524..b89e4400fa 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md @@ -159,12 +159,12 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ---------------------------------- | ---- | ---------------------------------------- | -| context | Context | 是 | 应用运行的上下文。
FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。
Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | -| bgMode | [BackgroundMode](#backgroundmode8) | 是 | 向系统申请的后台模式。 | -| wantAgent | [WantAgent](js-apis-wantAgent.md) | 是 | 通知参数，用于指定长时任务通知点击后跳转的界面。 | -| callback | AsyncCallback<void> | 是 | callback形式返回启动长时任务的结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | --------------------------------------------- | ---- | ------------------------------------------------------------ | +| context | Context | 是 | 应用运行的上下文。
FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。
Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | +| bgMode | [BackgroundMode](#backgroundmode8) | 是 | 向系统申请的后台模式。 | +| wantAgent | [WantAgent](js-apis-app-ability-wantAgent.md) | 是 | 通知参数，用于指定长时任务通知点击后跳转的界面。 | +| callback | AsyncCallback<void> | 是 | callback形式返回启动长时任务的结果。 | **示例**： @@ -251,11 +251,11 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ---------------------------------- | ---- | ---------------------------------------- | -| context | Context | 是 | 应用运行的上下文。
FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。
Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | -| bgMode | [BackgroundMode](#backgroundmode8) | 是 | 向系统申请的后台模式。 | -| wantAgent | [WantAgent](js-apis-wantAgent.md) | 是 | 通知参数，用于指定长时任务通知点击跳转的界面。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | --------------------------------------------- | ---- | ------------------------------------------------------------ | +| context | Context | 是 | 应用运行的上下文。
FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。
Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | +| bgMode | [BackgroundMode](#backgroundmode8) | 是 | 向系统申请的后台模式。 | +| wantAgent | [WantAgent](js-apis-app-ability-wantAgent.md) | 是 | 通知参数，用于指定长时任务通知点击跳转的界面。 | **返回值**： diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md index 7228bf96d4..3f0d49e87c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md @@ -9,5 +9,5 @@ | wants | Array\ | 是 | 将被执行的动作列表。 | | operationType | wantAgent.OperationType | 是 | 动作类型。 | | requestCode | number | 是 | 使用者定义的一个私有值。 | -| wantAgentFlags | Array<[wantAgent.WantAgentFlags](js-apis-wantAgent.md#WantAgentFlags)> | 否 | 动作执行属性。 | +| wantAgentFlags | Array<[wantAgent.WantAgentFlags](js-apis-app-ability-wantAgent.md#wantagentflags)> | 否 | 动作执行属性。 | | extraInfo | {[key: string]: any} | 否 | 额外数据。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-resourceschedule-backgroundTaskManager.md b/zh-cn/application-dev/reference/apis/js-apis-resourceschedule-backgroundTaskManager.md index a9b0d71a04..266497bac9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-resourceschedule-backgroundTaskManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-resourceschedule-backgroundTaskManager.md @@ -235,7 +235,7 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want | --------- | ---------------------------------- | ---- | ---------------------------------------- | | context | Context | 是 | 应用运行的上下文。
FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。
Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | | bgMode | [BackgroundMode](#backgroundmode) | 是 | 向系统申请的后台模式。 | -| wantAgent | [WantAgent](js-apis-wantAgent.md) | 是 | 通知参数，用于指定长时任务通知点击后跳转的界面。 | +| wantAgent | [WantAgent](js-apis-app-ability-wantAgent.md) | 是 | 通知参数，用于指定长时任务通知点击后跳转的界面。 | | callback | AsyncCallback<void> | 是 | callback形式返回启动长时任务的结果。 | **错误码**： @@ -309,7 +309,7 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want | --------- | ---------------------------------- | ---- | ---------------------------------------- | | context | Context | 是 | 应用运行的上下文。
FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。
Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | | bgMode | [BackgroundMode](#backgroundmode) | 是 | 向系统申请的后台模式。 | -| wantAgent | [WantAgent](js-apis-wantAgent.md) | 是 | 通知参数，用于指定长时任务通知点击跳转的界面。 | +| wantAgent | [WantAgent](js-apis-app-ability-wantAgent.md) | 是 | 通知参数，用于指定长时任务通知点击跳转的界面。 | **返回值**： diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-timer.md b/zh-cn/application-dev/reference/apis/js-apis-system-timer.md index f1cec2767a..05105ecb1c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-timer.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-timer.md @@ -33,13 +33,13 @@ import systemTimer from '@ohos.systemTimer'; **系统能力：** SystemCapability.MiscServices.Time -| 名称 | 类型 | 必填 | 说明 | -| --------- | --------------------------------- | ---- | ------------------------------------------------------------ | -| type | number | 是 | 定时器类型。
取值为1时，表示为系统启动时间定时器（定时器启动时间不能晚于当前设置的系统时间） ；
取值为2时，表示为唤醒定时器；
取值为4时，表示为精准定时器；
取值为5时，表示为IDLE模式定时器（暂不支持）。 | -| repeat | boolean | 是 | true为循环定时器，false为单次定时器。 | -| interval | number | 否 | 如果是循环定时器，repeat值应大于5000毫秒，非重复定时器置为0。 | -| wantAgent | [WantAgent](js-apis-wantAgent.md) | 否 | 设置通知的WantAgent，定时器到期后通知。（支持拉起应用MainAbility，暂不支持拉起ServiceAbility。） | -| callback | number | 是 | 以回调函数的形式返回定时器的ID。 | +| 名称 | 类型 | 必填 | 说明 | +| --------- | --------------------------------------------- | ---- | ------------------------------------------------------------ | +| type | number | 是 | 定时器类型。
取值为1时，表示为系统启动时间定时器（定时器启动时间不能晚于当前设置的系统时间） ；
取值为2时，表示为唤醒定时器；
取值为4时，表示为精准定时器；
取值为5时，表示为IDLE模式定时器（暂不支持）。 | +| repeat | boolean | 是 | true为循环定时器，false为单次定时器。 | +| interval | number | 否 | 如果是循环定时器，repeat值应大于5000毫秒，非重复定时器置为0。 | +| wantAgent | [WantAgent](js-apis-app-ability-wantAgent.md) | 否 | 设置通知的WantAgent，定时器到期后通知。（支持拉起应用MainAbility，暂不支持拉起ServiceAbility。） | +| callback | number | 是 | 以回调函数的形式返回定时器的ID。 | ## systemTimer.createTimer diff --git a/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md b/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md index 00eae0c2c4..f55d0a1123 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md +++ b/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md @@ -227,7 +227,6 @@ getBundleName(agent: WantAgent): Promise\ ```js import WantAgent from '@ohos.wantAgent'; - //wantAgent对象 var wantAgent; diff --git a/zh-cn/application-dev/task-management/continuous-task-dev-guide.md b/zh-cn/application-dev/task-management/continuous-task-dev-guide.md index dd6c4ee9da..632cacbce5 100644 --- a/zh-cn/application-dev/task-management/continuous-task-dev-guide.md +++ b/zh-cn/application-dev/task-management/continuous-task-dev-guide.md @@ -15,7 +15,7 @@ | stopBackgroundRunning(context: Context): Promise<void> | 停止后台长时任务的运行。 | -其中，wantAgent的信息详见（[WantAgent](../reference/apis/js-apis-wantAgent.md)） +其中，wantAgent的信息详见（[WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md)） **表2** 后台模式类型 -- GitLab