Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
“380973e7b077daea0cba7ad7c0743c9c6731f03d”上不存在“paddle/fluid/lite/git@gitcode.net:Crayonxin2000/Paddle.git”
提交 8620bcf1 编写于 作者: M mingxihua
浏览文件
操作

mingxihua@huawei.com.cn 

Signed-off-by: Nmingxihua <mingxihua@huawei.com>
上级 fb3e28e8
隐藏空白更改
内联 并排
Showing with 676 addition and 762 deletion
zh-cn/application-dev/dfx/errormanager-guidelines.md
浏览文件 @ 8620bcf1
...@@ -37,10 +37,10 @@ ...@@ -37,10 +37,10 @@
## 开发示例 ## 开发示例
```ts ```ts
import Ability from '@ohos.application.Ability' import Ability from '@ohos.application.Ability'
import errorManager from '@ohos.application.errorManager' import errorManager from '@ohos.app.ability.errorManager';
var registerId = -1; let registerId = -1;
var callback = { let callback = {
onUnhandledException: function (errMsg) { onUnhandledException: function (errMsg) {
console.log(errMsg); console.log(errMsg);
} }
...@@ -49,13 +49,13 @@ var callback = { ...@@ -49,13 +49,13 @@ var callback = {
export default class MainAbility extends Ability { export default class MainAbility extends Ability {
onCreate(want, launchParam) { onCreate(want, launchParam) {
console.log("[Demo] MainAbility onCreate") console.log("[Demo] MainAbility onCreate")
registerId = errorManager.registerErrorObserver(callback); registerId = errorManager.on("error", callback);
globalThis.abilityWant = want; globalThis.abilityWant = want;
} }
onDestroy() { onDestroy() {
console.log("[Demo] MainAbility onDestroy") console.log("[Demo] MainAbility onDestroy")
errorManager.unregisterErrorObserver(registerId, (result) => { errorManager.off("error", registerId, (result) => {
console.log("[Demo] result " + result.code + ";" + result.message) console.log("[Demo] result " + result.code + ";" + result.message)
}); });
} }
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md
浏览文件 @ 8620bcf1
...@@ -17,9 +17,9 @@ import Configuration from '@ohos.app.ability.Configuration' ...@@ -17,9 +17,9 @@ import Configuration from '@ohos.app.ability.Configuration'
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| language | string | 是 | 是 | 表示应用程序的当前语言。例如：zh。 | | language | string | 是 | 是 | 表示应用程序的当前语言。例如：zh。 |
| colorMode | [ColorMode](js-apis-app-ability-configurationConstant.md#configurationconstantcolormode) | 是 | 是 | 表示深浅色模式，取值范围：浅色模式（COLOR_MODE_LIGHT），深色模式（COLOR_MODE_DARK）。默认为浅色。 | | colorMode | [ColorMode](js-apis-app-ability-configurationConstant.md#configurationconstantcolormode) | 是 | 是 | 表示深浅色模式，取值范围：未设置(COLOR_MODE_NOT_SET)，浅色模式（COLOR_MODE_LIGHT），深色模式（COLOR_MODE_DARK）。默认为浅色。 |
| direction | [Direction](js-apis-app-ability-configurationConstant.md#configurationconstantdirection) | 是 | 否 | 表示屏幕方向，取值范围：水平方向（DIRECTION_HORIZONTAL），垂直方向（DIRECTION_VERTICAL）。 | | direction | [Direction](js-apis-app-ability-configurationConstant.md#configurationconstantdirection) | 是 | 否 | 表示屏幕方向，取值范围：未设置(DIRECTION_NOT_SET)，水平方向（DIRECTION_HORIZONTAL），垂直方向（DIRECTION_VERTICAL）。 |
| screenDensity | [ScreenDensity](js-apis-app-ability-configurationConstant.md#configurationconstantscreendensity) | 是 | 否 | 表示屏幕分辨率，取值范围：SCREEN_DENSITY_SDPI（120）、SCREEN_DENSITY_MDPI（160）、SCREEN_DENSITY_LDPI（240）、SCREEN_DENSITY_XLDPI（320）、SCREEN_DENSITY_XXLDPI（480）、SCREEN_DENSITY_XXXLDPI（640）。 | | screenDensity | [ScreenDensity](js-apis-app-ability-configurationConstant.md#configurationconstantscreendensity) | 是 | 否 | 表示屏幕分辨率，取值范围：未设置(SCREEN_DENSITY_NOT_SET)，SCREEN_DENSITY_SDPI（120）、SCREEN_DENSITY_MDPI（160）、SCREEN_DENSITY_LDPI（240）、SCREEN_DENSITY_XLDPI（320）、SCREEN_DENSITY_XXLDPI（480）、SCREEN_DENSITY_XXXLDPI（640）。 |
| displayId | number | 是 | 否 | 表示应用所在的物理屏幕Id。 | | displayId | number | 是 | 否 | 表示应用所在的物理屏幕Id。 |
| hasPointerDevice | boolean | 是 | 否 | 指示指针类型设备是否已连接，如键鼠、触控板等。 | | hasPointerDevice | boolean | 是 | 否 | 指示指针类型设备是否已连接，如键鼠、触控板等。 |
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-serviceExtensionAbility.md
浏览文件 @ 8620bcf1
...@@ -80,7 +80,7 @@ Extension生命周期回调，在销毁时回调，执行资源清理等操作 ...@@ -80,7 +80,7 @@ Extension生命周期回调，在销毁时回调，执行资源清理等操作
onRequest(want: Want, startId: number): void; onRequest(want: Want, startId: number): void;
Extension生命周期回调，如果是startAbility拉起的服务，会在onCreate之后回调。每次拉起服务都会回调，startId会递增。 Extension生命周期回调，如果是startAbility或者startServiceExtensionAbility拉起的服务，会在onCreate之后回调。每次拉起服务都会回调，startId会递增。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md
浏览文件 @ 8620bcf1
...@@ -20,5 +20,34 @@ import StartOptions from '@ohos.app.ability.StartOptions'; ...@@ -20,5 +20,34 @@ import StartOptions from '@ohos.app.ability.StartOptions';
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| [windowMode](js-apis-application-abilityConstant.md#abilityconstantwindowmode) | number | 否 | 窗口模式。 | | [windowMode](js-apis-app-ability-abilityConstant.md#abilityconstantwindowmode) | number | 否 | 窗口模式。 |
| displayId | number | 否 | 显示ID。 | | displayId | number | 否 | 显示ID。 |
**示例：**
```ts
import missionManager from '@ohos.app.ability.missionManager';
try {
missionManager.getMissionInfos("", 10, (error, missions) => {
if (error.code) {
console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) +
"error.message:" + JSON.stringify(error.message));
return;
}
console.log("size = " + missions.length);
console.log("missions = " + JSON.stringify(missions));
let id = missions[0].missionId;
let startOptions = {
windowMode : 101,
displayId: 0
};
missionManager.moveMissionToFront(id, startOptions).then(() => {
console.log("moveMissionToFront is called ");
});
});
} catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message);
}
```
zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md
浏览文件 @ 8620bcf1
...@@ -548,7 +548,7 @@ release(): void; ...@@ -548,7 +548,7 @@ release(): void;
console.log(' Caller OnRelease CallBack is called ' + str); console.log(' Caller OnRelease CallBack is called ' + str);
}); });
} catch (error) { } catch (error) {
console.log('Caller.on catch error, error.code: ' + JSON.stringify(error.code) + console.log('Caller.onRelease catch error, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message)); ' error.message: ' + JSON.stringify(error.message));
} }
}).catch((err) => { }).catch((err) => {
...@@ -610,6 +610,108 @@ release(): void; ...@@ -610,6 +610,108 @@ release(): void;
} }
``` ```
## Caller.off
off(type: "release", callback: OnReleaseCallback): void;
取消注册通用组件服务端Stub（桩）断开监听通知。预留能力，当前暂未支持。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 监听releaseCall事件，固定为'release'。 |
| callback | [OnReleaseCallBack](#onreleasecallback) | 是 | 返回off回调结果。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | If the input parameter is not valid parameter. |
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
**示例：**
```ts
var caller;
export default class MainUIAbility extends UIAbility {
onWindowStageCreate(windowStage) {
this.context.startAbilityByCall({
bundleName: "com.example.myservice",
abilityName: "MainUIAbility",
deviceId: ""
}).then((obj) => {
caller = obj;
try {
let onReleaseCallBack = (str) => {
console.log(' Caller OnRelease CallBack is called ' + str);
};
caller.on("release", onReleaseCallBack);
caller.off("release", onReleaseCallBack);
} catch (error) {
console.log('Caller.on or Caller.off catch error, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
}
}).catch((err) => {
console.log('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) +
' error.message: ' + JSON.stringify(err.message));
});
}
}
```
## Caller.off
off(type: "release"): void;
取消注册通用组件服务端Stub（桩）断开监听通知。预留能力，当前暂未支持。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 监听releaseCall事件，固定为'release'。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | If the input parameter is not valid parameter. |
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
**示例：**
```ts
var caller;
export default class MainUIAbility extends UIAbility {
onWindowStageCreate(windowStage) {
this.context.startAbilityByCall({
bundleName: "com.example.myservice",
abilityName: "MainUIAbility",
deviceId: ""
}).then((obj) => {
caller = obj;
try {
let onReleaseCallBack = (str) => {
console.log(' Caller OnRelease CallBack is called ' + str);
};
caller.on("release", onReleaseCallBack);
caller.off("release");
} catch (error) {
console.error('Caller.on or Caller.off catch error, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
}
}).catch((err) => {
console.error('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) +
' error.message: ' + JSON.stringify(err.message));
});
}
}
```
## Callee ## Callee
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-want.md
浏览文件 @ 8620bcf1
...@@ -25,7 +25,7 @@ import Want from '@ohos.app.ability.Want'; ...@@ -25,7 +25,7 @@ import Want from '@ohos.app.ability.Want';
| type | string | 否 | 表示MIME type类型描述，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 | | type | string | 否 | 表示MIME type类型描述，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 |
| flags | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-ability-wantConstant.md#wantConstant.Flags)。 | | flags | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-ability-wantConstant.md#wantConstant.Flags)。 |
| action | string | 否 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。 | | action | string | 否 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。 |
| parameters | {[key: string]: any} | 否 | 表示WantParams描述，由开发者自行决定传入的键值对。默认会携带以下key值：<br>ohos.aafwk.callerPid 表示拉起方的pid。<br>ohos.aafwk.param.callerToken 表示拉起方的token。<br>ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。 | | parameters | {[key: string]: any} | 否 | 表示WantParams描述，由开发者自行决定传入的键值对。默认会携带以下key值：<br />- ohos.aafwk.callerPid：表示拉起方的pid。<br />- ohos.aafwk.param.callerToken：表示拉起方的token。<br />- ohos.aafwk.param.callerUid：表示[BundleInfo](js-apis-bundleManager-bundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。<br />- component.startup.newRules：表示是否启用新的管控规则。<br />- moduleName：表示拉起方的模块名，该字段的值即使定义成其他字符串，在传递到另一端时会被修改为正确的值。<br />- ohos.dlp.params.sandbox：表示dlp文件才会有。 | |
| entities | Array\<string> | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 | | entities | Array\<string> | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 |
| moduleName | string | 否 | 表示待启动的Ability所属的模块（module）。 | | moduleName | string | 否 | 表示待启动的Ability所属的模块（module）。 |
...@@ -122,7 +122,7 @@ import Want from '@ohos.app.ability.Want'; ...@@ -122,7 +122,7 @@ import Want from '@ohos.app.ability.Want';
"abilityName": "MainAbility", "abilityName": "MainAbility",
"moduleName": "entry", // moduleName非必选 "moduleName": "entry", // moduleName非必选
"parameters": { "parameters": {
"keyFd":{"type":"FD", "value":fd} "keyFd":{"type":"FD", "value":fd} // {"type":"FD", "value":fd}是固定用法，用于表示该数据是FD
} }
}; };
this.context.startAbility(want, (error) => { this.context.startAbility(want, (error) => {
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-wantAgent.md
浏览文件 @ 8620bcf1
...@@ -1152,6 +1152,6 @@ try { ...@@ -1152,6 +1152,6 @@ try {
| info | WantAgent | 是 | 触发的wantAgent。 | | info | WantAgent | 是 | 触发的wantAgent。 |
| want | Want | 是 | 存在的被触发的want。 | | want | Want | 是 | 存在的被触发的want。 |
| finalCode | number | 是 | 触发wantAgent的请求代码。| | finalCode | number | 是 | 触发wantAgent的请求代码。|
| finalData | string | 否 | 公共事件收集的最终数据。 | | finalData | string | 是 | 公共事件收集的最终数据。 |
| extraInfo | {[key: string]: any} | 否 | 额外数据。 | | extraInfo | {[key: string]: any} | 否 | 额外数据。 |
zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorRegistry.md
浏览文件 @ 8620bcf1
# @ohos.application.abilityDelegatorRegistry (AbilityDelegatorRegistry) # @ohos.application.abilityDelegatorRegistry (AbilityDelegatorRegistry)
AbilityDelegatorRegistry模块提供用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力，包括获取应用程序的AbilityDelegator对象、获取单元测试参数AbilityDelegatorArgs对象。 AbilityDelegatorRegistry模块提供用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力，包括获取应用程序的AbilityDelegator对象、获取单元测试参数AbilityDelegatorArgs对象。该模块中的接口只能用于测试框架中。
> **说明：** > **说明：**
> >
......
zh-cn/application-dev/reference/apis/js-apis-application-abilityManager.md
浏览文件 @ 8620bcf1
...@@ -150,119 +150,4 @@ abilitymanager.getAbilityRunningInfos().then((data) => { ...@@ -150,119 +150,4 @@ abilitymanager.getAbilityRunningInfos().then((data) => {
}).catch((err) => { }).catch((err) => {
console.log("getAbilityRunningInfos err: " + err) console.log("getAbilityRunningInfos err: " + err)
}); });
```
## getExtensionRunningInfos<sup>9+</sup>
getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<ExtensionRunningInfo>>): void
获取关于运行扩展能力的信息（callback形式）。
**需要权限**: ohos.permission.GET_RUNNING_INFO
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| upperLimit | number | 是 | 获取消息数量的最大限制。 |
| callback | AsyncCallback\<Array\<[ExtensionRunningInfo](js-apis-inner-application-extensionRunningInfo.md)>> | 是 | 被指定的回调方法。 |
**示例**：
```ts
import abilitymanager from '@ohos.application.abilityManager';
var upperLimit = 0;
abilitymanager.getExtensionRunningInfos(upperLimit, (err,data) => {
console.log("getExtensionRunningInfos err: " + err + " data: " + JSON.stringify(data));
});
```
## getExtensionRunningInfos<sup>9+</sup>
getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningInfo>>
获取关于运行扩展能力的信息（Promise形式）。
**需要权限**: ohos.permission.GET_RUNNING_INFO
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| upperLimit | number | 是 | 获取消息数量的最大限制。 |
**返回值：**
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise\<Array\<[ExtensionRunningInfo](js-apis-inner-application-extensionRunningInfo.md)>> | 返回执行结果。 |
**示例**：
```ts
import abilitymanager from '@ohos.application.abilityManager';
var upperLimit = 0;
abilitymanager.getExtensionRunningInfos(upperLimit).then((data) => {
console.log("getAbilityRunningInfos data: " + JSON.stringify(data));
}).catch((err) => {
console.log("getAbilityRunningInfos err: " + err);
})
```
## getTopAbility<sup>9+</sup>
getTopAbility(callback: AsyncCallback\<ElementName>): void;
获取窗口焦点的ability接口（callback形式）。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<[ElementName](js-apis-bundleManager-elementName.md)> | 是 | 被指定的回调方法。 |
**示例**：
```ts
import abilitymanager from '@ohos.application.abilityManager';
abilitymanager.getTopAbility((err,data) => {
console.log("getTopAbility err: " + err + " data: " + JSON.stringify(data));
});
```
## getTopAbility<sup>9+</sup>
getTopAbility(): Promise\<ElementName>;
获取窗口焦点的ability接口（Promise形式）。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise\<[ElementName](js-apis-bundleManager-elementName.md)>| 返回执行结果。 |
**示例**：
```ts
import abilitymanager from '@ohos.application.abilityManager';
abilitymanager.getTopAbility().then((data) => {
console.log("getTopAbility data: " + JSON.stringify(data));
}).catch((err) => {
console.log("getTopAbility err: " + err);
})
``` ```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-application-appManager.md
浏览文件 @ 8620bcf1
...@@ -161,7 +161,7 @@ getProcessRunningInfos(): Promise\<Array\<ProcessRunningInfo>>; ...@@ -161,7 +161,7 @@ getProcessRunningInfos(): Promise\<Array\<ProcessRunningInfo>>;
获取有关运行进程的信息。 获取有关运行进程的信息。
> 从 API Version 9 开始废弃，建议使用[appManager.getProcessRunningInformation<sup>9+</sup>](#appmanagergetprocessrunninginformation9)替代。 > 从 API Version 9 开始废弃，建议使用[appManager.getProcessRunningInformation<sup>9+</sup>](js-apis-app-ability-appManager.md#appmanagergetprocessrunninginformation9)替代。
**需要权限**：ohos.permission.GET_RUNNING_INFO **需要权限**：ohos.permission.GET_RUNNING_INFO
...@@ -189,7 +189,7 @@ getProcessRunningInfos(callback: AsyncCallback\<Array\<ProcessRunningInfo>>): vo ...@@ -189,7 +189,7 @@ getProcessRunningInfos(callback: AsyncCallback\<Array\<ProcessRunningInfo>>): vo
获取有关运行进程的信息。 获取有关运行进程的信息。
> 从 API Version 9 开始废弃，建议使用[appManager.getProcessRunningInformation<sup>9+</sup>](#appmanagergetprocessrunninginformation9-1)替代。 > 从 API Version 9 开始废弃，建议使用[appManager.getProcessRunningInformation<sup>9+</sup>](js-apis-app-ability-appManager.md#appmanagergetprocessrunninginformation9-1)替代。
**需要权限**：ohos.permission.GET_RUNNING_INFO **需要权限**：ohos.permission.GET_RUNNING_INFO
...@@ -684,32 +684,4 @@ clearUpApplicationData(bundleName: string): Promise\<void>; ...@@ -684,32 +684,4 @@ clearUpApplicationData(bundleName: string): Promise\<void>;
.catch((err) => { .catch((err) => {
console.log('------------ clearUpApplicationData fail ------------', err); console.log('------------ clearUpApplicationData fail ------------', err);
}) })
``` ```
\ No newline at end of file
## ApplicationState<sup>9+</sup>
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
| 名称 | 值 | 说明 |
| -------------------- | --- | --------------------------------- |
| STATE_CREATE | 1 | 当应用在创建中的时候处于的状态。 |
| STATE_FOREGROUND | 2 | 当应用切换到前台的时候处于的状态。 |
| STATE_ACTIVE | 3 | 当应用在获焦的时候处于的状态。 |
| STATE_BACKGROUND | 4 | 当应用处于后台不可见时处于的状态。 |
| STATE_DESTROY | 5 | 当应用在销毁的时候处于的状态。 |
## ProcessState<sup>9+</sup>
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
| 名称 | 值 | 说明 |
| -------------------- | --- | --------------------------------- |
| STATE_CREATE | 1 | 当进程在创建中的时候处于的状态。 |
| STATE_FOREGROUND | 2 | 当进程切换到前台的时候处于的状态。 |
| STATE_ACTIVE | 3 | 当进程在获焦的时候处于的状态。 |
| STATE_BACKGROUND | 4 | 当进程处于后台不可见时处于的状态。 |
| STATE_DESTROY | 5 | 当进程在销毁的时候处于的状态。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-application-configuration.md
浏览文件 @ 8620bcf1
...@@ -18,10 +18,6 @@ import Configuration from '@ohos.application.Configuration' ...@@ -18,10 +18,6 @@ import Configuration from '@ohos.application.Configuration'
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| language<sup>8+</sup> | string | 是 | 是 | 表示应用程序的当前语言。 | | language<sup>8+</sup> | string | 是 | 是 | 表示应用程序的当前语言。 |
| colorMode<sup>8+</sup> | [ColorMode](js-apis-application-configurationConstant.md#configurationconstantcolormode) | 是 | 是 | 表示深浅色模式，取值范围：浅色模式（COLOR_MODE_LIGHT），深色模式（COLOR_MODE_DARK）。默认为浅色。 | | colorMode<sup>8+</sup> | [ColorMode](js-apis-application-configurationConstant.md#configurationconstantcolormode) | 是 | 是 | 表示深浅色模式，取值范围：浅色模式（COLOR_MODE_LIGHT），深色模式（COLOR_MODE_DARK）。默认为浅色。 |
| direction<sup>9+</sup> | [Direction](js-apis-application-configurationConstant.md#configurationconstantdirection9) | 是 | 否 | 表示屏幕方向，取值范围：水平方向（DIRECTION_HORIZONTAL），垂直方向（DIRECTION_VERTICAL）。 |
| screenDensity<sup>9+</sup> | [ScreenDensity](js-apis-application-configurationConstant.md#configurationconstantscreendensity9) | 是 | 否 | 表示屏幕分辨率，取值范围：SCREEN_DENSITY_SDPI（120）、SCREEN_DENSITY_MDPI（160）、SCREEN_DENSITY_LDPI（240）、SCREEN_DENSITY_XLDPI（320）、SCREEN_DENSITY_XXLDPI（480）、SCREEN_DENSITY_XXXLDPI（640）。 |
| displayId<sup>9+</sup> | number | 是 | 否 | 表示应用所在的物理屏幕Id。 |
| hasPointerDevice<sup>9+</sup> | boolean | 是 | 否 | 指示指针类型设备是否已连接，如键鼠、触控板等。 |
具体字段描述参考ohos.application.Configuration.d.ts文件 具体字段描述参考ohos.application.Configuration.d.ts文件
...@@ -45,10 +41,6 @@ export default class MainAbility extends Ability { ...@@ -45,10 +41,6 @@ export default class MainAbility extends Ability {
console.info(`envCallback onConfigurationUpdated success: ${JSON.stringify(config)}`) console.info(`envCallback onConfigurationUpdated success: ${JSON.stringify(config)}`)
let language = config.language; let language = config.language;
let colorMode = config.colorMode; let colorMode = config.colorMode;
let direction = config.direction;
let screenDensity = config.screenDensity;
let displayId = config.displayId;
let hasPointerDevice = config.hasPointerDevice;
} }
}; };
......
zh-cn/application-dev/reference/apis/js-apis-application-configurationConstant.md
浏览文件 @ 8620bcf1
...@@ -24,32 +24,3 @@ import ConfigurationConstant from '@ohos.application.ConfigurationConstant'; ...@@ -24,32 +24,3 @@ import ConfigurationConstant from '@ohos.application.ConfigurationConstant';
| COLOR_MODE_DARK | 0 | 深色模式。 | | COLOR_MODE_DARK | 0 | 深色模式。 |
| COLOR_MODE_LIGHT | 1 | 浅色模式。 | | COLOR_MODE_LIGHT | 1 | 浅色模式。 |
## ConfigurationConstant.Direction<sup>9+</sup>
使用时通过ConfigurationConstant.Direction获取。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| DIRECTION_NOT_SET | -1 | 未设置方向。 |
| DIRECTION_VERTICAL | 0 | 垂直方向。 |
| DIRECTION_HORIZONTAL | 1 | 水平方向。 |
## ConfigurationConstant.ScreenDensity<sup>9+</sup>
使用时通过ConfigurationConstant.ScreenDensity获取。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| SCREEN_DENSITY_NOT_SET | 0 | 未设置屏幕分辨率。 |
| SCREEN_DENSITY_SDPI | 120 | 屏幕分辨率为"sdpi"。 |
| SCREEN_DENSITY_MDPI | 160 | 屏幕分辨率为"mdpi"。 |
| SCREEN_DENSITY_LDPI | 240 | 屏幕分辨率为"ldpi"。 |
| SCREEN_DENSITY_XLDPI | 320 | 屏幕分辨率为"xldpi"。 |
| SCREEN_DENSITY_XXLDPI | 480 | 屏幕分辨率为"xxldpi"。 |
| SCREEN_DENSITY_XXXLDPI | 640 | 屏幕分辨率为"xxxldpi"。 |
zh-cn/application-dev/reference/apis/js-apis-application-context.md 已删除 100644 → 0
浏览文件 @ fb3e28e8
# @ohos.application.context (Context)
Context模块将二级模块API组织在一起方便开发者进行导出。
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用
## 导入模块
```ts
import context from '@ohos.application.context'
```
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| AbilityContext | 只读 | [AbilityContext](js-apis-ability-context.md) | 否 | AbilityContext二级模块。 |
| AbilityStageContext | 只读 | [AbilityStageContext](js-apis-inner-application-abilityStageContext.md) | 否 | AbilityStageContext二级模块。 |
| ApplicationContext | 只读 | [ApplicationContext](js-apis-inner-application-applicationContext.md) | 否 | ApplicationContext二级模块。 |
| BaseContext | 只读 | [BaseContext](js-apis-inner-application-baseContext.md) | 否 | BaseContext二级模块。 |
| Context | 只读 | [Context](js-apis-inner-application-context.md) | 否 | Context二级模块。 |
| ExtensionContext | 只读 | [ExtensionContext](js-apis-inner-application-extensionContext.md) | 否 | ExtensionContext二级模块。 |
| FormExtensionContext | 只读 | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | 否 | FormExtensionContext二级模块。 |
| EventHub | 只读 | [EventHub](js-apis-inner-application-eventHub.md) | 否 | EventHub二级模块。 |
| PermissionRequestResult | 只读 | [PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md) | 否 | PermissionRequestResult二级模块。 |
**示例：**
```ts
let abilityContext: context.AbilityContext;
let abilityStageContext: context.AbilityStageContext;
let applicationContext: context.ApplicationContext;
let baseContext: context.BaseContext;
let context: context.Context;
let extensionContext: context.ExtensionContext;
let formExtensionContext: context.FormExtensionContext;
let eventHub: context.EventHub;
let permissionRequestResult: context.PermissionRequestResult;
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-application-extensionAbility.md 已删除 100644 → 0
浏览文件 @ fb3e28e8
# @ohos.application.ExtensionAbility (ExtensionAbility)
ExtensionAbility模块提供对ExtensionAbility生命周期、上下文环境等调用管理的能力，包括ExtensionAbility创建、销毁、转储客户端信息等。
> **说明：**
>
> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
```ts
import ExtensionAbility from '@ohos.application.ExtensionAbility';
```
## ExtensionAbility.onConfigurationUpdated
onConfigurationUpdated(newConfig: Configuration): void;
当系统配置更新时调用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| newConfig | [Configuration](js-apis-application-configuration.md) | 是 | 表示需要更新的配置信息。 |
**示例：**
```ts
class MyExtensionAbility extends ExtensionAbility {
onConfigurationUpdated(config) {
console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
}
}
```
## ExtensionAbility.onMemoryLevel
onMemoryLevel(level: AbilityConstant.MemoryLevel): void;
当系统已决定调整内存时调用。例如，当该功能在后台运行时，没有足够的内存来运行尽可能多的后台进程时可以使用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| level | [AbilityConstant.MemoryLevel](js-apis-application-abilityConstant.md#abilityconstantmemorylevel) | 是 | 回调返回内存微调级别，显示当前内存使用状态。|
**示例：**
```ts
class MyExtensionAbility extends ExtensionAbility {
onMemoryLevel(level) {
console.log('onMemoryLevel, level:' + JSON.stringify(level));
}
}
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-application-want.md
浏览文件 @ 8620bcf1
...@@ -4,7 +4,7 @@ Want是对象间信息传递的载体, 可以用于应用组件间的信息传 ...@@ -4,7 +4,7 @@ Want是对象间信息传递的载体, 可以用于应用组件间的信息传
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 8 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8 开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.Want](js-apis-app-ability-want.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
...@@ -25,7 +25,7 @@ import Want from '@ohos.application.Want'; ...@@ -25,7 +25,7 @@ import Want from '@ohos.application.Want';
| type | string | 否 | 表示MIME type类型描述，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 | | type | string | 否 | 表示MIME type类型描述，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 |
| flags | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-ability-wantConstant.md#wantConstant.Flags)。 | | flags | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-ability-wantConstant.md#wantConstant.Flags)。 |
| action | string | 否 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。 | | action | string | 否 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。 |
| parameters | {[key: string]: any} | 否 | 表示WantParams描述，由开发者自行决定传入的键值对。默认会携带以下key值：<br>ohos.aafwk.callerPid 表示拉起方的pid。<br>ohos.aafwk.param.callerToken 表示拉起方的token。<br>ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。 | | parameters | {[key: string]: any} | 否 | 表示WantParams描述，由开发者自行决定传入的键值对。默认会携带以下key值：<br>ohos.aafwk.callerPid 表示拉起方的pid。<br>ohos.aafwk.param.callerToken 表示拉起方的token。<br>ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。<br />- component.startup.newRules：表示是否启用新的管控规则。<br />- moduleName：表示拉起方的模块名，该字段的值即使定义成其他字符串，在传递到另一端时会被修改为正确的值。<br />- ohos.dlp.params.sandbox：表示dlp文件才会有。 | |
| entities | Array\<string> | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 | | entities | Array\<string> | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 |
| moduleName<sup>9+</sup> | string | 否 | 表示待启动的Ability所属的模块（module）。 | | moduleName<sup>9+</sup> | string | 否 | 表示待启动的Ability所属的模块（module）。 |
......
zh-cn/application-dev/reference/apis/js-apis-inner-ability-connectOptions.md
浏览文件 @ 8620bcf1
...@@ -10,3 +10,25 @@ ...@@ -10,3 +10,25 @@
| onDisconnect<sup>7+</sup> | function | 是 | 断开连接时的回调函数。 | | onDisconnect<sup>7+</sup> | function | 是 | 断开连接时的回调函数。 |
| onFailed<sup>7+</sup> | function | 是 | 连接失败时的回调函数。 | | onFailed<sup>7+</sup> | function | 是 | 连接失败时的回调函数。 |
**示例：**
```ts
let want = {
bundleName: "com.example.myapp",
abilityName: "MyAbility"
};
let connectOptions = {
onConnect(elementName, remote) {
console.log('onConnect elementName: ' + elementName);
},
onDisconnect(elementName) {
console.log('onDisconnect elementName: ' + elementName);
},
onFailed(code) {
console.error('onFailed code: ' + code);
}
}
let connection = this.context.connectAbility(want, connectOptions);
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-ability-want.md
浏览文件 @ 8620bcf1
...@@ -4,7 +4,7 @@ Want是对象间信息传递的载体, 可以用于应用组件间的信息传 ...@@ -4,7 +4,7 @@ Want是对象间信息传递的载体, 可以用于应用组件间的信息传
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 6开始支持，从API version 9废弃，使用[@ohos.app.ability.Want](js-apis-app-ability-want.md)模块替代。后续版本的新增接口，采用上角标单独标记接口的起始版本。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
...@@ -17,7 +17,7 @@ Want是对象间信息传递的载体, 可以用于应用组件间的信息传 ...@@ -17,7 +17,7 @@ Want是对象间信息传递的载体, 可以用于应用组件间的信息传
| type | string | 否 | 表示MIME type类型，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 | | type | string | 否 | 表示MIME type类型，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 |
| flags | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-ability-wantConstant.md#wantConstant.Flags)。 | | flags | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-ability-wantConstant.md#wantConstant.Flags)。 |
| action | string | 否 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。 | | action | string | 否 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。 |
| parameters | {[key: string]: any} | 否 | 表示WantParams，由开发者自行决定传入的键值对。默认会携带以下key值：<br>ohos.aafwk.callerPid 表示拉起方的pid。<br>ohos.aafwk.param.callerToken 表示拉起方的token。<br>ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。 | | parameters | {[key: string]: any} | 否 | 表示WantParams，由开发者自行决定传入的键值对。默认会携带以下key值：<br>ohos.aafwk.callerPid 表示拉起方的pid。<br>ohos.aafwk.param.callerToken 表示拉起方的token。<br>ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。<br />- component.startup.newRules：表示是否启用新的管控规则。<br />- moduleName：表示拉起方的模块名，该字段的值即使定义成其他字符串，在传递到另一端时会被修改为正确的值。<br />- ohos.dlp.params.sandbox：表示dlp文件才会有。 | |
| entities | Array\<string> | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 | | entities | Array\<string> | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 |
| moduleName<sup>9+</sup> | string | 否 | 表示待启动的Ability所属的模块（module）。 | | moduleName<sup>9+</sup> | string | 否 | 表示待启动的Ability所属的模块（module）。 |
......
zh-cn/application-dev/reference/apis/js-apis-inner-app-processInfo.md
浏览文件 @ 8620bcf1
...@@ -19,9 +19,11 @@ import featureAbility from '@ohos.ability.featureAbility'; ...@@ -19,9 +19,11 @@ import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getProcessInfo((err, data) => { context.getProcessInfo((err, data) => {
console.info("getProcessInfo err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); if (err.code != 0) {
let pid = data.pid; console.info("getProcessInfo err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
let processName = data.processName; let pid = data.pid;
let processName = data.processName;
}
}); });
``` ```
zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationContext.md
浏览文件 @ 8620bcf1
...@@ -15,9 +15,9 @@ ApplicationContext模块提供开发者应用级别的的上下文的能力， ...@@ -15,9 +15,9 @@ ApplicationContext模块提供开发者应用级别的的上下文的能力，
let applicationContext = this.context.getApplicationContext(); let applicationContext = this.context.getApplicationContext();
``` ```
## ApplicationContext.registerAbilityLifecycleCallback ## ApplicationContext.on(type: "abilityLifecycle", callback: AbilityLifecycleCallback)
registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): **number**; on(type: "abilityLifecycle", callback: AbilityLifecycleCallback): **number**;
注册监听应用内生命周期 注册监听应用内生命周期
...@@ -27,6 +27,7 @@ registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): **number** ...@@ -27,6 +27,7 @@ registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): **number**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------------------ | -------- | ---- | ------------------------------ | | ------------------------ | -------- | ---- | ------------------------------ |
| type | "abilityLifecycle" | 是 | 监听事件的类型。 |
| callback | [AbilityLifecycleCallback](js-apis-app-ability-abilityLifecycleCallback.md) | 是 | 回调方法，返回注册监听事件的ID。 | | callback | [AbilityLifecycleCallback](js-apis-app-ability-abilityLifecycleCallback.md) | 是 | 回调方法，返回注册监听事件的ID。 |
**返回值：** **返回值：**
...@@ -38,58 +39,58 @@ registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): **number** ...@@ -38,58 +39,58 @@ registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): **number**
**示例：** **示例：**
```ts ```ts
import Ability from "@ohos.application.Ability"; import UIAbility from '@ohos.app.ability.UIAbility';
var lifecycleId; var lifecycleId;
export default class MyAbility extends Ability { export default class EntryAbility extends UIAbility {
onCreate() { onCreate() {
console.log("MyAbility onCreate") console.log("MyAbility onCreate")
let AbilityLifecycleCallback = { let AbilityLifecycleCallback = {
onAbilityCreate(ability) { onAbilityCreate(ability) {
console.log("AbilityLifecycleCallback onAbilityCreate ability:" + JSON.stringify(ability)); console.log("AbilityLifecycleCallback onAbilityCreate ability:" + ability);
}, },
onWindowStageCreate(ability, windowStage) { onWindowStageCreate(ability, windowStage) {
console.log("AbilityLifecycleCallback onWindowStageCreate ability:" + JSON.stringify(ability)); console.log("AbilityLifecycleCallback onWindowStageCreate ability:" + ability);
console.log("AbilityLifecycleCallback onWindowStageCreate windowStage:" + JSON.stringify(windowStage)); console.log("AbilityLifecycleCallback onWindowStageCreate windowStage:" + windowStage);
}, },
onWindowStageActive(ability, windowStage) { onWindowStageActive(ability, windowStage) {
console.log("AbilityLifecycleCallback onWindowStageActive ability:" + JSON.stringify(ability)); console.log("AbilityLifecycleCallback onWindowStageActive ability:" + ability);
console.log("AbilityLifecycleCallback onWindowStageActive windowStage:" + JSON.stringify(windowStage)); console.log("AbilityLifecycleCallback onWindowStageActive windowStage:" + windowStage);
}, },
onWindowStageInactive(ability, windowStage) { onWindowStageInactive(ability, windowStage) {
console.log("AbilityLifecycleCallback onWindowStageInactive ability:" + JSON.stringify(ability)); console.log("AbilityLifecycleCallback onWindowStageInactive ability:" + ability);
console.log("AbilityLifecycleCallback onWindowStageInactive windowStage:" + JSON.stringify(windowStage)); console.log("AbilityLifecycleCallback onWindowStageInactive windowStage:" + windowStage);
}, },
onWindowStageDestroy(ability, windowStage) { onWindowStageDestroy(ability, windowStage) {
console.log("AbilityLifecycleCallback onWindowStageDestroy ability:" + JSON.stringify(ability)); console.log("AbilityLifecycleCallback onWindowStageDestroy ability:" + ability);
console.log("AbilityLifecycleCallback onWindowStageDestroy windowStage:" + JSON.stringify(windowStage)); console.log("AbilityLifecycleCallback onWindowStageDestroy windowStage:" + windowStage);
}, },
onAbilityDestroy(ability) { onAbilityDestroy(ability) {
console.log("AbilityLifecycleCallback onAbilityDestroy ability:" + JSON.stringify(ability)); console.log("AbilityLifecycleCallback onAbilityDestroy ability:" + ability);
}, },
onAbilityForeground(ability) { onAbilityForeground(ability) {
console.log("AbilityLifecycleCallback onAbilityForeground ability:" + JSON.stringify(ability)); console.log("AbilityLifecycleCallback onAbilityForeground ability:" + ability);
}, },
onAbilityBackground(ability) { onAbilityBackground(ability) {
console.log("AbilityLifecycleCallback onAbilityBackground ability:" + JSON.stringify(ability)); console.log("AbilityLifecycleCallback onAbilityBackground ability:" + ability);
}, },
onAbilityContinue(ability) { onAbilityContinue(ability) {
console.log("AbilityLifecycleCallback onAbilityContinue ability:" + JSON.stringify(ability)); console.log("AbilityLifecycleCallback onAbilityContinue ability:" + ability);
} }
} }
// 1.通过context属性获取applicationContext // 1.通过context属性获取applicationContext
let applicationContext = this.context.getApplicationContext(); let applicationContext = this.context.getApplicationContext();
// 2.通过applicationContext注册监听应用内生命周期 // 2.通过applicationContext注册监听应用内生命周期
lifecycleId = applicationContext.registerAbilityLifecycleCallback(AbilityLifecycleCallback); lifecycleId = applicationContext.on("abilityLifecycle", AbilityLifecycleCallback);
console.log("registerAbilityLifecycleCallback number: " + JSON.stringify(lifecycleId)); console.log("registerAbilityLifecycleCallback number: " + JSON.stringify(lifecycleId));
} }
} }
``` ```
## ApplicationContext.unregisterAbilityLifecycleCallback ## ApplicationContext.off(type: "abilityLifecycle", callbackId: number, callback: AsyncCallback<void>)
unregisterAbilityLifecycleCallback(callbackId: **number**, callback: AsyncCallback<**void**>): **void**; off(type: "abilityLifecycle", callbackId: **number**, callback: AsyncCallback<**void**>): **void**;
取消监听应用内生命周期 取消监听应用内生命周期
...@@ -99,30 +100,62 @@ unregisterAbilityLifecycleCallback(callbackId: **number**, callback: AsyncCallb ...@@ -99,30 +100,62 @@ unregisterAbilityLifecycleCallback(callbackId: **number**, callback: AsyncCallb
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------- | -------- | ---- | -------------------------- | | ------------- | -------- | ---- | -------------------------- |
| type | "abilityLifecycle" | 是 | 取消监听事件的类型。 |
| callbackId | number | 是 | 注册监听应用内生命周期的ID。 | | callbackId | number | 是 | 注册监听应用内生命周期的ID。 |
| callback | AsyncCallback\<void> | 是 | 回调方法。 | | callback | AsyncCallback\<void> | 是 | 回调方法。 |
**示例：** **示例：**
```ts ```ts
import Ability from "@ohos.application.Ability"; import UIAbility from '@ohos.app.ability.UIAbility';
var lifecycleId; var lifecycleId;
export default class MyAbility extends Ability { export default class EntryAbility extends UIAbility {
onDestroy() { onDestroy() {
let applicationContext = this.context.getApplicationContext(); let applicationContext = this.context.getApplicationContext();
console.log("stage applicationContext: " + JSON.stringify(applicationContext)); console.log("stage applicationContext: " + applicationContext);
applicationContext.unregisterAbilityLifecycleCallback(lifecycleId, (error, data) => { applicationContext.off(type: "abilityLifecycle", lifecycleId, (error, data) => {
console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error)); console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error));
}); });
} }
} }
``` ```
## ApplicationContext.registerEnvironmentCallback ## ApplicationContext.off(type: "abilityLifecycle", callbackId: number)
off(type: "abilityLifecycle", callbackId: **number**): **void**;
取消监听应用内生命周期
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------- | -------- | ---- | -------------------------- |
| type | "abilityLifecycle" | 是 | 取消监听事件的类型。 |
| callbackId | number | 是 | 注册监听应用内生命周期的ID。 |
**示例：**
```ts
import Ability from "@ohos.app.ability.UIAbility";
var lifecycleId;
export default class MyAbility extends Ability {
onDestroy() {
let applicationContext = this.context.getApplicationContext();
console.log("stage applicationContext: " + applicationContext);
applicationContext.off(type: "abilityLifecycle", lifecycleId);
}
}
```
## ApplicationContext.on(type: "environment", callback: EnvironmentCallback)
registerEnvironmentCallback(callback: EnvironmentCallback): **number**; on(type: "environment", callback: EnvironmentCallback): **number**;
注册对系统环境变化的监听。使用callback异步回调。 注册对系统环境变化的监听。使用callback异步回调。
...@@ -132,6 +165,7 @@ registerEnvironmentCallback(callback: EnvironmentCallback): **number**; ...@@ -132,6 +165,7 @@ registerEnvironmentCallback(callback: EnvironmentCallback): **number**;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------------------ | -------- | ---- | ------------------------------ | | ------------------------ | -------- | ---- | ------------------------------ |
| type | "environment" | 是 | 监听事件的类型。 |
| callback | [EnvironmentCallback](js-apis-app-ability-environmentCallback.md) | 是 | 回调方法，返回注册监听事件的ID。 | | callback | [EnvironmentCallback](js-apis-app-ability-environmentCallback.md) | 是 | 回调方法，返回注册监听事件的ID。 |
**返回值：** **返回值：**
...@@ -143,11 +177,11 @@ registerEnvironmentCallback(callback: EnvironmentCallback): **number**; ...@@ -143,11 +177,11 @@ registerEnvironmentCallback(callback: EnvironmentCallback): **number**;
**示例：** **示例：**
```ts ```ts
import Ability from "@ohos.application.Ability"; import UIAbility from '@ohos.app.ability.UIAbility';
var callbackId; var callbackId;
export default class MyAbility extends Ability { export default class EntryAbility extends UIAbility {
onCreate() { onCreate() {
console.log("MyAbility onCreate") console.log("MyAbility onCreate")
globalThis.applicationContext = this.context.getApplicationContext(); globalThis.applicationContext = this.context.getApplicationContext();
...@@ -155,19 +189,22 @@ export default class MyAbility extends Ability { ...@@ -155,19 +189,22 @@ export default class MyAbility extends Ability {
onConfigurationUpdated(config){ onConfigurationUpdated(config){
console.log("onConfigurationUpdated config:" + JSON.stringify(config)); console.log("onConfigurationUpdated config:" + JSON.stringify(config));
}, },
onMemoryLevel(level){
console.log("onMemoryLevel level:" + level);
}
} }
// 1.获取applicationContext // 1.获取applicationContext
let applicationContext = globalThis.applicationContext; let applicationContext = globalThis.applicationContext;
// 2.通过applicationContext注册监听应用内生命周期 // 2.通过applicationContext注册监听应用内生命周期
callbackId = applicationContext.registerEnvironmentCallback(EnvironmentCallback); callbackId = applicationContext.on("environment", EnvironmentCallback);
console.log("registerEnvironmentCallback number: " + JSON.stringify(callbackId)); console.log("registerEnvironmentCallback number: " + JSON.stringify(callbackId));
} }
} }
``` ```
## ApplicationContext.unregisterEnvironmentCallback ## ApplicationContext.off(type: "environment", callbackId: number, callback: AsyncCallback<void>)
unregisterEnvironmentCallback(callbackId: **number**, callback: AsyncCallback<**void**>): **void**; off(type: "environment", callbackId: **number**, callback: AsyncCallback<**void**>): **void**;
取消对系统环境变化的监听。使用callback异步回调。 取消对系统环境变化的监听。使用callback异步回调。
...@@ -177,22 +214,163 @@ unregisterEnvironmentCallback(callbackId: **number**, callback: AsyncCallback<* ...@@ -177,22 +214,163 @@ unregisterEnvironmentCallback(callbackId: **number**, callback: AsyncCallback<*
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------- | -------- | ---- | -------------------------- | | ------------- | -------- | ---- | -------------------------- |
| type | "environment" | 是 | 取消监听事件的类型。 |
| callbackId | number | 是 | 注册监听系统环境变化的ID。 | | callbackId | number | 是 | 注册监听系统环境变化的ID。 |
| callback | AsyncCallback\<void> | 是 | 回调方法。 | | callback | AsyncCallback\<void> | 是 | 回调方法。 |
**示例：** **示例：**
```ts ```ts
import Ability from "@ohos.application.Ability"; import UIAbility from '@ohos.app.ability.UIAbility';
var callbackId; var callbackId;
export default class MyAbility extends Ability { export default class EntryAbility extends UIAbility {
onDestroy() { onDestroy() {
let applicationContext = this.context.getApplicationContext(); let applicationContext = this.context.getApplicationContext();
applicationContext.unregisterEnvironmentCallback(callbackId, (error, data) => { applicationContext.off("environment", callbackId, (error, data) => {
console.log("unregisterEnvironmentCallback success, err: " + JSON.stringify(error)); console.log("unregisterEnvironmentCallback success, err: " + JSON.stringify(error));
}); });
} }
} }
```
## ApplicationContext.off(type: "environment", callbackId: number)
off(type: "environment", callbackId: **number**, callback: AsyncCallback<**void**>): **void**;
取消对系统环境变化的监听。使用callback异步回调。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------- | -------- | ---- | -------------------------- |
| type | "environment" | 是 | 取消监听事件的类型。 |
| callbackId | number | 是 | 注册监听系统环境变化的ID。 |
**示例：**
```ts
import Ability from "@ohos.app.ability.UIAbility";
var callbackId;
export default class MyAbility extends Ability {
onDestroy() {
let applicationContext = this.context.getApplicationContext();
applicationContext.off("environment", callbackId);
}
}
```
## ApplicationContext.getProcessRunningInformation<sup>9+</sup>
getProcessRunningInformation(): Promise\<Array\<ProcessRunningInformation>>;
获取有关运行进程的信息。
**需要权限**：ohos.permission.GET_RUNNING_INFO
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise\<Array\<[ProcessRunningInformation](js-apis-inner-application-processRunningInformation.md)>> | 以Promise方式返回接口运行结果及有关运行进程的信息，可进行错误处理或其他自定义处理。 |
**示例：**
```ts
let applicationContext = this.context.getApplicationContext();
applicationContext.getProcessRunningInformation().then((data) => {
console.log("The process running information is:" + JSON.stringify(data));
}).catch((error) => {
console.log("error:" + JSON.stringify(error));
});
```
## ApplicationContext.getProcessRunningInformation<sup>9+</sup>
getProcessRunningInformation(callback: AsyncCallback\<Array\<ProcessRunningInformation>>): void;
获取有关运行进程的信息。
**需要权限**：ohos.permission.GET_RUNNING_INFO
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
|AsyncCallback\<Array\<[ProcessRunningInformation](js-apis-inner-application-processRunningInformation.md)>> | 以回调方式返回接口运行结果及有关运行进程的信息，可进行错误处理或其他自定义处理。 |
**示例：**
```ts
let applicationContext = this.context.getApplicationContext();
applicationContext.getProcessRunningInformation((err, data) => {
if (err.code !== 0) {
console.error("getProcessRunningInformation faile, err: " + JSON.stringify(err));
} else {
console.log("The process running information is:" + JSON.stringify(data));
}
})
```
## ApplicationContext.killProcessesBySelf<sup>9+</sup>
killProcessesBySelf(): Promise<void>;
杀死应用所在的进程。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise\<void>> | 以Promise方式返回杀死应用所在的进程结果。 |
**示例：**
```ts
let applicationContext = this.context.getApplicationContext();
applicationContext.killProcessesBySelf().then((data) => {
console.log("The process running information is:" + JSON.stringify(data));
}).catch((error) => {
console.error("error:" + JSON.stringify(error));
});
```
## ApplicationContext.killProcessesBySelf<sup>9+</sup>
killProcessesBySelf(callback: AsyncCallback<void>);
杀死应用所在的进程。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
|AsyncCallback\<void> | 以callback方式返回杀死应用所在的进程结果。 |
**示例：**
```ts
let applicationContext = this.context.getApplicationContext();
applicationContext.killProcessesBySelf(err => {
if (err.code !== 0) {
console.error("killProcessesBySelf faile, err: " + JSON.stringify(err));
}
})
``` ```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-application-serviceExtensionContext.md
浏览文件 @ 8620bcf1
...@@ -1214,7 +1214,7 @@ disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback&lt; ...@@ -1214,7 +1214,7 @@ disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback&lt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| connection | number | 是 | 在connectAbility中返回的number。 | | connection | number | 是 | 在connectServiceExtensionAbility中返回的number。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数，返回接口调用是否成功的结果。 | | callback | AsyncCallback&lt;void&gt; | 否 | 回调函数，返回接口调用是否成功的结果。 |
**错误码：** **错误码：**
...@@ -1266,7 +1266,7 @@ disconnectServiceExtensionAbility(connection: number): Promise&lt;void&gt;; ...@@ -1266,7 +1266,7 @@ disconnectServiceExtensionAbility(connection: number): Promise&lt;void&gt;;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| connection | number | 是 | 在connectAbility中返回的number。 | | connection | number | 是 | 在connectServiceExtensionAbility中返回的number。 |
**返回值：** **返回值：**
...@@ -1288,7 +1288,7 @@ disconnectServiceExtensionAbility(connection: number): Promise&lt;void&gt;; ...@@ -1288,7 +1288,7 @@ disconnectServiceExtensionAbility(connection: number): Promise&lt;void&gt;;
**示例：** **示例：**
```ts ```ts
// connection为connectAbility中的返回值 // connection为connectServiceExtensionAbility中的返回值
var connection = 1; var connection = 1;
try { try {
......
zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-triggerInfo.md
浏览文件 @ 8620bcf1
# TriggerInfo # TriggerInfo
作为[trigger](js-apis-app-ability-wantAgent.md#wantagenttrigger)的入参定义触发WantAgent所需要的的信息。 作为[trigger](js-apis-app-ability-wantAgent.md#wantagenttrigger)的入参定义触发WantAgent所需要的信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
......
zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md
浏览文件 @ 8620bcf1
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------------- | ------------------------------- | ---- | ---------------------- | | -------------- | ------------------------------- | ---- | ---------------------- |
| wants | Array\<Want\> | 是 | 将被执行的动作列表。 | | wants | Array\<Want\> | 是 | 将被执行的动作列表。 |
| operationType | wantAgent.OperationType | 是 | 动作类型。 | | operationType | [wantAgent.OperationType](js-apis-app-ability-wantAgent.md#operationtype) | 是 | 动作类型。 |
| requestCode | number | 是 | 使用者定义的一个私有值。 | | 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} | 否 | 额外数据。 | | extraInfo | {[key: string]: any} | 否 | 额外数据。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-system-configuration.md
浏览文件 @ 8620bcf1
...@@ -49,5 +49,4 @@ static getLocale(): LocaleResponse ...@@ -49,5 +49,4 @@ static getLocale(): LocaleResponse
| ---- | ------ | ---- | ---- | ---------------------------------------- | | ---- | ------ | ---- | ---- | ---------------------------------------- |
| language | string | 是 | 否 | 语言。例如：zh。 | | language | string | 是 | 否 | 语言。例如：zh。 |
| countryOrRegion | string | 是 | 否 | 国家或地区。例如：CN。 | | countryOrRegion | string | 是 | 否 | 国家或地区。例如：CN。 |
| dir | string | 是 | 否 | 文字布局方向。取值范围：<br/>-&nbsp;ltr：从左到右；<br/>-&nbsp;rtl：从右到左。 | | dir | string | 是 | 否 | 文字布局方向。取值范围：<br/>-&nbsp;ltr：从左到右；<br/>-&nbsp;rtl：从右到左。 |
| unicodeSetting<sup>5+</sup> | string | 是 | 否 | 语言环境定义的Unicode语言环境键集，如果此语言环境没有特定键集，则返回空集。<br/>例如：{"nu":"arab"}，表示当前环境下的数字采用阿拉伯语的数字。 | \ No newline at end of file
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-wantAgent.md
浏览文件 @ 8620bcf1
# @ohos.wantAgent (WantAgent模块) # @ohos.wantAgent (WantAgent模块)
WantAgent模块提供了触发、取消、比较WantAgent实例和获取bundle参数名的能力，包括创建WantAgent实例、获取实例的用户ID、获取want信息等。 WantAgent模块提供了创建WantAgent实例、获取实例的用户ID、获取want信息、比较WantAgent实例和获取bundle名称等能力。
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 7开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.wantAgent](js-apis-app-ability-wantAgent.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.wantAgent](js-apis-app-ability-wantAgent.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
``` ```
...@@ -24,37 +24,41 @@ getWantAgent(info: WantAgentInfo, callback: AsyncCallback\<WantAgent\>): void ...@@ -24,37 +24,41 @@ getWantAgent(info: WantAgentInfo, callback: AsyncCallback\<WantAgent\>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ----------------------- | | -------- | -------------------------- | ---- | ----------------------- |
| info | WantAgentInfo | 是 | WantAgent信息。 | | info | [WantAgentInfo](js-apis-inner-wantAgent-wantAgentInfo.md) | 是 | WantAgent信息。 |
| callback | AsyncCallback\<WantAgent\> | 是 | 创建WantAgent的回调方法。 | | callback | AsyncCallback\<WantAgent\> | 是 | 创建WantAgent的回调方法。 |
**示例：** **示例：**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
//getWantAgent回调 //getWantAgent回调
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>"); if (err.code) {
console.info('getWantAgent Callback err:' + JSON.stringify(err))
} else {
console.info('getWantAgent Callback success')
}
} }
//WantAgentInfo对象 //WantAgentInfo对象
var wantAgentInfo = { let wantAgentInfo = {
wants: [ wants: [
{ {
deviceId: "deviceId", deviceId: 'deviceId',
bundleName: "com.neu.setResultOnAbilityResultTest1", bundleName: 'com.neu.setResultOnAbilityResultTest1',
abilityName: "com.example.test.MainAbility", abilityName: 'com.example.test.EntryAbility',
action: "action1", action: 'action1',
entities: ["entity1"], entities: ['entity1'],
type: "MIMETYPE", type: 'MIMETYPE',
uri: "key={true,true,false}", uri: 'key={true,true,false}',
parameters: parameters:
{ {
mykey0: 2222, mykey0: 2222,
mykey1: [1, 2, 3], mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", mykey2: '[1, 2, 3]',
mykey3: "ssssssssssssssssssssssssss", mykey3: 'ssssssssssssssssssssssssss',
mykey4: [false, true, false], mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'],
mykey6: true, mykey6: true,
} }
} }
...@@ -64,11 +68,9 @@ var wantAgentInfo = { ...@@ -64,11 +68,9 @@ var wantAgentInfo = {
wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback);
``` ```
## WantAgent.getWantAgent ## WantAgent.getWantAgent
getWantAgent(info: WantAgentInfo): Promise\<WantAgent\> getWantAgent(info: WantAgentInfo): Promise\<WantAgent\>
...@@ -81,7 +83,7 @@ getWantAgent(info: WantAgentInfo): Promise\<WantAgent\> ...@@ -81,7 +83,7 @@ getWantAgent(info: WantAgentInfo): Promise\<WantAgent\>
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ------------- | ---- | ------------- | | ---- | ------------- | ---- | ------------- |
| info | WantAgentInfo | 是 | WantAgent信息。 | | info | [WantAgentInfo](js-apis-inner-wantAgent-wantAgentInfo.md) | 是 | WantAgent信息。 |
**返回值：** **返回值：**
...@@ -91,29 +93,29 @@ getWantAgent(info: WantAgentInfo): Promise\<WantAgent\> ...@@ -91,29 +93,29 @@ getWantAgent(info: WantAgentInfo): Promise\<WantAgent\>
**示例：** **示例：**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
//WantAgentInfo对象 //WantAgentInfo对象
var wantAgentInfo = { let wantAgentInfo = {
wants: [ wants: [
{ {
deviceId: "deviceId", deviceId: 'deviceId',
bundleName: "com.neu.setResultOnAbilityResultTest1", bundleName: 'com.neu.setResultOnAbilityResultTest1',
abilityName: "com.example.test.MainAbility", abilityName: 'com.example.test.EntryAbility',
action: "action1", action: 'action1',
entities: ["entity1"], entities: ['entity1'],
type: "MIMETYPE", type: 'MIMETYPE',
uri: "key={true,true,false}", uri: 'key={true,true,false}',
parameters: parameters:
{ {
mykey0: 2222, mykey0: 2222,
mykey1: [1, 2, 3], mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", mykey2: '[1, 2, 3]',
mykey3: "ssssssssssssssssssssssssss", mykey3: 'ssssssssssssssssssssssssss',
mykey4: [false, true, false], mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'],
mykey6: true, mykey6: true,
} }
} }
...@@ -124,17 +126,15 @@ var wantAgentInfo = { ...@@ -124,17 +126,15 @@ var wantAgentInfo = {
} }
WantAgent.getWantAgent(wantAgentInfo).then((data) => { WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>"); console.info('==========================>getWantAgentCallback=======================>');
}); });
``` ```
## WantAgent.getBundleName ## WantAgent.getBundleName
getBundleName(agent: WantAgent, callback: AsyncCallback\<string\>): void getBundleName(agent: WantAgent, callback: AsyncCallback\<string\>): void
获取WantAgent实例的包名（callback形式）。 获取WantAgent实例的Bundle名称（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统能力**：SystemCapability.Ability.AbilityRuntime.Core
...@@ -147,41 +147,48 @@ getBundleName(agent: WantAgent, callback: AsyncCallback\<string\>): void ...@@ -147,41 +147,48 @@ getBundleName(agent: WantAgent, callback: AsyncCallback\<string\>): void
**示例：** **示例：**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
//wantAgent对象 //wantAgent对象
var wantAgent; let wantAgent;
//getWantAgent回调 //getWantAgent回调
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>"); console.info('==========================>getWantAgentCallback=======================>');
if (err.code == 0) { if (err.code == 0) {
wantAgent = data; wantAgent = data;
} else { } else {
console.info('----getWantAgent failed!----'); console.error('getWantAgent failed, error: ' + JSON.stringify(err));
return;
}
//getBundleName回调
function getBundleNameCallback(err, data) {
console.info('==========================>getBundleNameCallback=======================>');
} }
WantAgent.getBundleName(wantAgent, getBundleNameCallback);
} }
//WantAgentInfo对象 //WantAgentInfo对象
var wantAgentInfo = { let wantAgentInfo = {
wants: [ wants: [
{ {
deviceId: "deviceId", deviceId: 'deviceId',
bundleName: "com.neu.setResultOnAbilityResultTest1", bundleName: 'com.neu.setResultOnAbilityResultTest1',
abilityName: "com.example.test.MainAbility", abilityName: 'com.example.test.EntryAbility',
action: "action1", action: 'action1',
entities: ["entity1"], entities: ['entity1'],
type: "MIMETYPE", type: 'MIMETYPE',
uri: "key={true,true,false}", uri: 'key={true,true,false}',
parameters: parameters:
{ {
mykey0: 2222, mykey0: 2222,
mykey1: [1, 2, 3], mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", mykey2: '[1, 2, 3]',
mykey3: "ssssssssssssssssssssssssss", mykey3: 'ssssssssssssssssssssssssss',
mykey4: [false, true, false], mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'],
mykey6: true, mykey6: true,
} }
} }
...@@ -192,12 +199,6 @@ var wantAgentInfo = { ...@@ -192,12 +199,6 @@ var wantAgentInfo = {
} }
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//getBundleName回调
function getBundleNameCallback(err, data) {
console.info("==========================>getBundleNameCallback=======================>");
}
WantAgent.getBundleName(wantAgent, getBundleNameCallback)
``` ```
...@@ -206,7 +207,7 @@ WantAgent.getBundleName(wantAgent, getBundleNameCallback) ...@@ -206,7 +207,7 @@ WantAgent.getBundleName(wantAgent, getBundleNameCallback)
getBundleName(agent: WantAgent): Promise\<string\> getBundleName(agent: WantAgent): Promise\<string\>
获取WantAgent实例的包名（Promise形式）。 获取WantAgent实例的Bundle名称（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统能力**：SystemCapability.Ability.AbilityRuntime.Core
...@@ -218,38 +219,37 @@ getBundleName(agent: WantAgent): Promise\<string\> ...@@ -218,38 +219,37 @@ getBundleName(agent: WantAgent): Promise\<string\>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------------------------------- | ------------------------------------------------------------ | | ----------------- | ------------------------------------------------ |
| Promise\<string\> | 以Promise形式返回获取WantAgent实例的包名。 | | Promise\<string\> | 以Promise形式返回获取WantAgent实例的Bundle名称。 |
**示例：** **示例：**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
//wantAgent对象 //wantAgent对象
var wantAgent; let wantAgent;
//WantAgentInfo对象 //WantAgentInfo对象
var wantAgentInfo = { let wantAgentInfo = {
wants: [ wants: [
{ {
deviceId: "deviceId", deviceId: 'deviceId',
bundleName: "com.neu.setResultOnAbilityResultTest1", bundleName: 'com.neu.setResultOnAbilityResultTest1',
abilityName: "com.example.test.MainAbility", abilityName: 'com.example.test.EntryAbility',
action: "action1", action: 'action1',
entities: ["entity1"], entities: ['entity1'],
type: "MIMETYPE", type: 'MIMETYPE',
uri: "key={true,true,false}", uri: 'key={true,true,false}',
parameters: parameters:
{ {
mykey0: 2222, mykey0: 2222,
mykey1: [1, 2, 3], mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", mykey2: '[1, 2, 3]',
mykey3: "ssssssssssssssssssssssssss", mykey3: 'ssssssssssssssssssssssssss',
mykey4: [false, true, false], mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'],
mykey6: true, mykey6: true,
} }
} }
...@@ -260,12 +260,13 @@ var wantAgentInfo = { ...@@ -260,12 +260,13 @@ var wantAgentInfo = {
} }
WantAgent.getWantAgent(wantAgentInfo).then((data) => { WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>"); console.info('==========================>getWantAgentCallback=======================>');
wantAgent = data; wantAgent = data;
}); if (wantAgent) {
WantAgent.getBundleName(wantAgent).then((data) => {
WantAgent.getBundleName(wantAgent).then((data) => { console.info('==========================>getBundleNameCallback=======================>');
console.info("==========================>getBundleNameCallback=======================>"); });
}
}); });
``` ```
...@@ -288,41 +289,48 @@ getUid(agent: WantAgent, callback: AsyncCallback\<number\>): void ...@@ -288,41 +289,48 @@ getUid(agent: WantAgent, callback: AsyncCallback\<number\>): void
**示例：** **示例：**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
//wantAgent对象 //wantAgent对象
var wantAgent; let wantAgent;
//getWantAgent回调 //getWantAgent回调
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>"); console.info('==========================>getWantAgentCallback=======================>');
if (err.code == 0) { if (err.code == 0) {
wantAgent = data; wantAgent = data;
} else { } else {
console.info('----getWantAgent failed!----'); console.error('getWantAgent failed, error: ' + JSON.stringify(err));
return;
}
//getUid回调
function getUidCallback(err, data) {
console.info('==========================>getUidCallback=======================>');
} }
WantAgent.getUid(wantAgent, getUidCallback);
} }
//WantAgentInfo对象 //WantAgentInfo对象
var wantAgentInfo = { let wantAgentInfo = {
wants: [ wants: [
{ {
deviceId: "deviceId", deviceId: 'deviceId',
bundleName: "com.neu.setResultOnAbilityResultTest1", bundleName: 'com.neu.setResultOnAbilityResultTest1',
abilityName: "com.example.test.MainAbility", abilityName: 'com.example.test.EntryAbility',
action: "action1", action: 'action1',
entities: ["entity1"], entities: ['entity1'],
type: "MIMETYPE", type: 'MIMETYPE',
uri: "key={true,true,false}", uri: 'key={true,true,false}',
parameters: parameters:
{ {
mykey0: 2222, mykey0: 2222,
mykey1: [1, 2, 3], mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", mykey2: '[1, 2, 3]',
mykey3: "ssssssssssssssssssssssssss", mykey3: 'ssssssssssssssssssssssssss',
mykey4: [false, true, false], mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'],
mykey6: true, mykey6: true,
} }
} }
...@@ -333,12 +341,6 @@ var wantAgentInfo = { ...@@ -333,12 +341,6 @@ var wantAgentInfo = {
} }
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//getUid回调
function getUidCallback(err, data) {
console.info("==========================>getUidCallback=======================>");
}
WantAgent.getUid(wantAgent, getUidCallback)
``` ```
...@@ -365,32 +367,32 @@ getUid(agent: WantAgent): Promise\<number\> ...@@ -365,32 +367,32 @@ getUid(agent: WantAgent): Promise\<number\>
**示例：** **示例：**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
//wantAgent对象 //wantAgent对象
var wantAgent; let wantAgent;
//WantAgentInfo对象 //WantAgentInfo对象
var wantAgentInfo = { let wantAgentInfo = {
wants: [ wants: [
{ {
deviceId: "deviceId", deviceId: 'deviceId',
bundleName: "com.neu.setResultOnAbilityResultTest1", bundleName: 'com.neu.setResultOnAbilityResultTest1',
abilityName: "com.example.test.MainAbility", abilityName: 'com.example.test.EntryAbility',
action: "action1", action: 'action1',
entities: ["entity1"], entities: ['entity1'],
type: "MIMETYPE", type: 'MIMETYPE',
uri: "key={true,true,false}", uri: 'key={true,true,false}',
parameters: parameters:
{ {
mykey0: 2222, mykey0: 2222,
mykey1: [1, 2, 3], mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", mykey2: '[1, 2, 3]',
mykey3: "ssssssssssssssssssssssssss", mykey3: 'ssssssssssssssssssssssssss',
mykey4: [false, true, false], mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'],
mykey6: true, mykey6: true,
} }
} }
...@@ -401,162 +403,17 @@ var wantAgentInfo = { ...@@ -401,162 +403,17 @@ var wantAgentInfo = {
} }
WantAgent.getWantAgent(wantAgentInfo).then((data) => { WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>"); console.info('==========================>getWantAgentCallback=======================>');
wantAgent = data; wantAgent = data;
}); if (wantAgent) {
WantAgent.getUid(wantAgent).then((data) => {
WantAgent.getUid(wantAgent).then((data) => { console.info('==========================>getUidCallback=======================>');
console.info("==========================>getUidCallback=======================>"); });
});
```
## WantAgent.getWant
getWant(agent: WantAgent, callback: AsyncCallback\<Want\>): void
获取WantAgent对象的want（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------------------- |
| agent | WantAgent | 是 | WantAgent对象。 |
| callback | AsyncCallback\<Want\> | 是 | 获取WantAgent对象want的回调方法。 |
**示例：**
```js
import WantAgent from '@ohos.wantAgent';
//wantAgent对象
var wantAgent;
//getWantAgent回调
function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>");
if (err.code == 0) {
wantAgent = data;
} else {
console.info('----getWantAgent failed!----');
} }
}
//WantAgentInfo对象
var wantAgentInfo = {
wants: [
{
deviceId: "deviceId",
bundleName: "com.neu.setResultOnAbilityResultTest1",
abilityName: "com.example.test.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true,true,false}",
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true,
}
}
],
operationType: WantAgent.OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
}
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//getWant回调
function getWantCallback(err, data) {
console.info("==========================>getWantCallback=======================>");
}
WantAgent.getWant(wantAgent, getWantCallback)
```
## WantAgent.getWant
getWant(agent: WantAgent): Promise\<Want\>
获取WantAgent对象的want（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | --------- | ---- | ------------- |
| agent | WantAgent | 是 | WantAgent对象。 |
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<Want\> | 以Promise形式返回获取WantAgent对象的want。 |
**示例：**
```js
import WantAgent from '@ohos.wantAgent';
//wantAgent对象
var wantAgent;
//WantAgentInfo对象
var wantAgentInfo = {
wants: [
{
deviceId: "deviceId",
bundleName: "com.neu.setResultOnAbilityResultTest1",
abilityName: "com.example.test.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true,true,false}",
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true,
}
}
],
operationType: WantAgent.OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
}
WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>");
wantAgent = data;
});
WantAgent.getWant(wantAgent).then((data) => {
console.info("==========================>getWantCallback=======================>");
}); });
``` ```
## WantAgent.cancel ## WantAgent.cancel
cancel(agent: WantAgent, callback: AsyncCallback\<void\>): void cancel(agent: WantAgent, callback: AsyncCallback\<void\>): void
...@@ -574,41 +431,48 @@ cancel(agent: WantAgent, callback: AsyncCallback\<void\>): void ...@@ -574,41 +431,48 @@ cancel(agent: WantAgent, callback: AsyncCallback\<void\>): void
**示例：** **示例：**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
//wantAgent对象 //wantAgent对象
var wantAgent; let wantAgent;
//getWantAgent回调 //getWantAgent回调
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>"); console.info('==========================>getWantAgentCallback=======================>');
if (err.code == 0) { if (err.code == 0) {
wantAgent = data; wantAgent = data;
} else { } else {
console.info('----getWantAgent failed!----'); console.error('getWantAgent failed, error: ' + JSON.stringify(err));
return;
} }
//cancel回调
function cancelCallback(err, data) {
console.info('==========================>cancelCallback=======================>');
}
WantAgent.cancel(wantAgent, cancelCallback);
} }
//WantAgentInfo对象 //WantAgentInfo对象
var wantAgentInfo = { let wantAgentInfo = {
wants: [ wants: [
{ {
deviceId: "deviceId", deviceId: 'deviceId',
bundleName: "com.neu.setResultOnAbilityResultTest1", bundleName: 'com.neu.setResultOnAbilityResultTest1',
abilityName: "com.example.test.MainAbility", abilityName: 'com.example.test.EntryAbility',
action: "action1", action: 'action1',
entities: ["entity1"], entities: ['entity1'],
type: "MIMETYPE", type: 'MIMETYPE',
uri: "key={true,true,false}", uri: 'key={true,true,false}',
parameters: parameters:
{ {
mykey0: 2222, mykey0: 2222,
mykey1: [1, 2, 3], mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", mykey2: '[1, 2, 3]',
mykey3: "ssssssssssssssssssssssssss", mykey3: 'ssssssssssssssssssssssssss',
mykey4: [false, true, false], mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'],
mykey6: true, mykey6: true,
} }
} }
...@@ -619,12 +483,6 @@ var wantAgentInfo = { ...@@ -619,12 +483,6 @@ var wantAgentInfo = {
} }
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//cancel回调
function cancelCallback(err, data) {
console.info("==========================>cancelCallback=======================>");
}
WantAgent.cancel(wantAgent, cancelCallback)
``` ```
...@@ -651,32 +509,32 @@ cancel(agent: WantAgent): Promise\<void\> ...@@ -651,32 +509,32 @@ cancel(agent: WantAgent): Promise\<void\>
**示例：** **示例：**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
//wantAgent对象 //wantAgent对象
var wantAgent; let wantAgent;
//WantAgentInfo对象 //WantAgentInfo对象
var wantAgentInfo = { let wantAgentInfo = {
wants: [ wants: [
{ {
deviceId: "deviceId", deviceId: 'deviceId',
bundleName: "com.neu.setResultOnAbilityResultTest1", bundleName: 'com.neu.setResultOnAbilityResultTest1',
abilityName: "com.example.test.MainAbility", abilityName: 'com.example.test.EntryAbility',
action: "action1", action: 'action1',
entities: ["entity1"], entities: ['entity1'],
type: "MIMETYPE", type: 'MIMETYPE',
uri: "key={true,true,false}", uri: 'key={true,true,false}',
parameters: parameters:
{ {
mykey0: 2222, mykey0: 2222,
mykey1: [1, 2, 3], mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", mykey2: '[1, 2, 3]',
mykey3: "ssssssssssssssssssssssssss", mykey3: 'ssssssssssssssssssssssssss',
mykey4: [false, true, false], mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'],
mykey6: true, mykey6: true,
} }
} }
...@@ -687,12 +545,13 @@ var wantAgentInfo = { ...@@ -687,12 +545,13 @@ var wantAgentInfo = {
} }
WantAgent.getWantAgent(wantAgentInfo).then((data) => { WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>"); console.info('==========================>getWantAgentCallback=======================>');
wantAgent = data; wantAgent = data;
}); if (wantAgent) {
WantAgent.cancel(wantAgent).then((data) => {
WantAgent.cancel(wantAgent).then((data) => { console.info('==========================>cancelCallback=======================>');
console.info("==========================>cancelCallback=======================>"); });
}
}); });
``` ```
...@@ -711,46 +570,57 @@ trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback\<Complet ...@@ -711,46 +570,57 @@ 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';
//wantAgent对象 //wantAgent对象
var wantAgent; let wantAgent;
//getWantAgent回调 //getWantAgent回调
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>"); console.info('==========================>getWantAgentCallback=======================>');
if (err.code == 0) { if (err.code == 0) {
wantAgent = data; wantAgent = data;
} else { } else {
console.info('----getWantAgent failed!----'); console.error('getWantAgent failed, error: ' + JSON.stringify(err));
return;
} }
//trigger回调
function triggerCallback(data) {
console.info('==========================>triggerCallback=======================>');
}
var triggerInfo = {
code:0
}
WantAgent.trigger(wantAgent, triggerInfo, triggerCallback)
} }
//WantAgentInfo对象 //WantAgentInfo对象
var wantAgentInfo = { let wantAgentInfo = {
wants: [ wants: [
{ {
deviceId: "deviceId", deviceId: 'deviceId',
bundleName: "com.neu.setResultOnAbilityResultTest1", bundleName: 'com.neu.setResultOnAbilityResultTest1',
abilityName: "com.example.test.MainAbility", abilityName: 'com.example.test.EntryAbility',
action: "action1", action: 'action1',
entities: ["entity1"], entities: ['entity1'],
type: "MIMETYPE", type: 'MIMETYPE',
uri: "key={true,true,false}", uri: 'key={true,true,false}',
parameters: parameters:
{ {
mykey0: 2222, mykey0: 2222,
mykey1: [1, 2, 3], mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", mykey2: '[1, 2, 3]',
mykey3: "ssssssssssssssssssssssssss", mykey3: 'ssssssssssssssssssssssssss',
mykey4: [false, true, false], mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'],
mykey6: true, mykey6: true,
} }
} }
...@@ -761,16 +631,6 @@ var wantAgentInfo = { ...@@ -761,16 +631,6 @@ var wantAgentInfo = {
} }
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//trigger回调
function triggerCallback(data) {
console.info("==========================>triggerCallback=======================>");
}
var triggerInfo = {
code:0
}
WantAgent.trigger(wantAgent, triggerInfo, triggerCallback)
``` ```
...@@ -779,7 +639,7 @@ WantAgent.trigger(wantAgent, triggerInfo, triggerCallback) ...@@ -779,7 +639,7 @@ WantAgent.trigger(wantAgent, triggerInfo, triggerCallback)
equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback\<boolean\>): void equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback\<boolean\>): void
判断两个WantAgent实例是否相等（callback形式）。 判断两个WantAgent实例是否相等（callback形式）,以此来判断是否是来自同一应用的相同操作。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统能力**：SystemCapability.Ability.AbilityRuntime.Core
...@@ -793,43 +653,50 @@ equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback\<boolean\ ...@@ -793,43 +653,50 @@ equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback\<boolean\
**示例：** **示例：**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
//wantAgent对象 //wantAgent对象
var wantAgent1; let wantAgent1;
var wantAgent2; let wantAgent2;
//getWantAgent回调 //getWantAgent回调
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>"); console.info('==========================>getWantAgentCallback=======================>');
if (err.code == 0) { if (err.code == 0) {
wantAgent1 = data; wantAgent1 = data;
wantAgent2 = data; wantAgent2 = data;
} else { } else {
console.info('----getWantAgent failed!----'); console.error('getWantAgent failed, error: ' + JSON.stringify(err));
return;
} }
//equal回调
function equalCallback(err, data) {
console.info('==========================>equalCallback=======================>');
}
WantAgent.equal(wantAgent1, wantAgent2, equalCallback)
} }
//WantAgentInfo对象 //WantAgentInfo对象
var wantAgentInfo = { let wantAgentInfo = {
wants: [ wants: [
{ {
deviceId: "deviceId", deviceId: 'deviceId',
bundleName: "com.neu.setResultOnAbilityResultTest1", bundleName: 'com.neu.setResultOnAbilityResultTest1',
abilityName: "com.example.test.MainAbility", abilityName: 'com.example.test.EntryAbility',
action: "action1", action: 'action1',
entities: ["entity1"], entities: ['entity1'],
type: "MIMETYPE", type: 'MIMETYPE',
uri: "key={true,true,false}", uri: 'key={true,true,false}',
parameters: parameters:
{ {
mykey0: 2222, mykey0: 2222,
mykey1: [1, 2, 3], mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", mykey2: '[1, 2, 3]',
mykey3: "ssssssssssssssssssssssssss", mykey3: 'ssssssssssssssssssssssssss',
mykey4: [false, true, false], mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'],
mykey6: true, mykey6: true,
} }
} }
...@@ -840,12 +707,6 @@ var wantAgentInfo = { ...@@ -840,12 +707,6 @@ var wantAgentInfo = {
} }
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//equal回调
function equalCallback(err, data) {
console.info("==========================>equalCallback=======================>");
}
WantAgent.equal(wantAgent1, wantAgent2, equalCallback)
``` ```
...@@ -854,7 +715,7 @@ WantAgent.equal(wantAgent1, wantAgent2, equalCallback) ...@@ -854,7 +715,7 @@ WantAgent.equal(wantAgent1, wantAgent2, equalCallback)
equal(agent: WantAgent, otherAgent: WantAgent): Promise\<boolean\> equal(agent: WantAgent, otherAgent: WantAgent): Promise\<boolean\>
判断两个WantAgent实例是否相等（Promise形式）。 判断两个WantAgent实例是否相等（Promise形式）,以此来判断是否是来自同一应用的相同操作。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统能力**：SystemCapability.Ability.AbilityRuntime.Core
...@@ -873,33 +734,33 @@ equal(agent: WantAgent, otherAgent: WantAgent): Promise\<boolean\> ...@@ -873,33 +734,33 @@ equal(agent: WantAgent, otherAgent: WantAgent): Promise\<boolean\>
**示例：** **示例：**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
//wantAgent对象 //wantAgent对象
var wantAgent1; let wantAgent1;
var wantAgent2; let wantAgent2;
//WantAgentInfo对象 //WantAgentInfo对象
var wantAgentInfo = { let wantAgentInfo = {
wants: [ wants: [
{ {
deviceId: "deviceId", deviceId: 'deviceId',
bundleName: "com.neu.setResultOnAbilityResultTest1", bundleName: 'com.neu.setResultOnAbilityResultTest1',
abilityName: "com.example.test.MainAbility", abilityName: 'com.example.test.EntryAbility',
action: "action1", action: 'action1',
entities: ["entity1"], entities: ['entity1'],
type: "MIMETYPE", type: 'MIMETYPE',
uri: "key={true,true,false}", uri: 'key={true,true,false}',
parameters: parameters:
{ {
mykey0: 2222, mykey0: 2222,
mykey1: [1, 2, 3], mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", mykey2: '[1, 2, 3]',
mykey3: "ssssssssssssssssssssssssss", mykey3: 'ssssssssssssssssssssssssss',
mykey4: [false, true, false], mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'],
mykey6: true, mykey6: true,
} }
} }
...@@ -910,13 +771,18 @@ var wantAgentInfo = { ...@@ -910,13 +771,18 @@ var wantAgentInfo = {
} }
WantAgent.getWantAgent(wantAgentInfo).then((data) => { WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>"); console.info('==========================>getWantAgentCallback=======================>');
wantAgent1 = data; wantAgent1 = data;
wantAgent2 = data; wantAgent2 = data;
if (data) {
WantAgent.equal(wantAgent1, wantAgent2).then((data) => {
console.info('==========================>equalCallback=======================>');
});
}
}); });
WantAgent.equal(wantAgent1, wantAgent2).then((data) => { WantAgent.equal(wantAgent1, wantAgent2).then((data) => {
console.info("==========================>equalCallback=======================>"); console.info('==========================>equalCallback=======================>');
}); });
``` ```
...@@ -937,31 +803,31 @@ getOperationType(agent: WantAgent, callback: AsyncCallback\<number>): void; ...@@ -937,31 +803,31 @@ getOperationType(agent: WantAgent, callback: AsyncCallback\<number>): void;
**示例：** **示例：**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
//wantAgent对象 //wantAgent对象
var wantAgent; let wantAgent;
//WantAgentInfo对象 //WantAgentInfo对象
var wantAgentInfo = { let wantAgentInfo = {
wants: [ wants: [
{ {
deviceId: "deviceId", deviceId: 'deviceId',
bundleName: "com.neu.setResultOnAbilityResultTest1", bundleName: 'com.neu.setResultOnAbilityResultTest1',
abilityName: "com.example.test.MainAbility", abilityName: 'com.example.test.EntryAbility',
action: "action1", action: 'action1',
entities: ["entity1"], entities: ['entity1'],
type: "MIMETYPE", type: 'MIMETYPE',
uri: "key={true,true,false}", uri: 'key={true,true,false}',
parameters: parameters:
{ {
mykey0: 2222, mykey0: 2222,
mykey1: [1, 2, 3], mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", mykey2: '[1, 2, 3]',
mykey3: "ssssssssssssssssssssssssss", mykey3: 'ssssssssssssssssssssssssss',
mykey4: [false, true, false], mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'],
mykey6: true, mykey6: true,
} }
} }
...@@ -972,13 +838,14 @@ var wantAgentInfo = { ...@@ -972,13 +838,14 @@ var wantAgentInfo = {
} }
WantAgent.getWantAgent(wantAgentInfo).then((data) => { WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>"); console.info('==========================>getWantAgentCallback=======================>');
wantAgent = data; wantAgent = data;
if (data) {
WantAgent.getOperationType(wantAgent, (OperationType) => {
console.log('----------- getOperationType ----------, OperationType: ' + OperationType);
})
}
}); });
WantAgent.getOperationType(wantAgent, (OperationType) => {
console.log('----------- getOperationType ----------, OperationType: ' + OperationType);
})
``` ```
## WantAgent.getOperationType<sup>9+</sup> ## WantAgent.getOperationType<sup>9+</sup>
...@@ -1003,31 +870,31 @@ getOperationType(agent: WantAgent): Promise\<number>; ...@@ -1003,31 +870,31 @@ getOperationType(agent: WantAgent): Promise\<number>;
**示例：** **示例：**
```js ```ts
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
//wantAgent对象 //wantAgent对象
var wantAgent; let wantAgent;
//WantAgentInfo对象 //WantAgentInfo对象
var wantAgentInfo = { let wantAgentInfo = {
wants: [ wants: [
{ {
deviceId: "deviceId", deviceId: 'deviceId',
bundleName: "com.neu.setResultOnAbilityResultTest1", bundleName: 'com.neu.setResultOnAbilityResultTest1',
abilityName: "com.example.test.MainAbility", abilityName: 'com.example.test.EntryAbility',
action: "action1", action: 'action1',
entities: ["entity1"], entities: ['entity1'],
type: "MIMETYPE", type: 'MIMETYPE',
uri: "key={true,true,false}", uri: 'key={true,true,false}',
parameters: parameters:
{ {
mykey0: 2222, mykey0: 2222,
mykey1: [1, 2, 3], mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", mykey2: '[1, 2, 3]',
mykey3: "ssssssssssssssssssssssssss", mykey3: 'ssssssssssssssssssssssssss',
mykey4: [false, true, false], mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'],
mykey6: true, mykey6: true,
} }
} }
...@@ -1038,18 +905,16 @@ var wantAgentInfo = { ...@@ -1038,18 +905,16 @@ var wantAgentInfo = {
} }
WantAgent.getWantAgent(wantAgentInfo).then((data) => { WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>"); console.info('==========================>getWantAgentCallback=======================>');
wantAgent = data; wantAgent = data;
WantAgent.getOperationType(wantAgent).then((OperationType) => {
console.log('getOperationType success, OperationType: ' + OperationType);
}).catch((err) => {
console.log('getOperationType fail, err: ' + err);
})
}); });
WantAgent.getOperationType(wantAgent).then((OperationType) => {
console.log('getOperationType success, OperationType: ' + OperationType);
}).catch((err) => {
console.log('getOperationType fail, err: ' + err);
})
``` ```
## WantAgentFlags ## WantAgentFlags
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
...@@ -1088,5 +953,5 @@ WantAgent.getOperationType(wantAgent).then((OperationType) => { ...@@ -1088,5 +953,5 @@ WantAgent.getOperationType(wantAgent).then((OperationType) => {
| info | WantAgent | 是 | 触发的wantAgent。 | | info | WantAgent | 是 | 触发的wantAgent。 |
| want | Want | 是 | 存在的被触发的want。 | | want | Want | 是 | 存在的被触发的want。 |
| finalCode | number | 是 | 触发wantAgent的请求代码。| | finalCode | number | 是 | 触发wantAgent的请求代码。|
| finalData | string | 否 | 公共事件收集的最终数据。 | | finalData | string | 是 | 公共事件收集的最终数据。 |
| extraInfo | {[key: string]: any} | 否 | 额外数据。 | | extraInfo | {[key: string]: any} | 否 | 额外数据。 |
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或