未验证 提交 1edff15a 编写于 作者: O openharmony_ci 提交者: Gitee

!12808 wantagent文档修改

Merge pull request !12808 from zhuhan/api_fix
# @ohos.app.ability.wantAgent (WantAgent模块) # @ohos.app.ability.wantAgent (WantAgent模块)
app.ability.WantAgent模块提供了触发、取消、比较WantAgent实例和获取bundle名称的能力,包括创建WantAgent实例、获取实例的用户ID、获取want信息等。该模块将会取代[@ohos.wantAgent](js-apis-wantAgent.md)模块,建议优先使用本模块。 app.ability.WantAgent模块提供了创建WantAgent实例、获取实例的用户ID、获取want信息、比较WantAgent实例和获取bundle名称等能力。该模块将会取代[@ohos.wantAgent](js-apis-wantAgent.md)模块,建议优先使用本模块。
> **说明:** > **说明:**
> >
...@@ -1042,10 +1042,6 @@ try{ ...@@ -1042,10 +1042,6 @@ try{
} }
``` ```
//TODO WantAgent.trigger Callback
## WantAgent.trigger ## WantAgent.trigger
trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: AsyncCallback\<CompleteData\>): void trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: AsyncCallback\<CompleteData\>): void
...@@ -1059,7 +1055,7 @@ trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: AsyncCallback\<Co ...@@ -1059,7 +1055,7 @@ trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: AsyncCallback\<Co
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------- | ---- | ------------------------------- | | ----------- | ----------------------------- | ---- | ------------------------------- |
| agent | WantAgent | 是 | WantAgent对象。 | | agent | WantAgent | 是 | WantAgent对象。 |
| triggerInfo | TriggerInfo | 是 | TriggerInfo对象。 | | triggerInfo | [TriggerInfo](js-apis-inner-wantAgent-triggerInfo.md) | 是 | TriggerInfo对象。 |
| callback | AsyncCallback\<CompleteData\> | 否 | 主动激发WantAgent实例的回调方法。 | | callback | AsyncCallback\<CompleteData\> | 否 | 主动激发WantAgent实例的回调方法。 |
**错误码:** **错误码:**
...@@ -1096,7 +1092,7 @@ trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: AsyncCallback\<Co ...@@ -1096,7 +1092,7 @@ trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: AsyncCallback\<Co
var wantAgent; var wantAgent;
// triggerInfo // triggerInfo
var triggerInfo = { var triggerInfo = {
code: 0 code: 0 //自定义义结果码
} }
//WantAgentInfo对象 //WantAgentInfo对象
var wantAgentInfo = { var wantAgentInfo = {
......
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ---------- | --- |-------------------- | ----------- | | ---------- | --- |-------------------- | ----------- |
| code | number | 是 | result code。 | | code | number | 是 | 提供给目标wantAgent的自定义结果码。 |
| want | Want | 否 | Want。 | | want | Want | 否 | Want。 |
| permission | string | 否 | 权限定义。 | | permission | string | 否 | 权限定义。 |
| extraInfo | {[key: string]: any} | 否 | 额外数据。 | | extraInfo | {[key: string]: any} | 否 | 额外数据。 |
# @ohos.wantAgent (WantAgent模块) # @ohos.wantAgent (WantAgent模块)
WantAgent模块提供了触发、取消、比较WantAgent实例和获取bundle名称的能力,包括创建WantAgent实例、获取实例的用户ID、获取want信息等 WantAgent模块提供了创建WantAgent实例、获取实例的用户ID、获取want信息、比较WantAgent实例和获取bundle名称等能力
> **说明:** > **说明:**
> >
...@@ -8,7 +8,7 @@ WantAgent模块提供了触发、取消、比较WantAgent实例和获取bundle ...@@ -8,7 +8,7 @@ WantAgent模块提供了触发、取消、比较WantAgent实例和获取bundle
## 导入模块 ## 导入模块
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
``` ```
...@@ -29,7 +29,7 @@ getWantAgent(info: WantAgentInfo, callback: AsyncCallback\<WantAgent\>): void ...@@ -29,7 +29,7 @@ getWantAgent(info: WantAgentInfo, callback: AsyncCallback\<WantAgent\>): void
**示例:** **示例:**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
//getWantAgent回调 //getWantAgent回调
...@@ -91,7 +91,7 @@ getWantAgent(info: WantAgentInfo): Promise\<WantAgent\> ...@@ -91,7 +91,7 @@ getWantAgent(info: WantAgentInfo): Promise\<WantAgent\>
**示例:** **示例:**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
...@@ -147,7 +147,7 @@ getBundleName(agent: WantAgent, callback: AsyncCallback\<string\>): void ...@@ -147,7 +147,7 @@ getBundleName(agent: WantAgent, callback: AsyncCallback\<string\>): void
**示例:** **示例:**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
...@@ -224,7 +224,7 @@ getBundleName(agent: WantAgent): Promise\<string\> ...@@ -224,7 +224,7 @@ getBundleName(agent: WantAgent): Promise\<string\>
**示例:** **示例:**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
//wantAgent对象 //wantAgent对象
...@@ -287,7 +287,7 @@ getUid(agent: WantAgent, callback: AsyncCallback\<number\>): void ...@@ -287,7 +287,7 @@ getUid(agent: WantAgent, callback: AsyncCallback\<number\>): void
**示例:** **示例:**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
...@@ -364,7 +364,7 @@ getUid(agent: WantAgent): Promise\<number\> ...@@ -364,7 +364,7 @@ getUid(agent: WantAgent): Promise\<number\>
**示例:** **示例:**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
...@@ -430,7 +430,7 @@ getWant(agent: WantAgent, callback: AsyncCallback\<Want\>): void ...@@ -430,7 +430,7 @@ getWant(agent: WantAgent, callback: AsyncCallback\<Want\>): void
**示例:** **示例:**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
...@@ -509,7 +509,7 @@ getWant(agent: WantAgent): Promise\<Want\> ...@@ -509,7 +509,7 @@ getWant(agent: WantAgent): Promise\<Want\>
**示例:** **示例:**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
...@@ -573,7 +573,7 @@ cancel(agent: WantAgent, callback: AsyncCallback\<void\>): void ...@@ -573,7 +573,7 @@ cancel(agent: WantAgent, callback: AsyncCallback\<void\>): void
**示例:** **示例:**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
...@@ -650,7 +650,7 @@ cancel(agent: WantAgent): Promise\<void\> ...@@ -650,7 +650,7 @@ cancel(agent: WantAgent): Promise\<void\>
**示例:** **示例:**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
...@@ -710,12 +710,12 @@ trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback\<Complet ...@@ -710,12 +710,12 @@ trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback\<Complet
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------- | ---- | ------------------------------- | | ----------- | ----------------------------- | ---- | ------------------------------- |
| agent | WantAgent | 是 | WantAgent对象。 | | agent | WantAgent | 是 | WantAgent对象。 |
| triggerInfo | TriggerInfo | 是 | TriggerInfo对象。 | | triggerInfo | [TriggerInfo](js-apis-inner-wantAgent-triggerInfo.md) | 是 | TriggerInfo对象。 |
| callback | AsyncCallback\<CompleteData\> | 否 | 主动激发WantAgent实例的回调方法。 | | callback | AsyncCallback\<CompleteData\> | 否 | 主动激发WantAgent实例的回调方法。 |
**示例:** **示例:**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
...@@ -792,7 +792,7 @@ equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback\<boolean\ ...@@ -792,7 +792,7 @@ equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback\<boolean\
**示例:** **示例:**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
...@@ -872,7 +872,7 @@ equal(agent: WantAgent, otherAgent: WantAgent): Promise\<boolean\> ...@@ -872,7 +872,7 @@ equal(agent: WantAgent, otherAgent: WantAgent): Promise\<boolean\>
**示例:** **示例:**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
...@@ -936,7 +936,7 @@ getOperationType(agent: WantAgent, callback: AsyncCallback\<number>): void; ...@@ -936,7 +936,7 @@ getOperationType(agent: WantAgent, callback: AsyncCallback\<number>): void;
**示例:** **示例:**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
//wantAgent对象 //wantAgent对象
...@@ -1002,7 +1002,7 @@ getOperationType(agent: WantAgent): Promise\<number>; ...@@ -1002,7 +1002,7 @@ getOperationType(agent: WantAgent): Promise\<number>;
**示例:** **示例:**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
//wantAgent对象 //wantAgent对象
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册