Skip to content

D
Docs

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

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 0612bb09 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!12208 元能力资料API整改 

Merge pull request !12208 from mingxihua/master
上级 f1bc044f 1dc2d733
展开全部 隐藏空白更改
内联 并排
Showing with 9203 addition and 4376 deletion
zh-cn/application-dev/reference/apis/js-apis-ability-Want.md 已删除 100644 → 0
浏览文件 @ f1bc044f
# Want
Want是对象间信息传递的载体, 可以用于应用组件间的信息传递。 Want的使用场景之一是作为startAbility的参数, 其包含了指定的启动目标, 以及启动时需携带的相关数据, 如bundleName和abilityName字段分别指明目标Ability所在应用的包名以及对应包内的Ability名称。当Ability A需要启动Ability B并传入一些数据时, 可使用Want作为载体将这些数据传递给Ability B。
> **说明：**
>
> 本模块首批接口从API version 6开始支持，从API version 9废弃，替换模块为[Want (Want)](js-apis-app-ability-Want.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ |
| deviceId | 是 | 否 | string | 否 | 表示运行指定Ability的设备ID。 |
| bundleName | 是 | 否 | string | 否 | 表示包名。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| abilityName | 是 | 否 | string | 否 | 表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 |
| uri | 是 | 否 | string | 否 | 表示Uri。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 |
| 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-featureAbility.md#flags说明)。 |
| 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。 |
| entities | 是 | 否 | Array\<string> | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 |
| moduleName<sup>9+</sup> | 是 | 否 | string | 否 | 表示待启动的Ability所属的模块（module）。 |
具体字段描述参考ability/want.d.ts文件
**示例：**
- 基础用法
``` ts
var want = {
"deviceId": "", // deviceId为空表示本设备
"bundleName": "com.extreme.test",
"abilityName": "MainAbility",
"moduleName": "entry" // moduleName非必选
};
this.context.startAbility(want, (error) => {
// 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability
console.log("error.code = " + error.code)
})
```
- 传递FD数据，FD表示文件描述符(FileDescriptor)
``` ts
import fileio from '@ohos.fileio';
var fd;
try {
fd = fileio.openSync("/data/storage/el2/base/haps/pic.png");
} catch(e) {
console.log("openSync fail:" + JSON.stringify(e));
}
var want = {
"deviceId": "", // deviceId为空表示本设备
"bundleName": "com.extreme.test",
"abilityName": "MainAbility",
"moduleName": "entry", // moduleName非必选
"parameters": {
"keyFd":{"type":"FD", "value":fd}
}
};
this.context.startAbility(want, (error) => {
// 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability
console.log("error.code = " + error.code)
})
```
<!--no_check-->
zh-cn/application-dev/reference/apis/js-apis-ability-ability.md
浏览文件 @ 0612bb09
......@@ -15,24 +15,25 @@ import ability from '@ohos.ability.ability'
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ |
| DataAbilityHelper | 是 | 否 | number | 否 | DataAbilityHelper二级模块。 |
| PacMap | 是 | 否 | Want | 否 | PacMap二级模块。 |
| DataAbilityOperation | 是 | 否 | Want | 否 | DataAbilityOperation二级模块。 |
| DataAbilityResult | 是 | 否 | Want | 否 | DataAbilityResult二级模块。 |
| AbilityResult | 是 | 否 | Want | 否 | AbilityResult二级模块。 |
| ConnectOptions | 是 | 否 | Want | 否 | ConnectOptions二级模块。 |
| StartAbilityParameter | 是 | 否 | Want | 否 | StartAbilityParameter二级模块。 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| DataAbilityHelper | 只读 | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 否 | DataAbilityHelper二级模块。 |
| PacMap | 只读 | [PacMap](js-apis-inner-ability-dataAbilityHelper.md#PacMap) | 否 | PacMap二级模块。 |
| DataAbilityOperation | 只读 | [DataAbilityOperation](js-apis-inner-ability-dataAbilityOperation.md) | 否 | DataAbilityOperation二级模块。 |
| DataAbilityResult | 只读 | [DataAbilityResult](js-apis-inner-ability-dataAbilityResult.md) | 否 | DataAbilityResult二级模块。 |
| AbilityResult | 只读 | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 否 | AbilityResult二级模块。 |
| ConnectOptions | 只读 | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 否 | ConnectOptions二级模块。 |
| StartAbilityParameter | 只读 | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 否 | StartAbilityParameter二级模块。 |
**示例：**
```ts
let dataAbilityHelper: ability.DataAbilityHelper;
let pacMap: ability.PacMap;
let dataAbilityOperation: ability.DataAbilityOperation;
let dataAbilityResult: ability.DataAbilityResult;
let abilityResult: ability.AbilityResult;
let connectOptions: ability.ConnectOptions;
let startAbilityParameter: ability.StartAbilityParameter;
```
\ No newline at end of file
```ts
import ability from '@ohos.ability.ability';
let dataAbilityHelper: ability.DataAbilityHelper;
let pacMap: ability.PacMap;
let dataAbilityOperation: ability.DataAbilityOperation;
let dataAbilityResult: ability.DataAbilityResult;
let abilityResult: ability.AbilityResult;
let connectOptions: ability.ConnectOptions;
let startAbilityParameter: ability.StartAbilityParameter;
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-ability-context.md
浏览文件 @ 0612bb09
......@@ -32,7 +32,7 @@ class MainAbility extends Ability {
| -------- | -------- | -------- | -------- | -------- |
| abilityInfo | AbilityInfo | 是 | 否 | Abilityinfo相关信息 |
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前hap包的信息 |
| config | [Configuration](js-apis-configuration.md) | 是 | 否 | 表示配置信息。 |
| config | [Configuration](js-apis-application-configuration.md) | 是 | 否 | 表示配置信息。 |
## AbilityContext.startAbility
......@@ -46,7 +46,7 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动结果 |
**错误码：**
......@@ -95,8 +95,8 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback&lt;void&
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-application-startOptions.md) | 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动结果。 |
**错误码：**
......@@ -148,8 +148,8 @@ startAbility(want: Want, options?: StartOptions): Promise&lt;void&gt;;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-application-startOptions.md) | 否 | 启动Ability所携带的参数。 |
**返回值：**
......@@ -206,8 +206,8 @@ startAbilityForResult(want: Want, callback: AsyncCallback&lt;AbilityResult&gt;):
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |[Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| callback | AsyncCallback&lt;[AbilityResult](js-apis-featureAbility.md#abilityresult)&gt; | 是 | 执行结果回调函数。 |
| want |[Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| callback | AsyncCallback&lt;[AbilityResult](js-apis-inner-ability-abilityResult.md)&gt; | 是 | 执行结果回调函数。 |
**错误码：**
......@@ -256,9 +256,9 @@ startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |[Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback&lt;[AbilityResult](js-apis-featureAbility.md#abilityresult)&gt; | 是 | 执行结果回调函数。 |
| want |[Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-application-startOptions.md) | 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback&lt;[AbilityResult](js-apis-inner-ability-abilityResult.md)&gt; | 是 | 执行结果回调函数。 |
**错误码：**
......@@ -311,15 +311,15 @@ startAbilityForResult(want: Want, options?: StartOptions): Promise&lt;AbilityRes
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-application-startOptions.md) | 否 | 启动Ability所携带的参数。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[AbilityResult](js-apis-featureAbility.md#abilityresult)&gt; | Promise形式返回执行结果。 |
| Promise&lt;[AbilityResult](js-apis-inner-ability-abilityResult.md)&gt; | Promise形式返回执行结果。 |
**错误码：**
......@@ -373,7 +373,7 @@ startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncC
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| callback | AsyncCallback\<AbilityResult\> | 是 | 启动Ability的回调函数，返回Ability结果。 |
......@@ -430,9 +430,9 @@ startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOp
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 |
| options | [StartOptions](js-apis-application-startOptions.md) | 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**错误码：**
......@@ -491,9 +491,9 @@ startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartO
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 |
| options | [StartOptions](js-apis-application-startOptions.md) | 否 | 启动Ability所携带的参数。 |
**返回值：**
......@@ -553,7 +553,7 @@ startServiceExtensionAbility(want: Want, callback: AsyncCallback\<void>): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**错误码：**
......@@ -604,7 +604,7 @@ startServiceExtensionAbility(want: Want): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
**错误码：**
......@@ -656,7 +656,7 @@ startServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
......@@ -711,7 +711,7 @@ startServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
**错误码：**
......@@ -762,7 +762,7 @@ stopServiceExtensionAbility(want: Want, callback: AsyncCallback\<void>): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**错误码：**
......@@ -813,7 +813,7 @@ stopServiceExtensionAbility(want: Want): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
**错误码：**
......@@ -865,7 +865,7 @@ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
......@@ -920,7 +920,7 @@ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\<
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
**错误码：**
......@@ -1042,7 +1042,7 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback&lt;voi
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter | [AbilityResult](js-apis-featureAbility.md#abilityresult) | 是 | 返回给调用startAbilityForResult&nbsp;接口调用方的相关信息。 |
| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 返回给调用startAbilityForResult&nbsp;接口调用方的相关信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回停止结果。 |
**错误码：**
......@@ -1097,7 +1097,7 @@ terminateSelfWithResult(parameter: AbilityResult): Promise&lt;void&gt;;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter | [AbilityResult](js-apis-featureAbility.md#abilityresult) | 是 | 返回给startAbilityForResult&nbsp;调用方的信息。 |
| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 返回给startAbilityForResult&nbsp;调用方的信息。 |
**返回值：**
......@@ -1153,12 +1153,14 @@ connectServiceExtensionAbility(want: Want, options: ConnectOptions): number;
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| options | [ConnectOptions](js-apis-featureAbility.md#connectoptions) | 是 | 远端对象实例。 |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 否 | 远端对象实例。 |
**返回值：**
......@@ -1214,9 +1216,9 @@ connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| options | [ConnectOptions](js-apis-featureAbility.md#connectoptions) | 是 | 远端对象实例。 |
| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 否 | 远端对象实例。 |
**返回值：**
......@@ -1264,6 +1266,8 @@ disconnectServiceExtensionAbility(connection: number): Promise\<void>;
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -1286,7 +1290,7 @@ disconnectServiceExtensionAbility(connection: number): Promise\<void>;
**示例：**
```ts
// connection为connectAbility中的返回值
// connection为connectServiceExtensionAbility中的返回值
var connection = 1;
try {
......@@ -1315,6 +1319,8 @@ disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback\<vo
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -1361,13 +1367,11 @@ startAbilityByCall(want: Want): Promise&lt;Caller&gt;;
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 传入需要启动的Ability的信息，包含abilityName、moduleName、bundleName、deviceId(可选)、parameters(可选)，其中deviceId缺省或为空表示启动本地Ability，parameters缺省或为空表示后台启动Ability。 |
| want | [Want](js-apis-application-want.md) | 是 | 传入需要启动的Ability的信息，包含abilityName、moduleName、bundleName、deviceId(可选)、parameters(可选)，其中deviceId缺省或为空表示启动本地Ability，parameters缺省或为空表示后台启动Ability。 |
**返回值：**
......@@ -1458,7 +1462,7 @@ startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\<
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
......@@ -1514,9 +1518,9 @@ startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, ca
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。|
| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 |
| options | [StartOptions](js-apis-application-startOptions.md) | 否 | 启动Ability所携带的参数。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**错误码：**
......@@ -1574,9 +1578,9 @@ startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions):
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 |
| options | [StartOptions](js-apis-application-startOptions.md) | 否 | 启动Ability所携带的参数。 |
**错误码：**
......@@ -1629,7 +1633,7 @@ requestPermissionsFromUser(permissions: Array&lt;string&gt;, requestCallback: As
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| permissions | Array&lt;string&gt; | 是 | 权限列表。 |
| callback | AsyncCallback&lt;[PermissionRequestResult](js-apis-permissionrequestresult.md)&gt; | 是 | 回调函数，返回接口调用是否成功的结果。 |
| callback | AsyncCallback&lt;[PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md)&gt; | 是 | 回调函数，返回接口调用是否成功的结果。 |
**示例：**
......@@ -1660,7 +1664,7 @@ requestPermissionsFromUser(permissions: Array&lt;string&gt;) : Promise&lt;Permis
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[PermissionRequestResult](js-apis-permissionrequestresult.md)&gt; | 返回一个Promise，包含接口的结果。 |
| Promise&lt;[PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md)&gt; | 返回一个Promise，包含接口的结果。 |
**示例：**
......@@ -1831,7 +1835,7 @@ restoreWindowStage(localStorage: LocalStorage) : void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| localStorage | LocalStorage | 是 | 用于恢复window stage的存储数据。 |
| localStorage | image.LocalStorage | 是 | 用于恢复window stage的存储数据。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md → zh-cn/application-dev/reference/apis/js-apis-ability-dataUriUtils.md
浏览文件 @ 0612bb09
......@@ -8,7 +8,7 @@ DataUriUtils模块提供用于处理使用DataAbilityHelper方案的对象的实
## 导入模块
```js
```ts
import dataUriUtils from '@ohos.ability.dataUriUtils';
```
......@@ -22,7 +22,7 @@ getId(uri: string): number
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中获取ID的uri对象。 |
......@@ -34,7 +34,7 @@ getId(uri: string): number
**示例：**
```js
```ts
dataUriUtils.getId("com.example.dataUriUtils/1221")
```
......@@ -50,7 +50,7 @@ attachId(uri: string, id: number): string
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中获取ID的uri对象。 |
| id | number | 是 | 指示要附加的ID。 |
......@@ -63,7 +63,7 @@ attachId(uri: string, id: number): string
**示例：**
```js
```ts
var idint = 1122;
dataUriUtils.attachId(
"com.example.dataUriUtils",
......@@ -83,7 +83,7 @@ deleteId(uri: string): string
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中删除ID的uri对象。 |
......@@ -95,7 +95,7 @@ deleteId(uri: string): string
**示例：**
```js
```ts
dataUriUtils.deleteId("com.example.dataUriUtils/1221")
```
......@@ -111,7 +111,7 @@ updateId(uri: string, id: number): string
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | ------------------- |
| uri | string | 是 | 指示要更新的uri对象 |
| id | number | 是 | 指示新ID |
......@@ -124,7 +124,7 @@ updateId(uri: string, id: number): string
**示例：**
```js
```ts
var idint = 1122;
dataUriUtils.updateId(
"com.example.dataUriUtils",
......
zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md
浏览文件 @ 0612bb09
......@@ -10,7 +10,7 @@ ErrorCode是定义启动功能时使用的错误代码。
## 导入模块
```
```ts
import errorCode from '@ohos.ability.errorCode'
```
......@@ -24,5 +24,5 @@ import errorCode from '@ohos.ability.errorCode'
| ------------------------------ | ---- | ---------------------------------------- |
| NO_ERROR | 0 | 没有错误。 |
| INVALID_PARAMETER | -1 | 无效的参数。 |
| ABILITY_NOT_FOUND | -2 | 找不到能力。 |
| ABILITY_NOT_FOUND | -2 | 找不到ABILITY。 |
| PERMISSION_DENY | -3 | 拒绝许可。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md
浏览文件 @ 0612bb09
......@@ -8,7 +8,7 @@ wantConstant模块提供want中操作want常数和解释Flags说明的能力。
## 导入模块
```js
```ts
import wantConstant from '@ohos.ability.wantConstant';
```
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-ability.md 0 → 100644
浏览文件 @ 0612bb09
# Ability
Ability模块提供对Ability生命周期、上下文环境等调用管理的能力，包括Ability创建、销毁、转储客户端信息等。
> **说明：**
>
> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
```ts
import Ability from '@ohos.app.ability.Ability';
```
## Ability.onConfigurationUpdated
onConfigurationUpdated(config: Configuration): void;
当系统配置更新时调用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 表示需要更新的配置信息。 |
**示例：**
```ts
class myAbility extends Ability {
onConfigurationUpdated(config) {
console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
}
}
```
## Ability.onMemoryLevel
onMemoryLevel(level: AbilityConstant.MemoryLevel): void;
当系统已决定调整内存时调用。例如，当该功能在后台运行时，没有足够的内存来运行尽可能多的后台进程时可以使用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| level | [AbilityConstant.MemoryLevel](js-apis-app-ability-abilityConstant.md#abilityconstantmemorylevel) | 是 | 回调返回内存微调级别，显示当前内存使用状态。|
**示例：**
```ts
class myAbility extends Ability {
onMemoryLevel(level) {
console.log('onMemoryLevel, level:' + JSON.stringify(level));
}
}
```
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md
浏览文件 @ 0612bb09
......@@ -11,7 +11,7 @@ AbilityConstant提供启动参数的接口的能力，包括设置初次开始
## 导入模块
```js
```ts
import AbilityConstant from '@ohos.app.ability.AbilityConstant';
```
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityDelegator.md
浏览文件 @ 0612bb09
......@@ -9,7 +9,7 @@ AbilityDelegator提供添加用于监视指定ability的生命周期状态更改
## 使用说明
通过AbilityDelegatorRegistry中getAbilityDelegator方法获取。
```js
```ts
import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry'
var abilityDelegator;
......@@ -37,7 +37,7 @@ addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): void
**示例：**
```js
```ts
var abilityDelegator;
function onAbilityCreateCallback(data) {
......@@ -79,7 +79,7 @@ addAbilityMonitor(monitor: AbilityMonitor): Promise\<void>
**示例：**
```js
```ts
var abilityDelegator;
function onAbilityCreateCallback(data) {
......@@ -116,7 +116,7 @@ removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): v
**示例：**
```js
```ts
var abilityDelegator;
function onAbilityCreateCallback(data) {
......@@ -158,7 +158,7 @@ removeAbilityMonitor(monitor: AbilityMonitor): Promise\<void>
- 示例
```js
```ts
var abilityDelegator;
function onAbilityCreateCallback(data) {
......@@ -195,7 +195,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<Ability>):
**示例：**
```js
```ts
var abilityDelegator;
function onAbilityCreateCallback(data) {
......@@ -233,7 +233,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCall
**示例：**
```js
```ts
var abilityDelegator;
var timeout = 100;
......@@ -277,7 +277,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise\<Ability>
**示例：**
```js
```ts
var abilityDelegator;
function onAbilityCreateCallback(data) {
......@@ -309,11 +309,11 @@ getAppContext(): Context
| 类型 | 说明 |
| ------------------------------------- | ------------------------------------------- |
| [Context](js-apis-Context.md#Context) | 应用[Context](js-apis-Context.md#Context)。 |
| [Context](js-apis-inner-application-context.md) | 应用[Context](js-apis-inner-application-context.md)。 |
**示例：**
```js
```ts
var abilityDelegator;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
......@@ -340,11 +340,11 @@ getAbilityState(ability: Ability): number
| 类型 | 说明 |
| ------ | ------------------------------------------------------------ |
| number | 指定ability的生命周期状态。状态枚举值使用[AbilityLifecycleState](js-apis-abilityDelegatorRegistry.md#AbilityLifecycleState)。 |
| number | 指定ability的生命周期状态。状态枚举值使用[AbilityLifecycleState](js-apis-application-abilityDelegatorRegistry.md#AbilityLifecycleState)。 |
**示例：**
```js
```ts
var abilityDelegator;
var ability;
......@@ -375,7 +375,7 @@ getCurrentTopAbility(callback: AsyncCallback\<Ability>): void
**示例：**
```js
```ts
var abilityDelegator;
var ability;
......@@ -404,7 +404,7 @@ getCurrentTopAbility(): Promise\<Ability>
**示例：**
```js
```ts
var abilityDelegator;
var ability;
......@@ -429,12 +429,12 @@ startAbility(want: Want, callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ------------------ |
| want | [Want](js-apis-app-ability-Want.md) | 是 | 启动Ability参数 |
| want | [Want](js-apis-app-ability-want.md) | 是 | 启动Ability参数 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法 |
**示例：**
```js
```ts
var abilityDelegator;
var want = {
bundleName: "bundleName",
......@@ -461,7 +461,7 @@ startAbility(want: Want): Promise\<void>
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------------------------------- | ---- | --------------- |
| want | [Want](js-apis-app-ability-Want.md) | 是 | 启动Ability参数 |
| want | [Want](js-apis-app-ability-want.md) | 是 | 启动Ability参数 |
**返回值：**
......@@ -471,7 +471,7 @@ startAbility(want: Want): Promise\<void>
**示例：**
```js
```ts
var abilityDelegator;
var want = {
bundleName: "bundleName",
......@@ -503,7 +503,7 @@ doAbilityForeground(ability: Ability, callback: AsyncCallback\<boolean>): void
**示例：**
```js
```ts
var abilityDelegator;
var ability;
......@@ -541,7 +541,7 @@ doAbilityForeground(ability: Ability): Promise\<boolean>
**示例：**
```js
```ts
var abilityDelegator;
var ability;
......@@ -574,7 +574,7 @@ doAbilityBackground(ability: Ability, callback: AsyncCallback\<boolean>): void
**示例：**
```js
```ts
var abilityDelegator;
var ability;
......@@ -612,7 +612,7 @@ doAbilityBackground(ability: Ability): Promise\<boolean>
**示例：**
```js
```ts
var abilityDelegator;
var ability;
......@@ -644,7 +644,7 @@ printSync(msg: string): void
**示例：**
```js
```ts
var abilityDelegator;
var msg = "msg";
......@@ -671,7 +671,7 @@ print(msg: string, callback: AsyncCallback\<void>): void
**示例：**
```js
```ts
var abilityDelegator;
var msg = "msg";
......@@ -705,7 +705,7 @@ print(msg: string): Promise\<void>
**示例：**
```js
```ts
var abilityDelegator;
var msg = "msg";
......@@ -730,11 +730,11 @@ executeShellCommand(cmd: string, callback: AsyncCallback\<ShellCmdResult>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------ |
| cmd | string | 是 | shell命令字符串 |
| callback | AsyncCallback\<[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)> | 是 | 表示指定的回调方法 |
| callback | AsyncCallback\<[ShellCmdResult](js-apis-inner-application-shellCmdResult.md)> | 是 | 表示指定的回调方法 |
**示例：**
```js
```ts
var abilityDelegator;
var cmd = "cmd";
......@@ -760,11 +760,11 @@ executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback\<S
| ----------- | ------------------------------------------------------------ | ---- | ----------------------------- |
| cmd | string | 是 | shell命令字符串 |
| timeoutSecs | number | 是 | 设定命令超时时间，单位秒（s） |
| callback | AsyncCallback\<[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)> | 是 | 表示指定的回调方法 |
| callback | AsyncCallback\<[ShellCmdResult](js-apis-inner-application-shellCmdResult.md)> | 是 | 表示指定的回调方法 |
**示例：**
```js
```ts
var abilityDelegator;
var cmd = "cmd";
var timeout = 100;
......@@ -796,11 +796,11 @@ executeShellCommand(cmd: string, timeoutSecs?: number): Promise\<ShellCmdResult>
| 类型 | 说明 |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| Promise\<[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)> | 以Promise形式返回Shell命令执行结果[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)对象。 |
| Promise\<[ShellCmdResult](js-apis-inner-application-shellCmdResult.md)> | 以Promise形式返回Shell命令执行结果[ShellCmdResult](js-apis-inner-application-shellCmdResult.md)对象。 |
**示例：**
```js
```ts
var abilityDelegator;
var cmd = "cmd";
var timeout = 100;
......@@ -831,7 +831,7 @@ finishTest(msg: string, code: number, callback: AsyncCallback\<void>): void
**示例：**
```js
```ts
var abilityDelegator;
var msg = "msg";
......@@ -866,7 +866,7 @@ finishTest(msg: string, code: number): Promise\<void>
**示例：**
```js
```ts
var abilityDelegator;
var msg = "msg";
......@@ -893,7 +893,7 @@ addAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\<vo
**示例：**
```js
```ts
var abilityDelegator;
var monitor = {
......@@ -931,7 +931,7 @@ addAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\<void>;
**示例：**
```js
```ts
var abilityDelegator;
var monitor = {
......@@ -962,7 +962,7 @@ removeAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\
**示例：**
```js
```ts
var abilityDelegator;
var monitor = {
......@@ -1000,7 +1000,7 @@ removeAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\<void>;
**示例：**
```js
```ts
var abilityDelegator;
var monitor = {
......@@ -1031,7 +1031,7 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\<A
**示例：**
```js
```ts
var abilityDelegator;
function onAbilityCreateCallback(data) {
......@@ -1072,7 +1072,7 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout?: number): Promise
**示例：**
```js
```ts
var abilityDelegator;
function onAbilityCreateCallback(data) {
......@@ -1108,7 +1108,7 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout: number, callback:
**示例：**
```js
```ts
var abilityDelegator;
var timeout = 100;
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityDelegatorRegistry.md 0 → 100644
浏览文件 @ 0612bb09
# AbilityDelegatorRegistry
AbilityDelegatorRegistry模块提供用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力，包括获取应用程序的AbilityDelegator对象、获取单元测试参数AbilityDelegatorArgs对象。
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```ts
import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry'
```
## AbilityLifecycleState
Ability生命周期状态。
**系统能力** ：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 |
| ------------- | ---- | --------------------------- |
| UNINITIALIZED | 0 | 表示无效状态。 |
| CREATE | 1 | 表示Ability处于已创建状态。 |
| FOREGROUND | 2 | 表示Ability处于前台状态。 |
| BACKGROUND | 3 | 表示Ability处于后台状态。 |
| DESTROY | 4 | 表示Ability处于已销毁状态。 |
## AbilityDelegatorRegistry.getAbilityDelegator
getAbilityDelegator(): AbilityDelegator
获取应用程序的AbilityDelegator对象
**系统能力：** SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
| 类型 | 说明 |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| [AbilityDelegator](js-apis-inner-application-abilityDelegator.md#AbilityDelegator) | [AbilityDelegator](js-apis-inner-application-abilityDelegator.md#AbilityDelegator)对象。可以用来调度测试框架相关功能。 |
**示例：**
```ts
var abilityDelegator;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
```
## AbilityDelegatorRegistry.getArguments
getArguments(): AbilityDelegatorArgs
获取单元测试参数AbilityDelegatorArgs对象
**系统能力：** SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
| 类型 | 说明 |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| [AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md) | [AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md)对象。可以用来获取测试参数。 |
**示例：**
```ts
var args = AbilityDelegatorRegistry.getArguments();
console.info("getArguments bundleName:" + args.bundleName);
console.info("getArguments testCaseNames:" + args.testCaseNames);
console.info("getArguments testRunnerClassName:" + args.testRunnerClassName);
```
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityLifecycleCallback.md
浏览文件 @ 0612bb09
......@@ -10,7 +10,7 @@ AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命
## 导入模块
```js
```ts
import AbilityLifecycleCallback from "@ohos.app.ability.AbilityLifecycleCallback";
```
......@@ -156,7 +156,7 @@ onAbilityContinue(ability: Ability): void;
**示例：**
```js
```ts
import Ability from "@ohos.application.Ability";
export default class MyAbility extends Ability {
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md
浏览文件 @ 0612bb09
......@@ -9,7 +9,7 @@ AbilityManager模块提供对Ability相关信息和状态信息进行获取、
## 导入模块
```js
```ts
import AbilityManager from '@ohos.app.ability.abilityManager'
```
......@@ -48,7 +48,7 @@ updateConfiguration(config: Configuration, callback: AsyncCallback\<void>): void
**示例**：
```js
```ts
import abilitymanager from '@ohos.app.ability.abilityManager';
var config = {
......@@ -89,7 +89,7 @@ updateConfiguration(config: Configuration): Promise\<void>
**示例**：
```js
```ts
import abilitymanager from '@ohos.app.ability.abilityManager';
var config = {
......@@ -126,7 +126,7 @@ getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): vo
**示例**：
```js
```ts
import abilitymanager from '@ohos.app.ability.abilityManager';
try {
......@@ -157,7 +157,7 @@ getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>>
**示例**：
```js
```ts
import abilitymanager from '@ohos.app.ability.abilityManager';
try {
......@@ -191,7 +191,7 @@ getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<Ext
**示例**：
```js
```ts
import abilitymanager from '@ohos.app.ability.abilityManager';
var upperLimit = 0;
......@@ -230,7 +230,7 @@ getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningIn
**示例**：
```js
```ts
import abilitymanager from '@ohos.app.ability.abilityManager';
var upperLimit = 0;
......@@ -263,7 +263,7 @@ getTopAbility(callback: AsyncCallback\<ElementName>): void;
**示例**：
```js
```ts
import abilitymanager from '@ohos.app.ability.abilityManager';
try {
......@@ -292,7 +292,7 @@ getTopAbility(): Promise\<ElementName>;
**示例**：
```js
```ts
import abilitymanager from '@ohos.app.ability.abilityManager';
try {
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityMonitor.md
浏览文件 @ 0612bb09
......@@ -10,7 +10,7 @@ AbilityMonitor模块提供匹配满足指定条件的受监视能力对象的方
通过abilityDelegator中的addAbilityMonitor来设置。
```js
```ts
import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry'
var abilityDelegator;
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilitystage.md → zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityStage.md
浏览文件 @ 0612bb09
......@@ -2,16 +2,16 @@
AbilityStage是HAP包的运行时类。
AbilityStage模块提供在HAP加载的时候，通知开发者，可以在此进行该HAP的初始化（如资源预加载，线程创建等）能力。
AbilityStage类提供在HAP加载的时候，通知开发者，可以在此进行该HAP的初始化（如资源预加载，线程创建等）能力。
> **说明：**
>
> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
## 导入类
```js
```ts
import AbilityStage from '@ohos.app.ability.AbilityStage';
```
......@@ -25,7 +25,7 @@ onCreate(): void
**示例：**
```js
```ts
class MyAbilityStage extends AbilityStage {
onCreate() {
console.log("MyAbilityStage.onCreate is called")
......@@ -46,7 +46,7 @@ onAcceptWant(want: Want): string;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 |
| want | [Want](js-apis-app-ability-want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 |
**返回值：**
......@@ -56,7 +56,7 @@ onAcceptWant(want: Want): string;
**示例：**
```js
```ts
class MyAbilityStage extends AbilityStage {
onAcceptWant(want) {
console.log("MyAbilityStage.onAcceptWant called");
......@@ -78,11 +78,11 @@ onConfigurationUpdated(config: Configuration): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| config | [Configuration](js-apis-configuration.md) | 是 | 发生全局配置变更时触发回调，当前全局配置包括系统语言、深浅色模式。 |
| config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 发生全局配置变更时触发回调，当前全局配置包括系统语言、深浅色模式。 |
**示例：**
```js
```ts
class MyAbilityStage extends AbilityStage {
onConfigurationUpdated(config) {
console.log('onConfigurationUpdated, language:' + config.language);
......@@ -102,11 +102,11 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| level | [AbilityConstant.MemoryLevel](js-apis-application-abilityConstant.md#abilityconstantmemorylevel) | 是 | 回调返回内存微调级别，显示当前内存使用状态。|
| level | [AbilityConstant.MemoryLevel](js-apis-app-ability-abilityConstant.md#abilityconstantmemorylevel) | 是 | 回调返回内存微调级别，显示当前内存使用状态。|
**示例：**
```js
```ts
class MyAbilityStage extends AbilityStage {
onMemoryLevel(level) {
console.log('onMemoryLevel, level:' + JSON.stringify(level));
......@@ -124,4 +124,4 @@ context: AbilityStageContext;
| 属性名 | 类型 | 说明 |
| ----------- | --------------------------- | ------------------------------------------------------------ |
| context | [AbilityStageContext](js-apis-abilitystagecontext.md) | 在启动能力阶段进行初始化时回调。 |
| context | [AbilityStageContext](js-apis-inner-application-abilityStageContext.md) | 在启动能力阶段进行初始化时回调。 |
zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md
浏览文件 @ 0612bb09
......@@ -7,7 +7,7 @@ appRecovery模块提供了应用在故障状态下的恢复能力。
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。当前版本仅支持单进程中单Ability的应用恢复。
## 导入模块
```
```ts
import appRecovery from '@ohos.app.ability.appRecovery'
```
......@@ -78,7 +78,7 @@ export default class MyAbilityStage extends AbilityStage {
restartApp(): void;
重启当前App进程，可以配合[errorManager](js-apis-errorManager.md#errorobserver)相关接口使用。
重启当前App进程，可以配合[errorManager](js-apis-app-ability-errorManager.md)相关接口使用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -99,7 +99,7 @@ var observer = {
saveAppState(): boolean;
保存当前App状态，可以配合[errorManager](js-apis-errorManager.md#errorobserver)相关接口使用
保存当前App状态，可以配合[errorManager](js-apis-app-ability-errorManager.md)相关接口使用
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -118,5 +118,4 @@ var observer = {
appRecovery.saveAppState();
}
}
```
zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md 0 → 100644
浏览文件 @ 0612bb09
# Common
Common模块将二级模块API组织在一起方便开发者进行导出。
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用
## 导入模块
```ts
import common from '@ohos.app.ability.common'
```
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| UIAbilityContext | 只读 | [UIAbilityContext](js-apis-inner-application-uiAbilityContext.md) | 否 | UIAbilityContext二级模块。 |
| 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二级模块。 |
| AreaMode | 只读 | [AreaMode](#areamode) | 否 | AreaMode枚举值。 |
| EventHub | 只读 | [EventHub](js-apis-inner-application-eventHub.md) | 否 | EventHub二级模块。 |
| PermissionRequestResult | 只读 | [PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md) | 否 | PermissionRequestResult二级模块。 |
| PacMap | 只读 | [PacMap](js-apis-inner-ability-dataAbilityHelper.md#PacMap) | 否 | PacMap二级模块。 |
| AbilityResult | 只读 | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 否 | AbilityResult二级模块。 |
| ConnectOptions | 只读 | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 否 | ConnectOptions二级模块。 |
**示例：**
```ts
import common from '@ohos.app.ability.common'
let uiAbilityContext: common.UIAbilityContext;
let abilityStageContext: common.AbilityStageContext;
let applicationContext: common.ApplicationContext;
let baseContext: common.BaseContext;
let context: common.Context;
let extensionContext: common.ExtensionContext;
let formExtensionContext: common.FormExtensionContext;
let areaMode: common.AreaMode;
let eventHub: common.EventHub;
let permissionRequestResult: common.PermissionRequestResult;
let pacMap: common.PacMap;
let abilityResult: common.AbilityResult;
let connectOptions: common.ConnectOptions;
```
## AreaMode
访问的文件分区，每个文件分区有对应自己的内容。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 描述 |
| --------------- | ---- | --------------- |
| EL1 | 0 | 设备级加密区。 |
| EL2 | 1 | 用户凭据加密区。默认为EL2。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-app-ability-StartOptions.md → zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md
浏览文件 @ 0612bb09
......@@ -9,15 +9,16 @@ StartOptions模块对系统的基本通信组件进行查询和设置的能力
## 导入模块
```
```ts
import StartOptions from '@ohos.app.ability.StartOptions';
```
## 属性
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 |
| 名称 | 可读 | 可写 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | -------- | -------- |
| [windowMode](js-apis-app-ability-abilityConstant.md#abilityconstantwindowmode) | 是 | 否 | number | 否 | 窗口模式。 |
| [windowMode](js-apis-application-abilityConstant.md#abilityconstantwindowmode) | 是 | 否 | number | 否 | 窗口模式。 |
| displayId | 是 | 否 | number | 否 | 显示ID。 |
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或