Skip to content

D
Docs

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

通知 161
Star 293
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' ...@@ -15,24 +15,25 @@ import ability from '@ohos.ability.ability'
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ | | ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| DataAbilityHelper | 是 | 否 | number | 否 | DataAbilityHelper二级模块。 | | DataAbilityHelper | 只读 | [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 否 | DataAbilityHelper二级模块。 |
| PacMap | 是 | 否 | Want | 否 | PacMap二级模块。 | | PacMap | 只读 | [PacMap](js-apis-inner-ability-dataAbilityHelper.md#PacMap) | 否 | PacMap二级模块。 |
| DataAbilityOperation | 是 | 否 | Want | 否 | DataAbilityOperation二级模块。 | | DataAbilityOperation | 只读 | [DataAbilityOperation](js-apis-inner-ability-dataAbilityOperation.md) | 否 | DataAbilityOperation二级模块。 |
| DataAbilityResult | 是 | 否 | Want | 否 | DataAbilityResult二级模块。 | | DataAbilityResult | 只读 | [DataAbilityResult](js-apis-inner-ability-dataAbilityResult.md) | 否 | DataAbilityResult二级模块。 |
| AbilityResult | 是 | 否 | Want | 否 | AbilityResult二级模块。 | | AbilityResult | 只读 | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 否 | AbilityResult二级模块。 |
| ConnectOptions | 是 | 否 | Want | 否 | ConnectOptions二级模块。 | | ConnectOptions | 只读 | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 否 | ConnectOptions二级模块。 |
| StartAbilityParameter | 是 | 否 | Want | 否 | StartAbilityParameter二级模块。 | | StartAbilityParameter | 只读 | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 否 | StartAbilityParameter二级模块。 |
**示例：** **示例：**
```ts
```ts import ability from '@ohos.ability.ability';
let dataAbilityHelper: ability.DataAbilityHelper;
let pacMap: ability.PacMap; let dataAbilityHelper: ability.DataAbilityHelper;
let dataAbilityOperation: ability.DataAbilityOperation; let pacMap: ability.PacMap;
let dataAbilityResult: ability.DataAbilityResult; let dataAbilityOperation: ability.DataAbilityOperation;
let abilityResult: ability.AbilityResult; let dataAbilityResult: ability.DataAbilityResult;
let connectOptions: ability.ConnectOptions; let abilityResult: ability.AbilityResult;
let startAbilityParameter: ability.StartAbilityParameter; let connectOptions: ability.ConnectOptions;
``` let startAbilityParameter: ability.StartAbilityParameter;
\ No newline at end of file ```
\ 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 { ...@@ -32,7 +32,7 @@ class MainAbility extends Ability {
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| abilityInfo | AbilityInfo | 是 | 否 | Abilityinfo相关信息 | | abilityInfo | AbilityInfo | 是 | 否 | Abilityinfo相关信息 |
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前hap包的信息 | | currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前hap包的信息 |
| config | [Configuration](js-apis-configuration.md) | 是 | 否 | 表示配置信息。 | | config | [Configuration](js-apis-application-configuration.md) | 是 | 否 | 表示配置信息。 |
## AbilityContext.startAbility ## AbilityContext.startAbility
...@@ -46,7 +46,7 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void; ...@@ -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形式返回启动结果 | | callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动结果 |
**错误码：** **错误码：**
...@@ -95,8 +95,8 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback&lt;void& ...@@ -95,8 +95,8 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback&lt;void&
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | | want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 | | options | [StartOptions](js-apis-application-startOptions.md) | 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动结果。 | | callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动结果。 |
**错误码：** **错误码：**
...@@ -148,8 +148,8 @@ startAbility(want: Want, options?: StartOptions): Promise&lt;void&gt;; ...@@ -148,8 +148,8 @@ startAbility(want: Want, options?: StartOptions): Promise&lt;void&gt;;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | | want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 | | options | [StartOptions](js-apis-application-startOptions.md) | 否 | 启动Ability所携带的参数。 |
**返回值：** **返回值：**
...@@ -206,8 +206,8 @@ startAbilityForResult(want: Want, callback: AsyncCallback&lt;AbilityResult&gt;): ...@@ -206,8 +206,8 @@ startAbilityForResult(want: Want, callback: AsyncCallback&lt;AbilityResult&gt;):
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want |[Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | | want |[Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| callback | AsyncCallback&lt;[AbilityResult](js-apis-featureAbility.md#abilityresult)&gt; | 是 | 执行结果回调函数。 | | callback | AsyncCallback&lt;[AbilityResult](js-apis-inner-ability-abilityResult.md)&gt; | 是 | 执行结果回调函数。 |
**错误码：** **错误码：**
...@@ -256,9 +256,9 @@ startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback ...@@ -256,9 +256,9 @@ startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want |[Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | | want |[Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 | | options | [StartOptions](js-apis-application-startOptions.md) | 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback&lt;[AbilityResult](js-apis-featureAbility.md#abilityresult)&gt; | 是 | 执行结果回调函数。 | | callback | AsyncCallback&lt;[AbilityResult](js-apis-inner-ability-abilityResult.md)&gt; | 是 | 执行结果回调函数。 |
**错误码：** **错误码：**
...@@ -311,15 +311,15 @@ startAbilityForResult(want: Want, options?: StartOptions): Promise&lt;AbilityRes ...@@ -311,15 +311,15 @@ startAbilityForResult(want: Want, options?: StartOptions): Promise&lt;AbilityRes
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | | want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 | | 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 ...@@ -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)。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| callback | AsyncCallback\<AbilityResult\> | 是 | 启动Ability的回调函数，返回Ability结果。 | | callback | AsyncCallback\<AbilityResult\> | 是 | 启动Ability的回调函数，返回Ability结果。 |
...@@ -430,9 +430,9 @@ startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOp ...@@ -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)。 | | 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的回调函数。 | | callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**错误码：** **错误码：**
...@@ -491,9 +491,9 @@ startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartO ...@@ -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)。 | | 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; ...@@ -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的回调函数。 | | callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**错误码：** **错误码：**
...@@ -604,7 +604,7 @@ startServiceExtensionAbility(want: Want): Promise\<void>; ...@@ -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: ...@@ -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)。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 | | callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
...@@ -711,7 +711,7 @@ startServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\ ...@@ -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)。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
**错误码：** **错误码：**
...@@ -762,7 +762,7 @@ stopServiceExtensionAbility(want: Want, callback: AsyncCallback\<void>): void; ...@@ -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的回调函数。 | | callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**错误码：** **错误码：**
...@@ -813,7 +813,7 @@ stopServiceExtensionAbility(want: Want): Promise\<void>; ...@@ -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: ...@@ -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)。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 | | callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
...@@ -920,7 +920,7 @@ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\< ...@@ -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)。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
**错误码：** **错误码：**
...@@ -1042,7 +1042,7 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback&lt;voi ...@@ -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形式返回停止结果。 | | callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回停止结果。 |
**错误码：** **错误码：**
...@@ -1097,7 +1097,7 @@ terminateSelfWithResult(parameter: AbilityResult): Promise&lt;void&gt;; ...@@ -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; ...@@ -1153,12 +1153,14 @@ connectServiceExtensionAbility(want: Want, options: ConnectOptions): number;
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | | want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [ConnectOptions](js-apis-featureAbility.md#connectoptions) | 是 | 远端对象实例。 | | options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 否 | 远端对象实例。 |
**返回值：** **返回值：**
...@@ -1214,9 +1216,9 @@ connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options ...@@ -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)。 | | 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>; ...@@ -1264,6 +1266,8 @@ disconnectServiceExtensionAbility(connection: number): Promise\<void>;
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1286,7 +1290,7 @@ disconnectServiceExtensionAbility(connection: number): Promise\<void>; ...@@ -1286,7 +1290,7 @@ disconnectServiceExtensionAbility(connection: number): Promise\<void>;
**示例：** **示例：**
```ts ```ts
// connection为connectAbility中的返回值 // connection为connectServiceExtensionAbility中的返回值
var connection = 1; var connection = 1;
try { try {
...@@ -1315,6 +1319,8 @@ disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback\<vo ...@@ -1315,6 +1319,8 @@ disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback\<vo
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1361,13 +1367,11 @@ startAbilityByCall(want: Want): Promise&lt;Caller&gt;; ...@@ -1361,13 +1367,11 @@ startAbilityByCall(want: Want): Promise&lt;Caller&gt;;
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统能力**：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\< ...@@ -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)。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 | | callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
...@@ -1514,9 +1518,9 @@ startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, ca ...@@ -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)。| | 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的回调函数。 | | callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**错误码：** **错误码：**
...@@ -1574,9 +1578,9 @@ startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): ...@@ -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)。 | | 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 ...@@ -1629,7 +1633,7 @@ requestPermissionsFromUser(permissions: Array&lt;string&gt;, requestCallback: As
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| permissions | Array&lt;string&gt; | 是 | 权限列表。 | | 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 ...@@ -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; ...@@ -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方案的对象的实 ...@@ -8,7 +8,7 @@ DataUriUtils模块提供用于处理使用DataAbilityHelper方案的对象的实
## 导入模块 ## 导入模块
```js ```ts
import dataUriUtils from '@ohos.ability.dataUriUtils'; import dataUriUtils from '@ohos.ability.dataUriUtils';
``` ```
...@@ -22,7 +22,7 @@ getId(uri: string): number ...@@ -22,7 +22,7 @@ getId(uri: string): number
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | --------------------------- | | ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中获取ID的uri对象。 | | uri | string | 是 | 指示要从中获取ID的uri对象。 |
...@@ -34,7 +34,7 @@ getId(uri: string): number ...@@ -34,7 +34,7 @@ getId(uri: string): number
**示例：** **示例：**
```js ```ts
dataUriUtils.getId("com.example.dataUriUtils/1221") dataUriUtils.getId("com.example.dataUriUtils/1221")
``` ```
...@@ -50,7 +50,7 @@ attachId(uri: string, id: number): string ...@@ -50,7 +50,7 @@ attachId(uri: string, id: number): string
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | --------------------------- | | ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中获取ID的uri对象。 | | uri | string | 是 | 指示要从中获取ID的uri对象。 |
| id | number | 是 | 指示要附加的ID。 | | id | number | 是 | 指示要附加的ID。 |
...@@ -63,7 +63,7 @@ attachId(uri: string, id: number): string ...@@ -63,7 +63,7 @@ attachId(uri: string, id: number): string
**示例：** **示例：**
```js ```ts
var idint = 1122; var idint = 1122;
dataUriUtils.attachId( dataUriUtils.attachId(
"com.example.dataUriUtils", "com.example.dataUriUtils",
...@@ -83,7 +83,7 @@ deleteId(uri: string): string ...@@ -83,7 +83,7 @@ deleteId(uri: string): string
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | --------------------------- | | ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中删除ID的uri对象。 | | uri | string | 是 | 指示要从中删除ID的uri对象。 |
...@@ -95,7 +95,7 @@ deleteId(uri: string): string ...@@ -95,7 +95,7 @@ deleteId(uri: string): string
**示例：** **示例：**
```js ```ts
dataUriUtils.deleteId("com.example.dataUriUtils/1221") dataUriUtils.deleteId("com.example.dataUriUtils/1221")
``` ```
...@@ -111,7 +111,7 @@ updateId(uri: string, id: number): string ...@@ -111,7 +111,7 @@ updateId(uri: string, id: number): string
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | ------------------- | | ---- | ------ | ---- | ------------------- |
| uri | string | 是 | 指示要更新的uri对象 | | uri | string | 是 | 指示要更新的uri对象 |
| id | number | 是 | 指示新ID | | id | number | 是 | 指示新ID |
...@@ -124,7 +124,7 @@ updateId(uri: string, id: number): string ...@@ -124,7 +124,7 @@ updateId(uri: string, id: number): string
**示例：** **示例：**
```js ```ts
var idint = 1122; var idint = 1122;
dataUriUtils.updateId( dataUriUtils.updateId(
"com.example.dataUriUtils", "com.example.dataUriUtils",
......
zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md
浏览文件 @ 0612bb09
...@@ -10,7 +10,7 @@ ErrorCode是定义启动功能时使用的错误代码。 ...@@ -10,7 +10,7 @@ ErrorCode是定义启动功能时使用的错误代码。
## 导入模块 ## 导入模块
``` ```ts
import errorCode from '@ohos.ability.errorCode' import errorCode from '@ohos.ability.errorCode'
``` ```
...@@ -24,5 +24,5 @@ import errorCode from '@ohos.ability.errorCode' ...@@ -24,5 +24,5 @@ import errorCode from '@ohos.ability.errorCode'
| ------------------------------ | ---- | ---------------------------------------- | | ------------------------------ | ---- | ---------------------------------------- |
| NO_ERROR | 0 | 没有错误。 | | NO_ERROR | 0 | 没有错误。 |
| INVALID_PARAMETER | -1 | 无效的参数。 | | INVALID_PARAMETER | -1 | 无效的参数。 |
| ABILITY_NOT_FOUND | -2 | 找不到能力。 | | ABILITY_NOT_FOUND | -2 | 找不到ABILITY。 |
| PERMISSION_DENY | -3 | 拒绝许可。 | | PERMISSION_DENY | -3 | 拒绝许可。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-featureAbility.md → zh-cn/application-dev/reference/apis/js-apis-ability-featureAbility.md
浏览文件 @ 0612bb09
# FeatureAbility模块(JS端SDK接口) # FeatureAbility模块(JS端SDK接口)
FeatureAbility模块提供带有UI设计与用户交互的能力，包括启动新的ability、获取dataAbilityHelper、设置此Page Ability、获取当前Ability对应的窗口，连接服务等。 FeatureAbility模块提供带有UI设计与用户交互的能力，包括启动新的ability、获取dataAbilityHelper、设置此Page Ability、获取当前Ability对应的窗口，连接服务等。
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在FA模型下使用。 > 本模块接口仅可在FA模型下使用。
## 使用限制 ## 使用限制
FeatureAbility模块的接口只能在Page类型的Ability调用 FeatureAbility模块的接口只能在Page类型的Ability调用
## 导入模块 ## 导入模块
``` ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
``` ```
## featureAbility.startAbility ## featureAbility.startAbility
startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>): void startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>): void
启动新的ability（callback形式）。 启动新的ability（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- | | --------- | ---------------------------------------- | ---- | -------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability。 | | parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 表示被启动的Ability。 |
| callback | AsyncCallback\<number> | 是 | 被指定的回调方法。 | | callback | AsyncCallback\<number> | 是 | 被指定的回调方法。 |
**示例：** **示例：**
```javascript ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import wantConstant from '@ohos.ability.wantConstant'; import wantConstant from '@ohos.ability.wantConstant';
featureAbility.startAbility( featureAbility.startAbility(
{ {
want: want:
{ {
action: "", action: "",
entities: [""], entities: [""],
type: "", type: "",
flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: "",
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
/* FA模型中abilityName由package + Ability name组成 */ /* FA模型中abilityName由package + Ability name组成 */
abilityName: "com.example.entry.secondAbility", abilityName: "com.example.entry.secondAbility",
uri: "" uri: ""
}, },
}, },
(err, data) => { (err, data) => {
console.info("startAbility err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info("startAbility err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
} }
); );
``` ```
## featureAbility.startAbility ## featureAbility.startAbility
startAbility(parameter: StartAbilityParameter): Promise\<number> startAbility(parameter: StartAbilityParameter): Promise\<number>
启动新的ability（Promise形式）。 启动新的ability（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- | | --------- | ---------------------------------------- | ---- | -------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability。 | | parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 表示被启动的Ability。 |
**示例：** **示例：**
```javascript ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import wantConstant from '@ohos.ability.wantConstant'; import wantConstant from '@ohos.ability.wantConstant';
featureAbility.startAbility( featureAbility.startAbility(
{ {
want: want:
{ {
action: "action.system.home", action: "action.system.home",
entities: ["entity.system.home"], entities: ["entity.system.home"],
type: "MIMETYPE", type: "MIMETYPE",
flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: "",
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
/* FA模型中abilityName由package + Ability name组成 */ /* FA模型中abilityName由package + Ability name组成 */
abilityName: "com.example.entry.secondAbility", abilityName: "com.example.entry.secondAbility",
uri: "" uri: ""
}, },
} }
).then((data) => { ).then((data) => {
console.info("startAbility data: " + JSON.stringify(data)); console.info("startAbility data: " + JSON.stringify(data));
}); });
``` ```
## featureAbility.acquireDataAbilityHelper<sup>7+</sup> ## featureAbility.acquireDataAbilityHelper<sup>7+</sup>
acquireDataAbilityHelper(uri: string): DataAbilityHelper acquireDataAbilityHelper(uri: string): DataAbilityHelper
获取dataAbilityHelper。 获取dataAbilityHelper。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ | | ---- | ------ | ---- | ------------ |
| uri | string | 是 | 指示要打开的文件的路径。 | | uri | string | 是 | 指示要打开的文件的路径。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------- | ------------------------------- | | ----------------- | ------------------------------- |
| DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类。 | | DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类。 |
**示例：** **示例：**
```javascript ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var dataAbilityHelper = featureAbility.acquireDataAbilityHelper( var dataAbilityHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
``` ```
## featureAbility.startAbilityForResult<sup>7+</sup> ## featureAbility.startAbilityForResult<sup>7+</sup>
startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\<AbilityResult>): void startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\<AbilityResult>): void
启动一个ability，并在该ability被销毁时返回执行结果（callback形式）。 启动一个ability，并在该ability被销毁时返回执行结果（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- | | --------- | ---------------------------------------- | ---- | -------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability。 | | parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 表示被启动的Ability。 |
| callback | AsyncCallback\<[AbilityResult](#abilityresult)> | 是 | 被指定的回调方法。 | | callback | AsyncCallback\<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | 是 | 被指定的回调方法。 |
**示例：** **示例：**
```javascript ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import wantConstant from '@ohos.ability.wantConstant'; import wantConstant from '@ohos.ability.wantConstant';
featureAbility.startAbilityForResult( featureAbility.startAbilityForResult(
{ {
want: want:
{ {
action: "action.system.home", action: "action.system.home",
entities: ["entity.system.home"], entities: ["entity.system.home"],
type: "MIMETYPE", type: "MIMETYPE",
flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: "",
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
/* FA模型中abilityName由package + Ability name组成 */ /* FA模型中abilityName由package + Ability name组成 */
abilityName: "com.example.entry.secondAbility", abilityName: "com.example.entry.secondAbility",
uri:"" uri:""
}, },
}, },
(err, data) => { (err, data) => {
console.info("startAbilityForResult err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info("startAbilityForResult err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
} }
); );
``` ```
## featureAbility.startAbilityForResult<sup>7+</sup> ## featureAbility.startAbilityForResult<sup>7+</sup>
startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult> startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult>
启动一个ability，并在该ability被销毁时返回执行结果（Promise形式）。 启动一个ability，并在该ability被销毁时返回执行结果（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | ------------- | | --------- | ---------------------------------------- | ---- | ------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability | | parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 表示被启动的Ability |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | ------- | | ---------------------------------------- | ------- |
| Promise\<[AbilityResult](#abilityresult)> | 返回执行结果。 | | Promise\<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | 返回执行结果。 |
**示例：** **示例：**
```javascript ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import wantConstant from '@ohos.ability.wantConstant'; import wantConstant from '@ohos.ability.wantConstant';
featureAbility.startAbilityForResult( featureAbility.startAbilityForResult(
{ {
want: want:
{ {
action: "action.system.home", action: "action.system.home",
entities: ["entity.system.home"], entities: ["entity.system.home"],
type: "MIMETYPE", type: "MIMETYPE",
flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: "",
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
/* FA模型中abilityName由package + Ability name组成 */ /* FA模型中abilityName由package + Ability name组成 */
abilityName: "com.example.entry.secondAbility", abilityName: "com.example.entry.secondAbility",
uri:"", uri:"",
parameters: parameters:
{ {
mykey0: 1111, mykey0: 1111,
mykey1: [1, 2, 3], mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", mykey2: "[1, 2, 3]",
mykey3: "xxxxxxxxxxxxxxxxxxxxxx", mykey3: "xxxxxxxxxxxxxxxxxxxxxx",
mykey4: [1, 15], mykey4: [1, 15],
mykey5: [false, true, false], mykey5: [false, true, false],
mykey6: ["aaaaaa", "bbbbb", "ccccccccccc"], mykey6: ["aaaaaa", "bbbbb", "ccccccccccc"],
mykey7: true, mykey7: true,
}, },
}, },
}, },
).then((data) => { ).then((data) => {
console.info("startAbilityForResult data: " + JSON.stringify(data)); console.info("startAbilityForResult data: " + JSON.stringify(data));
}); });
``` ```
## featureAbility.terminateSelfWithResult<sup>7+</sup> ## featureAbility.terminateSelfWithResult<sup>7+</sup>
terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>): void terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>): void
设置此Page Ability将返回给调用者的结果代码和数据并破坏此Page Ability（callback形式）。 设置此Page Ability将返回给调用者的结果代码和数据并破坏此Page Ability（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------- | ---- | -------------- | | --------- | ------------------------------- | ---- | -------------- |
| parameter | [AbilityResult](#abilityresult) | 是 | 表示被启动的Ability。 | | parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 表示被启动的Ability。 |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法。 | | callback | AsyncCallback\<void> | 是 | 被指定的回调方法。 |
**示例：** **示例：**
```javascript ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import wantConstant from '@ohos.ability.wantConstant'; import wantConstant from '@ohos.ability.wantConstant';
featureAbility.terminateSelfWithResult( featureAbility.terminateSelfWithResult(
{ {
resultCode: 1, resultCode: 1,
want: want:
{ {
action: "action.system.home", action: "action.system.home",
entities: ["entity.system.home"], entities: ["entity.system.home"],
type: "MIMETYPE", type: "MIMETYPE",
flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: "",
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
/* FA模型中abilityName由package + Ability name组成 */ /* FA模型中abilityName由package + Ability name组成 */
abilityName: "com.example.entry.secondAbility", abilityName: "com.example.entry.secondAbility",
uri:"", uri:"",
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: [1, 15], mykey4: [1, 15],
mykey5: [false, true, false], mykey5: [false, true, false],
mykey6: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], mykey6: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey7: true, mykey7: true,
} }
}, },
}, },
(err) => { (err) => {
console.info("err: " + JSON.stringify(err)) console.info("err: " + JSON.stringify(err))
} }
); );
``` ```
## featureAbility.terminateSelfWithResult<sup>7+</sup> ## featureAbility.terminateSelfWithResult<sup>7+</sup>
terminateSelfWithResult(parameter: AbilityResult): Promise\<void> terminateSelfWithResult(parameter: AbilityResult): Promise\<void>
设置此Page Ability将返回给调用者的结果代码和数据并破坏此Page Ability（Promise形式）。 设置此Page Ability将返回给调用者的结果代码和数据并破坏此Page Ability（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------- | ---- | ------------- | | --------- | ------------------------------- | ---- | ------------- |
| parameter | [AbilityResult](#abilityresult) | 是 | 表示被启动的Ability | | parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 表示被启动的Ability |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | --------------- | | -------------- | --------------- |
| Promise\<void> | 以Promise形式返回结果。 | | Promise\<void> | 以Promise形式返回结果。 |
**示例：** **示例：**
```javascript ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import wantConstant from '@ohos.ability.wantConstant'; import wantConstant from '@ohos.ability.wantConstant';
featureAbility.terminateSelfWithResult( featureAbility.terminateSelfWithResult(
{ {
resultCode: 1, resultCode: 1,
want: want:
{ {
action: "action.system.home", action: "action.system.home",
entities: ["entity.system.home"], entities: ["entity.system.home"],
type: "MIMETYPE", type: "MIMETYPE",
flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: "",
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
/* FA模型中abilityName由package + Ability name组成 */ /* FA模型中abilityName由package + Ability name组成 */
abilityName: "com.example.entry.secondAbility", abilityName: "com.example.entry.secondAbility",
uri:"", uri:"",
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: [1, 15], mykey4: [1, 15],
mykey5: [false, true, false], mykey5: [false, true, false],
mykey6: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], mykey6: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey7: true, mykey7: true,
} }
}, },
} }
).then((data) => { ).then((data) => {
console.info("==========================>terminateSelfWithResult=======================>"); console.info("==========================>terminateSelfWithResult=======================>");
}); });
``` ```
## featureAbility.hasWindowFocus<sup>7+<sup> ## featureAbility.hasWindowFocus<sup>7+<sup>
hasWindowFocus(callback: AsyncCallback\<boolean>): void hasWindowFocus(callback: AsyncCallback\<boolean>): void
检查Ability的主窗口是否具有窗口焦点（callback形式）。 检查Ability的主窗口是否具有窗口焦点（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ---------------------------------------- | | -------- | ----------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback\<boolean> | 是 | 被指定的回调方法。<br>如果此Ability当前具有视窗焦点，则返回true；否则返回false。 | | callback | AsyncCallback\<boolean> | 是 | 被指定的回调方法。<br>如果此Ability当前具有视窗焦点，则返回true；否则返回false。 |
**示例：** **示例：**
```javascript ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
featureAbility.hasWindowFocus((err, data) => { featureAbility.hasWindowFocus((err, data) => {
console.info("hasWindowFocus err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info("hasWindowFocus err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
}); });
``` ```
## featureAbility.hasWindowFocus<sup>7+<sup> ## featureAbility.hasWindowFocus<sup>7+<sup>
hasWindowFocus(): Promise\<boolean> hasWindowFocus(): Promise\<boolean>
检查Ability的主窗口是否具有窗口焦点（Promise形式）。 检查Ability的主窗口是否具有窗口焦点（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------- | ------------------------------------- | | ----------------- | ------------------------------------- |
| Promise\<boolean> | 如果此Ability当前具有视窗焦点，则返回true；否则返回false。 | | Promise\<boolean> | 如果此Ability当前具有视窗焦点，则返回true；否则返回false。 |
**示例：** **示例：**
```javascript ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
featureAbility.hasWindowFocus().then((data) => { featureAbility.hasWindowFocus().then((data) => {
console.info("hasWindowFocus data: " + JSON.stringify(data)); console.info("hasWindowFocus data: " + JSON.stringify(data));
}); });
``` ```
## featureAbility.getWant ## featureAbility.getWant
getWant(callback: AsyncCallback\<Want>): void getWant(callback: AsyncCallback\<Want>): void
获取从Ability发送的Want（callback形式）。 获取从Ability发送的Want（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | --------- | | -------- | ----------------------------- | ---- | --------- |
| callback | AsyncCallback\<[Want](js-apis-application-Want.md)> | 是 | 被指定的回调方法。 | | callback | AsyncCallback\<[Want](js-apis-application-want.md)> | 是 | 被指定的回调方法。 |
**示例：** **示例：**
```javascript ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
featureAbility.getWant((err, data) => { featureAbility.getWant((err, data) => {
console.info("getWant err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info("getWant err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
}); });
``` ```
## featureAbility.getWant ## featureAbility.getWant
getWant(): Promise\<Want> getWant(): Promise\<Want>
获取从Ability发送的Want（Promise形式）。 获取从Ability发送的Want（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------- | ---------------- | | ----------------------- | ---------------- |
| Promise\<[Want](js-apis-application-Want.md)> | 以Promise的形式返回结果。 | | Promise\<[Want](js-apis-application-want.md)> | 以Promise的形式返回结果。 |
**示例：** **示例：**
```javascript ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
featureAbility.getWant().then((data) => { featureAbility.getWant().then((data) => {
console.info("getWant data: " + JSON.stringify(data)); console.info("getWant data: " + JSON.stringify(data));
}); });
``` ```
## featureAbility.getContext ## featureAbility.getContext
getContext(): Context getContext(): Context
获取应用上下文。 获取应用上下文。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ---------- | | ------- | ---------- |
| Context | 返回应用程序上下文。 | | Context | 返回应用程序上下文。 |
**示例：** **示例：**
```javascript ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext() var context = featureAbility.getContext()
context.getBundleName((err, data) => { context.getBundleName((err, data) => {
console.info("getBundleName err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); console.info("getBundleName err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
}); });
``` ```
## featureAbility.terminateSelf<sup>7+</sup> ## featureAbility.terminateSelf<sup>7+</sup>
terminateSelf(callback: AsyncCallback\<void>): void terminateSelf(callback: AsyncCallback\<void>): void
设置Page Ability返回给被调用方的结果代码和数据，并销毁此Page Ability（callback形式）。 设置Page Ability返回给被调用方的结果代码和数据，并销毁此Page Ability（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | -------- | | -------- | -------------------- | ---- | -------- |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法 | | callback | AsyncCallback\<void> | 是 | 被指定的回调方法 |
**示例：** **示例：**
```javascript ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
featureAbility.terminateSelf( featureAbility.terminateSelf(
(err) => { (err) => {
console.info("err: " + JSON.stringify(err)) console.info("err: " + JSON.stringify(err))
} }
) )
``` ```
## featureAbility.terminateSelf<sup>7+</sup> ## featureAbility.terminateSelf<sup>7+</sup>
terminateSelf(): Promise\<void> terminateSelf(): Promise\<void>
设置Page Ability返回给被调用方的结果代码和数据，并销毁此Page Ability（Promise形式）。 设置Page Ability返回给被调用方的结果代码和数据，并销毁此Page Ability（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ---------------- | | -------------- | ---------------- |
| Promise\<void> | 以Promise的形式返回结果。 | | Promise\<void> | 以Promise的形式返回结果。 |
**示例：** **示例：**
```javascript ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
featureAbility.terminateSelf().then((data) => { featureAbility.terminateSelf().then((data) => {
console.info("==========================>terminateSelf=======================>"); console.info("==========================>terminateSelf=======================>");
}); });
``` ```
## featureAbility.connectAbility<sup>7+</sup> ## featureAbility.connectAbility<sup>7+</sup>
connectAbility(request: Want, options:ConnectOptions): number connectAbility(request: Want, options:ConnectOptions): number
将当前ability连接到指定ServiceAbility（callback形式）。 将当前ability连接到指定ServiceAbility（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | -------------- | ---- | --------------------- | | ------- | -------------- | ---- | --------------------- |
| request | [Want](js-apis-application-Want.md) | 是 | 表示被连接的ServiceAbility。 | | request | [Want](js-apis-application-want.md) | 是 | 表示被连接的ServiceAbility。 |
| options | [ConnectOptions](#connectoptions) | 是 | 被指定的回调方法。 | | options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 是 | 被指定的回调方法。 |
## ConnectOptions **返回值：**
ConnectOptions类型说明 | 类型 | 说明 |
| ------ | -------------------- |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core | number | 连接的ServiceAbilityID。 |
| 参数名 | 可读|可写 | 类型 | 必填 | 说明 | **示例：**
| ------------ | -- | -- | -------- | ---- | ------------------------- |
| onConnect<sup>7+</sup> | 是|否 | function | 是 | 连接成功时的回调函数。 | ```ts
| onDisconnect<sup>7+</sup> | 是|否 | function | 是 | 连接失败时的回调函数。 | import rpc from '@ohos.rpc';
| onFailed<sup>7+</sup> | 是|否 | function | 是 | ConnectAbility调用失败时的回调函数。 | import featureAbility from '@ohos.ability.featureAbility';
function onConnectCallback(element, remote){
**返回值：** console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
}
| 类型 | 说明 | function onDisconnectCallback(element){
| ------ | -------------------- | console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
| number | 连接的ServiceAbilityID。 | }
function onFailedCallback(code){
**示例：** console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code)
}
```javascript var connectId = featureAbility.connectAbility(
import rpc from '@ohos.rpc'; {
import featureAbility from '@ohos.ability.featureAbility'; deviceId: "",
function onConnectCallback(element, remote){ bundleName: "com.ix.ServiceAbility",
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); abilityName: "ServiceAbilityA",
} },
function onDisconnectCallback(element){ {
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) onConnect: onConnectCallback,
} onDisconnect: onDisconnectCallback,
function onFailedCallback(code){ onFailed: onFailedCallback,
console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) },
} );
var connectId = featureAbility.connectAbility( ```
{
deviceId: "", ## featureAbility.disconnectAbility<sup>7+</sup>
bundleName: "com.ix.ServiceAbility",
abilityName: "ServiceAbilityA", disconnectAbility(connection: number, callback:AsyncCallback\<void>): void
},
{ 断开与指定ServiceAbility的连接（callback形式）。
onConnect: onConnectCallback,
onDisconnect: onDisconnectCallback, **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
onFailed: onFailedCallback,
}, **参数：**
);
``` | 参数名 | 类型 | 必填 | 说明 |
| ---------- | -------------------- | ---- | ----------------------- |
## featureAbility.disconnectAbility<sup>7+</sup> | connection | number | 是 | 指定断开连接的ServiceAbilityID |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法 |
disconnectAbility(connection: number, callback:AsyncCallback\<void>): void
**示例：**
断开与指定ServiceAbility的连接（callback形式）。
```ts
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel import rpc from '@ohos.rpc';
import featureAbility from '@ohos.ability.featureAbility';
**参数：** function onConnectCallback(element, remote){
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
| 参数名 | 类型 | 必填 | 说明 | }
| ---------- | -------------------- | ---- | ----------------------- | function onDisconnectCallback(element){
| connection | number | 是 | 指定断开连接的ServiceAbilityID | console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法 | }
function onFailedCallback(code){
**示例：** console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code)
}
```javascript var connectId = featureAbility.connectAbility(
import rpc from '@ohos.rpc'; {
import featureAbility from '@ohos.ability.featureAbility'; bundleName: "com.ix.ServiceAbility",
function onConnectCallback(element, remote){ abilityName: "ServiceAbilityA",
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); },
} {
function onDisconnectCallback(element){ onConnect: onConnectCallback,
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) onDisconnect: onDisconnectCallback,
} onFailed: onFailedCallback,
function onFailedCallback(code){ },
console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) );
} var result = featureAbility.disconnectAbility(connectId,
var connectId = featureAbility.connectAbility( (error) => {
{ console.log('featureAbilityTest DisConnectJsSameBundleName result errCode : ' + error.code)
bundleName: "com.ix.ServiceAbility", },
abilityName: "ServiceAbilityA", );
}, ```
{
onConnect: onConnectCallback, ## featureAbility.disconnectAbility<sup>7+</sup>
onDisconnect: onDisconnectCallback,
onFailed: onFailedCallback, disconnectAbility(connection: number): Promise\<void>
},
); 断开与指定ServiceAbility的连接（Promise形式）。
var result = featureAbility.disconnectAbility(connectId,
(error) => { **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
console.log('featureAbilityTest DisConnectJsSameBundleName result errCode : ' + error.code)
}, **参数：**
);
``` | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ----------------------- |
## featureAbility.disconnectAbility<sup>7+</sup> | connection | number | 是 | 指定断开连接的ServiceAbilityID |
disconnectAbility(connection: number): Promise\<void> **返回值：**
断开与指定ServiceAbility的连接（Promise形式）。 | 类型 | 说明 |
| -------------- | --------------- |
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel | Promise\<void> | 以Promise形式返回结果。 |
**参数：** **示例：**
| 参数名 | 类型 | 必填 | 说明 | ```ts
| ---------- | ------ | ---- | ----------------------- | import rpc from '@ohos.rpc';
| connection | number | 是 | 指定断开连接的ServiceAbilityID | import featureAbility from '@ohos.ability.featureAbility';
function onConnectCallback(element, remote){
**返回值：** console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
}
| 类型 | 说明 | function onDisconnectCallback(element){
| -------------- | --------------- | console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
| Promise\<void> | 以Promise形式返回结果。 | }
function onFailedCallback(code){
**示例：** console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code)
}
```javascript var connectId = featureAbility.connectAbility(
import rpc from '@ohos.rpc'; {
import featureAbility from '@ohos.ability.featureAbility'; bundleName: "com.ix.ServiceAbility",
function onConnectCallback(element, remote){ abilityName: "ServiceAbilityA",
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); },
} {
function onDisconnectCallback(element){ onConnect: onConnectCallback,
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) onDisconnect: onDisconnectCallback,
} onFailed: onFailedCallback,
function onFailedCallback(code){ },
console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) );
}
var connectId = featureAbility.connectAbility( featureAbility.disconnectAbility(connectId).then((data) => {
{ console.log('data : ' + data);
bundleName: "com.ix.ServiceAbility", }).catch((error)=>{
abilityName: "ServiceAbilityA", console.log('featureAbilityTest result errCode : ' + error.code);
}, });
{ ```
onConnect: onConnectCallback,
onDisconnect: onDisconnectCallback,
onFailed: onFailedCallback, ## featureAbility.getWindow<sup>7+</sup>
},
); getWindow(callback: AsyncCallback\<window.Window>): void
featureAbility.disconnectAbility(connectId).then((data) => { 获取当前Ability对应的窗口（callback形式）。
console.log('data : ' + data);
}).catch((error)=>{ **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
console.log('featureAbilityTest result errCode : ' + error.code);
}); **参数：**
```
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | ----------------------------- |
## featureAbility.getWindow<sup>7+</sup> | callback | AsyncCallback\<window.Window> | 是 | 返回与当前Ability对应的窗口。 |
getWindow(callback: AsyncCallback\<window.Window>): void **示例：**
获取当前Ability对应的窗口（callback形式）。 ```ts
featureAbility.getWindow((err, data) => {
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel console.info("getWindow err: " + JSON.stringify(err) + "data: " + typeof(data));
});
**参数：** ```
| 参数名 | 类型 | 必填 | 说明 | ## featureAbility.getWindow<sup>7+</sup>
| -------- | ----------------------------- | ---- | ----------------------------- |
| callback | AsyncCallback\<window.Window> | 是 | 返回与当前Ability对应的窗口。 | getWindow(): Promise\<window.Window>;
**示例：** 获取当前Ability对应的窗口（Promise形式）。
```javascript **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
featureAbility.getWindow((err, data) => {
console.info("getWindow err: " + JSON.stringify(err) + "data: " + typeof(data)); **返回值：**
});
``` | 类型 | 说明 |
| ----------------------- | ----------------------------- |
## featureAbility.getWindow<sup>7+</sup> | Promise\<window.Window> | 返回与当前Ability对应的窗口。 |
getWindow(): Promise\<window.Window>; **示例：**
获取当前Ability对应的窗口（Promise形式）。 ```ts
featureAbility.getWindow().then((data) => {
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel console.info("getWindow data: " + typeof(data));
});
**返回值：** ```
| 类型 | 说明 | ## AbilityWindowConfiguration
| ----------------------- | ----------------------------- |
| Promise\<window.Window> | 返回与当前Ability对应的窗口。 | 使用时通过featureAbility.AbilityWindowConfiguration获取。
**示例：** **示例：**
```javascript ```
featureAbility.getWindow().then((data) => { featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED
console.info("getWindow data: " + typeof(data)); ```
});
``` **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
## ConnectOptions.onConnect<sup>7+</sup> | 名称 | 值 | 说明 |
| ---------------------------------------- | ---- | ---------------------------------------- |
onConnect(elementName: ElementName, remote: rpc.IRemoteObject): void; | WINDOW_MODE_UNDEFINED<sup>7+</sup> | 0 | 未定义。 |
| WINDOW_MODE_FULLSCREEN<sup>7+</sup> | 1 | 全屏。 |
连接成功时的回调函数。 | WINDOW_MODE_SPLIT_PRIMARY<sup>7+</sup> | 100 | 分屏主屏。 |
| WINDOW_MODE_SPLIT_SECONDARY<sup>7+</sup> | 101 | 分屏次屏。 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | WINDOW_MODE_FLOATING<sup>7+</sup> | 102 | 悬浮窗。 |
**参数：**
## AbilityStartSetting
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------- | ---- | -------- | abilityStartSetting属性是一个定义为[key: string]: any的对象，key对应设定类型为：AbilityStartSetting枚举类型，value对应设定类型为：AbilityWindowConfiguration枚举类型。
| elementName | ElementName | 是 | 元素名。 |
| remote | rpc.IRemoteObject | 是 | rpc远程对象。 | 使用时通过featureAbility.AbilityStartSetting获取。
**示例：** **示例：**
```javascript ```
import rpc from '@ohos.rpc'; featureAbility.AbilityStartSetting.BOUNDS_KEY
import featureAbility from '@ohos.ability.featureAbility'; ```
function onConnectCallback(element, remote){
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
}
function onDisconnectCallback(element){ | 名称 | 值 | 说明 |
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) | ---------------------------- | --------------- | ---------------------------------------- |
} | BOUNDS_KEY<sup>7+</sup> | "abilityBounds" | 窗口显示大小属性的参数名。 |
function onFailedCallback(code){ | WINDOW_MODE_KEY<sup>7+</sup> | "windowMode" | 窗口显示模式属性的参数名。|
console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) | DISPLAY_ID_KEY<sup>7+</sup> | "displayId" | 窗口显示设备ID属性的参数名。 |
}
var connectId = featureAbility.connectAbility( ## ErrorCode
{
deviceId: "", 获取错误代码。
bundleName: "com.ix.ServiceAbility",
abilityName: "ServiceAbilityA", **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
},
{ | 名称 | 值 | 说明 |
onConnect: onConnectCallback, | ------------------------------ | ---- | ---------------------------------------- |
onDisconnect: onDisconnectCallback, | NO_ERROR<sup>7+</sup> | 0 | 没有错误。 |
onFailed: onFailedCallback, | INVALID_PARAMETER<sup>7+</sup> | -1 | 无效的参数。 |
}, | ABILITY_NOT_FOUND<sup>7+</sup> | -2 | 找不到能力。 |
); | PERMISSION_DENY<sup>7+</sup> | -3 | 拒绝许可。 |
```
## ConnectOptions.onDisconnect<sup>7+</sup> ## DataAbilityOperationType
onDisconnect(elementName: ElementName): void; 指示数据的操作类型。
连接失败时的回调函数。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | 名称 | 值 | 说明 |
| ------------------------ | ---- | ---------------------------------------- |
**参数：** | TYPE_INSERT<sup>7+</sup> | 1 | 插入类型。 |
| TYPE_UPDATE<sup>7+</sup> | 2 | 修改类型。 |
| 参数名 | 类型 | 必填 | 说明 | | TYPE_DELETE<sup>7+</sup> | 3 | 删除类型。 |
| ----------- | ----------- | ---- | ---- | | TYPE_ASSERT<sup>7+</sup> | 4 | 声明类型。 |
| elementName | ElementName | 是 | 元素名。 |
## flags说明
**示例：**
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
```javascript
import rpc from '@ohos.rpc'; | 名称 | 值 | 说明 |
import featureAbility from '@ohos.ability.featureAbility'; | ------------------------------------ | ---------- | ---------------------------------------- |
function onConnectCallback(element, remote){ | FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权。 |
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); | FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权。 |
} | FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给元能力。 |
function onDisconnectCallback(element){ | FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备。 |
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) | FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS。 |
} | FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力。 |
function onFailedCallback(code){ | FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code) | FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
} | FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动。 |
var connectId = featureAbility.connectAbility( | FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
{ | FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。 |
deviceId: "", | FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能。 |
bundleName: "com.ix.ServiceAbility", | FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。 |
abilityName: "ServiceAbilityA", | FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给 **[ohos.app.Context](js-apis-ability-context.md)** 中**startAbility**方法的**Want**设置此标志，并且必须与**flag_ABILITY_NEW_MISSION**一起使用。 |
}, | FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 |
{ | FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 |
onConnect: onConnectCallback,
onDisconnect: onDisconnectCallback,
onFailed: onFailedCallback,
},
);
```
## ConnectOptions.onFailed<sup>7+</sup>
onFailed(code: number): void;
ConnectAbility调用失败时的回调函数。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | --------- |
| code | number | 是 | number类型。 |
**示例：**
```javascript
import rpc from '@ohos.rpc';
import featureAbility from '@ohos.ability.featureAbility';
function onConnectCallback(element, remote){
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
}
function onDisconnectCallback(element){
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
}
function onFailedCallback(code){
console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code)
}
var connectId = featureAbility.connectAbility(
{
deviceId: "",
bundleName: "com.ix.ServiceAbility",
abilityName: "ServiceAbilityA",
},
{
onConnect: onConnectCallback,
onDisconnect: onDisconnectCallback,
onFailed: onFailedCallback,
},
);
```
## AbilityWindowConfiguration
使用时通过featureAbility.AbilityWindowConfiguration获取。
**示例：**
```
featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED
```
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 值 | 说明 |
| ---------------------------------------- | ---- | ---------------------------------------- |
| WINDOW_MODE_UNDEFINED<sup>7+</sup> | 0 | 未定义。 |
| WINDOW_MODE_FULLSCREEN<sup>7+</sup> | 1 | 全屏。 |
| WINDOW_MODE_SPLIT_PRIMARY<sup>7+</sup> | 100 | 分屏主屏。 |
| WINDOW_MODE_SPLIT_SECONDARY<sup>7+</sup> | 101 | 分屏次屏。 |
| WINDOW_MODE_FLOATING<sup>7+</sup> | 102 | 悬浮窗。 |
## AbilityStartSetting
abilityStartSetting属性是一个定义为[key: string]: any的对象，key对应设定类型为：AbilityStartSetting枚举类型，value对应设定类型为：AbilityWindowConfiguration枚举类型。
使用时通过featureAbility.AbilityStartSetting获取。
**示例：**
```
featureAbility.AbilityStartSetting.BOUNDS_KEY
```
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 值 | 说明 |
| ---------------------------- | --------------- | ---------------------------------------- |
| BOUNDS_KEY<sup>7+</sup> | "abilityBounds" | 窗口显示大小属性的参数名。 |
| WINDOW_MODE_KEY<sup>7+</sup> | "windowMode" | 窗口显示模式属性的参数名。|
| DISPLAY_ID_KEY<sup>7+</sup> | "displayId" | 窗口显示设备ID属性的参数名。 |
## ErrorCode
获取错误代码。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 值 | 说明 |
| ------------------------------ | ---- | ---------------------------------------- |
| NO_ERROR<sup>7+</sup> | 0 | 没有错误。 |
| INVALID_PARAMETER<sup>7+</sup> | -1 | 无效的参数。 |
| ABILITY_NOT_FOUND<sup>7+</sup> | -2 | 找不到能力。 |
| PERMISSION_DENY<sup>7+</sup> | -3 | 拒绝许可。 |
## DataAbilityOperationType
指示数据的操作类型。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 值 | 说明 |
| ------------------------ | ---- | ---------------------------------------- |
| TYPE_INSERT<sup>7+</sup> | 1 | 插入类型。 |
| TYPE_UPDATE<sup>7+</sup> | 2 | 修改类型。 |
| TYPE_DELETE<sup>7+</sup> | 3 | 删除类型。 |
| TYPE_ASSERT<sup>7+</sup> | 4 | 声明类型。 |
## AbilityResult
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 类型 | 可读| 可写 | 必填 | 说明 |
| --------------- |-------- | ------ | ------------- | ---- | ------------------------------------- |
| resultCode<sup>7+</sup>| number| 是 | 否 | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误（暂不支持）。 |
| want<sup>7+</sup> | [Want](js-apis-application-Want.md)| 是 | 否 | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 |
## StartAbilityParameter
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 类型 | 可读| 可写 | 必填 | 说明 |
| ------------------- | -------- | -------------------- | ---- | -------------------------------------- |
| want | [Want](js-apis-application-Want.md)| 是 | 否 | 是 | 表示需要包含有关目标启动能力的信息。 |
| abilityStartSetting | {[key: string]: any} | 是 |否 | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。 |
## flags说明
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 值 | 说明 |
| ------------------------------------ | ---------- | ---------------------------------------- |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权。 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权。 |
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给元能力。 |
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备。 |
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS。 |
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力。 |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动。 |
| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。 |
| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能。 |
| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。 |
| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给 **[ohos.app.Context](js-apis-ability-context.md)** 中**startAbility**方法的**Want**设置此标志，并且必须与**flag_ABILITY_NEW_MISSION**一起使用。 |
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 |
| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 |
zh-cn/application-dev/reference/apis/js-apis-particleAbility.md → zh-cn/application-dev/reference/apis/js-apis-ability-particleAbility.md
浏览文件 @ 0612bb09
# particleAbility模块 # particleAbility模块
particleAbility模块提供了Service类型Ability的能力，包括启动、停止指定的particleAbility，获取dataAbilityHelper，连接、断开当前Ability与指定ServiceAbility等。 particleAbility模块提供了Service类型Ability的能力，包括启动、停止指定的particleAbility，获取dataAbilityHelper，连接、断开当前Ability与指定ServiceAbility等。
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在FA模型下使用。 > 本模块接口仅可在FA模型下使用。
## 使用限制 ## 使用限制
particleAbility模块用来对Data和Service类型的Ability进行操作。 particleAbility模块用来对Data和Service类型的Ability进行操作。
## 导入模块 ## 导入模块
```js ```ts
import particleAbility from '@ohos.ability.particleAbility' import particleAbility from '@ohos.ability.particleAbility'
``` ```
## particleAbility.startAbility ## particleAbility.startAbility
startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<void>): void startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<void>): void
使用此方法启动指定的particleAbility（callback形式）。 使用此方法启动指定的particleAbility（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ----------------------------------------------- | ---- | ----------------- | | --------- | ----------------------------------------------- | ---- | ----------------- |
| parameter | [StartAbilityParameter](js-apis-featureAbility.md#startabilityparameter) | 是 | 指示启动的ability | | parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 指示启动的ability |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法 | | callback | AsyncCallback\<void> | 是 | 被指定的回调方法 |
**示例：** **示例：**
```js ```ts
import particleAbility from '@ohos.ability.particleAbility' import particleAbility from '@ohos.ability.particleAbility'
import wantConstant from '@ohos.ability.wantConstant' import wantConstant from '@ohos.ability.wantConstant'
particleAbility.startAbility( particleAbility.startAbility(
{ {
want: want:
{ {
action: "action.system.home", action: "action.system.home",
entities: ["entity.system.home"], entities: ["entity.system.home"],
type: "MIMETYPE", type: "MIMETYPE",
flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: "",
bundleName: "com.example.Data", bundleName: "com.example.Data",
abilityName: "com.example.Data.MainAbility", abilityName: "com.example.Data.MainAbility",
uri: "" uri: ""
}, },
}, },
(error, result) => { (error, result) => {
console.log('particleAbility startAbility errCode:' + error + 'result:' + result) console.log('particleAbility startAbility errCode:' + error + 'result:' + result)
}, },
) )
``` ```
## particleAbility.startAbility ## particleAbility.startAbility
startAbility(parameter: StartAbilityParameter): Promise\<void>; startAbility(parameter: StartAbilityParameter): Promise\<void>;
使用此方法启动指定的particleAbility（Promise形式）。 使用此方法启动指定的particleAbility（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ----------------------------------------------- | ---- | ----------------- | | --------- | ----------------------------------------------- | ---- | ----------------- |
| parameter | [StartAbilityParameter](js-apis-featureAbility.md#startabilityparameter) | 是 | 指示启动的ability | | parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 指示启动的ability |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ------------------------- | | -------------- | ------------------------- |
| Promise\<void> | 使用Promise形式返回结果。 | | Promise\<void> | 使用Promise形式返回结果。 |
**示例：** **示例：**
```js ```ts
import particleAbility from '@ohos.ability.particleAbility' import particleAbility from '@ohos.ability.particleAbility'
import wantConstant from '@ohos.ability.wantConstant' import wantConstant from '@ohos.ability.wantConstant'
particleAbility.startAbility( particleAbility.startAbility(
{ {
want: want:
{ {
action: "action.system.home", action: "action.system.home",
entities: ["entity.system.home"], entities: ["entity.system.home"],
type: "MIMETYPE", type: "MIMETYPE",
flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION, flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: "",
bundleName: "com.example.Data", bundleName: "com.example.Data",
abilityName: "com.example. Data.MainAbility", abilityName: "com.example. Data.MainAbility",
uri: "" uri: ""
}, },
}, },
).then((data) => { ).then((data) => {
console.info("particleAbility startAbility"); console.info("particleAbility startAbility");
}); });
``` ```
## particleAbility.terminateSelf ## particleAbility.terminateSelf
terminateSelf(callback: AsyncCallback\<void>): void terminateSelf(callback: AsyncCallback\<void>): void
终止particleAbility（callback形式）。 终止particleAbility（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | -------------------- | | -------- | -------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法 | | callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
**示例：** **示例：**
```js ```ts
import particleAbility from '@ohos.ability.particleAbility' import particleAbility from '@ohos.ability.particleAbility'
particleAbility.terminateSelf( particleAbility.terminateSelf(
(error, result) => { (error, result) => {
console.log('particleAbility terminateSelf errCode:' + error + 'result:' + result) console.log('particleAbility terminateSelf errCode:' + error + 'result:' + result)
} }
) )
``` ```
## particleAbility.terminateSelf ## particleAbility.terminateSelf
terminateSelf(): Promise\<void> terminateSelf(): Promise\<void>
终止particleAbility（Promise形式）。 终止particleAbility（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ------------------------- | | -------------- | ------------------------- |
| Promise\<void> | 使用Promise形式返回结果。 | | Promise\<void> | 使用Promise形式返回结果。 |
**示例：** **示例：**
```js ```ts
import particleAbility from '@ohos.ability.particleAbility' import particleAbility from '@ohos.ability.particleAbility'
particleAbility.terminateSelf().then((data) => { particleAbility.terminateSelf().then((data) => {
console.info("particleAbility terminateSelf"); console.info("particleAbility terminateSelf");
}); });
``` ```
## particleAbility.acquireDataAbilityHelper ## particleAbility.acquireDataAbilityHelper
acquireDataAbilityHelper(uri: string): DataAbilityHelper acquireDataAbilityHelper(uri: string): DataAbilityHelper
获取dataAbilityHelper。 获取dataAbilityHelper。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| :--- | ------ | ---- | ------------------------ | | :--- | ------ | ---- | ------------------------ |
| uri | string | 是 | 指示要打开的文件的路径。 | | uri | string | 是 | 指示要打开的文件的路径。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------- | -------------------------------------------- | | ----------------- | -------------------------------------------- |
| DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类。 | | DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类。 |
**示例：** **示例：**
```js ```ts
import particleAbility from '@ohos.ability.particleAbility' import particleAbility from '@ohos.ability.particleAbility'
var uri = ""; var uri = "";
particleAbility.acquireDataAbilityHelper(uri) particleAbility.acquireDataAbilityHelper(uri)
``` ```
## particleAbility.startBackgroundRunning ## particleAbility.startBackgroundRunning
startBackgroundRunning(id: number, request: NotificationRequest, callback: AsyncCallback&lt;void&gt;): void; startBackgroundRunning(id: number, request: NotificationRequest, callback: AsyncCallback&lt;void&gt;): void;
向系统申请长时任务，使用callback形式返回结果，建议使用新接口[backgroundTaskManager.startBackgroundRunning](js-apis-backgroundTaskManager.md#backgroundtaskmanagerstartbackgroundrunning8)。 向系统申请长时任务，使用callback形式返回结果，建议使用新接口[backgroundTaskManager.startBackgroundRunning](js-apis-backgroundTaskManager.md#backgroundtaskmanagerstartbackgroundrunning8)。
**需要权限:** ohos.permission.KEEP_BACKGROUND_RUNNING **需要权限:** ohos.permission.KEEP_BACKGROUND_RUNNING
**系统能力**：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **系统能力**：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| id | number | 是 | 长时任务通知id号 | | id | number | 是 | 长时任务通知id号 |
| request | [NotificationRequest](js-apis-notification.md#notificationrequest) | 是 | 通知参数，用于显示通知栏的信息 | | request | [NotificationRequest](js-apis-notification.md#notificationrequest) | 是 | 通知参数，用于显示通知栏的信息 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动长时任务的结果 | | callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动长时任务的结果 |
**示例**： **示例**：
```js ```ts
import notification from '@ohos.notification'; import notification from '@ohos.notification';
import particleAbility from '@ohos.ability.particleAbility'; import particleAbility from '@ohos.ability.particleAbility';
import wantAgent from '@ohos.wantAgent'; import wantAgent from '@ohos.wantAgent';
function callback(err, data) { function callback(err, data) {
if (err) { if (err) {
console.error("Operation failed cause: " + JSON.stringify(err)); console.error("Operation failed cause: " + JSON.stringify(err));
} else { } else {
console.info("Operation succeeded"); console.info("Operation succeeded");
} }
} }
let wantAgentInfo = { let wantAgentInfo = {
wants: [ wants: [
{ {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
abilityName: "com.example.myapplication.MainAbility" abilityName: "com.example.myapplication.MainAbility"
} }
], ],
operationType: wantAgent.OperationType.START_ABILITY, operationType: wantAgent.OperationType.START_ABILITY,
requestCode: 0, requestCode: 0,
wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
}; };
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
let basicContent = { let basicContent = {
title: "title", title: "title",
text: "text" text: "text"
}; };
let notificationContent = { let notificationContent = {
contentType: notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, contentType: notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: basicContent normal: basicContent
}; };
let request = { let request = {
content: notificationContent, content: notificationContent,
wantAgent: wantAgentObj wantAgent: wantAgentObj
}; };
let id = 1; let id = 1;
particleAbility.startBackgroundRunning(id, request, callback); particleAbility.startBackgroundRunning(id, request, callback);
}); });
``` ```
## particleAbility.startBackgroundRunning ## particleAbility.startBackgroundRunning
startBackgroundRunning(id: number, request: NotificationRequest): Promise&lt;void&gt; startBackgroundRunning(id: number, request: NotificationRequest): Promise&lt;void&gt;
**需要权限:** ohos.permission.KEEP_BACKGROUND_RUNNING **需要权限:** ohos.permission.KEEP_BACKGROUND_RUNNING
**系统能力**：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **系统能力**：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
向系统申请长时任务，使用promise形式返回结果，建议使用新接口[backgroundTaskManager.startBackgroundRunning](js-apis-backgroundTaskManager.md#backgroundtaskmanagerstartbackgroundrunning8-1)。 向系统申请长时任务，使用promise形式返回结果，建议使用新接口[backgroundTaskManager.startBackgroundRunning](js-apis-backgroundTaskManager.md#backgroundtaskmanagerstartbackgroundrunning8-1)。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| id | number | 是 | 长时任务通知id号 | | id | number | 是 | 长时任务通知id号 |
| request | [NotificationRequest](js-apis-notification.md#notificationrequest) | 是 | 通知参数，用于显示通知栏的信息 | | request | [NotificationRequest](js-apis-notification.md#notificationrequest) | 是 | 通知参数，用于显示通知栏的信息 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ------------------------- | | -------------- | ------------------------- |
| Promise\<void> | 使用Promise形式返回结果。 | | Promise\<void> | 使用Promise形式返回结果。 |
**示例**： **示例**：
```js ```ts
import notification from '@ohos.notification'; import notification from '@ohos.notification';
import particleAbility from '@ohos.ability.particleAbility'; import particleAbility from '@ohos.ability.particleAbility';
import wantAgent from '@ohos.wantAgent'; import wantAgent from '@ohos.wantAgent';
let wantAgentInfo = { let wantAgentInfo = {
wants: [ wants: [
{ {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
abilityName: "com.example.myapplication.MainAbility" abilityName: "com.example.myapplication.MainAbility"
} }
], ],
operationType: wantAgent.OperationType.START_ABILITY, operationType: wantAgent.OperationType.START_ABILITY,
requestCode: 0, requestCode: 0,
wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
}; };
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
let basicContent = { let basicContent = {
title: "title", title: "title",
text: "text" text: "text"
}; };
let notificationContent = { let notificationContent = {
contentType: notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, contentType: notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: basicContent normal: basicContent
}; };
let request = { let request = {
content: notificationContent, content: notificationContent,
wantAgent: wantAgentObj wantAgent: wantAgentObj
}; };
let id = 1; let id = 1;
particleAbility.startBackgroundRunning(id, request).then(() => { particleAbility.startBackgroundRunning(id, request).then(() => {
console.info("Operation succeeded"); console.info("Operation succeeded");
}).catch((err) => { }).catch((err) => {
console.error("Operation failed cause: " + JSON.stringify(err)); console.error("Operation failed cause: " + JSON.stringify(err));
}); });
}); });
``` ```
## particleAbility.cancelBackgroundRunning ## particleAbility.cancelBackgroundRunning
cancelBackgroundRunning(callback: AsyncCallback&lt;void&gt;): void; cancelBackgroundRunning(callback: AsyncCallback&lt;void&gt;): void;
向系统申请取消长时任务，使用callback形式返回结果，建议使用新接口[backgroundTaskManager.stopBackgroundRunning](js-apis-backgroundTaskManager.md#backgroundtaskmanagerstopbackgroundrunning8)。 向系统申请取消长时任务，使用callback形式返回结果，建议使用新接口[backgroundTaskManager.stopBackgroundRunning](js-apis-backgroundTaskManager.md#backgroundtaskmanagerstopbackgroundrunning8)。
**系统能力**：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **系统能力**：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动长时任务的结果 | | callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动长时任务的结果 |
**示例**： **示例**：
```js ```ts
import particleAbility from '@ohos.ability.particleAbility'; import particleAbility from '@ohos.ability.particleAbility';
function callback(err, data) { function callback(err, data) {
if (err) { if (err) {
console.error("Operation failed cause: " + JSON.stringify(err)); console.error("Operation failed cause: " + JSON.stringify(err));
} else { } else {
console.info("Operation succeeded"); console.info("Operation succeeded");
} }
} }
particleAbility.cancelBackgroundRunning(callback); particleAbility.cancelBackgroundRunning(callback);
``` ```
## particleAbility.cancelBackgroundRunning ## particleAbility.cancelBackgroundRunning
cancelBackgroundRunning(): Promise&lt;void&gt;; cancelBackgroundRunning(): Promise&lt;void&gt;;
向系统申请取消长时任务，使用promise形式返回结果，建议使用新接口[backgroundTaskManager.stopBackgroundRunning](js-apis-backgroundTaskManager.md#backgroundtaskmanagerstopbackgroundrunning8-1)。 向系统申请取消长时任务，使用promise形式返回结果，建议使用新接口[backgroundTaskManager.stopBackgroundRunning](js-apis-backgroundTaskManager.md#backgroundtaskmanagerstopbackgroundrunning8-1)。
**系统能力**：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **系统能力**：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ------------------------- | | -------------- | ------------------------- |
| Promise\<void> | 使用Promise形式返回结果。 | | Promise\<void> | 使用Promise形式返回结果。 |
**示例**： **示例**：
```js ```ts
import particleAbility from '@ohos.ability.particleAbility'; import particleAbility from '@ohos.ability.particleAbility';
particleAbility.cancelBackgroundRunning().then(() => { particleAbility.cancelBackgroundRunning().then(() => {
console.info("Operation succeeded"); console.info("Operation succeeded");
}).catch((err) => { }).catch((err) => {
console.error("Operation failed cause: " + JSON.stringify(err)); console.error("Operation failed cause: " + JSON.stringify(err));
}); });
``` ```
## particleAbility.connectAbility ## particleAbility.connectAbility
connectAbility(request: Want, options:ConnectOptions): number connectAbility(request: Want, options:ConnectOptions): number
将当前ability连接到指定ServiceAbility（callback形式）。 将当前ability连接到指定ServiceAbility（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | -------------- | ---- | ---------------------------- | | ------- | -------------- | ---- | ---------------------------- |
| request | [Want](js-apis-application-Want.md) | 是 | 表示被连接的ServiceAbility。 | | request | [Want](js-apis-application-want.md) | 是 | 表示被连接的ServiceAbility。 |
| options | ConnectOptions | 是 | 被指定的回调方法。 | | options | ConnectOptions | 是 | 被指定的回调方法。 |
**ConnectOptions类型说明：** **ConnectOptions类型说明：**
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 参数名 | 读写属性 | 类型 | 必填 | 说明 | | 参数名 | 读写属性 | 类型 | 必填 | 说明 |
| ------------ | ---- | -------- | ---- | ------------------------- | | ------------ | ---- | -------- | ---- | ------------------------- |
| onConnect | 只读 | function | 是 | 连接成功时的回调函数。 | | onConnect | 只读 | function | 是 | 连接成功时的回调函数。 |
| onDisconnect | 只读 | function | 是 | 连接失败时的回调函数。 | | onDisconnect | 只读 | function | 是 | 连接失败时的回调函数。 |
| onFailed | 只读 | function | 是 | ConnectAbility调用失败时的回调函数。 | | onFailed | 只读 | function | 是 | ConnectAbility调用失败时的回调函数。 |
**示例**： **示例**：
```js ```ts
import rpc from '@ohos.rpc' import rpc from '@ohos.rpc'
function onConnectCallback(element, remote) { function onConnectCallback(element, remote) {
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
} }
function onDisconnectCallback(element) { function onDisconnectCallback(element) {
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
} }
function onFailedCallback(code) { function onFailedCallback(code) {
console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code) console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code)
} }
var connId = particleAbility.connectAbility( var connId = particleAbility.connectAbility(
{ {
bundleName: "com.ix.ServiceAbility", bundleName: "com.ix.ServiceAbility",
abilityName: "ServiceAbilityA", abilityName: "ServiceAbilityA",
}, },
{ {
onConnect: onConnectCallback, onConnect: onConnectCallback,
onDisconnect: onDisconnectCallback, onDisconnect: onDisconnectCallback,
onFailed: onFailedCallback, onFailed: onFailedCallback,
}, },
); );
particleAbility.disconnectAbility(connId).then((data) => { particleAbility.disconnectAbility(connId).then((data) => {
console.log(" data: " + data); console.log(" data: " + data);
}).catch((error) => { }).catch((error) => {
console.log('particleAbilityTest result errCode : ' + error.code) console.log('particleAbilityTest result errCode : ' + error.code)
}); });
``` ```
## particleAbility.disconnectAbility ## particleAbility.disconnectAbility
disconnectAbility(connection: number, callback:AsyncCallback\<void>): void; disconnectAbility(connection: number, callback:AsyncCallback\<void>): void;
将功能与服务功能断开连接。 将功能与服务功能断开连接。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回断开连接的结果 | | callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回断开连接的结果 |
**示例**： **示例**：
```js ```ts
import rpc from '@ohos.rpc' import rpc from '@ohos.rpc'
function onConnectCallback(element, remote) { function onConnectCallback(element, remote) {
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
} }
function onDisconnectCallback(element) { function onDisconnectCallback(element) {
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
} }
function onFailedCallback(code) { function onFailedCallback(code) {
console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code) console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code)
} }
var connId = particleAbility.connectAbility( var connId = particleAbility.connectAbility(
{ {
bundleName: "com.ix.ServiceAbility", bundleName: "com.ix.ServiceAbility",
abilityName: "ServiceAbilityA", abilityName: "ServiceAbilityA",
}, },
{ {
onConnect: onConnectCallback, onConnect: onConnectCallback,
onDisconnect: onDisconnectCallback, onDisconnect: onDisconnectCallback,
onFailed: onFailedCallback, onFailed: onFailedCallback,
}, },
); );
var result = particleAbility.disconnectAbility(connId).then((data) => { var result = particleAbility.disconnectAbility(connId).then((data) => {
console.log(" data: " + data); console.log(" data: " + data);
}).catch((error) => { }).catch((error) => {
console.log('particleAbilityTest result errCode : ' + error.code) console.log('particleAbilityTest result errCode : ' + error.code)
}); });
``` ```
## particleAbility.disconnectAbility ## particleAbility.disconnectAbility
disconnectAbility(connection: number): Promise\<void>; disconnectAbility(connection: number): Promise\<void>;
将功能与服务功能断开连接。 将功能与服务功能断开连接。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ------------------------- | | -------------- | ------------------------- |
| Promise\<void> | 使用Promise形式返回结果。 | | Promise\<void> | 使用Promise形式返回结果。 |
**示例**： **示例**：
```js ```ts
import rpc from '@ohos.rpc' import rpc from '@ohos.rpc'
function onConnectCallback(element, remote) { function onConnectCallback(element, remote) {
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
} }
function onDisconnectCallback(element) { function onDisconnectCallback(element) {
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
} }
function onFailedCallback(code) { function onFailedCallback(code) {
console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code) console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code)
} }
var connId = particleAbility.connectAbility( var connId = particleAbility.connectAbility(
{ {
bundleName: "com.ix.ServiceAbility", bundleName: "com.ix.ServiceAbility",
abilityName: "ServiceAbilityA", abilityName: "ServiceAbilityA",
}, },
{ {
onConnect: onConnectCallback, onConnect: onConnectCallback,
onDisconnect: onDisconnectCallback, onDisconnect: onDisconnectCallback,
onFailed: onFailedCallback, onFailed: onFailedCallback,
}, },
); );
particleAbility.disconnectAbility(connId).then((data) => { particleAbility.disconnectAbility(connId).then((data) => {
console.log(" data: " + data); console.log(" data: " + data);
}).catch((error) => { }).catch((error) => {
console.log('particleAbilityTest result errCode : ' + error.code) console.log('particleAbilityTest result errCode : ' + error.code)
}); });
``` ```
## ErrorCode ## ErrorCode
获取错误代码。 获取错误代码。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ | | ----------------------------- | ---- | ------------------------------------------------------------ |
| INVALID_PARAMETER | -1 | 无效的参数。 | | INVALID_PARAMETER | -1 | 无效的参数。 |
zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md
浏览文件 @ 0612bb09
...@@ -8,7 +8,7 @@ wantConstant模块提供want中操作want常数和解释Flags说明的能力。 ...@@ -8,7 +8,7 @@ wantConstant模块提供want中操作want常数和解释Flags说明的能力。
## 导入模块 ## 导入模块
```js ```ts
import wantConstant from '@ohos.ability.wantConstant'; 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提供启动参数的接口的能力，包括设置初次开始 ...@@ -11,7 +11,7 @@ AbilityConstant提供启动参数的接口的能力，包括设置初次开始
## 导入模块 ## 导入模块
```js ```ts
import AbilityConstant from '@ohos.app.ability.AbilityConstant'; 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的生命周期状态更改 ...@@ -9,7 +9,7 @@ AbilityDelegator提供添加用于监视指定ability的生命周期状态更改
## 使用说明 ## 使用说明
通过AbilityDelegatorRegistry中getAbilityDelegator方法获取。 通过AbilityDelegatorRegistry中getAbilityDelegator方法获取。
```js ```ts
import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry' import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry'
var abilityDelegator; var abilityDelegator;
...@@ -37,7 +37,7 @@ addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): void ...@@ -37,7 +37,7 @@ addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): void
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
...@@ -79,7 +79,7 @@ addAbilityMonitor(monitor: AbilityMonitor): Promise\<void> ...@@ -79,7 +79,7 @@ addAbilityMonitor(monitor: AbilityMonitor): Promise\<void>
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
...@@ -116,7 +116,7 @@ removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): v ...@@ -116,7 +116,7 @@ removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): v
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
...@@ -158,7 +158,7 @@ removeAbilityMonitor(monitor: AbilityMonitor): Promise\<void> ...@@ -158,7 +158,7 @@ removeAbilityMonitor(monitor: AbilityMonitor): Promise\<void>
- 示例 - 示例
```js ```ts
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
...@@ -195,7 +195,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<Ability>): ...@@ -195,7 +195,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<Ability>):
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
...@@ -233,7 +233,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCall ...@@ -233,7 +233,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCall
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var timeout = 100; var timeout = 100;
...@@ -277,7 +277,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise\<Ability> ...@@ -277,7 +277,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise\<Ability>
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
...@@ -309,11 +309,11 @@ getAppContext(): Context ...@@ -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; var abilityDelegator;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
...@@ -340,11 +340,11 @@ getAbilityState(ability: Ability): number ...@@ -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 abilityDelegator;
var ability; var ability;
...@@ -375,7 +375,7 @@ getCurrentTopAbility(callback: AsyncCallback\<Ability>): void ...@@ -375,7 +375,7 @@ getCurrentTopAbility(callback: AsyncCallback\<Ability>): void
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var ability; var ability;
...@@ -404,7 +404,7 @@ getCurrentTopAbility(): Promise\<Ability> ...@@ -404,7 +404,7 @@ getCurrentTopAbility(): Promise\<Ability>
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var ability; var ability;
...@@ -429,12 +429,12 @@ startAbility(want: Want, callback: AsyncCallback\<void>): void ...@@ -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> | 是 | 表示指定的回调方法 | | callback | AsyncCallback\<void> | 是 | 表示指定的回调方法 |
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var want = { var want = {
bundleName: "bundleName", bundleName: "bundleName",
...@@ -461,7 +461,7 @@ startAbility(want: Want): Promise\<void> ...@@ -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> ...@@ -471,7 +471,7 @@ startAbility(want: Want): Promise\<void>
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var want = { var want = {
bundleName: "bundleName", bundleName: "bundleName",
...@@ -503,7 +503,7 @@ doAbilityForeground(ability: Ability, callback: AsyncCallback\<boolean>): void ...@@ -503,7 +503,7 @@ doAbilityForeground(ability: Ability, callback: AsyncCallback\<boolean>): void
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var ability; var ability;
...@@ -541,7 +541,7 @@ doAbilityForeground(ability: Ability): Promise\<boolean> ...@@ -541,7 +541,7 @@ doAbilityForeground(ability: Ability): Promise\<boolean>
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var ability; var ability;
...@@ -574,7 +574,7 @@ doAbilityBackground(ability: Ability, callback: AsyncCallback\<boolean>): void ...@@ -574,7 +574,7 @@ doAbilityBackground(ability: Ability, callback: AsyncCallback\<boolean>): void
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var ability; var ability;
...@@ -612,7 +612,7 @@ doAbilityBackground(ability: Ability): Promise\<boolean> ...@@ -612,7 +612,7 @@ doAbilityBackground(ability: Ability): Promise\<boolean>
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var ability; var ability;
...@@ -644,7 +644,7 @@ printSync(msg: string): void ...@@ -644,7 +644,7 @@ printSync(msg: string): void
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var msg = "msg"; var msg = "msg";
...@@ -671,7 +671,7 @@ print(msg: string, callback: AsyncCallback\<void>): void ...@@ -671,7 +671,7 @@ print(msg: string, callback: AsyncCallback\<void>): void
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var msg = "msg"; var msg = "msg";
...@@ -705,7 +705,7 @@ print(msg: string): Promise\<void> ...@@ -705,7 +705,7 @@ print(msg: string): Promise\<void>
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var msg = "msg"; var msg = "msg";
...@@ -730,11 +730,11 @@ executeShellCommand(cmd: string, callback: AsyncCallback\<ShellCmdResult>): void ...@@ -730,11 +730,11 @@ executeShellCommand(cmd: string, callback: AsyncCallback\<ShellCmdResult>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------ | | -------- | ------------------------------------------------------------ | ---- | ------------------ |
| cmd | string | 是 | shell命令字符串 | | 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 abilityDelegator;
var cmd = "cmd"; var cmd = "cmd";
...@@ -760,11 +760,11 @@ executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback\<S ...@@ -760,11 +760,11 @@ executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback\<S
| ----------- | ------------------------------------------------------------ | ---- | ----------------------------- | | ----------- | ------------------------------------------------------------ | ---- | ----------------------------- |
| cmd | string | 是 | shell命令字符串 | | cmd | string | 是 | shell命令字符串 |
| timeoutSecs | number | 是 | 设定命令超时时间，单位秒（s） | | 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 abilityDelegator;
var cmd = "cmd"; var cmd = "cmd";
var timeout = 100; var timeout = 100;
...@@ -796,11 +796,11 @@ executeShellCommand(cmd: string, timeoutSecs?: number): Promise\<ShellCmdResult> ...@@ -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 abilityDelegator;
var cmd = "cmd"; var cmd = "cmd";
var timeout = 100; var timeout = 100;
...@@ -831,7 +831,7 @@ finishTest(msg: string, code: number, callback: AsyncCallback\<void>): void ...@@ -831,7 +831,7 @@ finishTest(msg: string, code: number, callback: AsyncCallback\<void>): void
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var msg = "msg"; var msg = "msg";
...@@ -866,7 +866,7 @@ finishTest(msg: string, code: number): Promise\<void> ...@@ -866,7 +866,7 @@ finishTest(msg: string, code: number): Promise\<void>
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var msg = "msg"; var msg = "msg";
...@@ -893,7 +893,7 @@ addAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\<vo ...@@ -893,7 +893,7 @@ addAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\<vo
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var monitor = { var monitor = {
...@@ -931,7 +931,7 @@ addAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\<void>; ...@@ -931,7 +931,7 @@ addAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\<void>;
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var monitor = { var monitor = {
...@@ -962,7 +962,7 @@ removeAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\ ...@@ -962,7 +962,7 @@ removeAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var monitor = { var monitor = {
...@@ -1000,7 +1000,7 @@ removeAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\<void>; ...@@ -1000,7 +1000,7 @@ removeAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\<void>;
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var monitor = { var monitor = {
...@@ -1031,7 +1031,7 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\<A ...@@ -1031,7 +1031,7 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\<A
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
...@@ -1072,7 +1072,7 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout?: number): Promise ...@@ -1072,7 +1072,7 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout?: number): Promise
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
...@@ -1108,7 +1108,7 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout: number, callback: ...@@ -1108,7 +1108,7 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout: number, callback:
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var timeout = 100; 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的生命 ...@@ -10,7 +10,7 @@ AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命
## 导入模块 ## 导入模块
```js ```ts
import AbilityLifecycleCallback from "@ohos.app.ability.AbilityLifecycleCallback"; import AbilityLifecycleCallback from "@ohos.app.ability.AbilityLifecycleCallback";
``` ```
...@@ -156,7 +156,7 @@ onAbilityContinue(ability: Ability): void; ...@@ -156,7 +156,7 @@ onAbilityContinue(ability: Ability): void;
**示例：** **示例：**
```js ```ts
import Ability from "@ohos.application.Ability"; import Ability from "@ohos.application.Ability";
export default class MyAbility extends 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相关信息和状态信息进行获取、 ...@@ -9,7 +9,7 @@ AbilityManager模块提供对Ability相关信息和状态信息进行获取、
## 导入模块 ## 导入模块
```js ```ts
import AbilityManager from '@ohos.app.ability.abilityManager' import AbilityManager from '@ohos.app.ability.abilityManager'
``` ```
...@@ -48,7 +48,7 @@ updateConfiguration(config: Configuration, callback: AsyncCallback\<void>): void ...@@ -48,7 +48,7 @@ updateConfiguration(config: Configuration, callback: AsyncCallback\<void>): void
**示例**： **示例**：
```js ```ts
import abilitymanager from '@ohos.app.ability.abilityManager'; import abilitymanager from '@ohos.app.ability.abilityManager';
var config = { var config = {
...@@ -89,7 +89,7 @@ updateConfiguration(config: Configuration): Promise\<void> ...@@ -89,7 +89,7 @@ updateConfiguration(config: Configuration): Promise\<void>
**示例**： **示例**：
```js ```ts
import abilitymanager from '@ohos.app.ability.abilityManager'; import abilitymanager from '@ohos.app.ability.abilityManager';
var config = { var config = {
...@@ -126,7 +126,7 @@ getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): vo ...@@ -126,7 +126,7 @@ getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): vo
**示例**： **示例**：
```js ```ts
import abilitymanager from '@ohos.app.ability.abilityManager'; import abilitymanager from '@ohos.app.ability.abilityManager';
try { try {
...@@ -157,7 +157,7 @@ getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>> ...@@ -157,7 +157,7 @@ getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>>
**示例**： **示例**：
```js ```ts
import abilitymanager from '@ohos.app.ability.abilityManager'; import abilitymanager from '@ohos.app.ability.abilityManager';
try { try {
...@@ -191,7 +191,7 @@ getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<Ext ...@@ -191,7 +191,7 @@ getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<Ext
**示例**： **示例**：
```js ```ts
import abilitymanager from '@ohos.app.ability.abilityManager'; import abilitymanager from '@ohos.app.ability.abilityManager';
var upperLimit = 0; var upperLimit = 0;
...@@ -230,7 +230,7 @@ getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningIn ...@@ -230,7 +230,7 @@ getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningIn
**示例**： **示例**：
```js ```ts
import abilitymanager from '@ohos.app.ability.abilityManager'; import abilitymanager from '@ohos.app.ability.abilityManager';
var upperLimit = 0; var upperLimit = 0;
...@@ -263,7 +263,7 @@ getTopAbility(callback: AsyncCallback\<ElementName>): void; ...@@ -263,7 +263,7 @@ getTopAbility(callback: AsyncCallback\<ElementName>): void;
**示例**： **示例**：
```js ```ts
import abilitymanager from '@ohos.app.ability.abilityManager'; import abilitymanager from '@ohos.app.ability.abilityManager';
try { try {
...@@ -292,7 +292,7 @@ getTopAbility(): Promise\<ElementName>; ...@@ -292,7 +292,7 @@ getTopAbility(): Promise\<ElementName>;
**示例**： **示例**：
```js ```ts
import abilitymanager from '@ohos.app.ability.abilityManager'; import abilitymanager from '@ohos.app.ability.abilityManager';
try { try {
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityMonitor.md
浏览文件 @ 0612bb09
...@@ -10,7 +10,7 @@ AbilityMonitor模块提供匹配满足指定条件的受监视能力对象的方 ...@@ -10,7 +10,7 @@ AbilityMonitor模块提供匹配满足指定条件的受监视能力对象的方
通过abilityDelegator中的addAbilityMonitor来设置。 通过abilityDelegator中的addAbilityMonitor来设置。
```js ```ts
import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry' import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry'
var abilityDelegator; 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 @@ ...@@ -2,16 +2,16 @@
AbilityStage是HAP包的运行时类。 AbilityStage是HAP包的运行时类。
AbilityStage模块提供在HAP加载的时候，通知开发者，可以在此进行该HAP的初始化（如资源预加载，线程创建等）能力。 AbilityStage类提供在HAP加载的时候，通知开发者，可以在此进行该HAP的初始化（如资源预加载，线程创建等）能力。
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。 > 本模块接口仅可在Stage模型下使用。
## 导入模块 ## 导入类
```js ```ts
import AbilityStage from '@ohos.app.ability.AbilityStage'; import AbilityStage from '@ohos.app.ability.AbilityStage';
``` ```
...@@ -25,7 +25,7 @@ onCreate(): void ...@@ -25,7 +25,7 @@ onCreate(): void
**示例：** **示例：**
```js ```ts
class MyAbilityStage extends AbilityStage { class MyAbilityStage extends AbilityStage {
onCreate() { onCreate() {
console.log("MyAbilityStage.onCreate is called") console.log("MyAbilityStage.onCreate is called")
...@@ -46,7 +46,7 @@ onAcceptWant(want: Want): string; ...@@ -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; ...@@ -56,7 +56,7 @@ onAcceptWant(want: Want): string;
**示例：** **示例：**
```js ```ts
class MyAbilityStage extends AbilityStage { class MyAbilityStage extends AbilityStage {
onAcceptWant(want) { onAcceptWant(want) {
console.log("MyAbilityStage.onAcceptWant called"); console.log("MyAbilityStage.onAcceptWant called");
...@@ -78,11 +78,11 @@ onConfigurationUpdated(config: Configuration): void; ...@@ -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 { class MyAbilityStage extends AbilityStage {
onConfigurationUpdated(config) { onConfigurationUpdated(config) {
console.log('onConfigurationUpdated, language:' + config.language); console.log('onConfigurationUpdated, language:' + config.language);
...@@ -102,11 +102,11 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void; ...@@ -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 { class MyAbilityStage extends AbilityStage {
onMemoryLevel(level) { onMemoryLevel(level) {
console.log('onMemoryLevel, level:' + JSON.stringify(level)); console.log('onMemoryLevel, level:' + JSON.stringify(level));
...@@ -124,4 +124,4 @@ context: AbilityStageContext; ...@@ -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-appmanager.md → zh-cn/application-dev/reference/apis/js-apis-app-ability-appManager.md
浏览文件 @ 0612bb09
...@@ -8,11 +8,11 @@ appManager模块提供App管理的能力，包括查询当前是否处于稳定 ...@@ -8,11 +8,11 @@ appManager模块提供App管理的能力，包括查询当前是否处于稳定
## 导入模块 ## 导入模块
```js ```ts
import app from '@ohos.app.ability.appManager'; import app from '@ohos.app.ability.appManager';
``` ```
## appManager.isRunningInStabilityTest ## appManager.isRunningInStabilityTest<sup>9+</sup>
static isRunningInStabilityTest(callback: AsyncCallback&lt;boolean&gt;): void static isRunningInStabilityTest(callback: AsyncCallback&lt;boolean&gt;): void
...@@ -28,15 +28,15 @@ static isRunningInStabilityTest(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -28,15 +28,15 @@ static isRunningInStabilityTest(callback: AsyncCallback&lt;boolean&gt;): void
**示例：** **示例：**
```js ```ts
import app from '@ohos.app.ability.appManager'; import app from '@ohos.application.appManager';
app.isRunningInStabilityTest((err, flag) => { app.isRunningInStabilityTest((err, flag) => {
console.log('startAbility result:' + JSON.stringify(err)); console.log('startAbility result:' + JSON.stringify(err));
}) })
``` ```
## appManager.isRunningInStabilityTest ## appManager.isRunningInStabilityTest<sup>9+</sup>
static isRunningInStabilityTest(): Promise&lt;boolean&gt; static isRunningInStabilityTest(): Promise&lt;boolean&gt;
...@@ -52,12 +52,12 @@ static isRunningInStabilityTest(): Promise&lt;boolean&gt; ...@@ -52,12 +52,12 @@ static isRunningInStabilityTest(): Promise&lt;boolean&gt;
**示例：** **示例：**
```js ```ts
import app from '@ohos.app.ability.appManager'; import app from '@ohos.application.appManager';
app.isRunningInStabilityTest().then((flag) => { app.isRunningInStabilityTest().then((flag) => {
console.log('success:' + JSON.stringify(flag)); console.log('success:' + JSON.stringify(flag));
}).catch((error) => { }).catch((error) => {
console.log('failed:' + JSON.stringify(err)); console.log('failed:' + JSON.stringify(error));
}); });
``` ```
...@@ -78,12 +78,12 @@ isRamConstrainedDevice(): Promise\<boolean>; ...@@ -78,12 +78,12 @@ isRamConstrainedDevice(): Promise\<boolean>;
**示例：** **示例：**
```js ```ts
app.isRamConstrainedDevice().then((data) => { app.isRamConstrainedDevice().then((data) => {
console.log('success:' + JSON.stringify(data)); console.log('success:' + JSON.stringify(data));
}).catch((error) => { }).catch((error) => {
console.log('failed:' + JSON.stringify(err)); console.log('failed:' + JSON.stringify(error));
}); });
``` ```
## appManager.isRamConstrainedDevice ## appManager.isRamConstrainedDevice
...@@ -102,11 +102,11 @@ isRamConstrainedDevice(callback: AsyncCallback\<boolean>): void; ...@@ -102,11 +102,11 @@ isRamConstrainedDevice(callback: AsyncCallback\<boolean>): void;
**示例：** **示例：**
```js ```ts
app.isRamConstrainedDevice((err, data) => { app.isRamConstrainedDevice((err, data) => {
console.log('startAbility result failed:' + JSON.stringify(err)); console.log('startAbility result failed:' + JSON.stringify(err));
console.log('startAbility result success:' + JSON.stringify(data)); console.log('startAbility result success:' + JSON.stringify(data));
}) })
``` ```
## appManager.getAppMemorySize ## appManager.getAppMemorySize
...@@ -125,12 +125,12 @@ getAppMemorySize(): Promise\<number>; ...@@ -125,12 +125,12 @@ getAppMemorySize(): Promise\<number>;
**示例：** **示例：**
```js ```ts
app.getAppMemorySize().then((data) => { app.getAppMemorySize().then((data) => {
console.log('success:' + JSON.stringify(data)); console.log('success:' + JSON.stringify(data));
}).catch((error) => { }).catch((error) => {
console.log('failed:' + error.code + ', ' + error.message); console.log('failed:' + JSON.stringify(error));
}); });
``` ```
## appManager.getAppMemorySize ## appManager.getAppMemorySize
...@@ -149,14 +149,68 @@ getAppMemorySize(callback: AsyncCallback\<number>): void; ...@@ -149,14 +149,68 @@ getAppMemorySize(callback: AsyncCallback\<number>): void;
**示例：** **示例：**
```js ```ts
app.getAppMemorySize((err, data) => { app.getAppMemorySize((err, data) => {
console.log('startAbility result failed :' + JSON.stringify(err)); console.log('startAbility result failed :' + JSON.stringify(err));
console.log('startAbility result success:' + JSON.stringify(data)); console.log('startAbility result success:' + JSON.stringify(data));
}) })
```
## appManager.getProcessRunningInfos<sup>(deprecated)</sup>
getProcessRunningInfos(): Promise\<Array\<ProcessRunningInfo>>;
获取有关运行进程的信息。
> 从 API Version 9 开始废弃，建议使用[appManager.getProcessRunningInformation<sup>9+</sup>](#appmanagergetprocessrunninginformation9)替代。
**需要权限**：ohos.permission.GET_RUNNING_INFO
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise\<Array\<ProcessRunningInfo>> | 获取有关运行进程的信息。 |
**示例：**
```ts
app.getProcessRunningInfos().then((data) => {
console.log('success:' + JSON.stringify(data));
}).catch((error) => {
console.log('failed:' + JSON.stringify(error));
});
```
## appManager.getProcessRunningInfos<sup>(deprecated)</sup>
getProcessRunningInfos(callback: AsyncCallback\<Array\<ProcessRunningInfo>>): void;
获取有关运行进程的信息。
> 从 API Version 9 开始废弃，建议使用[appManager.getProcessRunningInformation<sup>9+</sup>](#appmanagergetprocessrunninginformation9-1)替代。
**需要权限**：ohos.permission.GET_RUNNING_INFO
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback\<Array\<ProcessRunningInfo>> | 否 | 获取有关运行进程的信息。 |
**示例：**
```ts
app.getProcessRunningInfos((err, data) => {
console.log('startAbility result failed :' + JSON.stringify(err));
console.log('startAbility result success:' + JSON.stringify(data));
})
``` ```
## appManager.getProcessRunningInformation ## appManager.getProcessRunningInformation<sup>9+</sup>
getProcessRunningInformation(): Promise\<Array\<ProcessRunningInformation>>; getProcessRunningInformation(): Promise\<Array\<ProcessRunningInformation>>;
...@@ -170,19 +224,19 @@ getProcessRunningInformation(): Promise\<Array\<ProcessRunningInformation>>; ...@@ -170,19 +224,19 @@ getProcessRunningInformation(): Promise\<Array\<ProcessRunningInformation>>;
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise\<Array\<[ProcessRunningInformation](#processrunninginformation)>> | 获取有关运行进程的信息。 | | Promise\<Array\<[ProcessRunningInformation](js-apis-inner-application-processRunningInformation.md)>> | 获取有关运行进程的信息。 |
**示例：** **示例：**
```js ```ts
app.getProcessRunningInformation().then((data) => { app.getProcessRunningInformation().then((data) => {
console.log('success:' + JSON.stringify(data)); console.log('success:' + JSON.stringify(data));
}).catch((error) => { }).catch((error) => {
console.log('failed:' + JSON.stringify(error)); console.log('failed:' + JSON.stringify(error));
}); });
``` ```
## appManager.getProcessRunningInformation ## appManager.getProcessRunningInformation<sup>9+</sup>
getProcessRunningInformation(callback: AsyncCallback\<Array\<ProcessRunningInformation>>): void; getProcessRunningInformation(callback: AsyncCallback\<Array\<ProcessRunningInformation>>): void;
...@@ -196,20 +250,20 @@ getProcessRunningInformation(callback: AsyncCallback\<Array\<ProcessRunningInfor ...@@ -196,20 +250,20 @@ getProcessRunningInformation(callback: AsyncCallback\<Array\<ProcessRunningInfor
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback\<Array\<[ProcessRunningInformation](#processrunninginformation)>> | 否 | 获取有关运行进程的信息。 | | callback | AsyncCallback\<Array\<[ProcessRunningInformation](js-apis-inner-application-processRunningInformation.md)>> | 否 | 获取有关运行进程的信息。 |
**示例：** **示例：**
```js ```ts
app.getProcessRunningInformation((err, data) => { app.getProcessRunningInformation((err, data) => {
console.log('startAbility result failed :' + JSON.stringify(error)); console.log('startAbility result failed :' + JSON.stringify(err));
console.log('startAbility result success:' + JSON.stringify(data)); console.log('startAbility result success:' + JSON.stringify(data));
}) })
``` ```
## appManager.on ## appManager.registerApplicationStateObserver<sup>9+</sup>
on(type: "applicationState", observer: ApplicationStateObserver): number; registerApplicationStateObserver(observer: ApplicationStateObserver): number;
注册全部应用程序状态观测器。 注册全部应用程序状态观测器。
...@@ -223,12 +277,11 @@ on(type: "applicationState", observer: ApplicationStateObserver): number; ...@@ -223,12 +277,11 @@ on(type: "applicationState", observer: ApplicationStateObserver): number;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 调用接口类型 | | observer | [ApplicationStateObserver](js-apis-inner-application-applicationStateObserver.md) | 否 | 返回观察者的数字代码。 |
| observer | [ApplicationStateObserver](#applicationstateobserver) | 否 | 返回观察者的数字代码。 |
**示例：** **示例：**
```js ```ts
var applicationStateObserver = { var applicationStateObserver = {
onForegroundApplicationChanged(appStateData) { onForegroundApplicationChanged(appStateData) {
console.log('------------ onForegroundApplicationChanged -----------', appStateData); console.log('------------ onForegroundApplicationChanged -----------', appStateData);
...@@ -246,18 +299,13 @@ on(type: "applicationState", observer: ApplicationStateObserver): number; ...@@ -246,18 +299,13 @@ on(type: "applicationState", observer: ApplicationStateObserver): number;
console.log('------------ onProcessStateChanged -----------', processData); console.log('------------ onProcessStateChanged -----------', processData);
} }
} }
try { const observerCode = app.registerApplicationStateObserver(applicationStateObserver);
const observerCode = app.on(applicationStateObserver); console.log('-------- observerCode: ---------', observerCode);
console.log('-------- observerCode: ---------', observerCode);
} catch (paramError) {
console.log('error: ' + paramError.code + ', ' + paramError.message);
}
``` ```
## appManager.on ## appManager.registerApplicationStateObserver<sup>9+</sup>
on(type: "applicationState", observer: ApplicationStateObserver, bundleNameList: Array\<string>): number; registerApplicationStateObserver(observer: ApplicationStateObserver, bundleNameList: Array\<string>): number;
注册指定应用程序状态观测器。 注册指定应用程序状态观测器。
...@@ -271,13 +319,12 @@ on(type: "applicationState", observer: ApplicationStateObserver, bundleNameList: ...@@ -271,13 +319,12 @@ on(type: "applicationState", observer: ApplicationStateObserver, bundleNameList:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 调用接口类型 | | observer | [ApplicationStateObserver](js-apis-inner-application-applicationStateObserver.md) | 否 | 返回观察者的数字代码。 |
| observer | [ApplicationStateObserver](#applicationstateobserver) | 否 | 返回观察者的数字代码。 |
| bundleNameList | Array<string> | 否 | 表示需要注册监听的bundleName数组。最大值128。 | | bundleNameList | Array<string> | 否 | 表示需要注册监听的bundleName数组。最大值128。 |
**示例：** **示例：**
```js ```ts
var applicationStateObserver = { var applicationStateObserver = {
onForegroundApplicationChanged(appStateData) { onForegroundApplicationChanged(appStateData) {
console.log('------------ onForegroundApplicationChanged -----------', appStateData); console.log('------------ onForegroundApplicationChanged -----------', appStateData);
...@@ -296,17 +343,12 @@ on(type: "applicationState", observer: ApplicationStateObserver, bundleNameList: ...@@ -296,17 +343,12 @@ on(type: "applicationState", observer: ApplicationStateObserver, bundleNameList:
} }
} }
var bundleNameList = ['bundleName1', 'bundleName2']; var bundleNameList = ['bundleName1', 'bundleName2'];
try { const observerCode = app.registerApplicationStateObserver(applicationStateObserver, bundleNameList);
const observerCode = app.on("applicationState", applicationStateObserver, bundleNameList); console.log('-------- observerCode: ---------', observerCode);
console.log('-------- observerCode: ---------', observerCode);
} catch (paramError) {
console.log('error: ' + paramError.code + ', ' + paramError.message);
}
``` ```
## appManager.off ## appManager.unregisterApplicationStateObserver<sup>9+</sup>
off(type: "applicationState", observerId: number, callback: AsyncCallback\<void>): void; unregisterApplicationStateObserver(observerId: number, callback: AsyncCallback\<void>): void;
取消注册应用程序状态观测器。 取消注册应用程序状态观测器。
...@@ -320,30 +362,24 @@ off(type: "applicationState", observerId: number, callback: AsyncCallback\<void ...@@ -320,30 +362,24 @@ off(type: "applicationState", observerId: number, callback: AsyncCallback\<void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 调用接口类型 |
| observerId | number | 否 | 表示观察者的编号代码。 | | observerId | number | 否 | 表示观察者的编号代码。 |
| callback | AsyncCallback\<void> | 否 | 表示指定的回调方法。 | | callback | AsyncCallback\<void> | 否 | 表示指定的回调方法。 |
**示例：** **示例：**
```js ```ts
var observerId = 100; var observerId = 100;
function unregisterApplicationStateObserverCallback(err) {
function unregisterApplicationStateObserverCallback(err) { if (err) {
if (err) { console.log('------------ unregisterApplicationStateObserverCallback ------------', err);
console.log('------------ unregisterApplicationStateObserverCallback ------------', err);
}
}
try {
app.off(observerId, unregisterApplicationStateObserverCallback);
} catch (paramError) {
console.log('error: ' + paramError.code + ', ' + paramError.message);
} }
}
app.unregisterApplicationStateObserver(observerId, unregisterApplicationStateObserverCallback);
``` ```
## appManager.off ## appManager.unregisterApplicationStateObserver<sup>9+</sup>
off(type: "applicationState", observerId: number): Promise\<void>; unregisterApplicationStateObserver(observerId: number): Promise\<void>;
取消注册应用程序状态观测器。 取消注册应用程序状态观测器。
...@@ -357,7 +393,6 @@ off(type: "applicationState", observerId: number): Promise\<void>; ...@@ -357,7 +393,6 @@ off(type: "applicationState", observerId: number): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 调用接口类型 |
| observerId | number | 否 | 表示观察者的编号代码。 | | observerId | number | 否 | 表示观察者的编号代码。 |
**返回值：** **返回值：**
...@@ -368,23 +403,18 @@ off(type: "applicationState", observerId: number): Promise\<void>; ...@@ -368,23 +403,18 @@ off(type: "applicationState", observerId: number): Promise\<void>;
**示例：** **示例：**
```js ```ts
var observerId = 100; var observerId = 100;
app.unregisterApplicationStateObserver(observerId)
try { .then((data) => {
app.off(observerId) console.log('----------- unregisterApplicationStateObserver success ----------', data);
.then((data) => { })
console.log('----------- unregisterApplicationStateObserver success ----------', data); .catch((err) => {
}) console.log('----------- unregisterApplicationStateObserver fail ----------', err);
.catch((err) => { })
console.log('----------- unregisterApplicationStateObserver fail ----------', err);
})
} catch (paramError) {
console.log('error: ' + paramError.code + ', ' + paramError.message);
}
``` ```
## appManager.getForegroundApplications ## appManager.getForegroundApplications<sup>9+</sup>
getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void; getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
...@@ -404,18 +434,18 @@ getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void; ...@@ -404,18 +434,18 @@ getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
**示例：** **示例：**
```js ```ts
function getForegroundApplicationsCallback(err, data) { function getForegroundApplicationsCallback(err, data) {
if (err) { if (err) {
console.log('--------- getForegroundApplicationsCallback fail ---------', err.code + ': ' + err.message); console.log('--------- getForegroundApplicationsCallback fail ---------', err);
} else { } else {
console.log('--------- getForegroundApplicationsCallback success ---------', data) console.log('--------- getForegroundApplicationsCallback success ---------', data)
}
} }
app.getForegroundApplications(getForegroundApplicationsCallback); }
app.getForegroundApplications(getForegroundApplicationsCallback);
``` ```
## appManager.getForegroundApplications ## appManager.getForegroundApplications<sup>9+</sup>
getForegroundApplications(): Promise\<Array\<AppStateData>>; getForegroundApplications(): Promise\<Array\<AppStateData>>;
...@@ -435,17 +465,17 @@ getForegroundApplications(): Promise\<Array\<AppStateData>>; ...@@ -435,17 +465,17 @@ getForegroundApplications(): Promise\<Array\<AppStateData>>;
**示例：** **示例：**
```js ```ts
app.getForegroundApplications() app.getForegroundApplications()
.then((data) => { .then((data) => {
console.log('--------- getForegroundApplications success -------', data); console.log('--------- getForegroundApplications success -------', data);
}) })
.catch((err) => { .catch((err) => {
console.log('--------- getForegroundApplications fail -------', err.code + ': ' + err.message); console.log('--------- getForegroundApplications fail -------', err);
}) })
``` ```
## appManager.killProcessWithAccount ## appManager.killProcessWithAccount<sup>9+</sup>
killProcessWithAccount(bundleName: string, accountId: number): Promise\<void\> killProcessWithAccount(bundleName: string, accountId: number): Promise\<void\>
...@@ -466,24 +496,20 @@ killProcessWithAccount(bundleName: string, accountId: number): Promise\<void\> ...@@ -466,24 +496,20 @@ killProcessWithAccount(bundleName: string, accountId: number): Promise\<void\>
**示例：** **示例：**
```js ```ts
var bundleName = 'bundleName'; var bundleName = 'bundleName';
var accountId = 0; var accountId = 0;
try { app.killProcessWithAccount(bundleName, accountId)
app.killProcessWithAccount(bundleName, accountId) .then((data) => {
.then((data) => {
console.log('------------ killProcessWithAccount success ------------', data); console.log('------------ killProcessWithAccount success ------------', data);
}) })
.catch((err) => { .catch((err) => {
console.log('------------ killProcessWithAccount fail ------------', err); console.log('------------ killProcessWithAccount fail ------------', err);
}) })
} catch (paramError) {
console.log('error: ' + paramError.code + ', ' + paramError.message);
}
``` ```
## appManager.killProcessWithAccount ## appManager.killProcessWithAccount<sup>9+</sup>
killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCallback\<void\>): void killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCallback\<void\>): void
...@@ -505,7 +531,7 @@ killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCal ...@@ -505,7 +531,7 @@ killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCal
**示例：** **示例：**
```js ```ts
var bundleName = 'bundleName'; var bundleName = 'bundleName';
var accountId = 0; var accountId = 0;
function killProcessWithAccountCallback(err, data) { function killProcessWithAccountCallback(err, data) {
...@@ -515,14 +541,10 @@ function killProcessWithAccountCallback(err, data) { ...@@ -515,14 +541,10 @@ function killProcessWithAccountCallback(err, data) {
console.log('------------- killProcessWithAccountCallback success, data: --------------', data); console.log('------------- killProcessWithAccountCallback success, data: --------------', data);
} }
} }
try { app.killProcessWithAccount(bundleName, accountId, killProcessWithAccountCallback);
app.killProcessWithAccount(bundleName, accountId, killProcessWithAccountCallback);
} catch (paramError) {
console.log('error: ' + paramError.code + ', ' + paramError.message);
}
``` ```
## appManager.killProcessesByBundleName ## appManager.killProcessesByBundleName<sup>9+</sup>
killProcessesByBundleName(bundleName: string, callback: AsyncCallback\<void>); killProcessesByBundleName(bundleName: string, callback: AsyncCallback\<void>);
...@@ -543,23 +565,19 @@ killProcessesByBundleName(bundleName: string, callback: AsyncCallback\<void>); ...@@ -543,23 +565,19 @@ killProcessesByBundleName(bundleName: string, callback: AsyncCallback\<void>);
**示例：** **示例：**
```js ```ts
var bundleName = 'bundleName'; var bundleName = 'bundleName';
function killProcessesByBundleNameCallback(err, data) { function killProcessesByBundleNameCallback(err, data) {
if (err) { if (err) {
console.log('------------- killProcessesByBundleNameCallback fail, err: --------------', err); console.log('------------- killProcessesByBundleNameCallback fail, err: --------------', err);
} else { } else {
console.log('------------- killProcessesByBundleNameCallback success, data: --------------', data); console.log('------------- killProcessesByBundleNameCallback success, data: --------------', data);
}
}
try {
app.killProcessesByBundleName(bundleName, killProcessesByBundleNameCallback);
} catch (paramError) {
console.log('error: ' + paramError.code + ', ' + paramError.message);
} }
}
app.killProcessesByBundleName(bundleName, killProcessesByBundleNameCallback);
``` ```
## appManager.killProcessesByBundleName ## appManager.killProcessesByBundleName<sup>9+</sup>
killProcessesByBundleName(bundleName: string): Promise\<void>; killProcessesByBundleName(bundleName: string): Promise\<void>;
...@@ -585,23 +603,18 @@ killProcessesByBundleName(bundleName: string): Promise\<void>; ...@@ -585,23 +603,18 @@ killProcessesByBundleName(bundleName: string): Promise\<void>;
**示例：** **示例：**
```js ```ts
var bundleName = 'bundleName'; var bundleName = 'bundleName';
try { app.killProcessesByBundleName(bundleName)
app.killProcessesByBundleName(bundleName)
.then((data) => { .then((data) => {
console.log('------------ killProcessesByBundleName success ------------', data); console.log('------------ killProcessesByBundleName success ------------', data);
}) })
.catch((err) => { .catch((err) => {
console.log('------------ killProcessesByBundleName fail ------------', err); console.log('------------ killProcessesByBundleName fail ------------', err);
}) })
} catch (paramError) {
console.log('error: ' + paramError.code + ', ' + paramError.message);
}
``` ```
## appManager.clearUpApplicationData ## appManager.clearUpApplicationData<sup>9+</sup>
clearUpApplicationData(bundleName: string, callback: AsyncCallback\<void>); clearUpApplicationData(bundleName: string, callback: AsyncCallback\<void>);
...@@ -622,24 +635,19 @@ clearUpApplicationData(bundleName: string, callback: AsyncCallback\<void>); ...@@ -622,24 +635,19 @@ clearUpApplicationData(bundleName: string, callback: AsyncCallback\<void>);
**示例：** **示例：**
```js ```ts
var bundleName = 'bundleName'; var bundleName = 'bundleName';
function clearUpApplicationDataCallback(err, data) { function clearUpApplicationDataCallback(err, data) {
if (err) { if (err) {
console.log('------------- clearUpApplicationDataCallback fail, err: --------------', err); console.log('------------- clearUpApplicationDataCallback fail, err: --------------', err);
} else { } else {
console.log('------------- clearUpApplicationDataCallback success, data: --------------', data); console.log('------------- clearUpApplicationDataCallback success, data: --------------', data);
}
}
try {
app.clearUpApplicationData(bundleName, clearUpApplicationDataCallback);
} catch (paramError) {
console.log('error: ' + paramError.code + ', ' + paramError.message);
} }
}
app.clearUpApplicationData(bundleName, clearUpApplicationDataCallback);
``` ```
## appManager.clearUpApplicationData ## appManager.clearUpApplicationData<sup>9+</sup>
clearUpApplicationData(bundleName: string): Promise\<void>; clearUpApplicationData(bundleName: string): Promise\<void>;
...@@ -665,323 +673,18 @@ clearUpApplicationData(bundleName: string): Promise\<void>; ...@@ -665,323 +673,18 @@ clearUpApplicationData(bundleName: string): Promise\<void>;
**示例：** **示例：**
```js ```ts
var bundleName = 'bundleName'; var bundleName = 'bundleName';
try { app.clearUpApplicationData(bundleName)
app.clearUpApplicationData(bundleName) .then((data) => {
.then((data) => {
console.log('------------ clearUpApplicationData success ------------', data); console.log('------------ clearUpApplicationData success ------------', data);
}) })
.catch((err) => { .catch((err) => {
console.log('------------ clearUpApplicationData fail ------------', err); console.log('------------ clearUpApplicationData fail ------------', err);
}) })
} catch (paramError) {
console.log('error: ' + paramError.code + ', ' + paramError.message);
}
``` ```
## ApplicationStateObserver.onForegroundApplicationChanged ## ApplicationState<sup>9+</sup>
onForegroundApplicationChanged(appStateData: AppStateData): void;
将在前台或后台应用程序更改时调用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| appStateData | [AppStateData](#appstatedata) | 否 | 状态更改的应用程序信息。 |
**示例：**
```js
var applicationStateObserver = {
onForegroundApplicationChanged(appStateData) {
console.log('------------ onForegroundApplicationChanged -----------', appStateData);
},
onAbilityStateChanged(abilityStateData) {
console.log('------------ onAbilityStateChanged -----------', abilityStateData);
},
onProcessCreated(processData) {
console.log('------------ onProcessCreated -----------', processData);
},
onProcessDied(processData) {
console.log('------------ onProcessDied -----------', processData);
},
onProcessStateChanged(processData) {
console.log('------------ onProcessStateChanged -----------', processData);
}
}
try {
const observerCode = app.on("applicationState", applicationStateObserver);
console.log('-------- observerCode: ---------', observerCode);
} catch (paramError) {
console.log('error: ' + paramError.code + ', ' + paramError.message);
}
```
## ApplicationStateObserver.onAbilityStateChanged
onAbilityStateChanged(abilityStateData: AbilityStateData): void;
将在能力状态更改时调用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| abilityStateData | [AbilityStateData](#abilitystatedata) | 否 | 状态更改的能力信息。 |
**示例：**
```js
var applicationStateObserver = {
onForegroundApplicationChanged(appStateData) {
console.log('------------ onForegroundApplicationChanged -----------', appStateData);
},
onAbilityStateChanged(abilityStateData) {
console.log('------------ onAbilityStateChanged -----------', abilityStateData);
},
onProcessCreated(processData) {
console.log('------------ onProcessCreated -----------', processData);
},
onProcessDied(processData) {
console.log('------------ onProcessDied -----------', processData);
},
onProcessStateChanged(processData) {
console.log('------------ onProcessStateChanged -----------', processData);
}
}
try {
const observerCode = app.on("applicationState", applicationStateObserver);
console.log('-------- observerCode: ---------', observerCode);
} catch (paramError) {
console.log('error: ' + paramError.code + ', ' + paramError.message);
}
```
## ApplicationStateObserver.onProcessCreated
onProcessCreated(processData: ProcessData): void;
将在创建进程时调用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| processData | [ProcessData](#processdata) | 否 | 进程信息。 |
**示例：**
```js
var applicationStateObserver = {
onForegroundApplicationChanged(appStateData) {
console.log('------------ onForegroundApplicationChanged -----------', appStateData);
},
onAbilityStateChanged(abilityStateData) {
console.log('------------ onAbilityStateChanged -----------', abilityStateData);
},
onProcessCreated(processData) {
console.log('------------ onProcessCreated -----------', processData);
},
onProcessDied(processData) {
console.log('------------ onProcessDied -----------', processData);
},
onProcessStateChanged(processData) {
console.log('------------ onProcessStateChanged -----------', processData);
}
}
try {
const observerCode = app.on("applicationState", applicationStateObserver);
console.log('-------- observerCode: ---------', observerCode);
} catch (paramError) {
console.log('error: ' + paramError.code + ', ' + paramError.message);
}
```
## ApplicationStateObserver.onProcessDied
onProcessDied(processData: ProcessData): void;
将在进程终止时调用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| processData | [ProcessData](#processdata) | 否 | 进程信息。 |
**示例：**
```js
var applicationStateObserver = {
onForegroundApplicationChanged(appStateData) {
console.log('------------ onForegroundApplicationChanged -----------', appStateData);
},
onAbilityStateChanged(abilityStateData) {
console.log('------------ onAbilityStateChanged -----------', abilityStateData);
},
onProcessCreated(processData) {
console.log('------------ onProcessCreated -----------', processData);
},
onProcessDied(processData) {
console.log('------------ onProcessDied -----------', processData);
},
onProcessStateChanged(processData) {
console.log('------------ onProcessStateChanged -----------', processData);
}
}
try {
const observerCode = app.on("applicationState", applicationStateObserver);
console.log('-------- observerCode: ---------', observerCode);
} catch (paramError) {
console.log('error: ' + paramError.code + ', ' + paramError.message);
}
```
## ApplicationStateObserver.onProcessStateChanged
onProcessStateChanged(processData: ProcessData): void;
当进程状态更改时调用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| processData | [ProcessData](#processdata) | 否 | 进程信息。 |
**示例：**
```js
var applicationStateObserver = {
onForegroundApplicationChanged(appStateData) {
console.log('------------ onForegroundApplicationChanged -----------', appStateData);
},
onAbilityStateChanged(abilityStateData) {
console.log('------------ onAbilityStateChanged -----------', abilityStateData);
},
onProcessCreated(processData) {
console.log('------------ onProcessCreated -----------', processData);
},
onProcessDied(processData) {
console.log('------------ onProcessDied -----------', processData);
},
onProcessStateChanged(processData) {
console.log('------------ onProcessStateChanged -----------', processData);
}
}
try {
const observerCode = app.on("applicationState", applicationStateObserver);
console.log('-------- observerCode: ---------', observerCode);
} catch (paramError) {
console.log('error: ' + paramError.code + ', ' + paramError.message);
}
```
## AppStateData
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ |
| bundleName | 是 | 否 | string | 否 | 包名。 |
| uid | 是 | 否 | number | 否 | 用户ID。 |
| state | 是 | 否 | number | 否 | 应用状态。 |
## AbilityStateData
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------------------- | ---------| ---- | ---- | ------------------------- |
| pid | number | 是 | 否 | 进程ID。 |
| bundleName | string | 是 | 否 | 应用包名。 |
| abilityName | string | 是 | 否 | Ability名称。 |
| uid | number | 是 | 否 | 用户ID。 |
| state | number | 是 | 否 | Ability状态。 |
| moduleName | string | 是 | 否 | Ability所属的HAP包的名称。 |
| abilityType | string | 是 | 否 | 能力类型、页面或服务等。 |
## ProcessData
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------------------- | ---------| ---- | ---- | ------------------------- |
| pid | number | 是 | 否 | 进程ID。 |
| bundleName | string | 是 | 否 | 应用包名。 |
| uid | number | 是 | 否 | 用户ID。 |
| isContinuousTas | boolean | 是 | 否 | 判断过程是否为连续任务。 |
| isKeepAlive | boolean | 是 | 否 | 判断该过程是否保持活跃。 |
## ProcessRunningInfo
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| pid | 是 | 否 | number | 否 | 进程ID。 |
| uid | 是 | 否 | number | 否 | 用户ID。 |
| processName | 是 | 否 | string | 否 | 进程的名称。 |
| bundleNames | 是 | 否 | Array\<string> | 否 | 进程中运行的bundleName数组。 |
## ApplicationStateObserver
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------------------- | ---------| ---- | ---- | ------------------------- |
| [onForegroundApplicationChanged](#applicationstateobserveronforegroundapplicationchanged) | AsyncCallback\<void> | 是 | 否 | 应用前后台状态发生变化时执行的回调函数。 |
| [onAbilityStateChanged](#applicationstateobserveronabilitystatechanged) | AsyncCallback\<void> | 是 | 否 | ability状态发生变化时执行的回调函数。 |
| [onProcessCreated](#applicationstateobserveronprocesscreated) | AsyncCallback\<void> | 是 | 否 | 进程创建时执行的回调函数。 |
| [onProcessDied](#applicationstateobserveronprocessdied) | AsyncCallback\<void> | 是 | 否 | 进程销毁时执行的回调函数。 |
## ProcessRunningInformation
进程的运行信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| pid | 是 | 否 | number | 否 | 进程ID。 |
| uid | 是 | 否 | number | 否 | 用户ID。 |
| processName | 是 | 否 | string | 否 | 进程的名称。 |
| bundleNames | 是 | 否 | Array\<string> | 否 | 进程中运行的bundleName数组。 |
## ApplicationState
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统能力**：SystemCapability.Ability.AbilityRuntime.Core
...@@ -995,7 +698,7 @@ onProcessDied(processData: ProcessData): void; ...@@ -995,7 +698,7 @@ onProcessDied(processData: ProcessData): void;
| STATE_BACKGROUND | 4 | 当应用处于后台不可见时处于的状态。 | | STATE_BACKGROUND | 4 | 当应用处于后台不可见时处于的状态。 |
| STATE_DESTROY | 5 | 当应用在销毁的时候处于的状态。 | | STATE_DESTROY | 5 | 当应用在销毁的时候处于的状态。 |
## ProcessState ## ProcessState<sup>9+</sup>
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md
浏览文件 @ 0612bb09
...@@ -7,7 +7,7 @@ appRecovery模块提供了应用在故障状态下的恢复能力。 ...@@ -7,7 +7,7 @@ appRecovery模块提供了应用在故障状态下的恢复能力。
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。当前版本仅支持单进程中单Ability的应用恢复。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。当前版本仅支持单进程中单Ability的应用恢复。
## 导入模块 ## 导入模块
``` ```ts
import appRecovery from '@ohos.app.ability.appRecovery' import appRecovery from '@ohos.app.ability.appRecovery'
``` ```
...@@ -78,7 +78,7 @@ export default class MyAbilityStage extends AbilityStage { ...@@ -78,7 +78,7 @@ export default class MyAbilityStage extends AbilityStage {
restartApp(): void; restartApp(): void;
重启当前App进程，可以配合[errorManager](js-apis-errorManager.md#errorobserver)相关接口使用。 重启当前App进程，可以配合[errorManager](js-apis-app-ability-errorManager.md)相关接口使用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统能力**：SystemCapability.Ability.AbilityRuntime.Core
...@@ -99,7 +99,7 @@ var observer = { ...@@ -99,7 +99,7 @@ var observer = {
saveAppState(): boolean; saveAppState(): boolean;
保存当前App状态，可以配合[errorManager](js-apis-errorManager.md#errorobserver)相关接口使用 保存当前App状态，可以配合[errorManager](js-apis-app-ability-errorManager.md)相关接口使用
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统能力**：SystemCapability.Ability.AbilityRuntime.Core
...@@ -118,5 +118,4 @@ var observer = { ...@@ -118,5 +118,4 @@ var observer = {
appRecovery.saveAppState(); 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-configurationconstant.md → zh-cn/application-dev/reference/apis/js-apis-app-ability-configurationConstant.md
浏览文件 @ 0612bb09
...@@ -8,8 +8,7 @@ ConfigurationConstant模块提供配置信息枚举值定义的能力。 ...@@ -8,8 +8,7 @@ ConfigurationConstant模块提供配置信息枚举值定义的能力。
## 导入模块 ## 导入模块
```ts
```js
import ConfigurationConstant from '@ohos.app.ability.ConfigurationConstant'; import ConfigurationConstant from '@ohos.app.ability.ConfigurationConstant';
``` ```
...@@ -17,12 +16,6 @@ import ConfigurationConstant from '@ohos.app.ability.ConfigurationConstant'; ...@@ -17,12 +16,6 @@ import ConfigurationConstant from '@ohos.app.ability.ConfigurationConstant';
使用时通过ConfigurationConstant.ColorMode获取。 使用时通过ConfigurationConstant.ColorMode获取。
**示例：**
```
ConfigurationConstant.ColorMode.COLOR_MODE_LIGHT
```
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
...@@ -32,16 +25,10 @@ ConfigurationConstant.ColorMode.COLOR_MODE_LIGHT ...@@ -32,16 +25,10 @@ ConfigurationConstant.ColorMode.COLOR_MODE_LIGHT
| COLOR_MODE_LIGHT | 1 | 浅色模式。 | | COLOR_MODE_LIGHT | 1 | 浅色模式。 |
## ConfigurationConstant.Direction ## ConfigurationConstant.Direction<sup>9+</sup>
使用时通过ConfigurationConstant.Direction获取。 使用时通过ConfigurationConstant.Direction获取。
**示例：**
```
ConfigurationConstant.Direction.DIRECTION_VERTICAL
```
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
...@@ -51,16 +38,10 @@ ConfigurationConstant.Direction.DIRECTION_VERTICAL ...@@ -51,16 +38,10 @@ ConfigurationConstant.Direction.DIRECTION_VERTICAL
| DIRECTION_HORIZONTAL | 1 | 水平方向。 | | DIRECTION_HORIZONTAL | 1 | 水平方向。 |
## ConfigurationConstant.ScreenDensity ## ConfigurationConstant.ScreenDensity<sup>9+</sup>
使用时通过ConfigurationConstant.ScreenDensity获取。 使用时通过ConfigurationConstant.ScreenDensity获取。
**示例：**
```
ConfigurationConstant.ScreenDensity.SCREEN_DENSITY_NOT_SET
```
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-contextConstant.md 0 → 100644
浏览文件 @ 0612bb09
# ContextConstant
ContextConstant模块提供数据加密等级定义的能力。
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
```ts
import contextConstant from '@ohos.app.ability.contextConstant';
```
## ContextConstant.AreaMode
使用时通过ContextConstant.AreaMode获取。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| EL1 | 0 | 设备级加密区。 |
| EL2 | 1 | 用户凭据加密区。 |
zh-cn/application-dev/reference/apis/js-apis-app-ability-EnvironmentCallback.md → zh-cn/application-dev/reference/apis/js-apis-app-ability-environmentCallback.md 100755 → 100644
浏览文件 @ 0612bb09
...@@ -10,7 +10,7 @@ EnvironmentCallback模块提供应用上下文ApplicationContext对系统环境 ...@@ -10,7 +10,7 @@ EnvironmentCallback模块提供应用上下文ApplicationContext对系统环境
## 导入模块 ## 导入模块
```js ```ts
import EnvironmentCallback from "@ohos.app.ability.EnvironmentCallback"; import EnvironmentCallback from "@ohos.app.ability.EnvironmentCallback";
``` ```
...@@ -27,13 +27,13 @@ onConfigurationUpdated(config: Configuration): void; ...@@ -27,13 +27,13 @@ onConfigurationUpdated(config: Configuration): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| config | [Configuration](js-apis-configuration.md) | 是 | 变化后的Configuration对象。 | | config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 变化后的Configuration对象。 |
**示例：** **示例：**
```js ```ts
import Ability from "@ohos.app.ability.Ability"; import Ability from "@ohos.application.Ability";
var callbackId; var callbackId;
...@@ -49,18 +49,14 @@ export default class MyAbility extends Ability { ...@@ -49,18 +49,14 @@ export default class MyAbility extends Ability {
// 1.获取applicationContext // 1.获取applicationContext
let applicationContext = globalThis.applicationContext; let applicationContext = globalThis.applicationContext;
// 2.通过applicationContext注册监听应用内生命周期 // 2.通过applicationContext注册监听应用内生命周期
callbackId = applicationContext.on("environment", EnvironmentCallback); callbackId = applicationContext.registerEnvironmentCallback(EnvironmentCallback);
console.log("registerEnvironmentCallback number: " + JSON.stringify(callbackId)); console.log("registerEnvironmentCallback number: " + JSON.stringify(callbackId));
} }
onDestroy() { onDestroy() {
let applicationContext = globalThis.applicationContext; let applicationContext = globalThis.applicationContext;
try { 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)); });
});
} catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message);
}
} }
} }
``` ```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-app-ability-extensionAbility.md 0 → 100644
浏览文件 @ 0612bb09
# ExtensionAbility
ExtensionAbility模块提供对ExtensionAbility生命周期、上下文环境等调用管理的能力，包括ExtensionAbility创建、销毁、转储客户端信息等。
> **说明：**
>
> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
```ts
import ExtensionAbility from '@ohos.app.ability.ExtensionAbility';
```
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例：**
```ts
class MyExtensionAbility extends ExtensionAbility {
onConfigurationUpdated(config) {
console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
}
onMemoryLevel(level) {
console.log('onMemoryLevel, level:' + JSON.stringify(level));
}
}
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-app-ability-missionManager.md
浏览文件 @ 0612bb09
...@@ -8,7 +8,7 @@ missionManager模块提供系统任务管理能力，包括对系统任务执行 ...@@ -8,7 +8,7 @@ missionManager模块提供系统任务管理能力，包括对系统任务执行
## 导入模块 ## 导入模块
``` ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager'
``` ```
...@@ -42,7 +42,7 @@ on(type:"mission", listener: MissionListener): number; ...@@ -42,7 +42,7 @@ on(type:"mission", listener: MissionListener): number;
**示例：** **示例：**
```js ```ts
var listener = { var listener = {
onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")}, onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")},
onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")}, onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")},
...@@ -81,7 +81,7 @@ off(type: "mission", listenerId: number, callback: AsyncCallback&lt;void&gt;): v ...@@ -81,7 +81,7 @@ off(type: "mission", listenerId: number, callback: AsyncCallback&lt;void&gt;): v
**示例：** **示例：**
```js ```ts
var listener = { var listener = {
onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")}, onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")},
onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")}, onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")},
...@@ -129,7 +129,7 @@ off(type: "mission", listenerId: number): Promise&lt;void&gt;; ...@@ -129,7 +129,7 @@ off(type: "mission", listenerId: number): Promise&lt;void&gt;;
**示例：** **示例：**
```js ```ts
var listener = { var listener = {
onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")}, onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")},
onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")}, onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")},
...@@ -173,7 +173,7 @@ getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback&lt;M ...@@ -173,7 +173,7 @@ getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback&lt;M
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager'
try { try {
...@@ -220,7 +220,7 @@ getMissionInfo(deviceId: string, missionId: number): Promise&lt;MissionInfo&gt;; ...@@ -220,7 +220,7 @@ getMissionInfo(deviceId: string, missionId: number): Promise&lt;MissionInfo&gt;;
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager'
try { try {
...@@ -255,7 +255,7 @@ getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback&lt;Arr ...@@ -255,7 +255,7 @@ getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback&lt;Arr
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager'
try { try {
...@@ -297,7 +297,7 @@ getMissionInfos(deviceId: string, numMax: number): Promise&lt;Array&lt;MissionIn ...@@ -297,7 +297,7 @@ getMissionInfos(deviceId: string, numMax: number): Promise&lt;Array&lt;MissionIn
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager'
try { try {
...@@ -328,11 +328,11 @@ getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback& ...@@ -328,11 +328,11 @@ getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback&
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 设备ID，本机默认为空字符串。 | | deviceId | string | 是 | 设备ID，本机默认为空字符串。 |
| missionId | number | 是 | 任务ID。 | | missionId | number | 是 | 任务ID。 |
| callback | AsyncCallback&lt;[MissionSnapshot](js-apis-application-MissionSnapshot.md)&gt; | 是 | 执行结果回调函数，返回任务快照信息。 | | callback | AsyncCallback&lt;[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)&gt; | 是 | 执行结果回调函数，返回任务快照信息。 |
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager'
try { try {
...@@ -376,11 +376,11 @@ getMissionSnapShot(deviceId: string, missionId: number): Promise&lt;MissionSnaps ...@@ -376,11 +376,11 @@ getMissionSnapShot(deviceId: string, missionId: number): Promise&lt;MissionSnaps
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;[MissionSnapshot](js-apis-application-MissionSnapshot.md)&gt; | 任务快照信息。 | | Promise&lt;[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)&gt; | 任务快照信息。 |
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager'
try { try {
...@@ -418,11 +418,11 @@ getLowResolutionMissionSnapShot(deviceId: string, missionId: number, callback: A ...@@ -418,11 +418,11 @@ getLowResolutionMissionSnapShot(deviceId: string, missionId: number, callback: A
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 设备ID，本机默认为空字符串。 | | deviceId | string | 是 | 设备ID，本机默认为空字符串。 |
| missionId | number | 是 | 任务ID。 | | missionId | number | 是 | 任务ID。 |
| callback | AsyncCallback&lt;[MissionSnapshot](js-apis-application-MissionSnapshot.md)&gt; | 是 | 执行结果回调函数，返回任务快照信息。 | | callback | AsyncCallback&lt;[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)&gt; | 是 | 执行结果回调函数，返回任务快照信息。 |
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager'
try { try {
...@@ -466,11 +466,11 @@ getLowResolutionMissionSnapShot(deviceId: string, missionId: number): Promise\<M ...@@ -466,11 +466,11 @@ getLowResolutionMissionSnapShot(deviceId: string, missionId: number): Promise\<M
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;[MissionSnapshot](js-apis-application-MissionSnapshot.md)&gt; | 任务快照信息。 | | Promise&lt;[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)&gt; | 任务快照信息。 |
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager'
try { try {
...@@ -512,7 +512,7 @@ lockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void; ...@@ -512,7 +512,7 @@ lockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager'
try { try {
...@@ -558,7 +558,7 @@ lockMission(missionId: number): Promise&lt;void&gt;; ...@@ -558,7 +558,7 @@ lockMission(missionId: number): Promise&lt;void&gt;;
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager'
try { try {
...@@ -600,7 +600,7 @@ unlockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void; ...@@ -600,7 +600,7 @@ unlockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager'
try { try {
...@@ -646,7 +646,7 @@ unlockMission(missionId: number): Promise&lt;void&gt;; ...@@ -646,7 +646,7 @@ unlockMission(missionId: number): Promise&lt;void&gt;;
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager'
try { try {
...@@ -691,7 +691,7 @@ clearMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void; ...@@ -691,7 +691,7 @@ clearMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager'
try { try {
...@@ -737,7 +737,7 @@ clearMission(missionId: number): Promise&lt;void&gt;; ...@@ -737,7 +737,7 @@ clearMission(missionId: number): Promise&lt;void&gt;;
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager'
try { try {
...@@ -772,7 +772,7 @@ clearAllMissions(callback: AsyncCallback&lt;void&gt;): void; ...@@ -772,7 +772,7 @@ clearAllMissions(callback: AsyncCallback&lt;void&gt;): void;
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager'
missionManager.clearAllMissions().then(() => { missionManager.clearAllMissions().then(() => {
...@@ -801,7 +801,7 @@ clearAllMissions(): Promise&lt;void&gt;; ...@@ -801,7 +801,7 @@ clearAllMissions(): Promise&lt;void&gt;;
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager'
missionManager.clearAllMissions().catch(function (err){ missionManager.clearAllMissions().catch(function (err){
console.log(err); console.log(err);
...@@ -830,7 +830,7 @@ moveMissionToFront(missionId: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -830,7 +830,7 @@ moveMissionToFront(missionId: number, callback: AsyncCallback&lt;void&gt;): void
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager'
try { try {
...@@ -867,12 +867,12 @@ moveMissionToFront(missionId: number, options: StartOptions, callback: AsyncCall ...@@ -867,12 +867,12 @@ moveMissionToFront(missionId: number, options: StartOptions, callback: AsyncCall
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 | | missionId | number | 是 | 任务ID。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 | | options | [StartOptions](js-apis-app-ability-startOptions.md) | 是 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager'
try { try {
...@@ -909,7 +909,7 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&g ...@@ -909,7 +909,7 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&g
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 | | missionId | number | 是 | 任务ID。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 | | options | [StartOptions](js-apis-app-ability-startOptions.md) | 否 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 |
**返回值：** **返回值：**
...@@ -919,7 +919,7 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&g ...@@ -919,7 +919,7 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&g
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.app.ability.missionManager' import missionManager from '@ohos.app.ability.missionManager'
try { try {
...@@ -953,7 +953,7 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&g ...@@ -953,7 +953,7 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&g
| runningState | number | 是 | 是 | 表示运行状态。 | | runningState | number | 是 | 是 | 表示运行状态。 |
| lockedState | boolean | 是 | 是 | 表示锁定状态。 | | lockedState | boolean | 是 | 是 | 表示锁定状态。 |
| timestamp | string | 是 | 是 | 表示任务的最近创建或更新时间。 | | timestamp | string | 是 | 是 | 表示任务的最近创建或更新时间。 |
| want | [Want](js-apis-application-Want.md) | 是 | 是 | 表示任务的Want信息。 | | want | [Want](js-apis-application-want.md) | 是 | 是 | 表示任务的Want信息。 |
| label | string | 是 | 是 | 表示任务的标签。 | | label | string | 是 | 是 | 表示任务的标签。 |
| iconPath | string | 是 | 是 | 表示任务的图标路径。 | | iconPath | string | 是 | 是 | 表示任务的图标路径。 |
| continuable | boolean | 是 | 是 | 表示任务是否可以迁移。 | | continuable | boolean | 是 | 是 | 表示任务是否可以迁移。 |
zh-cn/application-dev/reference/apis/js-apis-app-ability-quickFixManager.md
浏览文件 @ 0612bb09
...@@ -8,7 +8,7 @@ quickFixManager模块提供快速修复的能力，快速修复是OpenHarmony提 ...@@ -8,7 +8,7 @@ quickFixManager模块提供快速修复的能力，快速修复是OpenHarmony提
## 导入模块 ## 导入模块
``` ```ts
import quickFixManager from '@ohos.app.ability.quickFixManager'; import quickFixManager from '@ohos.app.ability.quickFixManager';
``` ```
...@@ -64,7 +64,7 @@ applyQuickFix(hapModuleQuickFixFiles: Array\<string>, callback: AsyncCallback\<v ...@@ -64,7 +64,7 @@ applyQuickFix(hapModuleQuickFixFiles: Array\<string>, callback: AsyncCallback\<v
**示例：** **示例：**
```js ```ts
import quickFixManager from '@ohos.app.ability.quickFixManager' import quickFixManager from '@ohos.app.ability.quickFixManager'
try { try {
...@@ -107,7 +107,7 @@ applyQuickFix(hapModuleQuickFixFiles: Array\<string>): Promise\<void>; ...@@ -107,7 +107,7 @@ applyQuickFix(hapModuleQuickFixFiles: Array\<string>): Promise\<void>;
**示例：** **示例：**
```js ```ts
import quickFixManager from '@ohos.app.ability.quickFixManager' import quickFixManager from '@ohos.app.ability.quickFixManager'
let hapModuleQuickFixFiles = ["/data/storage/el2/base/entry.hqf"] let hapModuleQuickFixFiles = ["/data/storage/el2/base/entry.hqf"]
...@@ -143,7 +143,7 @@ getApplicationQuickFixInfo(bundleName: string, callback: AsyncCallback\<Applicat ...@@ -143,7 +143,7 @@ getApplicationQuickFixInfo(bundleName: string, callback: AsyncCallback\<Applicat
**示例：** **示例：**
```js ```ts
import quickFixManager from '@ohos.app.ability.quickFixManager' import quickFixManager from '@ohos.app.ability.quickFixManager'
try { try {
...@@ -186,7 +186,7 @@ getApplicationQuickFixInfo(bundleName: string): Promise\<ApplicationQuickFixInfo ...@@ -186,7 +186,7 @@ getApplicationQuickFixInfo(bundleName: string): Promise\<ApplicationQuickFixInfo
**示例：** **示例：**
```js ```ts
import quickFixManager from '@ohos.app.ability.quickFixManager' import quickFixManager from '@ohos.app.ability.quickFixManager'
try { try {
......
zh-cn/application-dev/reference/apis/js-apis-service-extension-ability.md → zh-cn/application-dev/reference/apis/js-apis-app-ability-serviceExtensionAbility.md
浏览文件 @ 0612bb09
...@@ -4,13 +4,13 @@ ServiceExtensionAbility模块提供ServiceExtension服务扩展相关接口的 ...@@ -4,13 +4,13 @@ ServiceExtensionAbility模块提供ServiceExtension服务扩展相关接口的
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 9开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.ServiceExtensionAbility](js-apis-app-ability-service-extension-ability.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.ServiceExtensionAbility](js-apis-app-ability-serviceExtensionAbility.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。 > 本模块接口仅可在Stage模型下使用。
## 导入模块 ## 导入模块
``` ```ts
import ServiceExtension from '@ohos.application.ServiceExtensionAbility'; import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility';
``` ```
## 权限 ## 权限
...@@ -25,7 +25,7 @@ import ServiceExtension from '@ohos.application.ServiceExtensionAbility'; ...@@ -25,7 +25,7 @@ import ServiceExtension from '@ohos.application.ServiceExtensionAbility';
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| context | [ServiceExtensionContext](js-apis-service-extension-context.md) | 是 | 否 | ServiceExtension的上下文环境，继承自ExtensionContext。 | | context | [ServiceExtensionContext](js-apis-inner-application-serviceExtensionContext.md) | 是 | 否 | ServiceExtension的上下文环境，继承自ExtensionContext。 |
## ServiceExtensionAbility.onCreate ## ServiceExtensionAbility.onCreate
...@@ -42,11 +42,11 @@ Extension生命周期回调，在创建时回调，执行初始化业务逻辑 ...@@ -42,11 +42,11 @@ Extension生命周期回调，在创建时回调，执行初始化业务逻辑
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | | want | [Want](js-apis-app-ability-want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 |
**示例：** **示例：**
```js ```ts
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
onCreate(want) { onCreate(want) {
console.log('onCreate, want:' + want.abilityName); console.log('onCreate, want:' + want.abilityName);
...@@ -67,7 +67,7 @@ Extension生命周期回调，在销毁时回调，执行资源清理等操作 ...@@ -67,7 +67,7 @@ Extension生命周期回调，在销毁时回调，执行资源清理等操作
**示例：** **示例：**
```js ```ts
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
onDestroy() { onDestroy() {
console.log('onDestroy'); console.log('onDestroy');
...@@ -90,12 +90,12 @@ Extension生命周期回调，如果是startAbility拉起的服务，会在onCre ...@@ -90,12 +90,12 @@ Extension生命周期回调，如果是startAbility拉起的服务，会在onCre
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | | want | [Want](js-apis-app-ability-want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 |
| startId | number | 是 | 返回拉起次数。首次拉起初始值返回1，多次之后自动递增。 | | startId | number | 是 | 返回拉起次数。首次拉起初始值返回1，多次之后自动递增。 |
**示例：** **示例：**
```js ```ts
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
onRequest(want, startId) { onRequest(want, startId) {
console.log('onRequest, want:' + want.abilityName); console.log('onRequest, want:' + want.abilityName);
...@@ -118,7 +118,7 @@ Extension生命周期回调，如果是connectAbility拉起的服务，会在onC ...@@ -118,7 +118,7 @@ Extension生命周期回调，如果是connectAbility拉起的服务，会在onC
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | | want | [Want](js-apis-app-ability-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 |
**返回值：** **返回值：**
...@@ -128,7 +128,7 @@ Extension生命周期回调，如果是connectAbility拉起的服务，会在onC ...@@ -128,7 +128,7 @@ Extension生命周期回调，如果是connectAbility拉起的服务，会在onC
**示例：** **示例：**
```js ```ts
import rpc from '@ohos.rpc' import rpc from '@ohos.rpc'
class StubTest extends rpc.RemoteObject{ class StubTest extends rpc.RemoteObject{
constructor(des) { constructor(des) {
...@@ -160,11 +160,11 @@ Extension的生命周期，断开服务连接时回调。 ...@@ -160,11 +160,11 @@ Extension的生命周期，断开服务连接时回调。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want |[Want](js-apis-application-Want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | | want |[Want](js-apis-app-ability-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 |
**示例：** **示例：**
```js ```ts
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
onDisconnect(want) { onDisconnect(want) {
console.log('onDisconnect, want:' + want.abilityName); console.log('onDisconnect, want:' + want.abilityName);
...@@ -186,11 +186,11 @@ onReconnect(want: Want): void; ...@@ -186,11 +186,11 @@ onReconnect(want: Want): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want |[Want](js-apis-application-Want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | | want |[Want](js-apis-app-ability-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 |
**示例：** **示例：**
```js ```ts
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
onReconnect(want) { onReconnect(want) {
console.log('onReconnect, want:' + want.abilityName); console.log('onReconnect, want:' + want.abilityName);
...@@ -212,11 +212,11 @@ onConfigurationUpdated(config: Configuration): void; ...@@ -212,11 +212,11 @@ onConfigurationUpdated(config: Configuration): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| config | [Configuration](js-apis-configuration.md) | 是 | 表示需要更新的配置信息。 | | config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 表示需要更新的配置信息。 |
**示例：** **示例：**
```js ```ts
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
onConfigurationUpdated(config) { onConfigurationUpdated(config) {
console.log('onConfigurationUpdated, config:' + JSON.stringify(config)); console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
...@@ -242,7 +242,7 @@ dump(params: Array\<string>): Array\<string>; ...@@ -242,7 +242,7 @@ dump(params: Array\<string>): Array\<string>;
**示例：** **示例：**
```js ```ts
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
dump(params) { dump(params) {
console.log('dump, params:' + JSON.stringify(params)); console.log('dump, params:' + JSON.stringify(params));
......
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模块对系统的基本通信组件进行查询和设置的能力 ...@@ -9,15 +9,16 @@ StartOptions模块对系统的基本通信组件进行查询和设置的能力
## 导入模块 ## 导入模块
``` ```ts
import StartOptions from '@ohos.app.ability.StartOptions'; import StartOptions from '@ohos.app.ability.StartOptions';
``` ```
## 属性 ## 属性
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 | | 名称 | 可读 | 可写 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- | -------- |
| [windowMode](js-apis-app-ability-abilityConstant.md#abilityconstantwindowmode) | 是 | 否 | number | 否 | 窗口模式。 | | [windowMode](js-apis-application-abilityConstant.md#abilityconstantwindowmode) | 是 | 否 | number | 否 | 窗口模式。 |
| displayId | 是 | 否 | number | 否 | 显示ID。 | | displayId | 是 | 否 | number | 否 | 显示ID。 |
zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md 0 → 100644
浏览文件 @ 0612bb09
# Ability
Ability模块提供对Ability生命周期、上下文环境等调用管理的能力，包括Ability创建、销毁、转储客户端信息等。
该模块提供以下Ability相关的常用功能：
- [Caller](#caller)：通用组件Caller通信客户端调用接口, 用来向通用组件服务端发送约定数据。
- [Callee](#callee)：通用组件服务端注册和解除客户端caller通知送信的callback接口。
> **说明：**
>
> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
```ts
import Ability from '@ohos.app.ability.UIAbility';
```
## 属性
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.AbilityCore
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| context | [UIAbilityContext](js-apis-inner-application-uiAbilityContext.md) | 是 | 否 | 上下文。 |
| launchWant | [Want](js-apis-app-ability-want.md) | 是 | 否 | Ability启动时的参数。 |
| lastRequestWant | [Want](js-apis-app-ability-want.md) | 是 | 否 | Ability最后请求时的参数。|
| callee | [Callee](#callee) | 是 | 否 | 调用Stub（桩）服务对象。|
## Ability.onCreate
onCreate(want: Want, param: AbilityConstant.LaunchParam): void;
Ability创建时回调，执行初始化业务逻辑操作。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-app-ability-want.md) | 是 | 当前Ability的Want类型信息，包括ability名称、bundle名称等。 |
| param | AbilityConstant.LaunchParam | 是 | 创建&nbsp;ability、上次异常退出的原因信息。 |
**示例：**
```ts
class myAbility extends Ability {
onCreate(want, param) {
console.log('onCreate, want:' + want.abilityName);
}
}
```
## Ability.onWindowStageCreate
onWindowStageCreate(windowStage: window.WindowStage): void
当WindowStage创建后调用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| windowStage | window.WindowStage | 是 | WindowStage相关信息。 |
**示例：**
```ts
class myAbility extends Ability {
onWindowStageCreate(windowStage) {
console.log('onWindowStageCreate');
}
}
```
## Ability.onWindowStageDestroy
onWindowStageDestroy(): void
当WindowStage销毁后调用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例：**
```ts
class myAbility extends Ability {
onWindowStageDestroy() {
console.log('onWindowStageDestroy');
}
}
```
## Ability.onWindowStageRestore
onWindowStageRestore(windowStage: window.WindowStage): void
当迁移多实例ability时，恢复WindowStage后调用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| windowStage | window.WindowStage | 是 | WindowStage相关信息。 |
**示例：**
```ts
class myAbility extends Ability {
onWindowStageRestore(windowStage) {
console.log('onWindowStageRestore');
}
}
```
## Ability.onDestroy
onDestroy(): void;
Ability生命周期回调，在销毁时回调，执行资源清理等操作。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例：**
```ts
class myAbility extends Ability {
onDestroy() {
console.log('onDestroy');
}
}
```
## Ability.onForeground
onForeground(): void;
Ability生命周期回调，当应用从后台转到前台时触发。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例：**
```ts
class myAbility extends Ability {
onForeground() {
console.log('onForeground');
}
}
```
## Ability.onBackground
onBackground(): void;
Ability生命周期回调，当应用从前台转到后台时触发。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例：**
```ts
class myAbility extends Ability {
onBackground() {
console.log('onBackground');
}
}
```
## Ability.onContinue
onContinue(wantParam : {[key: string]: any}): AbilityConstant.OnContinueResult;
当ability迁移准备迁移时触发，保存数据。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wantParam | {[key:&nbsp;string]:&nbsp;any} | 是 | want相关参数。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| AbilityConstant.OnContinueResult | 继续的结果。 |
**示例：**
```ts
import AbilityConstant from "@ohos.application.AbilityConstant"
class myAbility extends Ability {
onContinue(wantParams) {
console.log('onContinue');
wantParams["myData"] = "my1234567";
return AbilityConstant.OnContinueResult.AGREE;
}
}
```
## Ability.onNewWant
onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void;
当ability的启动模式设置为单例时回调会被调用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | Want类型参数，如ability名称，包名等。 |
| launchParams | AbilityConstant.LaunchParam | 是 | Ability启动的原因、上次异常退出的原因信息。 |
**示例：**
```ts
class myAbility extends Ability {
onNewWant(want) {
console.log('onNewWant, want:' + want.abilityName);
}
}
```
## Ability.dump
dump(params: Array\<string>): Array\<string>;
转储客户端信息时调用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| params | Array\<string> | 是 | 表示命令形式的参数。|
**示例：**
```ts
class myAbility extends Ability {
dump(params) {
console.log('dump, params:' + JSON.stringify(params));
return ["params"]
}
}
```
## Ability.onSaveState
onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: any}): AbilityConstant.OnSaveResult;
该API配合[appRecovery](js-apis-app-ability-appRecovery.md)使用。在应用故障时，如果使能了自动保存状态，框架将回调onSaveState保存Ability状态。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| reason | [AbilityConstant.StateType](js-apis-application-abilityConstant.md#abilityconstantstatetype) | 是 | 回调保存状态的原因。 |
| wantParam | {[key:&nbsp;string]:&nbsp;any} | 是 | want相关参数。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| AbilityConstant.OnSaveResult | 是否同意保存当前Ability的状态。 |
**示例：**
```ts
import AbilityConstant from '@ohos.application.AbilityConstant'
class myAbility extends Ability {
onSaveState(reason, wantParam) {
console.log('onSaveState');
wantParam["myData"] = "my1234567";
return AbilityConstant.OnSaveResult.RECOVERY_AGREE;
}
}
```
## Caller
通用组件Caller通信客户端调用接口, 用来向通用组件服务端发送约定数据。
## Caller.call
call(method: string, data: rpc.Sequenceable): Promise&lt;void&gt;;
向通用组件服务端发送约定序列化数据。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 约定的服务端注册事件字符串。 |
| data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | Promise形式返回应答。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16200001 | Caller released. The caller has been released. |
| 16200002 | Callee invalid. The callee does not exist. |
| 16000050 | Internal Error. |
**示例：**
```ts
import Ability from '@ohos.app.ability.UIAbility';
class MyMessageAble{ // 自定义的Sequenceable数据结构
name:""
str:""
num: 1
constructor(name, str) {
this.name = name;
this.str = str;
}
marshalling(messageParcel) {
messageParcel.writeInt(this.num);
messageParcel.writeString(this.str);
console.log('MyMessageAble marshalling num[' + this.num + '] str[' + this.str + ']');
return true;
}
unmarshalling(messageParcel) {
this.num = messageParcel.readInt();
this.str = messageParcel.readString();
console.log('MyMessageAble unmarshalling num[' + this.num + '] str[' + this.str + ']');
return true;
}
};
var method = 'call_Function'; // 约定的通知消息字符串
var caller;
export default class MainAbility extends Ability {
onWindowStageCreate(windowStage) {
this.context.startAbilityByCall({
bundleName: "com.example.myservice",
abilityName: "MainAbility",
deviceId: ""
}).then((obj) => {
caller = obj;
let msg = new MyMessageAble("msg", "world"); // 参考Sequenceable数据定义
caller.call(method, msg)
.then(() => {
console.log('Caller call() called');
})
.catch((callErr) => {
console.log('Caller.call catch error, error.code: ' + JSON.stringify(callErr.code) +
' error.message: ' + JSON.stringify(callErr.message));
});
}).catch((err) => {
console.log('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) +
' error.message: ' + JSON.stringify(err.message));
});
}
}
```
## Caller.callWithResult
callWithResult(method: string, data: rpc.Sequenceable): Promise&lt;rpc.MessageParcel&gt;;
向通用组件服务端发送约定序列化数据, 并将服务端返回的约定序列化数据带回。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 约定的服务端注册事件字符串。 |
| data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;rpc.MessageParcel&gt; | Promise形式返回通用组件服务端应答数据。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16200001 | Caller released. The caller has been released. |
| 16200002 | Callee invalid. The callee does not exist. |
| 16000050 | Internal Error. |
**示例：**
```ts
import Ability from '@ohos.app.ability.UIAbility';
class MyMessageAble{
name:""
str:""
num: 1
constructor(name, str) {
this.name = name;
this.str = str;
}
marshalling(messageParcel) {
messageParcel.writeInt(this.num);
messageParcel.writeString(this.str);
console.log('MyMessageAble marshalling num[' + this.num + '] str[' + this.str + ']');
return true;
}
unmarshalling(messageParcel) {
this.num = messageParcel.readInt();
this.str = messageParcel.readString();
console.log('MyMessageAble unmarshalling num[' + this.num + '] str[' + this.str + ']');
return true;
}
};
var method = 'call_Function';
var caller;
export default class MainAbility extends Ability {
onWindowStageCreate(windowStage) {
this.context.startAbilityByCall({
bundleName: "com.example.myservice",
abilityName: "MainAbility",
deviceId: ""
}).then((obj) => {
caller = obj;
let msg = new MyMessageAble(1, "world");
caller.callWithResult(method, msg)
.then((data) => {
console.log('Caller callWithResult() called');
let retmsg = new MyMessageAble(0, "");
data.readSequenceable(retmsg);
})
.catch((callErr) => {
console.log('Caller.callWithResult catch error, error.code: ' + JSON.stringify(callErr.code) +
' error.message: ' + JSON.stringify(callErr.message));
});
}).catch((err) => {
console.log('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) +
' error.message: ' + JSON.stringify(err.message));
});
}
}
```
## Caller.release
release(): void;
主动释放通用组件服务端的通信接口。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
| 16200001 | Caller released. The caller has been released. |
| 16200002 | Callee invalid. The callee does not exist. |
| 16000050 | Internal Error. |
**示例：**
```ts
import Ability from '@ohos.app.ability.UIAbility';
var caller;
export default class MainAbility extends Ability {
onWindowStageCreate(windowStage) {
this.context.startAbilityByCall({
bundleName: "com.example.myservice",
abilityName: "MainAbility",
deviceId: ""
}).then((obj) => {
caller = obj;
try {
caller.release();
} catch (releaseErr) {
console.log('Caller.release catch error, error.code: ' + JSON.stringify(releaseErr.code) +
' error.message: ' + JSON.stringify(releaseErr.message));
}
}).catch((err) => {
console.log('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) +
' error.message: ' + JSON.stringify(err.message));
});
}
}
```
## Caller.on
on(type: "release", callback: OnReleaseCallback): void;
注册通用组件服务端Stub（桩）断开监听通知。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 监听releaseCall事件，固定为'release'。 |
| callback | OnReleaseCallBack | 是 | 返回onRelease回调结果。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
import Ability from '@ohos.app.ability.UIAbility';
var caller;
export default class MainAbility extends Ability {
onWindowStageCreate(windowStage) {
this.context.startAbilityByCall({
bundleName: "com.example.myservice",
abilityName: "MainAbility",
deviceId: ""
}).then((obj) => {
caller = obj;
try {
caller.on("release", (str) => {
console.log(' Caller OnRelease CallBack is called ' + str);
});
} catch (error) {
console.log('Caller.on 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));
});
}
}
```
## Callee
通用组件服务端注册和解除客户端caller通知送信的callback接口。
## Callee.on
on(method: string, callback: CalleeCallBack): void;
通用组件服务端注册消息通知callback。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 与客户端约定的通知消息字符串。 |
| callback | CalleeCallBack | 是 | 一个rpc.MessageParcel类型入参的js通知同步回调函数,&nbsp;回调函数至少要返回一个空的rpc.Sequenceable数据对象,&nbsp;其他视为函数执行错误。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
| 16200004 | Method registered. The method has registered. |
| 16000050 | Internal Error. |
**示例：**
```ts
import Ability from '@ohos.app.ability.UIAbility';
class MyMessageAble{
name:""
str:""
num: 1
constructor(name, str) {
this.name = name;
this.str = str;
}
marshalling(messageParcel) {
messageParcel.writeInt(this.num);
messageParcel.writeString(this.str);
console.log('MyMessageAble marshalling num[' + this.num + '] str[' + this.str + ']');
return true;
}
unmarshalling(messageParcel) {
this.num = messageParcel.readInt();
this.str = messageParcel.readString();
console.log('MyMessageAble unmarshalling num[' + this.num + '] str[' + this.str + ']');
return true;
}
};
var method = 'call_Function';
function funcCallBack(pdata) {
console.log('Callee funcCallBack is called ' + pdata);
let msg = new MyMessageAble("test", "");
pdata.readSequenceable(msg);
return new MyMessageAble("test1", "Callee test");
}
export default class MainAbility extends Ability {
onCreate(want, launchParam) {
console.log('Callee onCreate is called');
try {
this.callee.on(method, funcCallBack);
} catch (error) {
console.log('Callee.on catch error, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
}
}
}
```
## Callee.off
off(method: string): void;
解除通用组件服务端注册消息通知callback。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 已注册的通知事件字符串。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
| 16200005 | Method not registered. The method has not registered. |
| 16000050 | Internal Error. |
**示例：**
```ts
import Ability from '@ohos.app.ability.UIAbility';
var method = 'call_Function';
export default class MainAbility extends Ability {
onCreate(want, launchParam) {
console.log('Callee onCreate is called');
try {
this.callee.off(method);
} catch (error) {
console.log('Callee.off catch error, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
}
}
}
```
## OnReleaseCallback
(msg: string): void;
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| (msg: string) | function | 是 | 否 | 调用者注册的侦听器函数接口的原型。 |
## CalleeCallback
(indata: rpc.MessageParcel): rpc.Sequenceable;
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| (indata: rpc.MessageParcel) | rpc.Sequenceable | 是 | 否 | 被调用方注册的消息侦听器函数接口的原型。 |
zh-cn/application-dev/reference/apis/js-apis-app-ability-want.md 0 → 100644
浏览文件 @ 0612bb09
# Want
Want是对象间信息传递的载体, 可以用于应用组件间的信息传递。 Want的使用场景之一是作为startAbility的参数, 其包含了指定的启动目标, 以及启动时需携带的相关数据, 如bundleName和abilityName字段分别指明目标Ability所在应用的包名以及对应包内的Ability名称。当Ability A需要启动Ability B并传入一些数据时, 可使用Want作为载体将这些数据传递给Ability B。
> **说明：**
>
> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入类
```ts
import Want from '@ohos.app.ability.Want';
```
## 属性
**系统能力**：以下各项对应的系统能力均为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-ability-wantConstant.md#wantConstant.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 | 只读 | string | 否 | 表示待启动的Ability所属的模块（module）。 |
**示例：**
- 基础用法
```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)
})
```
- 通过自定字段传递数据, 以下为当前支持类型。
* 字符串（String）
```ts
let want = {
bundleName: "com.example.demo",
abilityName: "com.example.demo.MainAbility",
parameters: {
keyForString: "str",
},
}
```
* 数字（Number）
```ts
let want = {
bundleName: "com.example.demo",
abilityName: "com.example.demo.MainAbility",
parameters: {
keyForInt: 100,
keyForDouble: 99.99,
},
}
```
* 布尔（Boolean）
```ts
let want = {
bundleName: "com.example.demo",
abilityName: "com.example.demo.MainAbility",
parameters: {
keyForBool: true,
},
}
```
* 对象（Object）
```ts
let want = {
bundleName: "com.example.demo",
abilityName: "com.example.demo.MainAbility",
parameters: {
keyForObject: {
keyForObjectString: "str",
keyForObjectInt: -200,
keyForObjectDouble: 35.5,
keyForObjectBool: false,
},
},
}
```
* 数组（Array）
```ts
let want = {
bundleName: "com.example.demo",
abilityName: "com.example.demo.MainAbility",
parameters: {
keyForArrayString: ["str1", "str2", "str3"],
keyForArrayInt: [100, 200, 300, 400],
keyForArrayDouble: [0.1, 0.2],
keyForArrayObject: [{obj1: "aaa"}, {obj2: 100}],
},
}
```
* 文件描述符（FD）
```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-app-form-formbindingdata.md
浏览文件 @ 0612bb09
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
## 导入模块 ## 导入模块
``` ```ts
import formBindingData from '@ohos.app.form.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
``` ```
...@@ -47,7 +47,7 @@ createFormBindingData(obj?: Object | string): FormBindingData ...@@ -47,7 +47,7 @@ createFormBindingData(obj?: Object | string): FormBindingData
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import fileio from '@ohos.fileio'; import fileio from '@ohos.fileio';
let context=featureAbility.getContext(); let context=featureAbility.getContext();
......
zh-cn/application-dev/reference/apis/js-apis-app-form-formextensionability.md
浏览文件 @ 0612bb09
...@@ -9,7 +9,7 @@ FormExtensionAbility模块提供了卡片扩展相关接口。 ...@@ -9,7 +9,7 @@ FormExtensionAbility模块提供了卡片扩展相关接口。
## 导入模块 ## 导入模块
``` ```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
``` ```
...@@ -19,7 +19,7 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; ...@@ -19,7 +19,7 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------- | ------------------------------------------------------- | ---- | ---- | --------------------------------------------------- | | ------- | ------------------------------------------------------- | ---- | ---- | --------------------------------------------------- |
| context | [FormExtensionContext](js-apis-formextensioncontext.md) | 是 | 否 | FormExtensionAbility的上下文环境，继承自ExtensionContext。 | | context | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | 是 | 否 | FormExtensionAbility的上下文环境，继承自ExtensionContext。 |
## onAddForm ## onAddForm
...@@ -33,7 +33,7 @@ onAddForm(want: Want): formBindingData.FormBindingData ...@@ -33,7 +33,7 @@ onAddForm(want: Want): formBindingData.FormBindingData
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------------------------------- | ---- | ------------------------------------------------------------ | | ------ | -------------------------------------- | ---- | ------------------------------------------------------------ |
| want | [Want](js-apis-application-Want.md) | 是 | 当前ExtensionAbility相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理，以便后续更新和删除卡片。 | | want | [Want](js-apis-application-want.md) | 是 | 当前ExtensionAbility相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理，以便后续更新和删除卡片。 |
**返回值：** **返回值：**
...@@ -43,7 +43,7 @@ onAddForm(want: Want): formBindingData.FormBindingData ...@@ -43,7 +43,7 @@ onAddForm(want: Want): formBindingData.FormBindingData
**示例：** **示例：**
```js ```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onAddForm(want) { onAddForm(want) {
...@@ -74,7 +74,7 @@ onCastToNormalForm(formId: string): void ...@@ -74,7 +74,7 @@ onCastToNormalForm(formId: string): void
**示例：** **示例：**
```js ```ts
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onCastToNormalForm(formId) { onCastToNormalForm(formId) {
console.log('FormExtensionAbility onCastToNormalForm, formId:' + formId); console.log('FormExtensionAbility onCastToNormalForm, formId:' + formId);
...@@ -86,7 +86,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility { ...@@ -86,7 +86,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility {
onUpdateForm(formId: string): void onUpdateForm(formId: string): void
卡片提供方接收更新卡片的通知接口。获取最新数据后调用[FormExtensionContext](js-apis-formextensioncontext.md)的updateForm接口刷新卡片数据。 卡片提供方接收更新卡片的通知接口。获取最新数据后调用[FormExtensionContext](js-apis-inner-application-formExtensionContext.md)的updateForm接口刷新卡片数据。
**系统能力**：SystemCapability.Ability.Form **系统能力**：SystemCapability.Ability.Form
...@@ -98,7 +98,7 @@ onUpdateForm(formId: string): void ...@@ -98,7 +98,7 @@ onUpdateForm(formId: string): void
**示例：** **示例：**
```js ```ts
import formBindingData from '@ohos.app.form.formBindingData' import formBindingData from '@ohos.app.form.formBindingData'
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onUpdateForm(formId) { onUpdateForm(formId) {
...@@ -128,7 +128,7 @@ onChangeFormVisibility(newStatus: { [key: string]: number }): void ...@@ -128,7 +128,7 @@ onChangeFormVisibility(newStatus: { [key: string]: number }): void
**示例：** **示例：**
```js ```ts
import formBindingData from '@ohos.app.form.formBindingData' import formBindingData from '@ohos.app.form.formBindingData'
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onChangeFormVisibility(newStatus) { onChangeFormVisibility(newStatus) {
...@@ -163,7 +163,7 @@ onFormEvent(formId: string, message: string): void ...@@ -163,7 +163,7 @@ onFormEvent(formId: string, message: string): void
**示例：** **示例：**
```js ```ts
export default class MyFormExtension extends FormExtensionAbility { export default class MyFormExtension extends FormExtensionAbility {
onFormEvent(formId, message) { onFormEvent(formId, message) {
console.log('FormExtensionAbility onFormEvent, formId:' + formId + ", message:" + message); console.log('FormExtensionAbility onFormEvent, formId:' + formId + ", message:" + message);
...@@ -187,7 +187,7 @@ onRemoveForm(formId: string): void ...@@ -187,7 +187,7 @@ onRemoveForm(formId: string): void
**示例：** **示例：**
```js ```ts
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onRemoveForm(formId) { onRemoveForm(formId) {
console.log('FormExtensionAbility onRemoveForm, formId:' + formId); console.log('FormExtensionAbility onRemoveForm, formId:' + formId);
...@@ -211,7 +211,7 @@ onConfigurationUpdate(config: Configuration): void; ...@@ -211,7 +211,7 @@ onConfigurationUpdate(config: Configuration): void;
**示例：** **示例：**
```js ```ts
class MyFormExtensionAbility extends FormExtensionAbility { class MyFormExtensionAbility extends FormExtensionAbility {
onConfigurationUpdate(config) { onConfigurationUpdate(config) {
console.log('onConfigurationUpdate, config:' + JSON.stringify(config)); console.log('onConfigurationUpdate, config:' + JSON.stringify(config));
...@@ -231,11 +231,11 @@ onAcquireFormState?(want: Want): formInfo.FormState; ...@@ -231,11 +231,11 @@ onAcquireFormState?(want: Want): formInfo.FormState;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 否 | want表示获取卡片状态的描述。描述包括包名称、能力名称、模块名称、卡片名和卡片维度。 | | want | [Want](js-apis-application-want.md) | 否 | want表示获取卡片状态的描述。描述包括包名称、能力名称、模块名称、卡片名和卡片维度。 |
**示例：** **示例：**
```js ```ts
import formInfo from '@ohos.app.form.formInfo'; import formInfo from '@ohos.app.form.formInfo';
class MyFormExtensionAbility extends FormExtensionAbility { class MyFormExtensionAbility extends FormExtensionAbility {
onAcquireFormState(want) { onAcquireFormState(want) {
...@@ -269,7 +269,7 @@ onShareForm?(formId: string): { [key: string]: any } ...@@ -269,7 +269,7 @@ onShareForm?(formId: string): { [key: string]: any }
**示例：** **示例：**
```js ```ts
class MyFormExtensionAbility extends FormExtensionAbility { class MyFormExtensionAbility extends FormExtensionAbility {
onShareForm(formId) { onShareForm(formId) {
console.log('FormExtensionAbility onShareForm, formId:' + formId); console.log('FormExtensionAbility onShareForm, formId:' + formId);
......
zh-cn/application-dev/reference/apis/js-apis-app-form-formhost.md
浏览文件 @ 0612bb09
...@@ -9,7 +9,7 @@ FormHost模块提供了卡片使用方相关接口的能力，包括对使用方 ...@@ -9,7 +9,7 @@ FormHost模块提供了卡片使用方相关接口的能力，包括对使用方
## 导入模块 ## 导入模块
``` ```ts
import formHost from '@ohos.app.form.formHost'; import formHost from '@ohos.app.form.formHost';
``` ```
...@@ -40,7 +40,7 @@ deleteForm(formId: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -40,7 +40,7 @@ deleteForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
**示例：** **示例：**
```js ```ts
try { try {
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.deleteForm(formId, (error, data) => { formHost.deleteForm(formId, (error, data) => {
...@@ -89,7 +89,7 @@ deleteForm(formId: string): Promise&lt;void&gt; ...@@ -89,7 +89,7 @@ deleteForm(formId: string): Promise&lt;void&gt;
**参数：** **参数：**
```js ```ts
try { try {
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.deleteForm(formId).then(() => { formHost.deleteForm(formId).then(() => {
...@@ -129,7 +129,7 @@ releaseForm(formId: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -129,7 +129,7 @@ releaseForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
**示例：** **示例：**
```js ```ts
try { try {
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.releaseForm(formId, (error, data) => { formHost.releaseForm(formId, (error, data) => {
...@@ -170,7 +170,7 @@ releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback&lt; ...@@ -170,7 +170,7 @@ releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback&lt;
**示例：** **示例：**
```js ```ts
try { try {
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.releaseForm(formId, true, (error, data) => { formHost.releaseForm(formId, true, (error, data) => {
...@@ -216,7 +216,7 @@ releaseForm(formId: string, isReleaseCache?: boolean): Promise&lt;void&gt; ...@@ -216,7 +216,7 @@ releaseForm(formId: string, isReleaseCache?: boolean): Promise&lt;void&gt;
**示例：** **示例：**
```js ```ts
try { try {
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.releaseForm(formId, true).then(() => { formHost.releaseForm(formId, true).then(() => {
...@@ -256,7 +256,7 @@ requestForm(formId: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -256,7 +256,7 @@ requestForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
**示例：** **示例：**
```js ```ts
try { try {
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.requestForm(formId, (error, data) => { formHost.requestForm(formId, (error, data) => {
...@@ -301,7 +301,7 @@ requestForm(formId: string): Promise&lt;void&gt; ...@@ -301,7 +301,7 @@ requestForm(formId: string): Promise&lt;void&gt;
**示例：** **示例：**
```js ```ts
try { try {
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.requestForm(formId).then(() => { formHost.requestForm(formId).then(() => {
...@@ -342,7 +342,7 @@ castTempForm(formId: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -342,7 +342,7 @@ castTempForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
**示例：** **示例：**
```js ```ts
try { try {
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.castTempForm(formId, (error, data) => { formHost.castTempForm(formId, (error, data) => {
...@@ -387,7 +387,7 @@ castTempForm(formId: string): Promise&lt;void&gt; ...@@ -387,7 +387,7 @@ castTempForm(formId: string): Promise&lt;void&gt;
**示例：** **示例：**
```js ```ts
try { try {
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.castTempForm(formId).then(() => { formHost.castTempForm(formId).then(() => {
...@@ -426,7 +426,7 @@ notifyVisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void ...@@ -426,7 +426,7 @@ notifyVisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void
**示例：** **示例：**
```js ```ts
try { try {
var formId = ["12400633174999288"]; var formId = ["12400633174999288"];
formHost.notifyVisibleForms(formId, (error, data) => { formHost.notifyVisibleForms(formId, (error, data) => {
...@@ -470,7 +470,7 @@ notifyVisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt; ...@@ -470,7 +470,7 @@ notifyVisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
**示例：** **示例：**
```js ```ts
try { try {
var formId = ["12400633174999288"]; var formId = ["12400633174999288"];
formHost.notifyVisibleForms(formId).then(() => { formHost.notifyVisibleForms(formId).then(() => {
...@@ -509,7 +509,7 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;vo ...@@ -509,7 +509,7 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;vo
**示例：** **示例：**
```js ```ts
try { try {
var formId = ["12400633174999288"]; var formId = ["12400633174999288"];
formHost.notifyInvisibleForms(formId, (error, data) => { formHost.notifyInvisibleForms(formId, (error, data) => {
...@@ -553,7 +553,7 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt; ...@@ -553,7 +553,7 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
**示例：** **示例：**
```js ```ts
try { try {
var formId = ["12400633174999288"]; var formId = ["12400633174999288"];
formHost.notifyInvisibleForms(formId).then(() => { formHost.notifyInvisibleForms(formId).then(() => {
...@@ -593,7 +593,7 @@ enableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void& ...@@ -593,7 +593,7 @@ enableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void&
**示例：** **示例：**
```js ```ts
try { try {
var formId = ["12400633174999288"]; var formId = ["12400633174999288"];
formHost.enableFormsUpdate(formId, (error, data) => { formHost.enableFormsUpdate(formId, (error, data) => {
...@@ -638,7 +638,7 @@ enableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt; ...@@ -638,7 +638,7 @@ enableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
**示例：** **示例：**
```js ```ts
try { try {
var formId = ["12400633174999288"]; var formId = ["12400633174999288"];
formHost.enableFormsUpdate(formId).then(() => { formHost.enableFormsUpdate(formId).then(() => {
...@@ -678,7 +678,7 @@ disableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void ...@@ -678,7 +678,7 @@ disableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void
**示例：** **示例：**
```js ```ts
try { try {
var formId = ["12400633174999288"]; var formId = ["12400633174999288"];
formHost.disableFormsUpdate(formId, (error, data) => { formHost.disableFormsUpdate(formId, (error, data) => {
...@@ -723,7 +723,7 @@ disableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt; ...@@ -723,7 +723,7 @@ disableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
**示例：** **示例：**
```js ```ts
try { try {
var formId = ["12400633174999288"]; var formId = ["12400633174999288"];
formHost.disableFormsUpdate(formId).then(() => { formHost.disableFormsUpdate(formId).then(() => {
...@@ -752,7 +752,7 @@ isSystemReady(callback: AsyncCallback&lt;void&gt;): void ...@@ -752,7 +752,7 @@ isSystemReady(callback: AsyncCallback&lt;void&gt;): void
**示例：** **示例：**
```js ```ts
try { try {
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.isSystemReady((error, data) => { formHost.isSystemReady((error, data) => {
...@@ -781,7 +781,7 @@ isSystemReady(): Promise&lt;void&gt; ...@@ -781,7 +781,7 @@ isSystemReady(): Promise&lt;void&gt;
**示例：** **示例：**
```js ```ts
try { try {
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.isSystemReady().then(() => { formHost.isSystemReady().then(() => {
...@@ -808,11 +808,11 @@ getAllFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): ...@@ -808,11 +808,11 @@ getAllFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;):
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](./js-apis-formInfo.md#forminfo-1)&gt;&gt; | 是 | 回调函数。当获取设备上所有应用提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 | | callback | AsyncCallback&lt;Array&lt;[FormInfo](js-apis-app-form-forminfo.md)&gt;&gt; | 是 | 回调函数。当获取设备上所有应用提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 |
**示例：** **示例：**
```js ```ts
try { try {
formHost.getAllFormsInfo((error, data) => { formHost.getAllFormsInfo((error, data) => {
if (error) { if (error) {
...@@ -840,11 +840,11 @@ getAllFormsInfo(): Promise&lt;Array&lt;formInfo.FormInfo&gt;&gt; ...@@ -840,11 +840,11 @@ getAllFormsInfo(): Promise&lt;Array&lt;formInfo.FormInfo&gt;&gt;
| 类型 | 说明 | | 类型 | 说明 |
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise&lt;Array&lt;[FormInfo](./js-apis-formInfo.md#forminfo-1)&gt;&gt; | Promise对象，返回查询到的卡片信息。 | | Promise&lt;Array&lt;[FormInfo](js-apis-app-form-forminfo.md)&gt;&gt; | Promise对象，返回查询到的卡片信息。 |
**示例：** **示例：**
```js ```ts
try { try {
formHost.getAllFormsInfo().then((data) => { formHost.getAllFormsInfo().then((data) => {
console.log('formHost getAllFormsInfo data:' + JSON.stringify(data)); console.log('formHost getAllFormsInfo data:' + JSON.stringify(data));
...@@ -871,7 +871,7 @@ getFormsInfo(bundleName: string, callback: AsyncCallback&lt;Array&lt;formInfo.Fo ...@@ -871,7 +871,7 @@ getFormsInfo(bundleName: string, callback: AsyncCallback&lt;Array&lt;formInfo.Fo
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| bundleName | string | 是 | 要查询的应用程序包名称。 | | bundleName | string | 是 | 要查询的应用程序包名称。 |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](./js-apis-formInfo.md#forminfo-1)&gt;&gt; | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 | | callback | AsyncCallback&lt;Array&lt;[FormInfo](js-apis-app-form-forminfo.md)&gt;&gt; | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 |
**错误码：** **错误码：**
...@@ -882,7 +882,7 @@ getFormsInfo(bundleName: string, callback: AsyncCallback&lt;Array&lt;formInfo.Fo ...@@ -882,7 +882,7 @@ getFormsInfo(bundleName: string, callback: AsyncCallback&lt;Array&lt;formInfo.Fo
**示例：** **示例：**
```js ```ts
try { try {
formHost.getFormsInfo("com.example.ohos.formjsdemo", (error, data) => { formHost.getFormsInfo("com.example.ohos.formjsdemo", (error, data) => {
if (error) { if (error) {
...@@ -912,7 +912,7 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback&lt; ...@@ -912,7 +912,7 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback&lt;
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| bundleName | string | 是 | 要查询的应用程序包名称。 | | bundleName | string | 是 | 要查询的应用程序包名称。 |
| moduleName | string | 是 | 要查询的模块名称。 | | moduleName | string | 是 | 要查询的模块名称。 |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](./js-apis-formInfo.md#forminfo-1)&gt;&gt; | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 | | callback | AsyncCallback&lt;Array&lt;[FormInfo](js-apis-app-form-forminfo.md)&gt;&gt; | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 |
**错误码：** **错误码：**
...@@ -923,7 +923,7 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback&lt; ...@@ -923,7 +923,7 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback&lt;
**示例：** **示例：**
```js ```ts
try { try {
formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry", (error, data) => { formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry", (error, data) => {
if (error) { if (error) {
...@@ -958,7 +958,7 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise&lt;Array&lt;formI ...@@ -958,7 +958,7 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise&lt;Array&lt;formI
| 类型 | 说明 | | 类型 | 说明 |
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise&lt;Array&lt;[FormInfo](./js-apis-formInfo.md#forminfo-1)&gt;&gt; | Promise对象，返回查询到的卡片信息。 | | Promise&lt;Array&lt;[FormInfo](js-apis-app-form-forminfo.md)&gt;&gt; | Promise对象，返回查询到的卡片信息。 |
**错误码：** **错误码：**
...@@ -969,7 +969,7 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise&lt;Array&lt;formI ...@@ -969,7 +969,7 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise&lt;Array&lt;formI
**示例：** **示例：**
```js ```ts
try { try {
formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry").then((data) => { formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry").then((data) => {
console.log('formHost getFormsInfo, data:' + JSON.stringify(data)); console.log('formHost getFormsInfo, data:' + JSON.stringify(data));
...@@ -1000,7 +1000,7 @@ deleteInvalidForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;numb ...@@ -1000,7 +1000,7 @@ deleteInvalidForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;numb
**示例：** **示例：**
```js ```ts
try { try {
var formIds = new Array("12400633174999288", "12400633174999289"); var formIds = new Array("12400633174999288", "12400633174999289");
formHost.deleteInvalidForms(formIds, (error, data) => { formHost.deleteInvalidForms(formIds, (error, data) => {
...@@ -1039,7 +1039,7 @@ deleteInvalidForms(formIds: Array&lt;string&gt;): Promise&lt;number&gt; ...@@ -1039,7 +1039,7 @@ deleteInvalidForms(formIds: Array&lt;string&gt;): Promise&lt;number&gt;
**示例：** **示例：**
```js ```ts
try { try {
var formIds = new Array("12400633174999288", "12400633174999289"); var formIds = new Array("12400633174999288", "12400633174999289");
formHost.deleteInvalidForms(formIds).then((data) => { formHost.deleteInvalidForms(formIds).then((data) => {
...@@ -1066,8 +1066,8 @@ acquireFormState(want: Want, callback: AsyncCallback&lt;formInfo.FormStateInfo&g ...@@ -1066,8 +1066,8 @@ acquireFormState(want: Want, callback: AsyncCallback&lt;formInfo.FormStateInfo&g
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| want | [Want](js-apis-application-Want.md) | 是 | 查询卡片状态时携带的want信息。 | | want | [Want](js-apis-application-want.md) | 是 | 查询卡片状态时携带的want信息。 |
| callback | AsyncCallback&lt;[FormStateInfo](js-apis-formInfo.md#formstateinfo)&gt; | 是 | 回调函数。当获取卡片状态成功，err为undefined，data为获取到的卡片状态；否则为错误对象。 | | callback | AsyncCallback&lt;[FormStateInfo](js-apis-app-form-forminfo.md#formstateinfo)&gt; | 是 | 回调函数。当获取卡片状态成功，err为undefined，data为获取到的卡片状态；否则为错误对象。 |
**错误码：** **错误码：**
...@@ -1078,7 +1078,7 @@ acquireFormState(want: Want, callback: AsyncCallback&lt;formInfo.FormStateInfo&g ...@@ -1078,7 +1078,7 @@ acquireFormState(want: Want, callback: AsyncCallback&lt;formInfo.FormStateInfo&g
**示例：** **示例：**
```js ```ts
var want = { var want = {
"deviceId": "", "deviceId": "",
"bundleName": "ohos.samples.FormApplication", "bundleName": "ohos.samples.FormApplication",
...@@ -1116,13 +1116,13 @@ acquireFormState(want: Want): Promise&lt;formInfo.FormStateInfo&gt; ...@@ -1116,13 +1116,13 @@ acquireFormState(want: Want): Promise&lt;formInfo.FormStateInfo&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| want | [Want](js-apis-application-Want.md) | 是 | 查询卡片状态时携带的want信息。 | | want | [Want](js-apis-application-want.md) | 是 | 查询卡片状态时携带的want信息。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise&lt;[FormStateInfo](js-apis-formInfo.md#formstateinfo)&gt; | Promise对象，返回卡片状态。 | | Promise&lt;[FormStateInfo](js-apis-app-form-forminfo.md#formstateinfo)&gt; | Promise对象，返回卡片状态。 |
**错误码：** **错误码：**
...@@ -1133,7 +1133,7 @@ acquireFormState(want: Want): Promise&lt;formInfo.FormStateInfo&gt; ...@@ -1133,7 +1133,7 @@ acquireFormState(want: Want): Promise&lt;formInfo.FormStateInfo&gt;
**示例：** **示例：**
```js ```ts
var want = { var want = {
"deviceId": "", "deviceId": "",
"bundleName": "ohos.samples.FormApplication", "bundleName": "ohos.samples.FormApplication",
...@@ -1172,7 +1172,7 @@ on(type: "formUninstall", callback: Callback&lt;string&gt;): void ...@@ -1172,7 +1172,7 @@ on(type: "formUninstall", callback: Callback&lt;string&gt;): void
**示例：** **示例：**
```js ```ts
let callback = function(formId) { let callback = function(formId) {
console.log('formHost on formUninstall, formId:' + formId); console.log('formHost on formUninstall, formId:' + formId);
} }
...@@ -1196,7 +1196,7 @@ off(type: "formUninstall", callback?: Callback&lt;string&gt;): void ...@@ -1196,7 +1196,7 @@ off(type: "formUninstall", callback?: Callback&lt;string&gt;): void
**示例：** **示例：**
```js ```ts
let callback = function(formId) { let callback = function(formId) {
console.log('formHost on formUninstall, formId:' + formId); console.log('formHost on formUninstall, formId:' + formId);
} }
...@@ -1230,7 +1230,7 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean, callback: A ...@@ -1230,7 +1230,7 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean, callback: A
**示例：** **示例：**
```js ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); var formIds = new Array("12400633174999288", "12400633174999289");
try { try {
formHost.notifyFormsVisible(formIds, true, (error, data) => { formHost.notifyFormsVisible(formIds, true, (error, data) => {
...@@ -1275,7 +1275,7 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean): Promise&lt ...@@ -1275,7 +1275,7 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean): Promise&lt
**示例：** **示例：**
```js ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); var formIds = new Array("12400633174999288", "12400633174999289");
try { try {
formHost.notifyFormsVisible(formIds, true).then(() => { formHost.notifyFormsVisible(formIds, true).then(() => {
...@@ -1315,7 +1315,7 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean, c ...@@ -1315,7 +1315,7 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean, c
**示例：** **示例：**
```js ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); var formIds = new Array("12400633174999288", "12400633174999289");
try { try {
formHost.notifyFormsEnableUpdate(formIds, true, (error, data) => { formHost.notifyFormsEnableUpdate(formIds, true, (error, data) => {
...@@ -1360,7 +1360,7 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean): ...@@ -1360,7 +1360,7 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean):
**示例：** **示例：**
```js ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); var formIds = new Array("12400633174999288", "12400633174999289");
try { try {
formHost.notifyFormsEnableUpdate(formIds, true).then(() => { formHost.notifyFormsEnableUpdate(formIds, true).then(() => {
...@@ -1401,7 +1401,7 @@ shareForm(formId: string, deviceId: string, callback: AsyncCallback&lt;void&gt;) ...@@ -1401,7 +1401,7 @@ shareForm(formId: string, deviceId: string, callback: AsyncCallback&lt;void&gt;)
**示例：** **示例：**
```js ```ts
var formId = "12400633174999288"; var formId = "12400633174999288";
var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2"; var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2";
try { try {
...@@ -1448,7 +1448,7 @@ shareForm(formId: string, deviceId: string): Promise&lt;void&gt; ...@@ -1448,7 +1448,7 @@ shareForm(formId: string, deviceId: string): Promise&lt;void&gt;
**参数：** **参数：**
```js ```ts
var formId = "12400633174999288"; var formId = "12400633174999288";
var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2"; var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2";
try { try {
...@@ -1477,7 +1477,7 @@ notifyFormsPrivacyProtected(formIds: Array<string>, isProtected: boolean, callba ...@@ -1477,7 +1477,7 @@ notifyFormsPrivacyProtected(formIds: Array<string>, isProtected: boolean, callba
| formId | string | 是 | 卡片标识。 | | formId | string | 是 | 卡片标识。 |
| deviceId | string | 是 | 远程设备标识。 | | deviceId | string | 是 | 远程设备标识。 |
```js ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); var formIds = new Array("12400633174999288", "12400633174999289");
try { try {
formHost.notifyFormsPrivacyProtected(formIds, true).then(() => { formHost.notifyFormsPrivacyProtected(formIds, true).then(() => {
......
zh-cn/application-dev/reference/apis/js-apis-app-form-forminfo.md
浏览文件 @ 0612bb09
...@@ -8,7 +8,7 @@ FormInfo模块提供对卡片的相关卡片信息和状态进行设置和查询 ...@@ -8,7 +8,7 @@ FormInfo模块提供对卡片的相关卡片信息和状态进行设置和查询
## 导入模块 ## 导入模块
``` ```ts
import formInfo from '@ohos.app.form.formInfo'; import formInfo from '@ohos.app.form.formInfo';
``` ```
......
zh-cn/application-dev/reference/apis/js-apis-app-form-formprovider.md
浏览文件 @ 0612bb09
...@@ -7,7 +7,7 @@ FormProvider模块提供了卡片提供方相关接口的能力，开发者在 ...@@ -7,7 +7,7 @@ FormProvider模块提供了卡片提供方相关接口的能力，开发者在
## 导入模块 ## 导入模块
``` ```ts
import formProvider from '@ohos.app.form.formProvider'; import formProvider from '@ohos.app.form.formProvider';
``` ```
...@@ -37,7 +37,7 @@ setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback&l ...@@ -37,7 +37,7 @@ setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback&l
**示例：** **示例：**
```js ```ts
var formId = "12400633174999288"; var formId = "12400633174999288";
try { try {
formProvider.setFormNextRefreshTime(formId, 5, (error, data) => { formProvider.setFormNextRefreshTime(formId, 5, (error, data) => {
...@@ -85,7 +85,7 @@ setFormNextRefreshTime(formId: string, minute: number): Promise&lt;void&gt; ...@@ -85,7 +85,7 @@ setFormNextRefreshTime(formId: string, minute: number): Promise&lt;void&gt;
**示例：** **示例：**
```js ```ts
var formId = "12400633174999288"; var formId = "12400633174999288";
try { try {
formProvider.setFormNextRefreshTime(formId, 5).then(() => { formProvider.setFormNextRefreshTime(formId, 5).then(() => {
...@@ -111,7 +111,7 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData,call ...@@ -111,7 +111,7 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData,call
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------------------------------------------------------------------- | ---- | ---------------- | | ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
| formId | string | 是 | 请求更新的卡片标识。 | | formId | string | 是 | 请求更新的卡片标识。 |
| formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据。 | | formBindingData | [FormBindingData](js-apis-app-form-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**错误码：** **错误码：**
...@@ -123,7 +123,7 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData,call ...@@ -123,7 +123,7 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData,call
**示例：** **示例：**
```js ```ts
import formBindingData from '@ohos.application.formBindingData'; import formBindingData from '@ohos.application.formBindingData';
var formId = "12400633174999288"; var formId = "12400633174999288";
try { try {
...@@ -153,7 +153,7 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr ...@@ -153,7 +153,7 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------------------------------------------------------------------- | ---- | ---------------- | | ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
| formId | string | 是 | 请求更新的卡片标识。 | | formId | string | 是 | 请求更新的卡片标识。 |
| formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据。 | | formBindingData | [FormBindingData](js-apis-app-form-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据。 |
**返回值：** **返回值：**
...@@ -170,7 +170,7 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr ...@@ -170,7 +170,7 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr
**示例：** **示例：**
```js ```ts
import formBindingData from '@ohos.application.formBindingData'; import formBindingData from '@ohos.application.formBindingData';
var formId = "12400633174999288"; var formId = "12400633174999288";
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
...@@ -197,7 +197,7 @@ getFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): voi ...@@ -197,7 +197,7 @@ getFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): voi
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](./js-apis-formInfo.md#forminfo-1)&gt;&gt; | 是 | 回调函数。返回查询到的卡片信息。 | | callback | AsyncCallback&lt;Array&lt;[FormInfo](js-apis-app-form-forminfo.md)&gt;&gt; | 是 | 回调函数。返回查询到的卡片信息。 |
**错误码：** **错误码：**
...@@ -209,7 +209,7 @@ getFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): voi ...@@ -209,7 +209,7 @@ getFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): voi
**示例：** **示例：**
```js ```ts
try { try {
formProvider.getFormsInfo((error, data) => { formProvider.getFormsInfo((error, data) => {
if (error) { if (error) {
...@@ -234,8 +234,8 @@ getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback&lt;Array&l ...@@ -234,8 +234,8 @@ getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback&lt;Array&l
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| filter | [formInfo.FormInfoFilter](./js-apis-formInfo.md#forminfofilter) | 是 | 卡片信息过滤器。 | | filter | [formInfo.FormInfoFilter](js-apis-app-form-forminfo.md#forminfofilter) | 是 | 卡片信息过滤器。 |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](./js-apis-formInfo.md#forminfo-1)&gt;&gt; | 是 | 回调函数。返回查询到符合条件的卡片信息。 | | callback | AsyncCallback&lt;Array&lt;[FormInfo](js-apis-app-form-forminfo.md)&gt;&gt; | 是 | 回调函数。返回查询到符合条件的卡片信息。 |
**错误码：** **错误码：**
...@@ -246,7 +246,7 @@ getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback&lt;Array&l ...@@ -246,7 +246,7 @@ getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback&lt;Array&l
**示例：** **示例：**
```js ```ts
import formInfo from '@ohos.application.formInfo'; import formInfo from '@ohos.application.formInfo';
const filter : formInfo.FormInfoFilter = { const filter : formInfo.FormInfoFilter = {
// get info of forms belong to module entry. // get info of forms belong to module entry.
...@@ -277,13 +277,13 @@ getFormsInfo(filter?: formInfo.FormInfoFilter): Promise&lt;Array&lt;formInfo.For ...@@ -277,13 +277,13 @@ getFormsInfo(filter?: formInfo.FormInfoFilter): Promise&lt;Array&lt;formInfo.For
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| filter | [formInfo.FormInfoFilter](./js-apis-formInfo.md) | 否 | 卡片信息过滤器。 | | filter | [formInfo.FormInfoFilter](js-apis-app-form-forminfo.md#forminfofilter) | 否 | 卡片信息过滤器。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise&lt;Array&lt;[FormInfo](./js-apis-formInfo.md#forminfo-1)&gt;&gt; | Promise对象。返回查询到符合条件的卡片信息。 | | Promise&lt;Array&lt;[FormInfo](js-apis-app-form-forminfo.md)&gt;&gt; | Promise对象。返回查询到符合条件的卡片信息。 |
**错误码：** **错误码：**
...@@ -294,7 +294,7 @@ getFormsInfo(filter?: formInfo.FormInfoFilter): Promise&lt;Array&lt;formInfo.For ...@@ -294,7 +294,7 @@ getFormsInfo(filter?: formInfo.FormInfoFilter): Promise&lt;Array&lt;formInfo.For
**示例：** **示例：**
```js ```ts
import formInfo from '@ohos.application.formInfo'; import formInfo from '@ohos.application.formInfo';
const filter : formInfo.FormInfoFilter = { const filter : formInfo.FormInfoFilter = {
// get info of forms belong to module entry. // get info of forms belong to module entry.
...@@ -325,8 +325,8 @@ requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData, ...@@ -325,8 +325,8 @@ requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData,
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------------------------------------------------------------------- | ---- | ---------------- | | ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
| want | [Want](js-apis-application-Want.md) | 是 | 发布请求。需包含以下字段。<br>abilityName: 目标卡片ability<br>parameters:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" | | want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。<br>abilityName: 目标卡片ability<br>parameters:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" |
| formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 创建卡片的数据。 | | formBindingData | [FormBindingData](js-apis-app-form-formbindingdata.md#formbindingdata) | 是 | 创建卡片的数据。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。返回卡片标识。 | | callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。返回卡片标识。 |
以下错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 以下错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。
...@@ -336,7 +336,7 @@ requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData, ...@@ -336,7 +336,7 @@ requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData,
**示例：** **示例：**
```js ```ts
import formBindingData from '@ohos.application.formBindingData'; import formBindingData from '@ohos.application.formBindingData';
var want = { var want = {
abilityName: "FormAbility", abilityName: "FormAbility",
...@@ -374,7 +374,7 @@ requestPublishForm(want: Want, callback: AsyncCallback&lt;string&gt;): void ...@@ -374,7 +374,7 @@ requestPublishForm(want: Want, callback: AsyncCallback&lt;string&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ----------------------------------- | ---- | ------------------------------------------------------------ |
| want | [Want](js-apis-application-Want.md) | 是 | 发布请求。需包含以下字段。<br>abilityName: 目标卡片ability<br>parameters:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" | | want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。<br>abilityName: 目标卡片ability<br>parameters:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。返回卡片标识。 | | callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。返回卡片标识。 |
以下错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 以下错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。
...@@ -384,7 +384,7 @@ requestPublishForm(want: Want, callback: AsyncCallback&lt;string&gt;): void ...@@ -384,7 +384,7 @@ requestPublishForm(want: Want, callback: AsyncCallback&lt;string&gt;): void
**示例：** **示例：**
```js ```ts
var want = { var want = {
abilityName: "FormAbility", abilityName: "FormAbility",
parameters: { parameters: {
...@@ -421,8 +421,8 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData ...@@ -421,8 +421,8 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | --------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| want | [Want](js-apis-application-Want.md) | 是 | 发布请求。需包含以下字段。<br>abilityName: 目标卡片ability<br>parameters:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" | | want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。<br>abilityName: 目标卡片ability<br>parameters:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" |
| formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 否 | 创建卡片的数据。 | | formBindingData | [FormBindingData](js-apis-app-form-formbindingdata.md#formbindingdata) | 否 | 创建卡片的数据。 |
**返回值：** **返回值：**
...@@ -437,7 +437,7 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData ...@@ -437,7 +437,7 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData
**示例：** **示例：**
```js ```ts
var want = { var want = {
abilityName: "FormAbility", abilityName: "FormAbility",
parameters: { parameters: {
...@@ -475,7 +475,7 @@ isRequestPublishFormSupported(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -475,7 +475,7 @@ isRequestPublishFormSupported(callback: AsyncCallback&lt;boolean&gt;): void
**示例：** **示例：**
```js ```ts
try { try {
formProvider.isRequestPublishFormSupported((error, isSupported) => { formProvider.isRequestPublishFormSupported((error, isSupported) => {
if (error) { if (error) {
...@@ -528,7 +528,7 @@ isRequestPublishFormSupported(): Promise&lt;boolean&gt; ...@@ -528,7 +528,7 @@ isRequestPublishFormSupported(): Promise&lt;boolean&gt;
**示例：** **示例：**
```js ```ts
try { try {
formProvider.isRequestPublishFormSupported().then((isSupported) => { formProvider.isRequestPublishFormSupported().then((isSupported) => {
if (isSupported) { if (isSupported) {
......
zh-cn/application-dev/reference/apis/js-apis-application-ability.md
浏览文件 @ 0612bb09
...@@ -14,7 +14,7 @@ Ability模块提供对Ability生命周期、上下文环境等调用管理的能 ...@@ -14,7 +14,7 @@ Ability模块提供对Ability生命周期、上下文环境等调用管理的能
## 导入模块 ## 导入模块
``` ```ts
import Ability from '@ohos.application.Ability'; import Ability from '@ohos.application.Ability';
``` ```
...@@ -22,11 +22,11 @@ import Ability from '@ohos.application.Ability'; ...@@ -22,11 +22,11 @@ import Ability from '@ohos.application.Ability';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.AbilityCore **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.AbilityCore
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| context | [AbilityContext](js-apis-ability-context.md) | 是 | 否 | 上下文。 | | context | [UIAbilityContext](js-apis-inner-application-uiAbilityContext.md) | 是 | 否 | 上下文。 |
| launchWant | [Want](js-apis-application-Want.md) | 是 | 否 | Ability启动时的参数。 | | launchWant | [Want](js-apis-app-ability-want.md) | 是 | 否 | Ability启动时的参数。 |
| lastRequestWant | [Want](js-apis-application-Want.md) | 是 | 否 | Ability最后请求时的参数。| | lastRequestWant | [Want](js-apis-app-ability-want.md) | 是 | 否 | Ability最后请求时的参数。|
| callee | [Callee](#callee) | 是 | 否 | 调用Stub（桩）服务对象。| | callee | [Callee](#callee) | 是 | 否 | 调用Stub（桩）服务对象。|
## Ability.onCreate ## Ability.onCreate
...@@ -41,7 +41,7 @@ Ability创建时回调，执行初始化业务逻辑操作。 ...@@ -41,7 +41,7 @@ Ability创建时回调，执行初始化业务逻辑操作。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 当前Ability的Want类型信息，包括ability名称、bundle名称等。 | | want | [Want](js-apis-app-ability-want.md) | 是 | 当前Ability的Want类型信息，包括ability名称、bundle名称等。 |
| param | AbilityConstant.LaunchParam | 是 | 创建&nbsp;ability、上次异常退出的原因信息。 | | param | AbilityConstant.LaunchParam | 是 | 创建&nbsp;ability、上次异常退出的原因信息。 |
**示例：** **示例：**
...@@ -227,7 +227,7 @@ onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void; ...@@ -227,7 +227,7 @@ onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | Want类型参数，如ability名称，包名等。 | | want | [Want](js-apis-application-want.md) | 是 | Want类型参数，如ability名称，包名等。 |
| launchParams | AbilityConstant.LaunchParam | 是 | Ability启动的原因、上次异常退出的原因信息。 | | launchParams | AbilityConstant.LaunchParam | 是 | Ability启动的原因、上次异常退出的原因信息。 |
**示例：** **示例：**
...@@ -240,31 +240,6 @@ onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void; ...@@ -240,31 +240,6 @@ onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void;
} }
``` ```
## Ability.onConfigurationUpdated
onConfigurationUpdated(config: Configuration): void;
当系统配置更新时调用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| config | [Configuration](js-apis-configuration.md) | 是 | 表示需要更新的配置信息。 |
**示例：**
```ts
class myAbility extends Ability {
onConfigurationUpdated(config) {
console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
}
}
```
## Ability.dump ## Ability.dump
dump(params: Array\<string>): Array\<string>; dump(params: Array\<string>): Array\<string>;
...@@ -290,30 +265,6 @@ dump(params: Array\<string>): Array\<string>; ...@@ -290,30 +265,6 @@ dump(params: Array\<string>): Array\<string>;
} }
``` ```
## Ability.onMemoryLevel
onMemoryLevel(level: AbilityConstant.MemoryLevel): void;
当系统已决定调整内存时调用。例如，当该功能在后台运行时，没有足够的内存来运行尽可能多的后台进程时可以使用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| level | [AbilityConstant.MemoryLevel](js-apis-application-abilityConstant.md#abilityconstantmemorylevel) | 是 | 回调返回内存微调级别，显示当前内存使用状态。|
**示例：**
```ts
class myAbility extends Ability {
onMemoryLevel(level) {
console.log('onMemoryLevel, level:' + JSON.stringify(level));
}
}
```
## Ability.onSaveState ## Ability.onSaveState
...@@ -338,7 +289,7 @@ onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: any}) ...@@ -338,7 +289,7 @@ onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: any})
**示例：** **示例：**
```js ```ts
import AbilityConstant from '@ohos.application.AbilityConstant' import AbilityConstant from '@ohos.application.AbilityConstant'
class myAbility extends Ability { class myAbility extends Ability {
...@@ -679,9 +630,9 @@ on(method: string, callback: CalleeCallBack): void; ...@@ -679,9 +630,9 @@ on(method: string, callback: CalleeCallBack): void;
var method = 'call_Function'; var method = 'call_Function';
function funcCallBack(pdata) { function funcCallBack(pdata) {
console.log('Callee funcCallBack is called ' + pdata); console.log('Callee funcCallBack is called ' + pdata);
let msg = new MyMessageAble(0, ""); let msg = new MyMessageAble("test", "");
pdata.readSequenceable(msg); pdata.readSequenceable(msg);
return new MyMessageAble(10, "Callee test"); return new MyMessageAble("test1", "Callee test");
} }
export default class MainAbility extends Ability { export default class MainAbility extends Ability {
onCreate(want, launchParam) { onCreate(want, launchParam) {
...@@ -743,7 +694,7 @@ off(method: string): void; ...@@ -743,7 +694,7 @@ off(method: string): void;
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore **系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| (msg: string) | function | 是 | 否 | 调用者注册的侦听器函数接口的原型。 | | (msg: string) | function | 是 | 否 | 调用者注册的侦听器函数接口的原型。 |
...@@ -753,6 +704,6 @@ off(method: string): void; ...@@ -753,6 +704,6 @@ off(method: string): void;
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore **系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| (indata: rpc.MessageParcel) | rpc.Sequenceable | 是 | 否 | 被调用方注册的消息侦听器函数接口的原型。 | | (indata: rpc.MessageParcel) | rpc.Sequenceable | 是 | 否 | 被调用方注册的消息侦听器函数接口的原型。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md
浏览文件 @ 0612bb09
...@@ -11,7 +11,7 @@ AbilityConstant提供启动参数的接口的能力，包括设置初次开始 ...@@ -11,7 +11,7 @@ AbilityConstant提供启动参数的接口的能力，包括设置初次开始
## 导入模块 ## 导入模块
```js ```ts
import AbilityConstant from '@ohos.application.AbilityConstant'; import AbilityConstant from '@ohos.application.AbilityConstant';
``` ```
......
zh-cn/application-dev/reference/apis/js-apis-abilityDelegatorRegistry.md → zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorRegistry.md
浏览文件 @ 0612bb09
# AbilityDelegatorRegistry # AbilityDelegatorRegistry
AbilityDelegatorRegistry模块提供用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力，包括获取应用程序的AbilityDelegator对象、获取单元测试参数AbilityDelegatorArgs对象。 AbilityDelegatorRegistry模块提供用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力，包括获取应用程序的AbilityDelegator对象、获取单元测试参数AbilityDelegatorArgs对象。
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
```js ```ts
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'
``` ```
## AbilityLifecycleState ## AbilityLifecycleState
Ability生命周期状态。 Ability生命周期状态。
**系统能力** ：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力** ：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ------------- | ---- | --------------------------- | | ------------- | ---- | --------------------------- |
| UNINITIALIZED | 0 | 表示无效状态。 | | UNINITIALIZED | 0 | 表示无效状态。 |
| CREATE | 1 | 表示Ability处于已创建状态。 | | CREATE | 1 | 表示Ability处于已创建状态。 |
| FOREGROUND | 2 | 表示Ability处于前台状态。 | | FOREGROUND | 2 | 表示Ability处于前台状态。 |
| BACKGROUND | 3 | 表示Ability处于后台状态。 | | BACKGROUND | 3 | 表示Ability处于后台状态。 |
| DESTROY | 4 | 表示Ability处于已销毁状态。 | | DESTROY | 4 | 表示Ability处于已销毁状态。 |
## AbilityDelegatorRegistry.getAbilityDelegator ## AbilityDelegatorRegistry.getAbilityDelegator
getAbilityDelegator(): AbilityDelegator getAbilityDelegator(): AbilityDelegator
获取应用程序的AbilityDelegator对象 获取应用程序的AbilityDelegator对象
**系统能力：** SystemCapability.Ability.AbilityRuntime.Core **系统能力：** SystemCapability.Ability.AbilityRuntime.Core
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------------------------ | ------------------------------------------------------------ | | ------------------------------------------------------------ | ------------------------------------------------------------ |
| [AbilityDelegator](js-apis-application-abilityDelegator.md#AbilityDelegator) | [AbilityDelegator](js-apis-application-abilityDelegator.md#AbilityDelegator)对象。可以用来调度测试框架相关功能。 | | [AbilityDelegator](js-apis-inner-application-abilityDelegator.md#AbilityDelegator) | [AbilityDelegator](js-apis-inner-application-abilityDelegator.md#AbilityDelegator)对象。可以用来调度测试框架相关功能。 |
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
``` ```
## AbilityDelegatorRegistry.getArguments
## AbilityDelegatorRegistry.getArguments getArguments(): AbilityDelegatorArgs
getArguments(): AbilityDelegatorArgs 获取单元测试参数AbilityDelegatorArgs对象
获取单元测试参数AbilityDelegatorArgs对象 **系统能力：** SystemCapability.Ability.AbilityRuntime.Core
**系统能力：** SystemCapability.Ability.AbilityRuntime.Core **返回值：**
**返回值：** | 类型 | 说明 |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| 类型 | 说明 | | [AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md#AbilityDelegatorArgs) | [AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md#AbilityDelegatorArgs)对象。可以用来获取测试参数。 |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| [AbilityDelegatorArgs](js-apis-application-abilityDelegatorArgs.md#AbilityDelegatorArgs) | [AbilityDelegatorArgs](js-apis-application-abilityDelegatorArgs.md#AbilityDelegatorArgs)对象。可以用来获取测试参数。 | **示例：**
**示例：** ```ts
var args = AbilityDelegatorRegistry.getArguments();
```js console.info("getArguments bundleName:" + args.bundleName);
var args = AbilityDelegatorRegistry.getArguments(); console.info("getArguments testCaseNames:" + args.testCaseNames);
console.info("getArguments bundleName:" + args.bundleName); console.info("getArguments testRunnerClassName:" + args.testRunnerClassName);
console.info("getArguments testCaseNames:" + args.testCaseNames); ```
console.info("getArguments testRunnerClassName:" + args.testRunnerClassName);
```
zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md
浏览文件 @ 0612bb09
...@@ -10,7 +10,7 @@ AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命 ...@@ -10,7 +10,7 @@ AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命
## 导入模块 ## 导入模块
```js ```ts
import AbilityLifecycleCallback from "@ohos.application.AbilityLifecycleCallback"; import AbilityLifecycleCallback from "@ohos.application.AbilityLifecycleCallback";
``` ```
...@@ -156,7 +156,7 @@ onAbilityContinue(ability: Ability): void; ...@@ -156,7 +156,7 @@ onAbilityContinue(ability: Ability): void;
**示例：** **示例：**
```js ```ts
import AbilityStage from "@ohos.application.AbilityStage"; import AbilityStage from "@ohos.application.AbilityStage";
var lifecycleid; var lifecycleid;
......
zh-cn/application-dev/reference/apis/js-apis-application-abilityManager.md
浏览文件 @ 0612bb09
...@@ -4,12 +4,12 @@ AbilityManager模块提供对Ability相关信息和状态信息进行获取、 ...@@ -4,12 +4,12 @@ AbilityManager模块提供对Ability相关信息和状态信息进行获取、
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 8开始支持, 从API version 9废弃，替换模块为[@ohos.app.ability.abilityManager](js-apis-app-ability-abilityManager.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口均为系统接口，三方应用不支持调用。 > 本模块接口均为系统接口，三方应用不支持调用。
## 导入模块 ## 导入模块
```js ```ts
import AbilityManager from '@ohos.application.abilityManager' import AbilityManager from '@ohos.application.abilityManager'
``` ```
...@@ -41,14 +41,14 @@ updateConfiguration(config: Configuration, callback: AsyncCallback\<void>): void ...@@ -41,14 +41,14 @@ updateConfiguration(config: Configuration, callback: AsyncCallback\<void>): void
**参数**： **参数**：
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 描述 |
| --------- | ---------------------------------------- | ---- | -------------- | | --------- | ---------------------------------------- | ---- | -------------- |
| config | [Configuration](js-apis-configuration.md) | 是 | 新的配置项。 | | config | [Configuration](js-apis-application-configuration.md) | 是 | 新的配置项。 |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法。 | | callback | AsyncCallback\<void> | 是 | 被指定的回调方法。 |
**示例**： **示例**：
```js ```ts
import abilitymanager from '@ohos.application.abilityManager'; import abilitymanager from '@ohos.application.abilityManager';
var config = { var config = {
...@@ -72,9 +72,9 @@ updateConfiguration(config: Configuration): Promise\<void> ...@@ -72,9 +72,9 @@ updateConfiguration(config: Configuration): Promise\<void>
**参数**： **参数**：
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 描述 |
| --------- | ---------------------------------------- | ---- | -------------- | | --------- | ---------------------------------------- | ---- | -------------- |
| config | [Configuration](js-apis-configuration.md) | 是 | 新的配置项。 | | config | [Configuration](js-apis-application-configuration.md) | 是 | 新的配置项。 |
**返回值：** **返回值：**
...@@ -84,7 +84,7 @@ updateConfiguration(config: Configuration): Promise\<void> ...@@ -84,7 +84,7 @@ updateConfiguration(config: Configuration): Promise\<void>
**示例**： **示例**：
```js ```ts
import abilitymanager from '@ohos.application.abilityManager'; import abilitymanager from '@ohos.application.abilityManager';
var config = { var config = {
...@@ -110,13 +110,13 @@ getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): vo ...@@ -110,13 +110,13 @@ getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): vo
**参数**： **参数**：
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 描述 |
| --------- | ---------------------------------------- | ---- | -------------- | | --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<Array\<AbilityRunningInfo>> | 是 | 被指定的回调方法。 | | callback | AsyncCallback\<Array\<AbilityRunningInfo>> | 是 | 被指定的回调方法。 |
**示例**： **示例**：
```js ```ts
import abilitymanager from '@ohos.application.abilityManager'; import abilitymanager from '@ohos.application.abilityManager';
abilitymanager.getAbilityRunningInfos((err,data) => { abilitymanager.getAbilityRunningInfos((err,data) => {
...@@ -142,7 +142,7 @@ getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>> ...@@ -142,7 +142,7 @@ getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>>
**示例**： **示例**：
```js ```ts
import abilitymanager from '@ohos.application.abilityManager'; import abilitymanager from '@ohos.application.abilityManager';
abilitymanager.getAbilityRunningInfos().then((data) => { abilitymanager.getAbilityRunningInfos().then((data) => {
...@@ -164,14 +164,14 @@ getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<Ext ...@@ -164,14 +164,14 @@ getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<Ext
**参数**： **参数**：
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 描述 |
| --------- | ---------------------------------------- | ---- | -------------- | | --------- | ---------------------------------------- | ---- | -------------- |
| upperLimit | number | 是 | 获取消息数量的最大限制。 | | upperLimit | number | 是 | 获取消息数量的最大限制。 |
| callback | AsyncCallback\<Array\<AbilityRunningInfo>> | 是 | 被指定的回调方法。 | | callback | AsyncCallback\<Array\<AbilityRunningInfo>> | 是 | 被指定的回调方法。 |
**示例**： **示例**：
```js ```ts
import abilitymanager from '@ohos.application.abilityManager'; import abilitymanager from '@ohos.application.abilityManager';
var upperLimit = 0; var upperLimit = 0;
...@@ -193,7 +193,7 @@ getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningIn ...@@ -193,7 +193,7 @@ getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningIn
**参数**： **参数**：
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 描述 |
| --------- | ---------------------------------------- | ---- | -------------- | | --------- | ---------------------------------------- | ---- | -------------- |
| upperLimit | number | 是 | 获取消息数量的最大限制。 | | upperLimit | number | 是 | 获取消息数量的最大限制。 |
...@@ -205,7 +205,7 @@ getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningIn ...@@ -205,7 +205,7 @@ getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningIn
**示例**： **示例**：
```js ```ts
import abilitymanager from '@ohos.application.abilityManager'; import abilitymanager from '@ohos.application.abilityManager';
var upperLimit = 0; var upperLimit = 0;
...@@ -227,13 +227,13 @@ getTopAbility(callback: AsyncCallback\<ElementName>): void; ...@@ -227,13 +227,13 @@ getTopAbility(callback: AsyncCallback\<ElementName>): void;
**参数**： **参数**：
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 描述 |
| --------- | ---------------------------------------- | ---- | -------------- | | --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<ElementName> | 是 | 被指定的回调方法。 | | callback | AsyncCallback\<ElementName> | 是 | 被指定的回调方法。 |
**示例**： **示例**：
```js ```ts
import abilitymanager from '@ohos.application.abilityManager'; import abilitymanager from '@ohos.application.abilityManager';
abilitymanager.getTopAbility((err,data) => { abilitymanager.getTopAbility((err,data) => {
...@@ -257,7 +257,7 @@ getTopAbility(): Promise\<ElementName>; ...@@ -257,7 +257,7 @@ getTopAbility(): Promise\<ElementName>;
**示例**： **示例**：
```js ```ts
import abilitymanager from '@ohos.application.abilityManager'; import abilitymanager from '@ohos.application.abilityManager';
abilitymanager.getTopAbility().then((data) => { abilitymanager.getTopAbility().then((data) => {
......
zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md → zh-cn/application-dev/reference/apis/js-apis-application-abilityStage.md
浏览文件 @ 0612bb09
...@@ -6,12 +6,12 @@ AbilityStage模块提供在HAP加载的时候，通知开发者，可以在此 ...@@ -6,12 +6,12 @@ AbilityStage模块提供在HAP加载的时候，通知开发者，可以在此
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 9 开始支持, 从API version 9废弃，替换模块为[@ohos.app.ability.AbilityStage](js-apis-app-ability-abilitystage.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9 开始支持, 从API version 9废弃，替换模块为[@ohos.app.ability.AbilityStage](js-apis-app-ability-abilityStage.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。 > 本模块接口仅可在Stage模型下使用。
## 导入模块 ## 导入模块
```js ```ts
import AbilityStage from '@ohos.application.AbilityStage'; import AbilityStage from '@ohos.application.AbilityStage';
``` ```
...@@ -25,7 +25,7 @@ onCreate(): void ...@@ -25,7 +25,7 @@ onCreate(): void
**示例：** **示例：**
```js ```ts
class MyAbilityStage extends AbilityStage { class MyAbilityStage extends AbilityStage {
onCreate() { onCreate() {
console.log("MyAbilityStage.onCreate is called") console.log("MyAbilityStage.onCreate is called")
...@@ -46,7 +46,7 @@ onAcceptWant(want: Want): string; ...@@ -46,7 +46,7 @@ onAcceptWant(want: Want): string;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | | want | [Want](js-apis-application-want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 |
**返回值：** **返回值：**
...@@ -56,7 +56,7 @@ onAcceptWant(want: Want): string; ...@@ -56,7 +56,7 @@ onAcceptWant(want: Want): string;
**示例：** **示例：**
```js ```ts
class MyAbilityStage extends AbilityStage { class MyAbilityStage extends AbilityStage {
onAcceptWant(want) { onAcceptWant(want) {
console.log("MyAbilityStage.onAcceptWant called"); console.log("MyAbilityStage.onAcceptWant called");
...@@ -78,11 +78,11 @@ onConfigurationUpdated(config: Configuration): void; ...@@ -78,11 +78,11 @@ onConfigurationUpdated(config: Configuration): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| config | [Configuration](js-apis-configuration.md) | 是 | 发生全局配置变更时触发回调，当前全局配置包括系统语言、深浅色模式。 | | config | [Configuration](js-apis-application-configuration.md) | 是 | 发生全局配置变更时触发回调，当前全局配置包括系统语言、深浅色模式。 |
**示例：** **示例：**
```js ```ts
class MyAbilityStage extends AbilityStage { class MyAbilityStage extends AbilityStage {
onConfigurationUpdated(config) { onConfigurationUpdated(config) {
console.log('onConfigurationUpdated, language:' + config.language); console.log('onConfigurationUpdated, language:' + config.language);
...@@ -106,7 +106,7 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void; ...@@ -106,7 +106,7 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void;
**示例：** **示例：**
```js ```ts
class MyAbilityStage extends AbilityStage { class MyAbilityStage extends AbilityStage {
onMemoryLevel(level) { onMemoryLevel(level) {
console.log('onMemoryLevel, level:' + JSON.stringify(level)); console.log('onMemoryLevel, level:' + JSON.stringify(level));
...@@ -124,4 +124,4 @@ context: AbilityStageContext; ...@@ -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-application-AccessibilityExtensionAbility.md → zh-cn/application-dev/reference/apis/js-apis-application-accessibilityExtensionAbility.md
浏览文件 @ 0612bb09
...@@ -5,8 +5,6 @@ ...@@ -5,8 +5,6 @@
>![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** >![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> >
>本模块首批接口从API version 9开始支持，后续版本的新增接口，采用上角标单独标记接口的起始版本。 >本模块首批接口从API version 9开始支持，后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
>本模块接口仅可在Stage模型下使用。
## 导入模块 ## 导入模块
...@@ -20,7 +18,7 @@ import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtens ...@@ -20,7 +18,7 @@ import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtens
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| --------- | -------- | ---- | ---- | ------------------------- | | --------- | -------- | ---- | ---- | ------------------------- |
| context | [AccessibilityExtensionContext](js-apis-accessibility-extension-context.md) | 是 | 否 | 表示辅助扩展能力上下文。 | | context | [AccessibilityExtensionContext](js-apis-inner-application-accessibilityExtensionContext.md) | 是 | 否 | 表示辅助扩展能力上下文。 |
## AccessibilityEvent ## AccessibilityEvent
......
zh-cn/application-dev/reference/apis/js-apis-appmanager.md → zh-cn/application-dev/reference/apis/js-apis-application-appManager.md
浏览文件 @ 0612bb09
...@@ -4,15 +4,15 @@ appManager模块提供App管理的能力，包括查询当前是否处于稳定 ...@@ -4,15 +4,15 @@ appManager模块提供App管理的能力，包括查询当前是否处于稳定
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 7 开始支持, 从API version 9废弃，替换模块为[@ohos.app.ability.appManager](js-apis-app-ability-appmanager.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
```js ```ts
import app from '@ohos.application.appManager'; import app from '@ohos.application.appManager';
``` ```
## appManager.isRunningInStabilityTest ## appManager.isRunningInStabilityTest<sup>8+</sup>
static isRunningInStabilityTest(callback: AsyncCallback&lt;boolean&gt;): void static isRunningInStabilityTest(callback: AsyncCallback&lt;boolean&gt;): void
...@@ -24,19 +24,19 @@ static isRunningInStabilityTest(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -24,19 +24,19 @@ static isRunningInStabilityTest(callback: AsyncCallback&lt;boolean&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 返回当前是否处于稳定性测试场景。 | | callback | AsyncCallback&lt;boolean&gt; | 否 | 返回当前是否处于稳定性测试场景。 |
**示例：** **示例：**
```js ```ts
import app from '@ohos.application.appManager'; import app from '@ohos.application.appManager';
app.isRunningInStabilityTest((err, flag) => { app.isRunningInStabilityTest((err, flag) => {
console.log('startAbility result:' + err.code + ', ' + err.message); console.log('startAbility result:' + JSON.stringify(err));
}) })
``` ```
## appManager.isRunningInStabilityTest ## appManager.isRunningInStabilityTest<sup>8+</sup>
static isRunningInStabilityTest(): Promise&lt;boolean&gt; static isRunningInStabilityTest(): Promise&lt;boolean&gt;
...@@ -52,8 +52,8 @@ static isRunningInStabilityTest(): Promise&lt;boolean&gt; ...@@ -52,8 +52,8 @@ static isRunningInStabilityTest(): Promise&lt;boolean&gt;
**示例：** **示例：**
```js ```ts
import app from '@ohos.app.ability.appManager'; import app from '@ohos.application.appManager';
app.isRunningInStabilityTest().then((flag) => { app.isRunningInStabilityTest().then((flag) => {
console.log('success:' + JSON.stringify(flag)); console.log('success:' + JSON.stringify(flag));
}).catch((error) => { }).catch((error) => {
...@@ -78,12 +78,12 @@ isRamConstrainedDevice(): Promise\<boolean>; ...@@ -78,12 +78,12 @@ isRamConstrainedDevice(): Promise\<boolean>;
**示例：** **示例：**
```js ```ts
app.isRamConstrainedDevice().then((data) => { app.isRamConstrainedDevice().then((data) => {
console.log('success:' + JSON.stringify(data)); console.log('success:' + JSON.stringify(data));
}).catch((error) => { }).catch((error) => {
console.log('failed:' + JSON.stringify(error)); console.log('failed:' + JSON.stringify(error));
}); });
``` ```
## appManager.isRamConstrainedDevice ## appManager.isRamConstrainedDevice
...@@ -98,15 +98,15 @@ isRamConstrainedDevice(callback: AsyncCallback\<boolean>): void; ...@@ -98,15 +98,15 @@ isRamConstrainedDevice(callback: AsyncCallback\<boolean>): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 返回当前是否是ram受限设备。 | | callback | AsyncCallback&lt;boolean&gt; | 否 | 返回当前是否是ram受限设备。 |
**示例：** **示例：**
```js ```ts
app.isRamConstrainedDevice((err, data) => { app.isRamConstrainedDevice((err, data) => {
console.log('startAbility result failed:' + JSON.stringify(err)); console.log('startAbility result failed:' + JSON.stringify(err));
console.log('startAbility result success:' + JSON.stringify(data)); console.log('startAbility result success:' + JSON.stringify(data));
}) })
``` ```
## appManager.getAppMemorySize ## appManager.getAppMemorySize
...@@ -125,12 +125,12 @@ getAppMemorySize(): Promise\<number>; ...@@ -125,12 +125,12 @@ getAppMemorySize(): Promise\<number>;
**示例：** **示例：**
```js ```ts
app.getAppMemorySize().then((data) => { app.getAppMemorySize().then((data) => {
console.log('success:' + JSON.stringify(data)); console.log('success:' + JSON.stringify(data));
}).catch((error) => { }).catch((error) => {
console.log('failed:' + JSON.stringify(error)); console.log('failed:' + JSON.stringify(error));
}); });
``` ```
## appManager.getAppMemorySize ## appManager.getAppMemorySize
...@@ -145,15 +145,15 @@ getAppMemorySize(callback: AsyncCallback\<number>): void; ...@@ -145,15 +145,15 @@ getAppMemorySize(callback: AsyncCallback\<number>): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 应用程序内存大小。 | | callback | AsyncCallback&lt;number&gt; | 否 | 应用程序内存大小。 |
**示例：** **示例：**
```js ```ts
app.getAppMemorySize((err, data) => { app.getAppMemorySize((err, data) => {
console.log('startAbility result failed :' + JSON.stringify(err)); console.log('startAbility result failed :' + JSON.stringify(err));
console.log('startAbility result success:' + JSON.stringify(data)); console.log('startAbility result success:' + JSON.stringify(data));
}) })
``` ```
## appManager.getProcessRunningInfos<sup>(deprecated)</sup> ## appManager.getProcessRunningInfos<sup>(deprecated)</sup>
...@@ -175,12 +175,12 @@ getProcessRunningInfos(): Promise\<Array\<ProcessRunningInfo>>; ...@@ -175,12 +175,12 @@ getProcessRunningInfos(): Promise\<Array\<ProcessRunningInfo>>;
**示例：** **示例：**
```js ```ts
app.getProcessRunningInfos().then((data) => { app.getProcessRunningInfos().then((data) => {
console.log('success:' + JSON.stringify(data)); console.log('success:' + JSON.stringify(data));
}).catch((error) => { }).catch((error) => {
console.log('failed:' + JSON.stringify(error)); console.log('failed:' + JSON.stringify(error));
}); });
``` ```
## appManager.getProcessRunningInfos<sup>(deprecated)</sup> ## appManager.getProcessRunningInfos<sup>(deprecated)</sup>
...@@ -199,15 +199,15 @@ getProcessRunningInfos(callback: AsyncCallback\<Array\<ProcessRunningInfo>>): vo ...@@ -199,15 +199,15 @@ getProcessRunningInfos(callback: AsyncCallback\<Array\<ProcessRunningInfo>>): vo
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback\<Array\<ProcessRunningInfo>> | 是 | 获取有关运行进程的信息。 | | callback | AsyncCallback\<Array\<ProcessRunningInfo>> | 否 | 获取有关运行进程的信息。 |
**示例：** **示例：**
```js ```ts
app.getProcessRunningInfos((err, data) => { app.getProcessRunningInfos((err, data) => {
console.log('startAbility result failed :' + JSON.stringify(err)); console.log('startAbility result failed :' + JSON.stringify(err));
console.log('startAbility result success:' + JSON.stringify(data)); console.log('startAbility result success:' + JSON.stringify(data));
}) })
``` ```
## appManager.getProcessRunningInformation<sup>9+</sup> ## appManager.getProcessRunningInformation<sup>9+</sup>
...@@ -224,16 +224,16 @@ getProcessRunningInformation(): Promise\<Array\<ProcessRunningInformation>>; ...@@ -224,16 +224,16 @@ getProcessRunningInformation(): Promise\<Array\<ProcessRunningInformation>>;
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise\<Array\<[ProcessRunningInformation](#processrunninginformation)>> | 获取有关运行进程的信息。 | | Promise\<Array\<[ProcessRunningInformation](js-apis-inner-application-processRunningInformation.md)>> | 获取有关运行进程的信息。 |
**示例：** **示例：**
```js ```ts
app.getProcessRunningInformation().then((data) => { app.getProcessRunningInformation().then((data) => {
console.log('success:' + JSON.stringify(data)); console.log('success:' + JSON.stringify(data));
}).catch((error) => { }).catch((error) => {
console.log('failed:' + JSON.stringify(error)); console.log('failed:' + JSON.stringify(error));
}); });
``` ```
## appManager.getProcessRunningInformation<sup>9+</sup> ## appManager.getProcessRunningInformation<sup>9+</sup>
...@@ -250,15 +250,15 @@ getProcessRunningInformation(callback: AsyncCallback\<Array\<ProcessRunningInfor ...@@ -250,15 +250,15 @@ getProcessRunningInformation(callback: AsyncCallback\<Array\<ProcessRunningInfor
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback\<Array\<[ProcessRunningInformation](#processrunninginformation)>> | 是 | 获取有关运行进程的信息。 | | callback | AsyncCallback\<Array\<[ProcessRunningInformation](js-apis-inner-application-processRunningInformation.md)>> | 否 | 获取有关运行进程的信息。 |
**示例：** **示例：**
```js ```ts
app.getProcessRunningInformation((err, data) => { app.getProcessRunningInformation((err, data) => {
console.log('startAbility result failed :' + JSON.stringify(err)); console.log('startAbility result failed :' + JSON.stringify(err));
console.log('startAbility result success:' + JSON.stringify(data)); console.log('startAbility result success:' + JSON.stringify(data));
}) })
``` ```
## appManager.registerApplicationStateObserver<sup>8+</sup> ## appManager.registerApplicationStateObserver<sup>8+</sup>
...@@ -277,11 +277,11 @@ registerApplicationStateObserver(observer: ApplicationStateObserver): number; ...@@ -277,11 +277,11 @@ registerApplicationStateObserver(observer: ApplicationStateObserver): number;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| observer | [ApplicationStateObserver](#applicationstateobserver) | 是 | 返回观察者的数字代码。 | | observer | [ApplicationStateObserver](js-apis-inner-application-applicationStateObserver.md) | 否 | 返回观察者的数字代码。 |
**示例：** **示例：**
```js ```ts
var applicationStateObserver = { var applicationStateObserver = {
onForegroundApplicationChanged(appStateData) { onForegroundApplicationChanged(appStateData) {
console.log('------------ onForegroundApplicationChanged -----------', appStateData); console.log('------------ onForegroundApplicationChanged -----------', appStateData);
...@@ -301,7 +301,6 @@ registerApplicationStateObserver(observer: ApplicationStateObserver): number; ...@@ -301,7 +301,6 @@ registerApplicationStateObserver(observer: ApplicationStateObserver): number;
} }
const observerCode = app.registerApplicationStateObserver(applicationStateObserver); const observerCode = app.registerApplicationStateObserver(applicationStateObserver);
console.log('-------- observerCode: ---------', observerCode); console.log('-------- observerCode: ---------', observerCode);
``` ```
## appManager.registerApplicationStateObserver<sup>9+</sup> ## appManager.registerApplicationStateObserver<sup>9+</sup>
...@@ -320,12 +319,12 @@ registerApplicationStateObserver(observer: ApplicationStateObserver, bundleNameL ...@@ -320,12 +319,12 @@ registerApplicationStateObserver(observer: ApplicationStateObserver, bundleNameL
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| observer | [ApplicationStateObserver](#applicationstateobserver) | 是 | 返回观察者的数字代码。 | | observer | [ApplicationStateObserver](js-apis-inner-application-applicationStateObserver.md) | 否 | 返回观察者的数字代码。 |
| bundleNameList | Array\<string> | 是 | 表示需要注册监听的bundleName数组。最大值128。 | | bundleNameList | Array<string> | 否 | 表示需要注册监听的bundleName数组。最大值128。 |
**示例：** **示例：**
```js ```ts
var applicationStateObserver = { var applicationStateObserver = {
onForegroundApplicationChanged(appStateData) { onForegroundApplicationChanged(appStateData) {
console.log('------------ onForegroundApplicationChanged -----------', appStateData); console.log('------------ onForegroundApplicationChanged -----------', appStateData);
...@@ -346,7 +345,6 @@ registerApplicationStateObserver(observer: ApplicationStateObserver, bundleNameL ...@@ -346,7 +345,6 @@ registerApplicationStateObserver(observer: ApplicationStateObserver, bundleNameL
var bundleNameList = ['bundleName1', 'bundleName2']; var bundleNameList = ['bundleName1', 'bundleName2'];
const observerCode = app.registerApplicationStateObserver(applicationStateObserver, bundleNameList); const observerCode = app.registerApplicationStateObserver(applicationStateObserver, bundleNameList);
console.log('-------- observerCode: ---------', observerCode); console.log('-------- observerCode: ---------', observerCode);
``` ```
## appManager.unregisterApplicationStateObserver<sup>8+</sup> ## appManager.unregisterApplicationStateObserver<sup>8+</sup>
...@@ -364,20 +362,20 @@ unregisterApplicationStateObserver(observerId: number, callback: AsyncCallback\ ...@@ -364,20 +362,20 @@ unregisterApplicationStateObserver(observerId: number, callback: AsyncCallback\
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| observerId | number | 是 | 表示观察者的编号代码。 | | observerId | number | 否 | 表示观察者的编号代码。 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法。 | | callback | AsyncCallback\<void> | 否 | 表示指定的回调方法。 |
**示例：** **示例：**
```js ```ts
var observerId = 100; var observerId = 100;
function unregisterApplicationStateObserverCallback(err) { function unregisterApplicationStateObserverCallback(err) {
if (err) { if (err) {
console.log('------------ unregisterApplicationStateObserverCallback ------------', err); console.log('------------ unregisterApplicationStateObserverCallback ------------', err);
}
} }
app.unregisterApplicationStateObserver(observerId, unregisterApplicationStateObserverCallback); }
app.unregisterApplicationStateObserver(observerId, unregisterApplicationStateObserverCallback);
``` ```
## appManager.unregisterApplicationStateObserver<sup>8+</sup> ## appManager.unregisterApplicationStateObserver<sup>8+</sup>
...@@ -396,7 +394,7 @@ unregisterApplicationStateObserver(observerId: number): Promise\<void>; ...@@ -396,7 +394,7 @@ unregisterApplicationStateObserver(observerId: number): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| observerId | number | 是 | 表示观察者的编号代码。 | | observerId | number | 否 | 表示观察者的编号代码。 |
**返回值：** **返回值：**
...@@ -406,16 +404,16 @@ unregisterApplicationStateObserver(observerId: number): Promise\<void>; ...@@ -406,16 +404,16 @@ unregisterApplicationStateObserver(observerId: number): Promise\<void>;
**示例：** **示例：**
```js ```ts
var observerId = 100; var observerId = 100;
app.unregisterApplicationStateObserver(observerId) app.unregisterApplicationStateObserver(observerId)
.then((data) => { .then((data) => {
console.log('----------- unregisterApplicationStateObserver success ----------', data); console.log('----------- unregisterApplicationStateObserver success ----------', data);
}) })
.catch((err) => { .catch((err) => {
console.log('----------- unregisterApplicationStateObserver fail ----------', err); console.log('----------- unregisterApplicationStateObserver fail ----------', err);
}) })
``` ```
## appManager.getForegroundApplications<sup>8+</sup> ## appManager.getForegroundApplications<sup>8+</sup>
...@@ -434,19 +432,19 @@ getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void; ...@@ -434,19 +432,19 @@ getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback\<Array\<AppStateData>> | 是 | 表示应用的状态数据。 | | callback | AsyncCallback\<Array\<AppStateData>> | 否 | 表示应用的状态数据。 |
**示例：** **示例：**
```js ```ts
function getForegroundApplicationsCallback(err, data) { function getForegroundApplicationsCallback(err, data) {
if (err) { if (err) {
console.log('--------- getForegroundApplicationsCallback fail ---------', err); console.log('--------- getForegroundApplicationsCallback fail ---------', err);
} else { } else {
console.log('--------- getForegroundApplicationsCallback success ---------', data) console.log('--------- getForegroundApplicationsCallback success ---------', data)
}
} }
app.getForegroundApplications(getForegroundApplicationsCallback); }
app.getForegroundApplications(getForegroundApplicationsCallback);
``` ```
## appManager.getForegroundApplications<sup>8+</sup> ## appManager.getForegroundApplications<sup>8+</sup>
...@@ -469,14 +467,14 @@ getForegroundApplications(): Promise\<Array\<AppStateData>>; ...@@ -469,14 +467,14 @@ getForegroundApplications(): Promise\<Array\<AppStateData>>;
**示例：** **示例：**
```js ```ts
app.getForegroundApplications() app.getForegroundApplications()
.then((data) => { .then((data) => {
console.log('--------- getForegroundApplications success -------', data); console.log('--------- getForegroundApplications success -------', data);
}) })
.catch((err) => { .catch((err) => {
console.log('--------- getForegroundApplications fail -------', err); console.log('--------- getForegroundApplications fail -------', err);
}) })
``` ```
## appManager.killProcessWithAccount<sup>8+</sup> ## appManager.killProcessWithAccount<sup>8+</sup>
...@@ -500,7 +498,7 @@ killProcessWithAccount(bundleName: string, accountId: number): Promise\<void\> ...@@ -500,7 +498,7 @@ killProcessWithAccount(bundleName: string, accountId: number): Promise\<void\>
**示例：** **示例：**
```js ```ts
var bundleName = 'bundleName'; var bundleName = 'bundleName';
var accountId = 0; var accountId = 0;
app.killProcessWithAccount(bundleName, accountId) app.killProcessWithAccount(bundleName, accountId)
...@@ -535,7 +533,7 @@ killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCal ...@@ -535,7 +533,7 @@ killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCal
**示例：** **示例：**
```js ```ts
var bundleName = 'bundleName'; var bundleName = 'bundleName';
var accountId = 0; var accountId = 0;
function killProcessWithAccountCallback(err, data) { function killProcessWithAccountCallback(err, data) {
...@@ -564,21 +562,21 @@ killProcessesByBundleName(bundleName: string, callback: AsyncCallback\<void>); ...@@ -564,21 +562,21 @@ killProcessesByBundleName(bundleName: string, callback: AsyncCallback\<void>);
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| bundleName | string | 是 | 表示包名。 | | bundleName | string | 否 | 表示包名。 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法。 | | callback | AsyncCallback\<void> | 否 | 表示指定的回调方法。 |
**示例：** **示例：**
```js ```ts
var bundleName = 'bundleName'; var bundleName = 'bundleName';
function killProcessesByBundleNameCallback(err, data) { function killProcessesByBundleNameCallback(err, data) {
if (err) { if (err) {
console.log('------------- killProcessesByBundleNameCallback fail, err: --------------', err); console.log('------------- killProcessesByBundleNameCallback fail, err: --------------', err);
} else { } else {
console.log('------------- killProcessesByBundleNameCallback success, data: --------------', data); console.log('------------- killProcessesByBundleNameCallback success, data: --------------', data);
}
} }
app.killProcessesByBundleName(bundleName, killProcessesByBundleNameCallback); }
app.killProcessesByBundleName(bundleName, killProcessesByBundleNameCallback);
``` ```
## appManager.killProcessesByBundleName<sup>8+</sup> ## appManager.killProcessesByBundleName<sup>8+</sup>
...@@ -597,7 +595,7 @@ killProcessesByBundleName(bundleName: string): Promise\<void>; ...@@ -597,7 +595,7 @@ killProcessesByBundleName(bundleName: string): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| bundleName | string | 是 | 表示包名。 | | bundleName | string | 否 | 表示包名。 |
**返回值：** **返回值：**
...@@ -607,16 +605,15 @@ killProcessesByBundleName(bundleName: string): Promise\<void>; ...@@ -607,16 +605,15 @@ killProcessesByBundleName(bundleName: string): Promise\<void>;
**示例：** **示例：**
```js ```ts
var bundleName = 'bundleName'; var bundleName = 'bundleName';
app.killProcessesByBundleName(bundleName) app.killProcessesByBundleName(bundleName)
.then((data) => { .then((data) => {
console.log('------------ killProcessesByBundleName success ------------', data); console.log('------------ killProcessesByBundleName success ------------', data);
}) })
.catch((err) => { .catch((err) => {
console.log('------------ killProcessesByBundleName fail ------------', err); console.log('------------ killProcessesByBundleName fail ------------', err);
}) })
``` ```
## appManager.clearUpApplicationData<sup>8+</sup> ## appManager.clearUpApplicationData<sup>8+</sup>
...@@ -635,22 +632,21 @@ clearUpApplicationData(bundleName: string, callback: AsyncCallback\<void>); ...@@ -635,22 +632,21 @@ clearUpApplicationData(bundleName: string, callback: AsyncCallback\<void>);
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| bundleName | string | 是 | 表示包名。 | | bundleName | string | 否 | 表示包名。 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法。 | | callback | AsyncCallback\<void> | 否 | 表示指定的回调方法。 |
**示例：** **示例：**
```js ```ts
var bundleName = 'bundleName'; var bundleName = 'bundleName';
function clearUpApplicationDataCallback(err, data) { function clearUpApplicationDataCallback(err, data) {
if (err) { if (err) {
console.log('------------- clearUpApplicationDataCallback fail, err: --------------', err); console.log('------------- clearUpApplicationDataCallback fail, err: --------------', err);
} else { } else {
console.log('------------- clearUpApplicationDataCallback success, data: --------------', data); console.log('------------- clearUpApplicationDataCallback success, data: --------------', data);
}
} }
app.clearUpApplicationData(bundleName, clearUpApplicationDataCallback); }
app.clearUpApplicationData(bundleName, clearUpApplicationDataCallback);
``` ```
## appManager.clearUpApplicationData<sup>8+</sup> ## appManager.clearUpApplicationData<sup>8+</sup>
...@@ -669,7 +665,7 @@ clearUpApplicationData(bundleName: string): Promise\<void>; ...@@ -669,7 +665,7 @@ clearUpApplicationData(bundleName: string): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| bundleName | string | 是 | 表示包名。 | | bundleName | string | 否 | 表示包名。 |
**返回值：** **返回值：**
...@@ -679,7 +675,7 @@ clearUpApplicationData(bundleName: string): Promise\<void>; ...@@ -679,7 +675,7 @@ clearUpApplicationData(bundleName: string): Promise\<void>;
**示例：** **示例：**
```js ```ts
var bundleName = 'bundleName'; var bundleName = 'bundleName';
app.clearUpApplicationData(bundleName) app.clearUpApplicationData(bundleName)
.then((data) => { .then((data) => {
...@@ -688,7 +684,6 @@ clearUpApplicationData(bundleName: string): Promise\<void>; ...@@ -688,7 +684,6 @@ clearUpApplicationData(bundleName: string): Promise\<void>;
.catch((err) => { .catch((err) => {
console.log('------------ clearUpApplicationData fail ------------', err); console.log('------------ clearUpApplicationData fail ------------', err);
}) })
``` ```
## ApplicationStateObserver.onForegroundApplicationChanged<sup>8+</sup> ## ApplicationStateObserver.onForegroundApplicationChanged<sup>8+</sup>
...@@ -705,31 +700,30 @@ onForegroundApplicationChanged(appStateData: AppStateData): void; ...@@ -705,31 +700,30 @@ onForegroundApplicationChanged(appStateData: AppStateData): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| appStateData | [AppStateData](#appstatedata) | 是 | 状态更改的应用程序信息。 | | appStateData | [AppStateData](js-apis-inner-application-appStateData.md) | 否 | 状态更改的应用程序信息。 |
**示例：** **示例：**
```js ```ts
var applicationStateObserver = { var applicationStateObserver = {
onForegroundApplicationChanged(appStateData) { onForegroundApplicationChanged(appStateData) {
console.log('------------ onForegroundApplicationChanged -----------', appStateData); console.log('------------ onForegroundApplicationChanged -----------', appStateData);
}, },
onAbilityStateChanged(abilityStateData) { onAbilityStateChanged(abilityStateData) {
console.log('------------ onAbilityStateChanged -----------', abilityStateData); console.log('------------ onAbilityStateChanged -----------', abilityStateData);
}, },
onProcessCreated(processData) { onProcessCreated(processData) {
console.log('------------ onProcessCreated -----------', processData); console.log('------------ onProcessCreated -----------', processData);
}, },
onProcessDied(processData) { onProcessDied(processData) {
console.log('------------ onProcessDied -----------', processData); console.log('------------ onProcessDied -----------', processData);
}, },
onProcessStateChanged(processData) { onProcessStateChanged(processData) {
console.log('------------ onProcessStateChanged -----------', processData); console.log('------------ onProcessStateChanged -----------', processData);
}
} }
const observerCode = app.registerApplicationStateObserver(applicationStateObserver); }
console.log('-------- observerCode: ---------', observerCode); const observerCode = app.registerApplicationStateObserver(applicationStateObserver);
console.log('-------- observerCode: ---------', observerCode);
``` ```
## ApplicationStateObserver.onAbilityStateChanged<sup>8+</sup> ## ApplicationStateObserver.onAbilityStateChanged<sup>8+</sup>
...@@ -746,30 +740,30 @@ onAbilityStateChanged(abilityStateData: AbilityStateData): void; ...@@ -746,30 +740,30 @@ onAbilityStateChanged(abilityStateData: AbilityStateData): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| abilityStateData | [AbilityStateData](#abilitystatedata) | 是 | 状态更改的能力信息。 | | abilityStateData | [AbilityStateData](js-apis-inner-application-abilityStateData.md) | 否 | 状态更改的能力信息。 |
**示例：** **示例：**
```js ```ts
var applicationStateObserver = { var applicationStateObserver = {
onForegroundApplicationChanged(appStateData) { onForegroundApplicationChanged(appStateData) {
console.log('------------ onForegroundApplicationChanged -----------', appStateData); console.log('------------ onForegroundApplicationChanged -----------', appStateData);
}, },
onAbilityStateChanged(abilityStateData) { onAbilityStateChanged(abilityStateData) {
console.log('------------ onAbilityStateChanged -----------', abilityStateData); console.log('------------ onAbilityStateChanged -----------', abilityStateData);
}, },
onProcessCreated(processData) { onProcessCreated(processData) {
console.log('------------ onProcessCreated -----------', processData); console.log('------------ onProcessCreated -----------', processData);
}, },
onProcessDied(processData) { onProcessDied(processData) {
console.log('------------ onProcessDied -----------', processData); console.log('------------ onProcessDied -----------', processData);
}, },
onProcessStateChanged(processData) { onProcessStateChanged(processData) {
console.log('------------ onProcessStateChanged -----------', processData); console.log('------------ onProcessStateChanged -----------', processData);
}
} }
const observerCode = app.registerApplicationStateObserver(applicationStateObserver); }
console.log('-------- observerCode: ---------', observerCode); const observerCode = app.registerApplicationStateObserver(applicationStateObserver);
console.log('-------- observerCode: ---------', observerCode);
``` ```
## ApplicationStateObserver.onProcessCreated<sup>8+</sup> ## ApplicationStateObserver.onProcessCreated<sup>8+</sup>
...@@ -786,30 +780,30 @@ onProcessCreated(processData: ProcessData): void; ...@@ -786,30 +780,30 @@ onProcessCreated(processData: ProcessData): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| processData | [ProcessData](#processdata) | 是 | 进程信息。 | | processData | [ProcessData](js-apis-inner-application-processData.md) | 否 | 进程信息。 |
**示例：** **示例：**
```js ```ts
var applicationStateObserver = { var applicationStateObserver = {
onForegroundApplicationChanged(appStateData) { onForegroundApplicationChanged(appStateData) {
console.log('------------ onForegroundApplicationChanged -----------', appStateData); console.log('------------ onForegroundApplicationChanged -----------', appStateData);
}, },
onAbilityStateChanged(abilityStateData) { onAbilityStateChanged(abilityStateData) {
console.log('------------ onAbilityStateChanged -----------', abilityStateData); console.log('------------ onAbilityStateChanged -----------', abilityStateData);
}, },
onProcessCreated(processData) { onProcessCreated(processData) {
console.log('------------ onProcessCreated -----------', processData); console.log('------------ onProcessCreated -----------', processData);
}, },
onProcessDied(processData) { onProcessDied(processData) {
console.log('------------ onProcessDied -----------', processData); console.log('------------ onProcessDied -----------', processData);
}, },
onProcessStateChanged(processData) { onProcessStateChanged(processData) {
console.log('------------ onProcessStateChanged -----------', processData); console.log('------------ onProcessStateChanged -----------', processData);
}
} }
const observerCode = app.registerApplicationStateObserver(applicationStateObserver); }
console.log('-------- observerCode: ---------', observerCode); const observerCode = app.registerApplicationStateObserver(applicationStateObserver);
console.log('-------- observerCode: ---------', observerCode);
``` ```
## ApplicationStateObserver.onProcessDied<sup>8+</sup> ## ApplicationStateObserver.onProcessDied<sup>8+</sup>
...@@ -826,30 +820,30 @@ onProcessDied(processData: ProcessData): void; ...@@ -826,30 +820,30 @@ onProcessDied(processData: ProcessData): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| processData | [ProcessData](#processdata) | 是 | 进程信息。 | | processData | [ProcessData](js-apis-inner-application-processData.md) | 否 | 进程信息。 |
**示例：** **示例：**
```js ```ts
var applicationStateObserver = { var applicationStateObserver = {
onForegroundApplicationChanged(appStateData) { onForegroundApplicationChanged(appStateData) {
console.log('------------ onForegroundApplicationChanged -----------', appStateData); console.log('------------ onForegroundApplicationChanged -----------', appStateData);
}, },
onAbilityStateChanged(abilityStateData) { onAbilityStateChanged(abilityStateData) {
console.log('------------ onAbilityStateChanged -----------', abilityStateData); console.log('------------ onAbilityStateChanged -----------', abilityStateData);
}, },
onProcessCreated(processData) { onProcessCreated(processData) {
console.log('------------ onProcessCreated -----------', processData); console.log('------------ onProcessCreated -----------', processData);
}, },
onProcessDied(processData) { onProcessDied(processData) {
console.log('------------ onProcessDied -----------', processData); console.log('------------ onProcessDied -----------', processData);
}, },
onProcessStateChanged(processData) { onProcessStateChanged(processData) {
console.log('------------ onProcessStateChanged -----------', processData); console.log('------------ onProcessStateChanged -----------', processData);
}
} }
const observerCode = app.registerApplicationStateObserver(applicationStateObserver); }
console.log('-------- observerCode: ---------', observerCode); const observerCode = app.registerApplicationStateObserver(applicationStateObserver);
console.log('-------- observerCode: ---------', observerCode);
``` ```
## ApplicationStateObserver.onProcessStateChanged<sup>9+</sup> ## ApplicationStateObserver.onProcessStateChanged<sup>9+</sup>
...@@ -866,118 +860,39 @@ onProcessDied(processData: ProcessData): void; ...@@ -866,118 +860,39 @@ onProcessDied(processData: ProcessData): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| processData | [ProcessData](#processdata) | 是 | 进程信息。 | | processData | [ProcessData](js-apis-inner-application-processData.md) | 否 | 进程信息。 |
**示例：** **示例：**
```js ```ts
var applicationStateObserver = { var applicationStateObserver = {
onForegroundApplicationChanged(appStateData) { onForegroundApplicationChanged(appStateData) {
console.log('------------ onForegroundApplicationChanged -----------', appStateData); console.log('------------ onForegroundApplicationChanged -----------', appStateData);
}, },
onAbilityStateChanged(abilityStateData) { onAbilityStateChanged(abilityStateData) {
console.log('------------ onAbilityStateChanged -----------', abilityStateData); console.log('------------ onAbilityStateChanged -----------', abilityStateData);
}, },
onProcessCreated(processData) { onProcessCreated(processData) {
console.log('------------ onProcessCreated -----------', processData); console.log('------------ onProcessCreated -----------', processData);
}, },
onProcessDied(processData) { onProcessDied(processData) {
console.log('------------ onProcessDied -----------', processData); console.log('------------ onProcessDied -----------', processData);
}, },
onProcessStateChanged(processData) { onProcessStateChanged(processData) {
console.log('------------ onProcessStateChanged -----------', processData); console.log('------------ onProcessStateChanged -----------', processData);
}
} }
const observerCode = app.registerApplicationStateObserver(applicationStateObserver); }
console.log('-------- observerCode: ---------', observerCode); const observerCode = app.registerApplicationStateObserver(applicationStateObserver);
console.log('-------- observerCode: ---------', observerCode);
``` ```
## AppStateData
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | -------- | -------------------- | ---- | -------------------------------- |
| bundleName<sup>8+</sup>| string | 是 | 否 | 包名。 |
| uid<sup>8+</sup> | number | 是 | 否 | 用户ID。 |
| state<sup>8+</sup> | number | 是 | 否 | 应用状态。 |
## AbilityStateData
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------------------- | ---------| ---- | ---- | ------------------------- |
| pid<sup>8+</sup> | number | 是 | 否 | 进程ID。 |
| bundleName<sup>8+</sup> | string | 是 | 否 | 应用包名。 |
| abilityName<sup>8+</sup> | string | 是 | 否 | Ability名称。 |
| uid<sup>8+</sup> | number | 是 | 否 | 用户ID。 |
| state<sup>8+</sup> | number | 是 | 否 | Ability状态。 |
| moduleName<sup>9+</sup> | string | 是 | 否 | Ability所属的HAP包的名称。 |
| abilityType<sup>8+</sup> | number | 是 | 否 | 能力类型、页面或服务等。 |
## ProcessData
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------------------- | ---------| ---- | ---- | ------------------------- |
| pid<sup>8+</sup> | number | 是 | 否 | 进程ID。 |
| bundleName<sup>8+</sup> | string | 是 | 否 | 应用包名。 |
| uid<sup>8+</sup> | number | 是 | 否 | 用户ID。 |
| isContinuousTask<sup>9+</sup> | boolean | 是 | 否 | 判断过程是否为连续任务。 |
| isKeepAlive<sup>9+</sup> | boolean | 是 | 否 | 判断该过程是否保持活跃。 |
## ProcessRunningInfo
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| pid<sup>8+</sup> |number | 是 | 否 | 进程ID。 |
| uid<sup>8+</sup> | number | 是 | 否 | 用户ID。 |
| processName<sup>8+</sup> | string | 是 | 否 | 进程的名称。 |
| bundleNames<sup>8+</sup> | Array\<string> | 是 | 否 | 进程中运行的bundleName数组。 |
## ApplicationStateObserver
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------------------- | ---------| ---- | ---- | ------------------------- |
| [onForegroundApplicationChanged<sup>8+</sup>](#applicationstateobserveronforegroundapplicationchanged8) | AppStateData | 是 | 否 | 应用前后台状态发生变化时执行的回调函数。 |
| [onAbilityStateChanged<sup>8+</sup>](#applicationstateobserveronabilitystatechanged8) | AbilityStateData | 是 | 否 | ability状态发生变化时执行的回调函数。 |
| [onProcessCreated<sup>8+</sup>](#applicationstateobserveronprocesscreated8) | ProcessData | 是 | 否 | 进程创建时执行的回调函数。 |
| [onProcessDied<sup>8+</sup>](#applicationstateobserveronprocessdied8) |ProcessData | 是 | 否 | 进程销毁时执行的回调函数。 |
## ProcessRunningInformation
进程的运行信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| pid<sup>9+</sup> | number | 是 | 否 | 进程ID。 |
| uid<sup>9+</sup> | number | 是 | 否 | 用户ID。 |
| processName<sup>9+</sup> | string | 是 | 否 | 进程的名称。 |
| bundleNames<sup>9+</sup> | Array\<string> | 是 | 否 | 进程中运行的bundleName数组。 |
## ApplicationState<sup>9+</sup> ## ApplicationState<sup>9+</sup>
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。 **系统API**: 此接口为系统接口，三方应用不支持调用。
| 名称 | 值 | 说明 | | 名称 | 值 | 描述 |
| -------------------- | --- | --------------------------------- | | -------------------- | --- | --------------------------------- |
| STATE_CREATE | 1 | 当应用在创建中的时候处于的状态。 | | STATE_CREATE | 1 | 当应用在创建中的时候处于的状态。 |
| STATE_FOREGROUND | 2 | 当应用切换到前台的时候处于的状态。 | | STATE_FOREGROUND | 2 | 当应用切换到前台的时候处于的状态。 |
...@@ -991,10 +906,10 @@ onProcessDied(processData: ProcessData): void; ...@@ -991,10 +906,10 @@ onProcessDied(processData: ProcessData): void;
**系统API**: 此接口为系统接口，三方应用不支持调用。 **系统API**: 此接口为系统接口，三方应用不支持调用。
| 名称 | 值 | 说明 | | 名称 | 值 | 描述 |
| -------------------- | --- | --------------------------------- | | -------------------- | --- | --------------------------------- |
| STATE_CREATE | 1 | 当进程在创建中的时候处于的状态。 | | STATE_CREATE | 1 | 当进程在创建中的时候处于的状态。 |
| STATE_FOREGROUND | 2 | 当进程切换到前台的时候处于的状态。 | | STATE_FOREGROUND | 2 | 当进程切换到前台的时候处于的状态。 |
| STATE_ACTIVE | 3 | 当进程在获焦的时候处于的状态。 | | STATE_ACTIVE | 3 | 当进程在获焦的时候处于的状态。 |
| STATE_BACKGROUND | 4 | 当进程处于后台不可见时处于的状态。 | | STATE_BACKGROUND | 4 | 当进程处于后台不可见时处于的状态。 |
| STATE_DESTROY | 5 | 当进程在销毁的时候处于的状态。 | | STATE_DESTROY | 5 | 当进程在销毁的时候处于的状态。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-application-configuration.md
浏览文件 @ 0612bb09
...@@ -10,9 +10,9 @@ ...@@ -10,9 +10,9 @@
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| language<sup>8+</sup> | string | 是 | 是 | 表示应用程序的当前语言。 | | language<sup>8+</sup> | string | 是 | 是 | 表示应用程序的当前语言。 |
| colorMode<sup>8+</sup> | [ColorMode](js-apis-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 | 是 | 否 | 表示屏幕方向，取值范围：水平方向（DIRECTION_HORIZONTAL），垂直方向（DIRECTION_VERTICAL）。 | | direction<sup>9+</sup> | [Direction](js-apis-application-configurationConstant.md#configurationconstantdirection9) | 是 | 否 | 表示屏幕方向，取值范围：水平方向（DIRECTION_HORIZONTAL），垂直方向（DIRECTION_VERTICAL）。 |
| screenDensity<sup>9+</sup> | ScreenDensity | 是 | 否 | 表示屏幕分辨率，取值范围：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<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。 | | displayId<sup>9+</sup> | number | 是 | 否 | 表示应用所在的物理屏幕Id。 |
| hasPointerDevice<sup>9+</sup> | boolean | 是 | 否 | 指示指针类型设备是否已连接，如键鼠、触控板等。 | | hasPointerDevice<sup>9+</sup> | boolean | 是 | 否 | 指示指针类型设备是否已连接，如键鼠、触控板等。 |
......
zh-cn/application-dev/reference/apis/js-apis-application-context.md
浏览文件 @ 0612bb09
# Context # Context
Context模块提供开发者运行代码的上下文环境的能力，包括查询和设置应用信息、ResourceManager等信息。 Context模块将二级模块API组织在一起方便开发者进行导出。
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。 > 本模块接口仅可在Stage模型下使用
## 使用说明 ## 导入模块
通过AbilityContext等继承实现。 ```ts
import context from '@ohos.application.context'
```js
import Ability from '@ohos.application.Ability'
class MainAbility extends Ability {
onWindowStageCreate(windowStage) {
let test = "com.example.test";
let context = this.context.createBundleContext(test);
}
}
```
## 属性
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| resourceManager | resmgr.ResourceManager; | 是 | 否 | ResourceManager对象。 |
| applicationInfo | ApplicationInfo | 是 | 否 | 当前应用信息。 |
| cacheDir | string | 是 | 否 | 应用在内部存储上的缓存路径。 |
| tempDir | string | 是 | 否 | 应用的临时文件路径。 |
| filesDir | string | 是 | 否 | 应用在内部存储上的文件路径。 |
| databaseDir | string | 是 | 否 | 获取本地数据存储路径。 |
| bundleCodeDir | string | 是 | 否 | 应用安装路径。 |
| distributedFilesDir | string | 是 | 否 | 应用的分布式文件路径。 |
| eventHub | [EventHub](js-apis-eventhub.md) | 是 | 否 | 事件中心信息。|
| area | [AreaMode](#areamode) | 是 | 是 | 文件分区。|
| preferencesDir | string | 是 | 是 | 指示应用程序首选项目录。|
## Context.createBundleContext
createBundleContext(bundleName: string): Context;
创建指定应用上下文。
**需要权限**：ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| bundleName | string | 是 | 应用bundle名。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Context | 对应创建应用的上下文context。 |
**示例：**
```js
import Ability from '@ohos.application.Ability'
class MainAbility extends Ability {
onWindowStageCreate(windowStage) {
let test = "com.example.test";
let context = this.context.createBundleContext(test);
}
}
```
## Context.createModuleContext
createModuleContext(moduleName: string): Context;
创建指定hap上下文。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| moduleName | string | 是 | 应用内hap名。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Context | 对应创建hap的上下文context。 |
**示例：**
```js
import Ability from '@ohos.application.Ability'
class MainAbility extends Ability {
onWindowStageCreate(windowStage) {
let moduleName = "module";
let context = this.context.createModuleContext(moduleName);
}
}
``` ```
## Context.createModuleContext **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
createModuleContext(bundleName: string, moduleName: string): Context;
创建指定应用上下文。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：** | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| 参数名 | 类型 | 必填 | 说明 | | AbilityContext | 只读 | [AbilityContext](js-apis-ability-context.md) | 否 | AbilityContext二级模块。 |
| -------- | -------- | -------- | -------- | | AbilityStageContext | 只读 | [AbilityStageContext](js-apis-inner-application-abilityStageContext.md) | 否 | AbilityStageContext二级模块。 |
| bundleName | string | 是 | 应用bundle名。 | | ApplicationContext | 只读 | [ApplicationContext](js-apis-inner-application-applicationContext.md) | 否 | ApplicationContext二级模块。 |
| moduleName | string | 是 | 应用内hap名。 | | 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二级模块。 |
| Context | 对应创建应用内hap的上下文context。 |
**示例：** **示例：**
```ts
```js let abilityContext: context.AbilityContext;
import Ability from '@ohos.application.Ability' let abilityStageContext: context.AbilityStageContext;
let applicationContext: context.ApplicationContext;
class MainAbility extends Ability { let baseContext: context.BaseContext;
onWindowStageCreate(windowStage) { let context: context.Context;
let bundleName = "com.example.bundle"; let extensionContext: context.ExtensionContext;
let moduleName = "module"; let formExtensionContext: context.FormExtensionContext;
let context = this.context.createModuleContext(bundleName, moduleName); let eventHub: context.EventHub;
} let permissionRequestResult: context.PermissionRequestResult;
} ```
``` \ No newline at end of file
## Context.getApplicationContext
getApplicationContext(): ApplicationContext;
获取当前applicationContext。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ApplicationContext | 当前ApplicationContext对象信息。 |
**示例：**
```js
import Ability from '@ohos.application.Ability'
class MainAbility extends Ability {
onWindowStageCreate(windowStage) {
let applicationContext = this.context.getApplicationContext();
}
}
```
## AreaMode
访问的文件分区，每个文件分区有对应自己的内容。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 |
| --------------- | ---- | --------------- |
| EL1 | 0 | 设备级加密区。 |
| EL2 | 1 | 用户凭据加密区。默认为EL2。 |
zh-cn/application-dev/reference/apis/js-apis-application-DataShareExtensionAbility.md → zh-cn/application-dev/reference/apis/js-apis-application-dataShareExtensionAbility.md
浏览文件 @ 0612bb09
...@@ -23,7 +23,7 @@ import DataShareExtensionAbility from '@ohos.application.DataShareExtensionAbili ...@@ -23,7 +23,7 @@ import DataShareExtensionAbility from '@ohos.application.DataShareExtensionAbili
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| context | [ExtensionContext](js-apis-extension-context.md) | 是 | 否 |表示数据共享扩展能力上下文。 | | context | [ExtensionContext](js-apis-inner-application-extensionContext.md) | 是 | 否 |表示数据共享扩展能力上下文。 |
## onCreate ## onCreate
...@@ -37,7 +37,7 @@ DataShare客户端连接DataShareExtensionAbility服务端时，服务端回调 ...@@ -37,7 +37,7 @@ DataShare客户端连接DataShareExtensionAbility服务端时，服务端回调
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ | | ----- | ------ | ------ | ------ |
| want | [Want](js-apis-application-Want.md#want) | 是 | Want类型信息，包括ability名称、bundle名称等。 | | want | [Want](js-apis-application-want.md#want) | 是 | Want类型信息，包括ability名称、bundle名称等。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。无返回值。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。无返回值。 |
**示例：** **示例：**
...@@ -83,7 +83,7 @@ insert?(uri: string, valueBucket: ValuesBucket, callback: AsyncCallback&lt;numbe ...@@ -83,7 +83,7 @@ insert?(uri: string, valueBucket: ValuesBucket, callback: AsyncCallback&lt;numbe
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ | | ----- | ------ | ------ | ------ |
| uri |string | 是 | 指示要插入的数据的路径。 | | uri |string | 是 | 指示要插入的数据的路径。 |
| valueBucket |[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要插入的数据。 | | valueBucket |[ValuesBucket](js-apis-data-valuesBucket.md#valuesbucket) | 是 | 指示要插入的数据。 |
| callback |AsyncCallback&lt;number&gt; | 是 | 回调函数。返回插入数据记录的索引。 | | callback |AsyncCallback&lt;number&gt; | 是 | 回调函数。返回插入数据记录的索引。 |
**示例：** **示例：**
...@@ -128,7 +128,7 @@ update?(uri: string, predicates: dataSharePredicates.DataSharePredicates, valueB ...@@ -128,7 +128,7 @@ update?(uri: string, predicates: dataSharePredicates.DataSharePredicates, valueB
| ----- | ------ | ------ | ------ | | ----- | ------ | ------ | ------ |
| uri | string | 是 | 指示要更新的数据的路径。 | | uri | string | 是 | 指示要更新的数据的路径。 |
| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 | | predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 |
| valueBucket | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要更新的数据。 | | valueBucket | [ValuesBucket](js-apis-data-valuesBucket.md#valuesbucket) | 是 | 指示要更新的数据。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。返回更新的数据记录数。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。返回更新的数据记录数。 |
**示例：** **示例：**
...@@ -258,7 +258,7 @@ batchInsert?(uri: string, valueBuckets: Array&lt;ValuesBucket&gt;, callback: Asy ...@@ -258,7 +258,7 @@ batchInsert?(uri: string, valueBuckets: Array&lt;ValuesBucket&gt;, callback: Asy
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------------------------------------------------------ | ---- | -------------------------------- | | ------------ | ------------------------------------------------------------ | ---- | -------------------------------- |
| uri | string | 是 | 指示要批量插入的数据的路径。 | | uri | string | 是 | 指示要批量插入的数据的路径。 |
| valueBuckets | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 指示要批量插入的数据。 | | valueBuckets | Array&lt;[ValuesBucket](js-apis-data-valuesBucket.md#valuesbucket)&gt; | 是 | 指示要批量插入的数据。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。返回插入的数据记录数。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。返回插入的数据记录数。 |
**示例：** **示例：**
......
zh-cn/application-dev/reference/apis/js-apis-application-EnvironmentCallback.md → zh-cn/application-dev/reference/apis/js-apis-application-environmentCallback.md
浏览文件 @ 0612bb09
...@@ -4,13 +4,13 @@ EnvironmentCallback模块提供应用上下文ApplicationContext对系统环境 ...@@ -4,13 +4,13 @@ EnvironmentCallback模块提供应用上下文ApplicationContext对系统环境
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 9 开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.EnvironmentCallback](js-apis-app-ability-EnvironmentCallback.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9 开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.EnvironmentCallback](js-apis-app-ability-environmentCallback.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。 > 本模块接口仅可在Stage模型下使用。
## 导入模块 ## 导入模块
```js ```ts
import EnvironmentCallback from "@ohos.application.EnvironmentCallback"; import EnvironmentCallback from "@ohos.application.EnvironmentCallback";
``` ```
...@@ -27,12 +27,12 @@ onConfigurationUpdated(config: Configuration): void; ...@@ -27,12 +27,12 @@ onConfigurationUpdated(config: Configuration): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| config | [Configuration](js-apis-configuration.md) | 是 | 变化后的Configuration对象。 | | config | [Configuration](js-apis-application-configuration.md) | 是 | 变化后的Configuration对象。 |
**示例：** **示例：**
```js ```ts
import Ability from "@ohos.application.Ability"; import Ability from "@ohos.application.Ability";
var callbackId; var callbackId;
......
zh-cn/application-dev/reference/apis/js-apis-errorManager.md → zh-cn/application-dev/reference/apis/js-apis-application-errorManager.md
浏览文件 @ 0612bb09
...@@ -4,10 +4,10 @@ ErrorManager模块提供对错误观察器的注册和注销的能力。 ...@@ -4,10 +4,10 @@ ErrorManager模块提供对错误观察器的注册和注销的能力。
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 9开始支持，从API version 9废弃，替换接口为[@ohos.app.ability.errorManager](js-apis-app-ability-errorManager.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
``` ```ts
import errorManager from '@ohos.application.errorManager' import errorManager from '@ohos.application.errorManager'
``` ```
...@@ -23,11 +23,11 @@ registerErrorObserver(observer: ErrorObserver): number; ...@@ -23,11 +23,11 @@ registerErrorObserver(observer: ErrorObserver): number;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| observer | [ErrorObserver](#errorobserver) | 否 | 返回观察者的数字代码。 | | observer | [ErrorObserver](js-apis-inner-application-errorObserver.md) | 否 | 返回观察者的数字代码。 |
**示例：** **示例：**
```js ```ts
var observer = { var observer = {
onUnhandledException(errorMsg) { onUnhandledException(errorMsg) {
console.log('onUnhandledException, errorMsg: ', errorMsg) console.log('onUnhandledException, errorMsg: ', errorMsg)
...@@ -53,7 +53,7 @@ unregisterErrorObserver(observerId: number, callback: AsyncCallback\<void>): vo ...@@ -53,7 +53,7 @@ unregisterErrorObserver(observerId: number, callback: AsyncCallback\<void>): vo
**示例：** **示例：**
```js ```ts
var observerId = 100; var observerId = 100;
function unregisterErrorObserverCallback(err) { function unregisterErrorObserverCallback(err) {
...@@ -87,7 +87,7 @@ unregisterErrorObserver(observerId: number): Promise\<void>; ...@@ -87,7 +87,7 @@ unregisterErrorObserver(observerId: number): Promise\<void>;
**示例：** **示例：**
```js ```ts
var observerId = 100; var observerId = 100;
errorManager.unregisterErrorObserver(observerId) errorManager.unregisterErrorObserver(observerId)
.then((data) => { .then((data) => {
...@@ -97,29 +97,4 @@ errorManager.unregisterErrorObserver(observerId) ...@@ -97,29 +97,4 @@ errorManager.unregisterErrorObserver(observerId)
console.log('----------- unregisterErrorObserver fail ----------', err); console.log('----------- unregisterErrorObserver fail ----------', err);
}) })
```
## ErrorObserver
onUnhandledException(errMsg: string): void;
将在js运行时引发用户未捕获的异常时调用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| errMsg | string | 否 | 有关异常的消息和错误堆栈跟踪。 |
**示例：**
```js
var observer = {
onUnhandledException(errorMsg) {
console.log('onUnhandledException, errorMsg: ', errorMsg)
}
}
errorManager.registerErrorObserver(observer)
``` ```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-application-ExtensionAbility.md → zh-cn/application-dev/reference/apis/js-apis-application-extensionAbility.md
浏览文件 @ 0612bb09
# ExtensionAbility # ExtensionAbility
ExtensionAbility，是Stage模型中新增的扩展组件的基类，一般用于处理无界面的任务，生命周期较简单，没有前后台生命周期。 ExtensionAbility模块提供对ExtensionAbility生命周期、上下文环境等调用管理的能力，包括ExtensionAbility创建、销毁、转储客户端信息等。
> **说明：** > **说明：**
> >
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 本模块接口仅可在Stage模型下使用。 > 本模块接口仅可在Stage模型下使用。
## 导入模块 ## 导入模块
```js ```ts
import ExtensionAbility from '@ohos.application.ExtensionAbility'; import ExtensionAbility from '@ohos.application.ExtensionAbility';
``` ```
## AbilityStage.onConfigurationUpdated ## ExtensionAbility.onConfigurationUpdated
onConfigurationUpdated(config: Configuration): void; onConfigurationUpdated(config: Configuration): void;
环境变化通知接口，发生全局配置变更时回调。 当系统配置更新时调用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| config | [Configuration](js-apis-configuration.md) | 是 | 发生全局配置变更时触发回调，当前全局配置包括系统语言、深浅色模式。 | | config | [Configuration](js-apis-application-configuration.md) | 是 | 表示需要更新的配置信息。 |
**示例：** **示例：**
```js ```ts
class MyExtension extends ExtensionAbility { class MyExtensionAbility extends ExtensionAbility {
onConfigurationUpdated(config) { onConfigurationUpdated(config) {
console.log('onConfigurationUpdated, language:' + config.language); console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
} }
} }
``` ```
## ExtensionAbility.onMemoryLevel
## AbilityStage.onMemoryLevel
onMemoryLevel(level: AbilityConstant.MemoryLevel): void; onMemoryLevel(level: AbilityConstant.MemoryLevel): void;
...@@ -54,8 +53,8 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void; ...@@ -54,8 +53,8 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void;
**示例：** **示例：**
```js ```ts
class MyExtension extends ExtensionAbility { class MyExtensionAbility extends ExtensionAbility {
onMemoryLevel(level) { onMemoryLevel(level) {
console.log('onMemoryLevel, level:' + JSON.stringify(level)); console.log('onMemoryLevel, level:' + JSON.stringify(level));
} }
......
zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md → zh-cn/application-dev/reference/apis/js-apis-application-formBindingData.md
浏览文件 @ 0612bb09
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
> 从API version 9 开始不再维护，建议使用[FormBindingData](js-apis-app-form-formbindingdata.md)替代。 > 从API version 9 开始不再维护，建议使用[FormBindingData](js-apis-app-form-formbindingdata.md)替代。
## 导入模块 ## 导入模块
``` ```ts
import formBindingData from '@ohos.application.formBindingData'; import formBindingData from '@ohos.application.formBindingData';
``` ```
...@@ -47,30 +47,17 @@ createFormBindingData(obj?: Object | string): FormBindingData ...@@ -47,30 +47,17 @@ createFormBindingData(obj?: Object | string): FormBindingData
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import fileio from '@ohos.fileio'; import fileio from '@ohos.fileio';
let context=featureAbility.getContext(); let context=featureAbility.getContext();
context.getOrCreateLocalDir((err,data)=>{ context.getOrCreateLocalDir((err,data)=>{
let path=data+"/xxx.jpg"; let path=data+"/xxx.jpg";
let fd = fileio.openSync(path); let fd = fileio.openSync(path);
let obj = { let obj = {
"temperature": "21°", "temperature": "21°",
"formImages": {"image": fd} "formImages": {"image": fd}
}; };
let formBindingDataObj = formBindingData.createFormBindingData(obj); let formBindingDataObj = formBindingData.createFormBindingData(obj);
}) })
```
\ No newline at end of file
```
## 属性
FormBindingData相关描述。
**系统能力**：SystemCapability.Ability.Form
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | -------- | -------- |
| data | 是 | 否 | Object | 是 | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。|
zh-cn/application-dev/reference/apis/js-apis-formerror.md → zh-cn/application-dev/reference/apis/js-apis-application-formError.md
浏览文件 @ 0612bb09
...@@ -9,7 +9,7 @@ FormError模块提供获取卡片错误码的能力。 ...@@ -9,7 +9,7 @@ FormError模块提供获取卡片错误码的能力。
## 导入模块 ## 导入模块
``` ```ts
import formError from '@ohos.application.formError'; import formError from '@ohos.application.formError';
``` ```
......
zh-cn/application-dev/reference/apis/js-apis-formextension.md → zh-cn/application-dev/reference/apis/js-apis-application-formExtension.md
浏览文件 @ 0612bb09
...@@ -10,7 +10,7 @@ FormExtension模块提供了FormExtension卡片扩展相关接口。 ...@@ -10,7 +10,7 @@ FormExtension模块提供了FormExtension卡片扩展相关接口。
## 导入模块 ## 导入模块
``` ```ts
import FormExtension from '@ohos.application.FormExtension'; import FormExtension from '@ohos.application.FormExtension';
``` ```
...@@ -20,7 +20,7 @@ import FormExtension from '@ohos.application.FormExtension'; ...@@ -20,7 +20,7 @@ import FormExtension from '@ohos.application.FormExtension';
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------- | ------------------------------------------------------- | ---- | ---- | --------------------------------------------------- | | ------- | ------------------------------------------------------- | ---- | ---- | --------------------------------------------------- |
| context | [FormExtensionContext](js-apis-formextensioncontext.md) | 是 | 否 | FormExtension的上下文环境，继承自ExtensionContext。 | | context | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | 是 | 否 | FormExtension的上下文环境，继承自ExtensionContext。 |
## onCreate ## onCreate
...@@ -34,17 +34,17 @@ onCreate(want: Want): formBindingData.FormBindingData ...@@ -34,17 +34,17 @@ onCreate(want: Want): formBindingData.FormBindingData
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------------------------------- | ---- | ------------------------------------------------------------ | | ------ | -------------------------------------- | ---- | ------------------------------------------------------------ |
| want | [Want](js-apis-application-Want.md) | 是 | 当前Extension相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理，以便后续更新和删除卡片。 | | want | [Want](js-apis-application-want.md) | 是 | 当前Extension相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理，以便后续更新和删除卡片。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------------------------ | ----------------------------------------------------------- | | ------------------------------------------------------------ | ----------------------------------------------------------- |
| [formBindingData.FormBindingData](js-apis-formbindingdata.md#formbindingdata) | formBindingData.FormBindingData对象，卡片要显示的数据。 | | [formBindingData.FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | formBindingData.FormBindingData对象，卡片要显示的数据。 |
**示例：** **示例：**
```js ```ts
import formBindingData from '@ohos.application.formBindingData' import formBindingData from '@ohos.application.formBindingData'
export default class MyFormExtension extends FormExtension { export default class MyFormExtension extends FormExtension {
onCreate(want) { onCreate(want) {
...@@ -75,7 +75,7 @@ onCastToNormal(formId: string): void ...@@ -75,7 +75,7 @@ onCastToNormal(formId: string): void
**示例：** **示例：**
```js ```ts
export default class MyFormExtension extends FormExtension { export default class MyFormExtension extends FormExtension {
onCastToNormal(formId) { onCastToNormal(formId) {
console.log('FormExtension onCastToNormal, formId:' + formId); console.log('FormExtension onCastToNormal, formId:' + formId);
...@@ -87,7 +87,7 @@ export default class MyFormExtension extends FormExtension { ...@@ -87,7 +87,7 @@ export default class MyFormExtension extends FormExtension {
onUpdate(formId: string): void onUpdate(formId: string): void
卡片提供方接收更新卡片的通知接口。获取最新数据后调用[FormExtensionContext](js-apis-formextensioncontext.md)的updateForm接口刷新卡片数据。 卡片提供方接收更新卡片的通知接口。获取最新数据后调用[FormExtensionContext](js-apis-inner-application-formExtensionContext.md)的updateForm接口刷新卡片数据。
**系统能力**：SystemCapability.Ability.Form **系统能力**：SystemCapability.Ability.Form
...@@ -99,7 +99,7 @@ onUpdate(formId: string): void ...@@ -99,7 +99,7 @@ onUpdate(formId: string): void
**示例：** **示例：**
```js ```ts
import formBindingData from '@ohos.application.formBindingData' import formBindingData from '@ohos.application.formBindingData'
export default class MyFormExtension extends FormExtension { export default class MyFormExtension extends FormExtension {
onUpdate(formId) { onUpdate(formId) {
...@@ -129,7 +129,7 @@ onVisibilityChange(newStatus: { [key: string]: number }): void ...@@ -129,7 +129,7 @@ onVisibilityChange(newStatus: { [key: string]: number }): void
**示例：** **示例：**
```js ```ts
import formBindingData from '@ohos.application.formBindingData' import formBindingData from '@ohos.application.formBindingData'
export default class MyFormExtension extends FormExtension { export default class MyFormExtension extends FormExtension {
onVisibilityChange(newStatus) { onVisibilityChange(newStatus) {
...@@ -164,7 +164,7 @@ onEvent(formId: string, message: string): void ...@@ -164,7 +164,7 @@ onEvent(formId: string, message: string): void
**示例：** **示例：**
```js ```ts
export default class MyFormExtension extends FormExtension { export default class MyFormExtension extends FormExtension {
onEvent(formId, message) { onEvent(formId, message) {
console.log('FormExtension onEvent, formId:' + formId + ", message:" + message); console.log('FormExtension onEvent, formId:' + formId + ", message:" + message);
...@@ -188,7 +188,7 @@ onDestroy(formId: string): void ...@@ -188,7 +188,7 @@ onDestroy(formId: string): void
**示例：** **示例：**
```js ```ts
export default class MyFormExtension extends FormExtension { export default class MyFormExtension extends FormExtension {
onDestroy(formId) { onDestroy(formId) {
console.log('FormExtension onDestroy, formId:' + formId); console.log('FormExtension onDestroy, formId:' + formId);
...@@ -208,11 +208,11 @@ onConfigurationUpdated(config: Configuration): void; ...@@ -208,11 +208,11 @@ onConfigurationUpdated(config: Configuration): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| config | [Configuration](js-apis-configuration.md) | 是 | 表示需要更新的配置信息。 | | config | [Configuration](js-apis-application-configuration.md) | 是 | 表示需要更新的配置信息。 |
**示例：** **示例：**
```js ```ts
class MyFormExtension extends FormExtension { class MyFormExtension extends FormExtension {
onConfigurationUpdated(config) { onConfigurationUpdated(config) {
console.log('onConfigurationUpdated, config:' + JSON.stringify(config)); console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
...@@ -232,11 +232,11 @@ onAcquireFormState?(want: Want): formInfo.FormState; ...@@ -232,11 +232,11 @@ onAcquireFormState?(want: Want): formInfo.FormState;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 否 | want表示获取卡片状态的描述。描述包括包名称、能力名称、模块名称、卡片名和卡片维度。 | | want | [Want](js-apis-application-want.md) | 否 | want表示获取卡片状态的描述。描述包括包名称、能力名称、模块名称、卡片名和卡片维度。 |
**示例：** **示例：**
```js ```ts
import formInfo from '@ohos.application.formInfo' import formInfo from '@ohos.application.formInfo'
class MyFormExtension extends FormExtension { class MyFormExtension extends FormExtension {
onAcquireFormState(want) { onAcquireFormState(want) {
...@@ -270,7 +270,7 @@ onShare?(formId: string): {[key: string]: any}; ...@@ -270,7 +270,7 @@ onShare?(formId: string): {[key: string]: any};
**示例：** **示例：**
```js ```ts
class MyFormExtension extends FormExtension { class MyFormExtension extends FormExtension {
onShare(formId) { onShare(formId) {
console.log('FormExtension onShare, formId:' + formId); console.log('FormExtension onShare, formId:' + formId);
......
zh-cn/application-dev/reference/apis/js-apis-formhost.md → zh-cn/application-dev/reference/apis/js-apis-application-formHost.md
浏览文件 @ 0612bb09
...@@ -10,7 +10,7 @@ FormHost模块提供了卡片使用方相关接口的能力，包括对使用方 ...@@ -10,7 +10,7 @@ FormHost模块提供了卡片使用方相关接口的能力，包括对使用方
## 导入模块 ## 导入模块
``` ```ts
import formHost from '@ohos.application.formHost'; import formHost from '@ohos.application.formHost';
``` ```
...@@ -33,7 +33,7 @@ deleteForm(formId: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -33,7 +33,7 @@ deleteForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
**示例：** **示例：**
```js ```ts
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.deleteForm(formId, (error, data) => { formHost.deleteForm(formId, (error, data) => {
if (error.code) { if (error.code) {
...@@ -66,7 +66,7 @@ deleteForm(formId: string): Promise&lt;void&gt; ...@@ -66,7 +66,7 @@ deleteForm(formId: string): Promise&lt;void&gt;
**参数：** **参数：**
```js ```ts
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.deleteForm(formId).then(() => { formHost.deleteForm(formId).then(() => {
console.log('formHost deleteForm success'); console.log('formHost deleteForm success');
...@@ -94,7 +94,7 @@ releaseForm(formId: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -94,7 +94,7 @@ releaseForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
**示例：** **示例：**
```js ```ts
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.releaseForm(formId, (error, data) => { formHost.releaseForm(formId, (error, data) => {
if (error.code) { if (error.code) {
...@@ -123,7 +123,7 @@ releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback&lt; ...@@ -123,7 +123,7 @@ releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback&lt;
**示例：** **示例：**
```js ```ts
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.releaseForm(formId, true, (error, data) => { formHost.releaseForm(formId, true, (error, data) => {
if (error.code) { if (error.code) {
...@@ -157,7 +157,7 @@ releaseForm(formId: string, isReleaseCache?: boolean): Promise&lt;void&gt; ...@@ -157,7 +157,7 @@ releaseForm(formId: string, isReleaseCache?: boolean): Promise&lt;void&gt;
**示例：** **示例：**
```js ```ts
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.releaseForm(formId, true).then(() => { formHost.releaseForm(formId, true).then(() => {
console.log('formHost releaseForm success'); console.log('formHost releaseForm success');
...@@ -185,7 +185,7 @@ requestForm(formId: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -185,7 +185,7 @@ requestForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
**示例：** **示例：**
```js ```ts
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.requestForm(formId, (error, data) => { formHost.requestForm(formId, (error, data) => {
if (error.code) { if (error.code) {
...@@ -218,7 +218,7 @@ requestForm(formId: string): Promise&lt;void&gt; ...@@ -218,7 +218,7 @@ requestForm(formId: string): Promise&lt;void&gt;
**示例：** **示例：**
```js ```ts
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.requestForm(formId).then(() => { formHost.requestForm(formId).then(() => {
console.log('formHost requestForm success'); console.log('formHost requestForm success');
...@@ -246,7 +246,7 @@ castTempForm(formId: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -246,7 +246,7 @@ castTempForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
**示例：** **示例：**
```js ```ts
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.castTempForm(formId, (error, data) => { formHost.castTempForm(formId, (error, data) => {
if (error.code) { if (error.code) {
...@@ -279,7 +279,7 @@ castTempForm(formId: string): Promise&lt;void&gt; ...@@ -279,7 +279,7 @@ castTempForm(formId: string): Promise&lt;void&gt;
**示例：** **示例：**
```js ```ts
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.castTempForm(formId).then(() => { formHost.castTempForm(formId).then(() => {
console.log('formHost castTempForm success'); console.log('formHost castTempForm success');
...@@ -307,7 +307,7 @@ notifyVisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void ...@@ -307,7 +307,7 @@ notifyVisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void
**示例：** **示例：**
```js ```ts
var formId = ["12400633174999288"]; var formId = ["12400633174999288"];
formHost.notifyVisibleForms(formId, (error, data) => { formHost.notifyVisibleForms(formId, (error, data) => {
if (error.code) { if (error.code) {
...@@ -340,7 +340,7 @@ notifyVisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt; ...@@ -340,7 +340,7 @@ notifyVisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
**示例：** **示例：**
```js ```ts
var formId = ["12400633174999288"]; var formId = ["12400633174999288"];
formHost.notifyVisibleForms(formId).then(() => { formHost.notifyVisibleForms(formId).then(() => {
console.log('formHost notifyVisibleForms success'); console.log('formHost notifyVisibleForms success');
...@@ -368,7 +368,7 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;vo ...@@ -368,7 +368,7 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;vo
**示例：** **示例：**
```js ```ts
var formId = ["12400633174999288"]; var formId = ["12400633174999288"];
formHost.notifyInvisibleForms(formId, (error, data) => { formHost.notifyInvisibleForms(formId, (error, data) => {
if (error.code) { if (error.code) {
...@@ -401,7 +401,7 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt; ...@@ -401,7 +401,7 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
**示例：** **示例：**
```js ```ts
var formId = ["12400633174999288"]; var formId = ["12400633174999288"];
formHost.notifyInvisibleForms(formId).then(() => { formHost.notifyInvisibleForms(formId).then(() => {
console.log('formHost notifyInvisibleForms success'); console.log('formHost notifyInvisibleForms success');
...@@ -429,7 +429,7 @@ enableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void& ...@@ -429,7 +429,7 @@ enableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void&
**示例：** **示例：**
```js ```ts
var formId = ["12400633174999288"]; var formId = ["12400633174999288"];
formHost.enableFormsUpdate(formId, (error, data) => { formHost.enableFormsUpdate(formId, (error, data) => {
if (error.code) { if (error.code) {
...@@ -462,7 +462,7 @@ enableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt; ...@@ -462,7 +462,7 @@ enableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
**示例：** **示例：**
```js ```ts
var formId = ["12400633174999288"]; var formId = ["12400633174999288"];
formHost.enableFormsUpdate(formId).then(() => { formHost.enableFormsUpdate(formId).then(() => {
console.log('formHost enableFormsUpdate success'); console.log('formHost enableFormsUpdate success');
...@@ -490,7 +490,7 @@ disableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void ...@@ -490,7 +490,7 @@ disableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void
**示例：** **示例：**
```js ```ts
var formId = ["12400633174999288"]; var formId = ["12400633174999288"];
formHost.disableFormsUpdate(formId, (error, data) => { formHost.disableFormsUpdate(formId, (error, data) => {
if (error.code) { if (error.code) {
...@@ -523,7 +523,7 @@ disableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt; ...@@ -523,7 +523,7 @@ disableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
**示例：** **示例：**
```js ```ts
var formId = ["12400633174999288"]; var formId = ["12400633174999288"];
formHost.disableFormsUpdate(formId).then(() => { formHost.disableFormsUpdate(formId).then(() => {
console.log('formHost disableFormsUpdate success'); console.log('formHost disableFormsUpdate success');
...@@ -548,7 +548,7 @@ isSystemReady(callback: AsyncCallback&lt;void&gt;): void ...@@ -548,7 +548,7 @@ isSystemReady(callback: AsyncCallback&lt;void&gt;): void
**示例：** **示例：**
```js ```ts
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.isSystemReady((error, data) => { formHost.isSystemReady((error, data) => {
if (error.code) { if (error.code) {
...@@ -573,7 +573,7 @@ isSystemReady(): Promise&lt;void&gt; ...@@ -573,7 +573,7 @@ isSystemReady(): Promise&lt;void&gt;
**示例：** **示例：**
```js ```ts
var formId = "12400633174999288"; var formId = "12400633174999288";
formHost.isSystemReady().then(() => { formHost.isSystemReady().then(() => {
console.log('formHost isSystemReady success'); console.log('formHost isSystemReady success');
...@@ -596,11 +596,11 @@ getAllFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): ...@@ -596,11 +596,11 @@ getAllFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;):
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](./js-apis-formInfo.md#forminfo-1)&gt;&gt; | 是 | 回调函数。当获取设备上所有应用提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 | | callback | AsyncCallback&lt;Array&lt;[FormInfo](js-apis-application-formInfo.md)&gt;&gt; | 是 | 回调函数。当获取设备上所有应用提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 |
**示例：** **示例：**
```js ```ts
formHost.getAllFormsInfo((error, data) => { formHost.getAllFormsInfo((error, data) => {
if (error.code) { if (error.code) {
console.log('formHost getAllFormsInfo, error:' + JSON.stringify(error)); console.log('formHost getAllFormsInfo, error:' + JSON.stringify(error));
...@@ -624,11 +624,11 @@ getAllFormsInfo(): Promise&lt;Array&lt;formInfo.FormInfo&gt;&gt; ...@@ -624,11 +624,11 @@ getAllFormsInfo(): Promise&lt;Array&lt;formInfo.FormInfo&gt;&gt;
| 类型 | 说明 | | 类型 | 说明 |
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise&lt;Array&lt;[FormInfo](./js-apis-formInfo.md#forminfo-1)&gt;&gt; | Promise对象，返回查询到的卡片信息。 | | Promise&lt;Array&lt;[FormInfo](js-apis-application-formInfo.md)&gt;&gt; | Promise对象，返回查询到的卡片信息。 |
**示例：** **示例：**
```js ```ts
formHost.getAllFormsInfo().then((data) => { formHost.getAllFormsInfo().then((data) => {
console.log('formHost getAllFormsInfo data:' + JSON.stringify(data)); console.log('formHost getAllFormsInfo data:' + JSON.stringify(data));
}).catch((error) => { }).catch((error) => {
...@@ -651,11 +651,11 @@ getFormsInfo(bundleName: string, callback: AsyncCallback&lt;Array&lt;formInfo.Fo ...@@ -651,11 +651,11 @@ getFormsInfo(bundleName: string, callback: AsyncCallback&lt;Array&lt;formInfo.Fo
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| bundleName | string | 是 | 要查询的应用程序包名称。 | | bundleName | string | 是 | 要查询的应用程序包名称。 |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](./js-apis-formInfo.md#forminfo-1)&gt;&gt; | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 | | callback | AsyncCallback&lt;Array&lt;[FormInfo](js-apis-application-formInfo.md)&gt;&gt; | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 |
**示例：** **示例：**
```js ```ts
formHost.getFormsInfo("com.example.ohos.formjsdemo", (error, data) => { formHost.getFormsInfo("com.example.ohos.formjsdemo", (error, data) => {
if (error.code) { if (error.code) {
console.log('formHost getFormsInfo, error:' + JSON.stringify(error)); console.log('formHost getFormsInfo, error:' + JSON.stringify(error));
...@@ -681,11 +681,11 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback&lt; ...@@ -681,11 +681,11 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback&lt;
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| bundleName | string | 是 | 要查询的应用程序包名称。 | | bundleName | string | 是 | 要查询的应用程序包名称。 |
| moduleName | string | 是 | 要查询的模块名称。 | | moduleName | string | 是 | 要查询的模块名称。 |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](./js-apis-formInfo.md#forminfo-1)&gt;&gt; | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 | | callback | AsyncCallback&lt;Array&lt;[FormInfo](js-apis-application-formInfo.md)&gt;&gt; | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功，err为undefined，data为查询到的卡片信息；否则为错误对象。 |
**示例：** **示例：**
```js ```ts
formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry", (error, data) => { formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry", (error, data) => {
if (error.code) { if (error.code) {
console.log('formHost getFormsInfo, error:' + JSON.stringify(error)); console.log('formHost getFormsInfo, error:' + JSON.stringify(error));
...@@ -716,11 +716,11 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise&lt;Array&lt;formI ...@@ -716,11 +716,11 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise&lt;Array&lt;formI
| 类型 | 说明 | | 类型 | 说明 |
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise&lt;Array&lt;[FormInfo](./js-apis-formInfo.md#forminfo-1)&gt;&gt; | Promise对象，返回查询到的卡片信息。 | | Promise&lt;Array&lt;[FormInfo](js-apis-application-formInfo.md)&gt;&gt; | Promise对象，返回查询到的卡片信息。 |
**示例：** **示例：**
```js ```ts
formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry").then((data) => { formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry").then((data) => {
console.log('formHost getFormsInfo, data:' + JSON.stringify(data)); console.log('formHost getFormsInfo, data:' + JSON.stringify(data));
}).catch((error) => { }).catch((error) => {
...@@ -747,7 +747,7 @@ deleteInvalidForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;numb ...@@ -747,7 +747,7 @@ deleteInvalidForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;numb
**示例：** **示例：**
```js ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); var formIds = new Array("12400633174999288", "12400633174999289");
formHost.deleteInvalidForms(formIds, (error, data) => { formHost.deleteInvalidForms(formIds, (error, data) => {
if (error.code) { if (error.code) {
...@@ -782,7 +782,7 @@ deleteInvalidForms(formIds: Array&lt;string&gt;): Promise&lt;number&gt; ...@@ -782,7 +782,7 @@ deleteInvalidForms(formIds: Array&lt;string&gt;): Promise&lt;number&gt;
**示例：** **示例：**
```js ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); var formIds = new Array("12400633174999288", "12400633174999289");
formHost.deleteInvalidForms(formIds).then((data) => { formHost.deleteInvalidForms(formIds).then((data) => {
console.log('formHost deleteInvalidForms, data:' + JSON.stringify(data)); console.log('formHost deleteInvalidForms, data:' + JSON.stringify(data));
...@@ -805,12 +805,12 @@ acquireFormState(want: Want, callback: AsyncCallback&lt;formInfo.FormStateInfo&g ...@@ -805,12 +805,12 @@ acquireFormState(want: Want, callback: AsyncCallback&lt;formInfo.FormStateInfo&g
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| want | [Want](js-apis-application-Want.md) | 是 | 查询卡片状态时携带的want信息。 | | want | [Want](js-apis-application-want.md) | 是 | 查询卡片状态时携带的want信息。 |
| callback | AsyncCallback&lt;[FormStateInfo](js-apis-formInfo.md#formstateinfo)&gt; | 是 | 回调函数。当获取卡片状态成功，err为undefined，data为获取到的卡片状态；否则为错误对象。 | | callback | AsyncCallback&lt;[FormStateInfo](js-apis-application-formInfo.md#formstateinfo)&gt; | 是 | 回调函数。当获取卡片状态成功，err为undefined，data为获取到的卡片状态；否则为错误对象。 |
**示例：** **示例：**
```js ```ts
var want = { var want = {
"deviceId": "", "deviceId": "",
"bundleName": "ohos.samples.FormApplication", "bundleName": "ohos.samples.FormApplication",
...@@ -844,17 +844,17 @@ acquireFormState(want: Want): Promise&lt;formInfo.FormStateInfo&gt; ...@@ -844,17 +844,17 @@ acquireFormState(want: Want): Promise&lt;formInfo.FormStateInfo&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| want | [Want](js-apis-application-Want.md) | 是 | 查询卡片状态时携带的want信息。 | | want | [Want](js-apis-application-want.md) | 是 | 查询卡片状态时携带的want信息。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise&lt;[FormStateInfo](js-apis-formInfo.md#formstateinfo)&gt; | Promise对象，返回卡片状态。 | | Promise&lt;[FormStateInfo](js-apis-application-formInfo.md#formstateinfo)&gt; | Promise对象，返回卡片状态。 |
**示例：** **示例：**
```js ```ts
var want = { var want = {
"deviceId": "", "deviceId": "",
"bundleName": "ohos.samples.FormApplication", "bundleName": "ohos.samples.FormApplication",
...@@ -889,7 +889,7 @@ on(type: "formUninstall", callback: Callback&lt;string&gt;): void ...@@ -889,7 +889,7 @@ on(type: "formUninstall", callback: Callback&lt;string&gt;): void
**示例：** **示例：**
```js ```ts
let callback = function(formId) { let callback = function(formId) {
console.log('formHost on formUninstall, formId:' + formId); console.log('formHost on formUninstall, formId:' + formId);
} }
...@@ -913,7 +913,7 @@ off(type: "formUninstall", callback?: Callback&lt;string&gt;): void ...@@ -913,7 +913,7 @@ off(type: "formUninstall", callback?: Callback&lt;string&gt;): void
**示例：** **示例：**
```js ```ts
let callback = function(formId) { let callback = function(formId) {
console.log('formHost on formUninstall, formId:' + formId); console.log('formHost on formUninstall, formId:' + formId);
} }
...@@ -940,7 +940,7 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean, callback: A ...@@ -940,7 +940,7 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean, callback: A
**示例：** **示例：**
```js ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); var formIds = new Array("12400633174999288", "12400633174999289");
formHost.notifyFormsVisible(formIds, true, (error, data) => { formHost.notifyFormsVisible(formIds, true, (error, data) => {
if (error.code) { if (error.code) {
...@@ -974,7 +974,7 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean): Promise&lt ...@@ -974,7 +974,7 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean): Promise&lt
**示例：** **示例：**
```js ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); var formIds = new Array("12400633174999288", "12400633174999289");
formHost.notifyFormsVisible(formIds, true).then(() => { formHost.notifyFormsVisible(formIds, true).then(() => {
console.log('formHost notifyFormsVisible success'); console.log('formHost notifyFormsVisible success');
...@@ -1003,7 +1003,7 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean, c ...@@ -1003,7 +1003,7 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean, c
**示例：** **示例：**
```js ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); var formIds = new Array("12400633174999288", "12400633174999289");
formHost.notifyFormsEnableUpdate(formIds, true, (error, data) => { formHost.notifyFormsEnableUpdate(formIds, true, (error, data) => {
if (error.code) { if (error.code) {
...@@ -1037,7 +1037,7 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean): ...@@ -1037,7 +1037,7 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean):
**示例：** **示例：**
```js ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); var formIds = new Array("12400633174999288", "12400633174999289");
formHost.notifyFormsEnableUpdate(formIds, true).then(() => { formHost.notifyFormsEnableUpdate(formIds, true).then(() => {
console.log('formHost notifyFormsEnableUpdate success'); console.log('formHost notifyFormsEnableUpdate success');
...@@ -1065,7 +1065,7 @@ shareForm(formId: string, deviceId: string, callback: AsyncCallback&lt;void&gt;) ...@@ -1065,7 +1065,7 @@ shareForm(formId: string, deviceId: string, callback: AsyncCallback&lt;void&gt;)
**示例：** **示例：**
```js ```ts
var formId = "12400633174999288"; var formId = "12400633174999288";
var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2"; var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2";
formHost.shareForm(formId, deviceId, (error, data) => { formHost.shareForm(formId, deviceId, (error, data) => {
...@@ -1100,7 +1100,7 @@ shareForm(formId: string, deviceId: string): Promise&lt;void&gt; ...@@ -1100,7 +1100,7 @@ shareForm(formId: string, deviceId: string): Promise&lt;void&gt;
**参数：** **参数：**
```js ```ts
var formId = "12400633174999288"; var formId = "12400633174999288";
var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2"; var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2";
formHost.shareForm(formId, deviceId).then(() => { formHost.shareForm(formId, deviceId).then(() => {
...@@ -1125,7 +1125,7 @@ notifyFormsPrivacyProtected(formIds: Array<string>, isProtected: boolean, callba ...@@ -1125,7 +1125,7 @@ notifyFormsPrivacyProtected(formIds: Array<string>, isProtected: boolean, callba
| formId | string | 是 | 卡片标识。 | | formId | string | 是 | 卡片标识。 |
| deviceId | string | 是 | 远程设备标识。 | | deviceId | string | 是 | 远程设备标识。 |
```js ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); var formIds = new Array("12400633174999288", "12400633174999289");
formHost.notifyFormsPrivacyProtected(formIds, true).then(() => { formHost.notifyFormsPrivacyProtected(formIds, true).then(() => {
console.log('formHost shareForm success'); console.log('formHost shareForm success');
......
zh-cn/application-dev/reference/apis/js-apis-formInfo.md → zh-cn/application-dev/reference/apis/js-apis-application-formInfo.md
浏览文件 @ 0612bb09
...@@ -9,7 +9,7 @@ FormInfo模块提供对卡片的相关卡片信息和状态进行设置和查询 ...@@ -9,7 +9,7 @@ FormInfo模块提供对卡片的相关卡片信息和状态进行设置和查询
## 导入模块 ## 导入模块
``` ```ts
import formInfo from '@ohos.application.formInfo'; import formInfo from '@ohos.application.formInfo';
``` ```
......
zh-cn/application-dev/reference/apis/js-apis-formprovider.md → zh-cn/application-dev/reference/apis/js-apis-application-formProvider.md
浏览文件 @ 0612bb09
...@@ -8,7 +8,7 @@ FormProvider模块提供了卡片提供方相关接口的能力，开发者在 ...@@ -8,7 +8,7 @@ FormProvider模块提供了卡片提供方相关接口的能力，开发者在
## 导入模块 ## 导入模块
``` ```ts
import formProvider from '@ohos.application.formProvider'; import formProvider from '@ohos.application.formProvider';
``` ```
...@@ -30,7 +30,7 @@ setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback&l ...@@ -30,7 +30,7 @@ setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback&l
**示例：** **示例：**
```js ```ts
var formId = "12400633174999288"; var formId = "12400633174999288";
formProvider.setFormNextRefreshTime(formId, 5, (error, data) => { formProvider.setFormNextRefreshTime(formId, 5, (error, data) => {
if (error.code) { if (error.code) {
...@@ -62,7 +62,7 @@ setFormNextRefreshTime(formId: string, minute: number): Promise&lt;void&gt; ...@@ -62,7 +62,7 @@ setFormNextRefreshTime(formId: string, minute: number): Promise&lt;void&gt;
**示例：** **示例：**
```js ```ts
var formId = "12400633174999288"; var formId = "12400633174999288";
formProvider.setFormNextRefreshTime(formId, 5).then(() => { formProvider.setFormNextRefreshTime(formId, 5).then(() => {
console.log('formProvider setFormNextRefreshTime success'); console.log('formProvider setFormNextRefreshTime success');
...@@ -84,12 +84,12 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData,call ...@@ -84,12 +84,12 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData,call
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------------------------------------------------------------------- | ---- | ---------------- | | ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
| formId | string | 是 | 请求更新的卡片标识。 | | formId | string | 是 | 请求更新的卡片标识。 |
| formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据。 | | formBindingData | [FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是 | 用于更新的数据。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```ts
import formBindingData from '@ohos.application.formBindingData'; import formBindingData from '@ohos.application.formBindingData';
var formId = "12400633174999288"; var formId = "12400633174999288";
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
...@@ -113,7 +113,7 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr ...@@ -113,7 +113,7 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------------------------------------------------------------------- | ---- | ---------------- | | ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
| formId | string | 是 | 请求更新的卡片标识。 | | formId | string | 是 | 请求更新的卡片标识。 |
| formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据。 | | formBindingData | [FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是 | 用于更新的数据。 |
**返回值：** **返回值：**
...@@ -123,7 +123,7 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr ...@@ -123,7 +123,7 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr
**示例：** **示例：**
```js ```ts
import formBindingData from '@ohos.application.formBindingData'; import formBindingData from '@ohos.application.formBindingData';
var formId = "12400633174999288"; var formId = "12400633174999288";
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
...@@ -146,11 +146,11 @@ getFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): voi ...@@ -146,11 +146,11 @@ getFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): voi
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](./js-apis-formInfo.md#forminfo-1)&gt;&gt; | 是 | 回调函数。返回查询到的卡片信息。 | | callback | AsyncCallback&lt;Array&lt;[FormInfo](./js-apis-application-formInfo.md#forminfo-1)&gt;&gt; | 是 | 回调函数。返回查询到的卡片信息。 |
**示例：** **示例：**
```js ```ts
formProvider.getFormsInfo((error, data) => { formProvider.getFormsInfo((error, data) => {
if (error.code) { if (error.code) {
console.log('formProvider getFormsInfo, error:' + JSON.stringify(error)); console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
...@@ -171,12 +171,12 @@ getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback&lt;Array&l ...@@ -171,12 +171,12 @@ getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback&lt;Array&l
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| filter | [formInfo.FormInfoFilter](./js-apis-formInfo.md#forminfofilter) | 是 | 卡片信息过滤器。 | | filter | [formInfo.FormInfoFilter](./js-apis-application-formInfo.md#forminfofilter) | 是 | 卡片信息过滤器。 |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](./js-apis-formInfo.md#forminfo-1)&gt;&gt; | 是 | 回调函数。返回查询到符合条件的卡片信息。 | | callback | AsyncCallback&lt;Array&lt;[FormInfo](./js-apis-application-formInfo.md#forminfo-1)&gt;&gt; | 是 | 回调函数。返回查询到符合条件的卡片信息。 |
**示例：** **示例：**
```js ```ts
import formInfo from '@ohos.application.formInfo'; import formInfo from '@ohos.application.formInfo';
const filter : formInfo.FormInfoFilter = { const filter : formInfo.FormInfoFilter = {
// get info of forms belong to module entry. // get info of forms belong to module entry.
...@@ -203,17 +203,17 @@ getFormsInfo(filter?: formInfo.FormInfoFilter): Promise&lt;Array&lt;formInfo.For ...@@ -203,17 +203,17 @@ getFormsInfo(filter?: formInfo.FormInfoFilter): Promise&lt;Array&lt;formInfo.For
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| filter | [formInfo.FormInfoFilter](./js-apis-formInfo.md) | 否 | 卡片信息过滤器。 | | filter | [formInfo.FormInfoFilter](./js-apis-application-formInfo.md) | 否 | 卡片信息过滤器。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise&lt;Array&lt;[FormInfo](./js-apis-formInfo.md#forminfo-1)&gt;&gt; | Promise对象。返回查询到符合条件的卡片信息。 | | Promise&lt;Array&lt;[FormInfo](./js-apis-application-formInfo.md#forminfo-1)&gt;&gt; | Promise对象。返回查询到符合条件的卡片信息。 |
**示例：** **示例：**
```js ```ts
import formInfo from '@ohos.application.formInfo'; import formInfo from '@ohos.application.formInfo';
const filter : formInfo.FormInfoFilter = { const filter : formInfo.FormInfoFilter = {
// get info of forms belong to module entry. // get info of forms belong to module entry.
...@@ -240,13 +240,13 @@ requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData, ...@@ -240,13 +240,13 @@ requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData,
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------------------------------------------------------------------- | ---- | ---------------- | | ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
| want | [Want](js-apis-application-Want.md) | 是 | 发布请求。需包含以下字段。<br>abilityName: 目标卡片ability<br>parameters:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" | | want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。<br>abilityName: 目标卡片ability<br>parameters:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" |
| formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 创建卡片的数据。 | | formBindingData | [FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是 | 创建卡片的数据。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。返回卡片标识。 | | callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。返回卡片标识。 |
**示例：** **示例：**
```js ```ts
import formBindingData from '@ohos.application.formBindingData'; import formBindingData from '@ohos.application.formBindingData';
var want = { var want = {
abilityName: "FormAbility", abilityName: "FormAbility",
...@@ -280,12 +280,12 @@ requestPublishForm(want: Want, callback: AsyncCallback&lt;string&gt;): void ...@@ -280,12 +280,12 @@ requestPublishForm(want: Want, callback: AsyncCallback&lt;string&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ----------------------------------- | ---- | ------------------------------------------------------------ |
| want | [Want](js-apis-application-Want.md) | 是 | 发布请求。需包含以下字段。<br>abilityName: 目标卡片ability<br>parameters:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" | | want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。<br>abilityName: 目标卡片ability<br>parameters:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。返回卡片标识。 | | callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。返回卡片标识。 |
**示例：** **示例：**
```js ```ts
var want = { var want = {
abilityName: "FormAbility", abilityName: "FormAbility",
parameters: { parameters: {
...@@ -317,8 +317,8 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData ...@@ -317,8 +317,8 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | --------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| want | [Want](js-apis-application-Want.md) | 是 | 发布请求。需包含以下字段。<br>abilityName: 目标卡片ability<br>parameters:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" | | want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。<br>abilityName: 目标卡片ability<br>parameters:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" |
| formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 否 | 创建卡片的数据。 | | formBindingData | [FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 否 | 创建卡片的数据。 |
**返回值：** **返回值：**
...@@ -328,7 +328,7 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData ...@@ -328,7 +328,7 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData
**示例：** **示例：**
```js ```ts
var want = { var want = {
abilityName: "FormAbility", abilityName: "FormAbility",
parameters: { parameters: {
...@@ -362,7 +362,7 @@ isRequestPublishFormSupported(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -362,7 +362,7 @@ isRequestPublishFormSupported(callback: AsyncCallback&lt;boolean&gt;): void
**示例：** **示例：**
```js ```ts
formProvider.isRequestPublishFormSupported((error, isSupported) => { formProvider.isRequestPublishFormSupported((error, isSupported) => {
if (error.code) { if (error.code) {
console.log('formProvider isRequestPublishFormSupported, error:' + JSON.stringify(error)); console.log('formProvider isRequestPublishFormSupported, error:' + JSON.stringify(error));
...@@ -406,7 +406,7 @@ isRequestPublishFormSupported(): Promise&lt;boolean&gt; ...@@ -406,7 +406,7 @@ isRequestPublishFormSupported(): Promise&lt;boolean&gt;
**示例：** **示例：**
```js ```ts
formProvider.isRequestPublishFormSupported().then((isSupported) => { formProvider.isRequestPublishFormSupported().then((isSupported) => {
if (isSupported) { if (isSupported) {
var want = { var want = {
......
zh-cn/application-dev/reference/apis/js-apis-missionManager.md → zh-cn/application-dev/reference/apis/js-apis-application-missionManager.md 100755 → 100644
浏览文件 @ 0612bb09
...@@ -4,11 +4,11 @@ missionManager模块提供系统任务管理能力，包括对系统任务执行 ...@@ -4,11 +4,11 @@ missionManager模块提供系统任务管理能力，包括对系统任务执行
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 8开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.missionManager](js-apis-app-ability-missionManager.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
``` ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
``` ```
...@@ -32,7 +32,7 @@ registerMissionListener(listener: MissionListener): number; ...@@ -32,7 +32,7 @@ registerMissionListener(listener: MissionListener): number;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| listener | MissionListener | 是 | 系统任务监听方法。 | | listener | [MissionListener](js-apis-inner-application-missionListener.md) | 是 | 系统任务监听方法。 |
**返回值：** **返回值：**
...@@ -42,18 +42,18 @@ registerMissionListener(listener: MissionListener): number; ...@@ -42,18 +42,18 @@ registerMissionListener(listener: MissionListener): number;
**示例：** **示例：**
```js ```ts
var listener = { var listener = {
onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")}, onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")},
onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")}, onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")},
onMissionSnapshotChanged: function (mission) {console.log("--------onMissionSnapshotChanged-------")}, onMissionSnapshotChanged: function (mission) {console.log("--------onMissionSnapshotChanged-------")},
onMissionMovedToFront: function (mission) {console.log("--------onMissionMovedToFront-------")}, onMissionMovedToFront: function (mission) {console.log("--------onMissionMovedToFront-------")},
onMissionIconUpdated: function (mission, icon) {console.log("--------onMissionIconUpdated-------")}, onMissionIconUpdated: function (mission, icon) {console.log("--------onMissionIconUpdated-------")},
onMissionClosed: function (mission) {console.log("--------onMissionClosed-------")}, onMissionClosed: function (mission) {console.log("--------onMissionClosed-------")},
onMissionLabelUpdated: function (mission) {console.log("--------onMissionLabelUpdated-------")} onMissionLabelUpdated: function (mission) {console.log("--------onMissionLabelUpdated-------")}
}; };
console.log("registerMissionListener") console.log("registerMissionListener")
var listenerid = missionManager.registerMissionListener(listener); var listenerid = missionManager.registerMissionListener(listener);
``` ```
...@@ -78,7 +78,7 @@ unregisterMissionListener(listenerId: number, callback: AsyncCallback&lt;void&gt ...@@ -78,7 +78,7 @@ unregisterMissionListener(listenerId: number, callback: AsyncCallback&lt;void&gt
**示例：** **示例：**
```js ```ts
var listener = { var listener = {
onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")}, onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")},
onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")}, onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")},
...@@ -123,7 +123,7 @@ unregisterMissionListener(listenerId: number): Promise&lt;void&gt;; ...@@ -123,7 +123,7 @@ unregisterMissionListener(listenerId: number): Promise&lt;void&gt;;
**示例：** **示例：**
```js ```ts
var listener = { var listener = {
onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")}, onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")},
onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")}, onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")},
...@@ -160,11 +160,11 @@ getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback&lt;M ...@@ -160,11 +160,11 @@ getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback&lt;M
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 设备ID，本机默认为空字符串。 | | deviceId | string | 是 | 设备ID，本机默认为空字符串。 |
| missionId | number | 是 | 任务ID。 | | missionId | number | 是 | 任务ID。 |
| callback | AsyncCallback&lt;[MissionInfo](#missioninfo)&gt; | 是 | 执行结果回调函数，返回任务信息。 | | callback | AsyncCallback&lt;[MissionInfo](js-apis-inner-application-missionInfo.md)&gt; | 是 | 执行结果回调函数，返回任务信息。 |
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
var allMissions=missionManager.getMissionInfos("",10).catch(function(err){console.log(err);}); var allMissions=missionManager.getMissionInfos("",10).catch(function(err){console.log(err);});
...@@ -203,11 +203,11 @@ getMissionInfo(deviceId: string, missionId: number): Promise&lt;MissionInfo&gt;; ...@@ -203,11 +203,11 @@ getMissionInfo(deviceId: string, missionId: number): Promise&lt;MissionInfo&gt;;
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;[MissionInfo](#missioninfo)&gt; | 任务信息。 | | Promise&lt;[MissionInfo](js-apis-inner-application-missionInfo.md)&gt; | 任务信息。 |
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
var mission = missionManager.getMissionInfo("", 10).catch(function (err){ var mission = missionManager.getMissionInfo("", 10).catch(function (err){
...@@ -234,11 +234,11 @@ getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback&lt;Arr ...@@ -234,11 +234,11 @@ getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback&lt;Arr
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 设备ID，本机默认为空字符串。 | | deviceId | string | 是 | 设备ID，本机默认为空字符串。 |
| numMax | number | 是 | 任务信息数量上限。 | | numMax | number | 是 | 任务信息数量上限。 |
| callback | AsyncCallback&lt;Array&lt;[MissionInfo](#missioninfo)&gt;&gt; | 是 | 执行结果回调函数，返回任务信息数组。 | | callback | AsyncCallback&lt;Array&lt;[MissionInfo](js-apis-inner-application-missionInfo.md)&gt;&gt; | 是 | 执行结果回调函数，返回任务信息数组。 |
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
missionManager.getMissionInfos("", 10, (error, missions) => { missionManager.getMissionInfos("", 10, (error, missions) => {
...@@ -272,11 +272,11 @@ getMissionInfos(deviceId: string, numMax: number): Promise&lt;Array&lt;MissionIn ...@@ -272,11 +272,11 @@ getMissionInfos(deviceId: string, numMax: number): Promise&lt;Array&lt;MissionIn
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;Array&lt;[MissionInfo](#missioninfo)&gt;&gt; | 任务信息数组。 | | Promise&lt;Array&lt;[MissionInfo](js-apis-inner-application-missionInfo.md)&gt;&gt; | 任务信息数组。 |
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
var allMissions = missionManager.getMissionInfos("", 10).catch(function (err){ var allMissions = missionManager.getMissionInfos("", 10).catch(function (err){
...@@ -303,11 +303,11 @@ getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback& ...@@ -303,11 +303,11 @@ getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback&
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 设备ID，本机默认为空字符串。 | | deviceId | string | 是 | 设备ID，本机默认为空字符串。 |
| missionId | number | 是 | 任务ID。 | | missionId | number | 是 | 任务ID。 |
| callback | AsyncCallback&lt;[MissionSnapshot](js-apis-application-MissionSnapshot.md)&gt; | 是 | 执行结果回调函数，返回任务快照信息。 | | callback | AsyncCallback&lt;[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)&gt; | 是 | 执行结果回调函数，返回任务快照信息。 |
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
missionManager.getMissionInfos("", 10, (error, missions) => { missionManager.getMissionInfos("", 10, (error, missions) => {
...@@ -347,11 +347,11 @@ getMissionSnapShot(deviceId: string, missionId: number): Promise&lt;MissionSnaps ...@@ -347,11 +347,11 @@ getMissionSnapShot(deviceId: string, missionId: number): Promise&lt;MissionSnaps
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;[MissionSnapshot](js-apis-application-MissionSnapshot.md)&gt; | 任务快照信息。 | | Promise&lt;[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)&gt; | 任务快照信息。 |
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
var allMissions; var allMissions;
...@@ -385,11 +385,11 @@ getLowResolutionMissionSnapShot(deviceId: string, missionId: number, callback: A ...@@ -385,11 +385,11 @@ getLowResolutionMissionSnapShot(deviceId: string, missionId: number, callback: A
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 设备ID，本机默认为空字符串。 | | deviceId | string | 是 | 设备ID，本机默认为空字符串。 |
| missionId | number | 是 | 任务ID。 | | missionId | number | 是 | 任务ID。 |
| callback | AsyncCallback&lt;[MissionSnapshot](js-apis-application-MissionSnapshot.md)&gt; | 是 | 执行结果回调函数，返回任务快照信息。 | | callback | AsyncCallback&lt;[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)&gt; | 是 | 执行结果回调函数，返回任务快照信息。 |
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
missionManager.getMissionInfos("", 10, (error, missions) => { missionManager.getMissionInfos("", 10, (error, missions) => {
...@@ -429,11 +429,11 @@ getLowResolutionMissionSnapShot(deviceId: string, missionId: number): Promise\<M ...@@ -429,11 +429,11 @@ getLowResolutionMissionSnapShot(deviceId: string, missionId: number): Promise\<M
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;[MissionSnapshot](js-apis-application-MissionSnapshot.md)&gt; | 任务快照信息。 | | Promise&lt;[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)&gt; | 任务快照信息。 |
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
var allMissions; var allMissions;
...@@ -471,7 +471,7 @@ lockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void; ...@@ -471,7 +471,7 @@ lockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
missionManager.getMissionInfos("", 10, (error, missions) => { missionManager.getMissionInfos("", 10, (error, missions) => {
...@@ -513,7 +513,7 @@ lockMission(missionId: number): Promise&lt;void&gt;; ...@@ -513,7 +513,7 @@ lockMission(missionId: number): Promise&lt;void&gt;;
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
var allMissions; var allMissions;
missionManager.getMissionInfos("",10).then(function(res){ missionManager.getMissionInfos("",10).then(function(res){
...@@ -550,7 +550,7 @@ unlockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void; ...@@ -550,7 +550,7 @@ unlockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
missionManager.getMissionInfos("", 10, (error, missions) => { missionManager.getMissionInfos("", 10, (error, missions) => {
...@@ -592,7 +592,7 @@ unlockMission(missionId: number): Promise&lt;void&gt;; ...@@ -592,7 +592,7 @@ unlockMission(missionId: number): Promise&lt;void&gt;;
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
var allMissions; var allMissions;
...@@ -633,7 +633,7 @@ clearMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void; ...@@ -633,7 +633,7 @@ clearMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
missionManager.getMissionInfos("", 10, (error, missions) => { missionManager.getMissionInfos("", 10, (error, missions) => {
...@@ -675,7 +675,7 @@ clearMission(missionId: number): Promise&lt;void&gt;; ...@@ -675,7 +675,7 @@ clearMission(missionId: number): Promise&lt;void&gt;;
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
var allMissions; var allMissions;
...@@ -706,7 +706,7 @@ clearAllMissions(callback: AsyncCallback&lt;void&gt;): void; ...@@ -706,7 +706,7 @@ clearAllMissions(callback: AsyncCallback&lt;void&gt;): void;
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
missionManager.clearAllMissions().then(() => { missionManager.clearAllMissions().then(() => {
...@@ -735,7 +735,7 @@ clearAllMissions(): Promise&lt;void&gt;; ...@@ -735,7 +735,7 @@ clearAllMissions(): Promise&lt;void&gt;;
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
missionManager.clearAllMissions().catch(function (err){ missionManager.clearAllMissions().catch(function (err){
console.log(err); console.log(err);
...@@ -764,7 +764,7 @@ moveMissionToFront(missionId: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -764,7 +764,7 @@ moveMissionToFront(missionId: number, callback: AsyncCallback&lt;void&gt;): void
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
missionManager.getMissionInfos("", 10, (error, missions) => { missionManager.getMissionInfos("", 10, (error, missions) => {
...@@ -797,12 +797,12 @@ moveMissionToFront(missionId: number, options: StartOptions, callback: AsyncCall ...@@ -797,12 +797,12 @@ moveMissionToFront(missionId: number, options: StartOptions, callback: AsyncCall
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 | | missionId | number | 是 | 任务ID。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 | | options | [StartOptions](js-apis-application-startOptions.md) | 是 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
missionManager.getMissionInfos("", 10, (error, missions) => { missionManager.getMissionInfos("", 10, (error, missions) => {
...@@ -835,7 +835,7 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&g ...@@ -835,7 +835,7 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&g
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 | | missionId | number | 是 | 任务ID。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 | | options | [StartOptions](js-apis-application-startOptions.md) | 否 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 |
**返回值：** **返回值：**
...@@ -845,7 +845,7 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&g ...@@ -845,7 +845,7 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&g
**示例：** **示例：**
```js ```ts
import missionManager from '@ohos.application.missionManager' import missionManager from '@ohos.application.missionManager'
var allMissions; var allMissions;
...@@ -859,23 +859,4 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&g ...@@ -859,23 +859,4 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&g
missionManager.moveMissionToFront(id).catch(function (err){ missionManager.moveMissionToFront(id).catch(function (err){
console.log(err); console.log(err);
}); });
``` ```
\ No newline at end of file
## MissionInfo
表示Ability对应任务信息的枚举。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口，三方应用不支持调用。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| missionId | number | 是 | 是 | 表示任务ID。|
| runningState | number | 是 | 是 | 表示运行状态。 |
| lockedState | boolean | 是 | 是 | 表示锁定状态。 |
| timestamp | string | 是 | 是 | 表示任务的最近创建或更新时间。 |
| want | [Want](js-apis-application-Want.md) | 是 | 是 | 表示任务的Want信息。 |
| label | string | 是 | 是 | 表示任务的标签。 |
| iconPath | string | 是 | 是 | 表示任务的图标路径。 |
| continuable | boolean | 是 | 是 | 表示任务是否可以迁移。 |
zh-cn/application-dev/reference/apis/js-apis-app-ability-service-extension-ability.md → zh-cn/application-dev/reference/apis/js-apis-application-serviceExtensionAbility.md
浏览文件 @ 0612bb09
...@@ -9,8 +9,8 @@ ServiceExtensionAbility模块提供ServiceExtension服务扩展相关接口的 ...@@ -9,8 +9,8 @@ ServiceExtensionAbility模块提供ServiceExtension服务扩展相关接口的
## 导入模块 ## 导入模块
``` ```ts
import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility'; import ServiceExtensionAbility from '@ohos.application.ServiceExtensionAbility';
``` ```
## 权限 ## 权限
...@@ -25,7 +25,7 @@ import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility'; ...@@ -25,7 +25,7 @@ import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility';
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| context | [ServiceExtensionContext](js-apis-service-extension-context.md) | 是 | 否 | ServiceExtension的上下文环境，继承自ExtensionContext。 | | context | [ServiceExtensionContext](js-apis-inner-application-serviceExtensionContext.md) | 是 | 否 | ServiceExtension的上下文环境，继承自ExtensionContext。 |
## ServiceExtensionAbility.onCreate ## ServiceExtensionAbility.onCreate
...@@ -42,11 +42,11 @@ Extension生命周期回调，在创建时回调，执行初始化业务逻辑 ...@@ -42,11 +42,11 @@ Extension生命周期回调，在创建时回调，执行初始化业务逻辑
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | | want | [Want](js-apis-application-want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 |
**示例：** **示例：**
```js ```ts
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
onCreate(want) { onCreate(want) {
console.log('onCreate, want:' + want.abilityName); console.log('onCreate, want:' + want.abilityName);
...@@ -67,7 +67,7 @@ Extension生命周期回调，在销毁时回调，执行资源清理等操作 ...@@ -67,7 +67,7 @@ Extension生命周期回调，在销毁时回调，执行资源清理等操作
**示例：** **示例：**
```js ```ts
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
onDestroy() { onDestroy() {
console.log('onDestroy'); console.log('onDestroy');
...@@ -90,12 +90,12 @@ Extension生命周期回调，如果是startAbility拉起的服务，会在onCre ...@@ -90,12 +90,12 @@ Extension生命周期回调，如果是startAbility拉起的服务，会在onCre
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | | want | [Want](js-apis-application-want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 |
| startId | number | 是 | 返回拉起次数。首次拉起初始值返回1，多次之后自动递增。 | | startId | number | 是 | 返回拉起次数。首次拉起初始值返回1，多次之后自动递增。 |
**示例：** **示例：**
```js ```ts
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
onRequest(want, startId) { onRequest(want, startId) {
console.log('onRequest, want:' + want.abilityName); console.log('onRequest, want:' + want.abilityName);
...@@ -118,7 +118,7 @@ Extension生命周期回调，如果是connectAbility拉起的服务，会在onC ...@@ -118,7 +118,7 @@ Extension生命周期回调，如果是connectAbility拉起的服务，会在onC
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | | want | [Want](js-apis-application-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 |
**返回值：** **返回值：**
...@@ -128,7 +128,7 @@ Extension生命周期回调，如果是connectAbility拉起的服务，会在onC ...@@ -128,7 +128,7 @@ Extension生命周期回调，如果是connectAbility拉起的服务，会在onC
**示例：** **示例：**
```js ```ts
import rpc from '@ohos.rpc' import rpc from '@ohos.rpc'
class StubTest extends rpc.RemoteObject{ class StubTest extends rpc.RemoteObject{
constructor(des) { constructor(des) {
...@@ -160,11 +160,11 @@ Extension的生命周期，断开服务连接时回调。 ...@@ -160,11 +160,11 @@ Extension的生命周期，断开服务连接时回调。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want |[Want](js-apis-application-Want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | | want |[Want](js-apis-application-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 |
**示例：** **示例：**
```js ```ts
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
onDisconnect(want) { onDisconnect(want) {
console.log('onDisconnect, want:' + want.abilityName); console.log('onDisconnect, want:' + want.abilityName);
...@@ -186,11 +186,11 @@ onReconnect(want: Want): void; ...@@ -186,11 +186,11 @@ onReconnect(want: Want): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want |[Want](js-apis-application-Want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | | want |[Want](js-apis-application-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 |
**示例：** **示例：**
```js ```ts
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
onReconnect(want) { onReconnect(want) {
console.log('onReconnect, want:' + want.abilityName); console.log('onReconnect, want:' + want.abilityName);
...@@ -212,11 +212,11 @@ onConfigurationUpdated(config: Configuration): void; ...@@ -212,11 +212,11 @@ onConfigurationUpdated(config: Configuration): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| config | [Configuration](js-apis-configuration.md) | 是 | 表示需要更新的配置信息。 | | config | [Configuration](js-apis-application-configuration.md) | 是 | 表示需要更新的配置信息。 |
**示例：** **示例：**
```js ```ts
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
onConfigurationUpdated(config) { onConfigurationUpdated(config) {
console.log('onConfigurationUpdated, config:' + JSON.stringify(config)); console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
...@@ -224,9 +224,9 @@ onConfigurationUpdated(config: Configuration): void; ...@@ -224,9 +224,9 @@ onConfigurationUpdated(config: Configuration): void;
} }
``` ```
## ServiceExtensionAbility.onDump ## ServiceExtensionAbility.dump
onDump(params: Array\<string>): Array\<string>; dump(params: Array\<string>): Array\<string>;
转储客户端信息时调用。 转储客户端信息时调用。
...@@ -242,9 +242,9 @@ onDump(params: Array\<string>): Array\<string>; ...@@ -242,9 +242,9 @@ onDump(params: Array\<string>): Array\<string>;
**示例：** **示例：**
```js ```ts
class ServiceExt extends ServiceExtension { class ServiceExt extends ServiceExtension {
onDump(params) { dump(params) {
console.log('dump, params:' + JSON.stringify(params)); console.log('dump, params:' + JSON.stringify(params));
return ["params"] return ["params"]
} }
......
zh-cn/application-dev/reference/apis/js-apis-application-StartOptions.md → zh-cn/application-dev/reference/apis/js-apis-application-startOptions.md
浏览文件 @ 0612bb09
...@@ -4,12 +4,12 @@ StartOptions模块对系统的基本通信组件进行查询和设置的能力 ...@@ -4,12 +4,12 @@ StartOptions模块对系统的基本通信组件进行查询和设置的能力
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 9 开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.StartOptions](js-apis-app-ability-StartOptions.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9 开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.StartOptions](js-apis-app-ability-startOptions.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。 > 本模块接口仅可在Stage模型下使用。
## 导入模块 ## 导入模块
``` ```ts
import StartOptions from '@ohos.application.StartOptions'; import StartOptions from '@ohos.application.StartOptions';
``` ```
......
zh-cn/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md
浏览文件 @ 0612bb09
...@@ -8,7 +8,7 @@ StaticSubscriberExtensionAbility模块提供静态订阅者ExtensionAbility的 ...@@ -8,7 +8,7 @@ StaticSubscriberExtensionAbility模块提供静态订阅者ExtensionAbility的
> 本模块接口仅可在Stage模型下使用。 > 本模块接口仅可在Stage模型下使用。
## 导入模块 ## 导入模块
``` ```ts
import StaticSubscriberExtensionAbility from '@ohos.application.StaticSubscriberExtensionAbility' import StaticSubscriberExtensionAbility from '@ohos.application.StaticSubscriberExtensionAbility'
``` ```
...@@ -30,7 +30,7 @@ onReceiveEvent(event: CommonEventData): void; ...@@ -30,7 +30,7 @@ onReceiveEvent(event: CommonEventData): void;
**示例：** **示例：**
```js ```ts
var StaticSubscriberExtensionAbility = requireNapi("application.StaticSubscriberExtensionAbility") var StaticSubscriberExtensionAbility = requireNapi("application.StaticSubscriberExtensionAbility")
{ {
onReceiveEvent(event){ onReceiveEvent(event){
......
zh-cn/application-dev/reference/apis/js-apis-testRunner.md → zh-cn/application-dev/reference/apis/js-apis-application-testRunner.md
浏览文件 @ 0612bb09
# TestRunner # TestRunner
TestRunner模块提供了框架测试的能力。包括准备单元测试环境、运行测试用例。 TestRunner模块提供了框架测试的能力。包括准备单元测试环境、运行测试用例。
如果您想实现自己的单元测试框架，您必须继承这个类并覆盖它的所有方法。 如果您想实现自己的单元测试框架，您必须继承这个类并覆盖它的所有方法。
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
```js ```ts
import TestRunner from '@ohos.application.testRunner' import TestRunner from '@ohos.application.testRunner'
``` ```
## TestRunner.onPrepare ## TestRunner.onPrepare
onPrepare(): void onPrepare(): void
为运行测试用例准备单元测试环境 为运行测试用例准备单元测试环境
**系统能力：** SystemCapability.Ability.AbilityRuntime.Core **系统能力：** SystemCapability.Ability.AbilityRuntime.Core
**示例：** **示例：**
```js ```ts
export default class UserTestRunner implements TestRunner { export default class UserTestRunner implements TestRunner {
onPrepare() { onPrepare() {
console.log("Trigger onPrepare") console.log("Trigger onPrepare")
} }
onRun() {} onRun() {}
}; };
``` ```
## TestRunner.onRun ## TestRunner.onRun
onRun(): void onRun(): void
运行测试用例 运行测试用例
**系统能力：** SystemCapability.Ability.AbilityRuntime.Core **系统能力：** SystemCapability.Ability.AbilityRuntime.Core
**示例：** **示例：**
```js ```ts
export default class UserTestRunner implements TestRunner { export default class UserTestRunner implements TestRunner {
onPrepare() {} onPrepare() {}
onRun() { onRun() {
console.log("Trigger onRun") console.log("Trigger onRun")
} }
}; };
``` ```
zh-cn/application-dev/reference/apis/js-apis-application-Want.md → zh-cn/application-dev/reference/apis/js-apis-application-want.md
浏览文件 @ 0612bb09
# Want # Want
Want模块提供系统的基本通信组件的能力。 Want是对象间信息传递的载体, 可以用于应用组件间的信息传递。 Want的使用场景之一是作为startAbility的参数, 其包含了指定的启动目标, 以及启动时需携带的相关数据, 如bundleName和abilityName字段分别指明目标Ability所在应用的包名以及对应包内的Ability名称。当Ability A需要启动Ability B并传入一些数据时, 可使用Want作为载体将这些数据传递给Ability B。
> **说明：** > **说明：**
> >
...@@ -8,7 +8,7 @@ Want模块提供系统的基本通信组件的能力。 ...@@ -8,7 +8,7 @@ Want模块提供系统的基本通信组件的能力。
## 导入模块 ## 导入模块
``` ```ts
import Want from '@ohos.application.Want'; import Want from '@ohos.application.Want';
``` ```
...@@ -16,24 +16,24 @@ import Want from '@ohos.application.Want'; ...@@ -16,24 +16,24 @@ import Want from '@ohos.application.Want';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------- | -------------------- | ---- | ------------------------------------------------------------ | | ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| deviceId | 是 | 否 | string | 否 | 表示运行指定Ability的设备ID。 | | deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 |
| bundleName | 是 | 否 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 | | bundleName | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| abilityName | 是 | 否 | string | 否 | 表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 | | abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 |
| uri | 是 | 否 | string | 否 | 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 | | 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。 | | 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说明)。 | | 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。 |
| 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）。 |
**示例：** **示例：**
- 基础用法 - 基础用法
``` js ```ts
var want = { var want = {
"deviceId": "", // deviceId为空表示本设备 "deviceId": "", // deviceId为空表示本设备
"bundleName": "com.extreme.test", "bundleName": "com.extreme.test",
...@@ -131,6 +131,4 @@ import Want from '@ohos.application.Want'; ...@@ -131,6 +131,4 @@ import Want from '@ohos.application.Want';
}) })
``` ```
<!--no_check--> <!--no_check-->
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-application-WindowExtensionAbility.md → zh-cn/application-dev/reference/apis/js-apis-application-windowExtensionAbility.md
浏览文件 @ 0612bb09
...@@ -21,7 +21,7 @@ import WindowExtensionAbility from '@ohos.application.WindowExtensionAbility'; ...@@ -21,7 +21,7 @@ import WindowExtensionAbility from '@ohos.application.WindowExtensionAbility';
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| --------- | -------- | ---- | ---- | ------------------------- | | --------- | -------- | ---- | ---- | ------------------------- |
| context | [ExtensionContext](js-apis-extension-context.md) | 是 | 否 | 上下文。 | | context | [ExtensionContext](js-apis-inner-application-extensionContext.md) | 是 | 否 | 上下文。 |
## WindowExtensionAbility.onConnect ## WindowExtensionAbility.onConnect
...@@ -35,7 +35,7 @@ onConnect(want: Want): void ...@@ -35,7 +35,7 @@ onConnect(want: Want): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 当前ability的Want类型信息，包括ability名称、bundle名称等。 | | want | [Want](js-apis-application-want.md) | 是 | 当前ability的Want类型信息，包括ability名称、bundle名称等。 |
**示例：** **示例：**
...@@ -61,7 +61,7 @@ onDisconnect(want: Want): void ...@@ -61,7 +61,7 @@ onDisconnect(want: Want): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 当前Ability的Want类型信息，包括ability名称、bundle名称等。 | | want | [Want](js-apis-application-want.md) | 是 | 当前Ability的Want类型信息，包括ability名称、bundle名称等。 |
**示例：** **示例：**
......
zh-cn/application-dev/reference/apis/js-apis-configurationconstant.md 已删除 100644 → 0
浏览文件 @ f1bc044f
# ConfigurationConstant
ConfigurationConstant模块提供配置信息枚举值定义的能力。
> **说明：**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```js
import ConfigurationConstant from '@ohos.application.ConfigurationConstant';
```
## ConfigurationConstant.ColorMode
使用时通过ConfigurationConstant.ColorMode获取。
**示例：**
```
ConfigurationConstant.ColorMode.COLOR_MODE_LIGHT
```
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| COLOR_MODE_NOT_SET | -1 | 未设置颜色模式。 |
| COLOR_MODE_DARK | 0 | 深色模式。 |
| COLOR_MODE_LIGHT | 1 | 浅色模式。 |
## ConfigurationConstant.Direction<sup>9+</sup>
使用时通过ConfigurationConstant.Direction获取。
**示例：**
```
ConfigurationConstant.Direction.DIRECTION_VERTICAL
```
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| DIRECTION_NOT_SET | -1 | 未设置方向。 |
| DIRECTION_VERTICAL | 0 | 垂直方向。 |
| DIRECTION_HORIZONTAL | 1 | 水平方向。 |
## ConfigurationConstant.ScreenDensity<sup>9+</sup>
使用时通过ConfigurationConstant.ScreenDensity获取。
**示例：**
```
ConfigurationConstant.ScreenDensity.SCREEN_DENSITY_NOT_SET
```
**系统能力**：以下各项对应的系统能力均为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-ability-abilityResult.md → zh-cn/application-dev/reference/apis/js-apis-inner-ability-abilityResult.md
浏览文件 @ 0612bb09
...@@ -4,10 +4,10 @@ ...@@ -4,10 +4,10 @@
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ | | ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| resultCode | 是 | 否 | number | 否 | 表示ability拉起、销毁之后返回的结果码。 | | resultCode | 只读 | number | 否 | 表示ability拉起、销毁之后返回的结果码。 |
| want | 是 | 否 | [Want](js-apis-ability-Want.md) | 否 | 表示ability销毁之后返回的数据。 | | want | 只读 | [Want](js-apis-application-want.md) | 否 | 表示ability销毁之后返回的数据。 |
**示例：** **示例：**
```ts ```ts
......
zh-cn/application-dev/reference/apis/js-apis-inner-ability-connectOptions.md 0 → 100644
浏览文件 @ 0612bb09
# ConnectOptions
ConnectOptions类型说明
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 参数名 | 可读|可写 | 类型 | 必填 | 说明 |
| ------------ | -- | -- | -------- | ---- | ------------------------- |
| onConnect<sup>7+</sup> | 是|否 | function | 是 | 连接成功时的回调函数。 |
| onDisconnect<sup>7+</sup> | 是|否 | function | 是 | 连接失败时的回调函数。 |
| onFailed<sup>7+</sup> | 是|否 | function | 是 | ConnectAbility调用失败时的回调函数。 |
**返回值：**
| 类型 | 说明 |
| ------ | -------------------- |
| number | 连接的ServiceAbilityID。 |
**示例：**
```ts
import rpc from '@ohos.rpc';
import featureAbility from '@ohos.ability.featureAbility';
function onConnectCallback(element, remote){
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
}
function onDisconnectCallback(element){
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
}
function onFailedCallback(code){
console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code)
}
var connectId = featureAbility.connectAbility(
{
deviceId: "",
bundleName: "com.ix.ServiceAbility",
abilityName: "ServiceAbilityA",
},
{
onConnect: onConnectCallback,
onDisconnect: onDisconnectCallback,
onFailed: onFailedCallback,
},
);
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md → zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityHelper.md
浏览文件 @ 0612bb09
# DataAbilityHelper模块(JS端SDK接口) # DataAbilityHelper模块(JS端SDK接口)
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在FA模型下使用。 > 本模块接口仅可在FA模型下使用。
## 使用说明 ## 使用说明
使用前根据具体情况引入如下模块 使用前根据具体情况引入如下模块
``` ```ts
import ohos_data_ability from '@ohos.data.dataAbility' import ohos_data_ability from '@ohos.data.dataAbility'
import ohos_data_rdb from '@ohos.data.rdb' import ohos_data_rdb from '@ohos.data.rdb'
``` ```
## DataAbilityHelper.openFile ## DataAbilityHelper.openFile
openFile(uri: string, mode: string, callback: AsyncCallback\<number>): void openFile(uri: string, mode: string, callback: AsyncCallback\<number>): void
在指定的远程路径中打开文件（callback形式）。 在指定的远程路径中打开文件（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ---------------------------------- | | -------- | ---------------------- | ---- | ---------------------------------- |
| uri | string | 是 | 指示要打开的文件的路径。 | | uri | string | 是 | 指示要打开的文件的路径。 |
| mode | string | 是 | 指示文件打开模式‘rwt’。 | | mode | string | 是 | 指示文件打开模式‘rwt’。 |
| callback | AsyncCallback\<number> | 是 | 被指定的回调方法，返回文件说明符。 | | callback | AsyncCallback\<number> | 是 | 被指定的回调方法，返回文件说明符。 |
**示例：** **示例：**
```javascript ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
var mode = "rwt"; var mode = "rwt";
DAHelper.openFile( DAHelper.openFile(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
mode, mode,
(err) => { (err) => {
console.info("==========================>Called=======================>"); console.info("==========================>Called=======================>");
}); });
``` ```
## DataAbilityHelper.openFile ## DataAbilityHelper.openFile
openFile(uri: string, mode: string): Promise\<number> openFile(uri: string, mode: string): Promise\<number>
在指定的远程路径中打开文件（promise形式）。 在指定的远程路径中打开文件（promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------------------ | | ---- | ------ | ---- | ------------------------ |
| uri | string | 是 | 指示要打开的文件的路径。 | | uri | string | 是 | 指示要打开的文件的路径。 |
| mode | string | 是 | 指示文件打开模式‘rwt’。 | | mode | string | 是 | 指示文件打开模式‘rwt’。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ---------------- | | ---------------- | ---------------- |
| Promise\<number> | 返回文件说明符。 | | Promise\<number> | 返回文件说明符。 |
**示例：** **示例：**
```javascript ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
var mode = "rwt"; var mode = "rwt";
DAHelper.openFile( DAHelper.openFile(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
mode).then((data) => { mode).then((data) => {
console.info("==========================>openFileCallback=======================>"); console.info("==========================>openFileCallback=======================>");
}); });
``` ```
## DataAbilityHelper.on ## DataAbilityHelper.on
on(type: 'dataChange', uri: string, callback: AsyncCallback\<void>): void on(type: 'dataChange', uri: string, callback: AsyncCallback\<void>): void
注册观察者以观察给定uri指定的数据callback通知。 注册观察者以观察给定uri指定的数据callback通知。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| type | string | 是 | 数据更改。 | | type | string | 是 | 数据更改。 |
| uri | string | 是 | 指示要操作的数据的路径。 | | uri | string | 是 | 指示要操作的数据的路径。 |
| callback | AsyncCallback\<void> | 是 | 指示数据更改时的回调。 | | callback | AsyncCallback\<void> | 是 | 指示数据更改时的回调。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var helper = featureAbility.acquireDataAbilityHelper( var helper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
function onChangeNotify() { function onChangeNotify() {
console.info("==========================>onChangeNotify=======================>"); console.info("==========================>onChangeNotify=======================>");
}; };
helper.on( helper.on(
"dataChange", "dataChange",
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
onChangeNotify onChangeNotify
) )
``` ```
## DataAbilityHelper.off ## DataAbilityHelper.off
off(type: 'dataChange', uri: string, callback?: AsyncCallback\<void>): void off(type: 'dataChange', uri: string, callback?: AsyncCallback\<void>): void
注消观察者以停止观察给定uri指定的数据callback通知。 注消观察者以停止观察给定uri指定的数据callback通知。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| type | string | 是 | 数据更改。 | | type | string | 是 | 数据更改。 |
| uri | string | 是 | 指示要操作的数据的路径。 | | uri | string | 是 | 指示要操作的数据的路径。 |
| callback | AsyncCallback\<void> | 否 | 指示已注册的回调。 | | callback | AsyncCallback\<void> | 否 | 指示已注册的回调。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var helper = featureAbility.acquireDataAbilityHelper( var helper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
function onChangeNotify() { function onChangeNotify() {
console.info("==========================>onChangeNotify=======================>"); console.info("==========================>onChangeNotify=======================>");
}; };
helper.off( helper.off(
"dataChange", "dataChange",
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
) )
helper.off( helper.off(
"dataChange", "dataChange",
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
onChangeNotify onChangeNotify
) )
``` ```
## DataAbilityHelper.getType ## DataAbilityHelper.getType
getType(uri: string, callback: AsyncCallback\<string>): void getType(uri: string, callback: AsyncCallback\<string>): void
获取给定URI指定数据的MIME类型（callback形式）。 获取给定URI指定数据的MIME类型（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | --------------------------------------------- | | -------- | ---------------------- | ---- | --------------------------------------------- |
| uri | string | 是 | 指示要操作的数据的路径。 | | uri | string | 是 | 指示要操作的数据的路径。 |
| callback | AsyncCallback\<string> | 是 | 回调方法，返回与uri指定的数据匹配的MIME类型。 | | callback | AsyncCallback\<string> | 是 | 回调方法，返回与uri指定的数据匹配的MIME类型。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
DAHelper.getType( DAHelper.getType(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
(err, data) => { (err, data) => {
console.info("==========================>Called=======================>"); console.info("==========================>Called=======================>");
}); });
``` ```
## DataAbilityHelper.getType ## DataAbilityHelper.getType
getType(uri: string): Promise\<string> getType(uri: string): Promise\<string>
获取给定URI指定数据的MIME类型（Promise形式）。 获取给定URI指定数据的MIME类型（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------------------ | | ---- | ------ | ---- | ------------------------ |
| uri | string | 是 | 指示要操作的数据的路径。 | | uri | string | 是 | 指示要操作的数据的路径。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ----------------------------------- | | ---------------- | ----------------------------------- |
| Promise\<string> | 返回与uri指定的数据匹配的MIME类型。 | | Promise\<string> | 返回与uri指定的数据匹配的MIME类型。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
DAHelper.getType( DAHelper.getType(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
).then((data) => { ).then((data) => {
console.info("==========================>getTypeCallback=======================>"); console.info("==========================>getTypeCallback=======================>");
}); });
``` ```
## DataAbilityHelper.getFileTypes ## DataAbilityHelper.getFileTypes
getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array\<string>>): void getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array\<string>>): void
获取支持的文件的MIME类型（callback形式）。 获取支持的文件的MIME类型（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------------------------------ | ---- | ---------------------------------- | | -------------- | ------------------------------ | ---- | ---------------------------------- |
| uri | string | 是 | 指示要获取的文件的路径。 | | uri | string | 是 | 指示要获取的文件的路径。 |
| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 | | mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 |
| callback | AsyncCallback\<Array\<string>> | 是 | 回调方法，返回匹配的MIME类型数组。 | | callback | AsyncCallback\<Array\<string>> | 是 | 回调方法，返回匹配的MIME类型数组。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
DAHelper.getFileTypes( DAHelper.getFileTypes(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
"image/*", "image/*",
(err, data) => { (err, data) => {
console.info("==========================>Called=======================>"); console.info("==========================>Called=======================>");
}); });
``` ```
## DataAbilityHelper.getFileTypes ## DataAbilityHelper.getFileTypes
getFileTypes(uri: string, mimeTypeFilter: string): Promise\<Array\<string>> getFileTypes(uri: string, mimeTypeFilter: string): Promise\<Array\<string>>
获取支持的文件的MIME类型（Promise形式）。 获取支持的文件的MIME类型（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------ | ---- | ---------------------------- | | -------------- | ------ | ---- | ---------------------------- |
| uri | string | 是 | 指示要获取的文件的路径。 | | uri | string | 是 | 指示要获取的文件的路径。 |
| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 | | mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------ | ------------------------ | | ------------------------ | ------------------------ |
| Promise\<Array\<string>> | 返回匹配的MIME类型数组。 | | Promise\<Array\<string>> | 返回匹配的MIME类型数组。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
DAHelper.getFileTypes( DAHelper.getFileTypes(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
"image/*" "image/*"
).then((data) => { ).then((data) => {
console.info("==========================>getFileTypesCallback=======================>"); console.info("==========================>getFileTypesCallback=======================>");
}); });
``` ```
## DataAbilityHelper.normalizeUri ## DataAbilityHelper.normalizeUri
normalizeUri(uri: string, callback: AsyncCallback\<string>): void normalizeUri(uri: string, callback: AsyncCallback\<string>): void
将引用数据功能的给定uri转换为规范化uri（callback形式）。 将引用数据功能的给定uri转换为规范化uri（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要规范化的uri对象。 | | uri | string | 是 | 指示要规范化的uri对象。 |
| callback | AsyncCallback\<string> | 是 | 回调方法。如果数据功能支持uri规范化，则返回规范化uri对象；否则返回null。 | | callback | AsyncCallback\<string> | 是 | 回调方法。如果数据功能支持uri规范化，则返回规范化uri对象；否则返回null。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
DAHelper.normalizeUri( DAHelper.normalizeUri(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
(err, data) => { (err, data) => {
console.info("==========================>Called=======================>"); console.info("==========================>Called=======================>");
}); });
``` ```
## DataAbilityHelper.normalizeUri ## DataAbilityHelper.normalizeUri
normalizeUri(uri: string): Promise\<string> normalizeUri(uri: string): Promise\<string>
将引用数据功能的给定uri转换为规范化uri（Promise形式）。 将引用数据功能的给定uri转换为规范化uri（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----------------------- | | ---- | ------ | ---- | ----------------------- |
| uri | string | 是 | 指示要规范化的uri对象。 | | uri | string | 是 | 指示要规范化的uri对象。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ------------------------------------------------------ | | ---------------- | ------------------------------------------------------ |
| Promise\<string> | 如果数据功能支持uri规范化，则返回规范化uri对象；否则返回null。 | | Promise\<string> | 如果数据功能支持uri规范化，则返回规范化uri对象；否则返回null。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
DAHelper.normalizeUri( DAHelper.normalizeUri(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
).then((data) => { ).then((data) => {
console.info("==========================>normalizeUriCallback=======================>"); console.info("==========================>normalizeUriCallback=======================>");
}); });
``` ```
## DataAbilityHelper.denormalizeUri ## DataAbilityHelper.denormalizeUri
denormalizeUri(uri: string, callback: AsyncCallback\<string>): void denormalizeUri(uri: string, callback: AsyncCallback\<string>): void
将由normalizeUri（uri）生成的给定规范化uri转换为非规范化uri（callback形式）。 将由normalizeUri（uri）生成的给定规范化uri转换为非规范化uri（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | --------------------------------------------------- | | -------- | ---------------------- | ---- | --------------------------------------------------- |
| uri | string | 是 | 指示要规范化的uri对象。 | | uri | string | 是 | 指示要规范化的uri对象。 |
| callback | AsyncCallback\<string> | 是 | 回调方法。如果反规范化成功，则返回反规范化uri对象。 | | callback | AsyncCallback\<string> | 是 | 回调方法。如果反规范化成功，则返回反规范化uri对象。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
DAHelper.denormalizeUri( DAHelper.denormalizeUri(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
(err, data) => { (err, data) => {
console.info("==========================>Called=======================>"); console.info("==========================>Called=======================>");
}); });
``` ```
## DataAbilityHelper.denormalizeUri ## DataAbilityHelper.denormalizeUri
denormalizeUri(uri: string): Promise\<string> denormalizeUri(uri: string): Promise\<string>
将由normalizeUri（uri）生成的给定规范化uri转换为非规范化uri（Promise形式）。 将由normalizeUri（uri）生成的给定规范化uri转换为非规范化uri（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----------------------- | | ---- | ------ | ---- | ----------------------- |
| uri | string | 是 | 指示要规范化的uri对象。 | | uri | string | 是 | 指示要规范化的uri对象。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ----------------------------------------- | | ---------------- | ----------------------------------------- |
| Promise\<string> | 如果反规范化成功，则返回反规范化uri对象。 | | Promise\<string> | 如果反规范化成功，则返回反规范化uri对象。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
DAHelper.denormalizeUri( DAHelper.denormalizeUri(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
).then((data) => { ).then((data) => {
console.info("==========================>denormalizeUriCallback=======================>"); console.info("==========================>denormalizeUriCallback=======================>");
}); });
``` ```
## DataAbilityHelper.notifyChange ## DataAbilityHelper.notifyChange
notifyChange(uri: string, callback: AsyncCallback\<void>): void notifyChange(uri: string, callback: AsyncCallback\<void>): void
通知已注册的观察者uri指定的数据资源的更改（callback形式）。 通知已注册的观察者uri指定的数据资源的更改（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| uri | string | 是 | 指示要操作的数据的路径。 | | uri | string | 是 | 指示要操作的数据的路径。 |
| callback | AsyncCallback\<void> | 是 | 回调方法。 | | callback | AsyncCallback\<void> | 是 | 回调方法。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var helper = featureAbility.acquireDataAbilityHelper( var helper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
helper.notifyChange( helper.notifyChange(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
(err) => { (err) => {
console.info("==========================>Called=======================>"); console.info("==========================>Called=======================>");
}); });
``` ```
## DataAbilityHelper.notifyChange ## DataAbilityHelper.notifyChange
notifyChange(uri: string): Promise\<void> notifyChange(uri: string): Promise\<void>
通知已注册的观察者uri指定的数据资源的更改（Promise形式）。 通知已注册的观察者uri指定的数据资源的更改（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------------------ | | ---- | ------ | ---- | ------------------------ |
| uri | string | 是 | 指示要操作的数据的路径。 | | uri | string | 是 | 指示要操作的数据的路径。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | --------------------- | | -------------- | --------------------- |
| Promise\<void> | 返回值为Promise对象。 | | Promise\<void> | 返回值为Promise对象。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
DAHelper.notifyChange( DAHelper.notifyChange(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
).then(() => { ).then(() => {
console.info("==========================>notifyChangeCallback=======================>"); console.info("==========================>notifyChangeCallback=======================>");
}); });
``` ```
## DataAbilityHelper.insert ## DataAbilityHelper.insert
insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback\<number>): void insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback\<number>): void
将单个数据记录插入数据库（callback形式）。 将单个数据记录插入数据库（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | ---------------------- | ---- | ------------------------------------------------------ | | ------------ | ---------------------- | ---- | ------------------------------------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 | | uri | string | 是 | 指示要插入的数据的路径。 |
| valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空，将插入一个空行。 | | valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空，将插入一个空行。 |
| callback | AsyncCallback\<number> | 是 | 回调方法，返回插入数据记录的索引。 | | callback | AsyncCallback\<number> | 是 | 回调方法，返回插入数据记录的索引。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
const valueBucket = { const valueBucket = {
"name": "rose", "name": "rose",
"age": 22, "age": 22,
"salary": 200.5, "salary": 200.5,
"blobType": "u8", "blobType": "u8",
} }
DAHelper.insert( DAHelper.insert(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
valueBucket, valueBucket,
(err, data) => { (err, data) => {
console.info("==========================>Called=======================>"); console.info("==========================>Called=======================>");
}); });
``` ```
## DataAbilityHelper.insert ## DataAbilityHelper.insert
insert(uri: string, valuesBucket: rdb.ValuesBucket): Promise\<number> insert(uri: string, valuesBucket: rdb.ValuesBucket): Promise\<number>
将单个数据记录插入数据库（Promise形式）。 将单个数据记录插入数据库（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | ---------------- | ---- | ------------------------------------------------------ | | ------------ | ---------------- | ---- | ------------------------------------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 | | uri | string | 是 | 指示要插入的数据的路径。 |
| valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空，将插入一个空行。 | | valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空，将插入一个空行。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ------------------------ | | ---------------- | ------------------------ |
| Promise\<number> | 返回插入数据记录的索引。 | | Promise\<number> | 返回插入数据记录的索引。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
const valueBucket = { const valueBucket = {
"name": "rose1", "name": "rose1",
"age": 221, "age": 221,
"salary": 20.5, "salary": 20.5,
"blobType": "u8", "blobType": "u8",
} }
DAHelper.insert( DAHelper.insert(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
valueBucket valueBucket
).then((data) => { ).then((data) => {
console.info("==========================>insertCallback=======================>"); console.info("==========================>insertCallback=======================>");
}); });
``` ```
## DataAbilityHelper.batchInsert ## DataAbilityHelper.batchInsert
batchInsert(uri: string, valuesBuckets: Array\<rdb.ValuesBucket>, callback: AsyncCallback\<number>): void batchInsert(uri: string, valuesBuckets: Array\<rdb.ValuesBucket>, callback: AsyncCallback\<number>): void
插入数据库（callback形式）。 插入数据库（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | ----------------------- | ---- | -------------------------------- | | ------------ | ----------------------- | ---- | -------------------------------- |
| uri | string | 是 | 指示要插入的数据的路径。 | | uri | string | 是 | 指示要插入的数据的路径。 |
| valuesBucket | Array\<rdb.ValuesBucket> | 是 | 指示要插入的数据记录。 | | valuesBucket | Array\<rdb.ValuesBucket> | 是 | 指示要插入的数据记录。 |
| callback | AsyncCallback\<number> | 是 | 回调方法。返回插入的数据记录数。 | | callback | AsyncCallback\<number> | 是 | 回调方法。返回插入的数据记录数。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": "u8",}, var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": "u8",},
{"name": "roe12", "age": 21, "salary": 20.5, "blobType": "u8",}, {"name": "roe12", "age": 21, "salary": 20.5, "blobType": "u8",},
{"name": "roe13", "age": 21, "salary": 20.5, "blobType": "u8",}) {"name": "roe13", "age": 21, "salary": 20.5, "blobType": "u8",})
DAHelper.batchInsert( DAHelper.batchInsert(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
cars, cars,
(err, data) => { (err, data) => {
console.info("==========================>Called=======================>"); console.info("==========================>Called=======================>");
}); });
``` ```
## DataAbilityHelper.batchInsert ## DataAbilityHelper.batchInsert
batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>): Promise\<number> batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>): Promise\<number>
将多个数据记录插入数据库（Promise形式）。 将多个数据记录插入数据库（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | ----------------------- | ---- | ------------------------ | | ------------ | ----------------------- | ---- | ------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 | | uri | string | 是 | 指示要插入的数据的路径。 |
| valuesBucket | Array<rdb.ValuesBucket> | 是 | 指示要插入的数据记录。 | | valuesBucket | Array<rdb.ValuesBucket> | 是 | 指示要插入的数据记录。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ---------------------- | | ---------------- | ---------------------- |
| Promise\<number> | 返回插入的数据记录数。 | | Promise\<number> | 返回插入的数据记录数。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": "u8",}, var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": "u8",},
{"name": "roe12", "age": 21, "salary": 20.5, "blobType": "u8",}, {"name": "roe12", "age": 21, "salary": 20.5, "blobType": "u8",},
{"name": "roe13", "age": 21, "salary": 20.5, "blobType": "u8",}) {"name": "roe13", "age": 21, "salary": 20.5, "blobType": "u8",})
DAHelper.batchInsert( DAHelper.batchInsert(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
cars cars
).then((data) => { ).then((data) => {
console.info("==========================>batchInsertCallback=======================>"); console.info("==========================>batchInsertCallback=======================>");
}); });
``` ```
## DataAbilityHelper.delete ## DataAbilityHelper.delete
delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>): void delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>): void
从数据库中删除一个或多个数据记录（callback形式）。 从数据库中删除一个或多个数据记录（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ | | ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要删除的数据的路径。 | | uri | string | 是 | 指示要删除的数据的路径。 |
| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | | predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 |
| callback | AsyncCallback\<number> | 是 | 回调方法。返回已删除的数据记录数。 | | callback | AsyncCallback\<number> | 是 | 回调方法。返回已删除的数据记录数。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataAbility' import ohos_data_ability from '@ohos.data.dataAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
let da = new ohos_data_ability.DataAbilityPredicates() let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.delete( DAHelper.delete(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
da, da,
(err, data) => { (err, data) => {
console.info("==========================>Called=======================>"); console.info("==========================>Called=======================>");
}); });
``` ```
## DataAbilityHelper.delete ## DataAbilityHelper.delete
delete(uri: string, predicates?: dataAbility.DataAbilityPredicates): Promise\<number>; delete(uri: string, predicates?: dataAbility.DataAbilityPredicates): Promise\<number>;
从数据库中删除一个或多个数据记录（Promise形式）。 从数据库中删除一个或多个数据记录（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ | | ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要删除的数据的路径。 | | uri | string | 是 | 指示要删除的数据的路径。 |
| predicates | dataAbility.DataAbilityPredicates | 否 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | | predicates | dataAbility.DataAbilityPredicates | 否 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ------------------------ | | ---------------- | ------------------------ |
| Promise\<number> | 返回已删除的数据记录数。 | | Promise\<number> | 返回已删除的数据记录数。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataAbility' import ohos_data_ability from '@ohos.data.dataAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
let da = new ohos_data_ability.DataAbilityPredicates() let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.delete( DAHelper.delete(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
da da
).then((data) => { ).then((data) => {
console.info("==========================>deleteCallback=======================>"); console.info("==========================>deleteCallback=======================>");
}); });
``` ```
## DataAbilityHelper.update ## DataAbilityHelper.update
update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>): void update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>): void
更新数据库中的数据记录（callback形式）。 更新数据库中的数据记录（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ | | ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要更新的数据的路径。 | | uri | string | 是 | 指示要更新的数据的路径。 |
| valuesBucket | rdb.ValuesBucket | 是 | 指示要更新的数据。 | | valuesBucket | rdb.ValuesBucket | 是 | 指示要更新的数据。 |
| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | | predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 |
| callback | AsyncCallback\<number> | 是 | 回调方法，返回更新的数据记录数。 | | callback | AsyncCallback\<number> | 是 | 回调方法，返回更新的数据记录数。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataAbility' import ohos_data_ability from '@ohos.data.dataAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
const va = { const va = {
"name": "roe1", "name": "roe1",
"age": 21, "age": 21,
"salary": 20.5, "salary": 20.5,
"blobType": "u8", "blobType": "u8",
} }
let da = new ohos_data_ability.DataAbilityPredicates() let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.update( DAHelper.update(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
va, va,
da, da,
(err, data) => { (err, data) => {
console.info("==========================>Called=======================>"); console.info("==========================>Called=======================>");
}); });
``` ```
## DataAbilityHelper.update ## DataAbilityHelper.update
update(uri: string, valuesBucket: rdb.ValuesBucket, predicates?: dataAbility.DataAbilityPredicates): Promise\<number>; update(uri: string, valuesBucket: rdb.ValuesBucket, predicates?: dataAbility.DataAbilityPredicates): Promise\<number>;
更新数据库中的数据记录（Promise形式）。 更新数据库中的数据记录（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ | | ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要更新的数据的路径。 | | uri | string | 是 | 指示要更新的数据的路径。 |
| valuesBucket | rdb.ValuesBucket | 是 | 指示要更新的数据。 | | valuesBucket | rdb.ValuesBucket | 是 | 指示要更新的数据。 |
| predicates | dataAbility.DataAbilityPredicates | 否 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | | predicates | dataAbility.DataAbilityPredicates | 否 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | -------------------------------------------- | | ---------------- | -------------------------------------------- |
| Promise\<number> | Promise中包含更新的数据记录数。 。 | | Promise\<number> | Promise中包含更新的数据记录数。 。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataAbility' import ohos_data_ability from '@ohos.data.dataAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
const va = { const va = {
"name": "roe1", "name": "roe1",
"age": 21, "age": 21,
"salary": 20.5, "salary": 20.5,
"blobType": "u8", "blobType": "u8",
} }
let da = new ohos_data_ability.DataAbilityPredicates() let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.update( DAHelper.update(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
va, va,
da da
).then((data) => { ).then((data) => {
console.info("==========================>updateCallback=======================>"); console.info("==========================>updateCallback=======================>");
}); });
``` ```
## DataAbilityHelper.query ## DataAbilityHelper.query
query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<ResultSet>): void query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<ResultSet>): void
查询数据库中的数据（callback形式）。 查询数据库中的数据（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ | | ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要查询的数据的路径。 | | uri | string | 是 | 指示要查询的数据的路径。 |
| columns | Array\<string> | 是 | 指示要查询的列。如果此参数为空，则查询所有列。 | | columns | Array\<string> | 是 | 指示要查询的列。如果此参数为空，则查询所有列。 |
| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | | predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 |
| callback | AsyncCallback\<ResultSet> | 是 | 回调方法，返回查询结果。 | | callback | AsyncCallback\<ResultSet> | 是 | 回调方法，返回查询结果。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataAbility' import ohos_data_ability from '@ohos.data.dataAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
var cars=new Array("value1", "value2", "value3", "value4"); var cars=new Array("value1", "value2", "value3", "value4");
let da = new ohos_data_ability.DataAbilityPredicates() let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.query( DAHelper.query(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
cars, cars,
da, da,
(err, data) => { (err, data) => {
console.info("==========================>Called=======================>"); console.info("==========================>Called=======================>");
}); });
``` ```
## DataAbilityHelper.query ## DataAbilityHelper.query
query(uri: string, columns?: Array\<string>, predicates?: dataAbility.DataAbilityPredicates): Promise\<ResultSet>; query(uri: string, columns?: Array\<string>, predicates?: dataAbility.DataAbilityPredicates): Promise\<ResultSet>;
查询数据库中的数据（Promise形式）。 查询数据库中的数据（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ | | ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要查询的数据的路径。 | | uri | string | 是 | 指示要查询的数据的路径。 |
| columns | Array\<string> | 否 | 指示要查询的列。如果此参数为空，则查询所有列。 | | columns | Array\<string> | 否 | 指示要查询的列。如果此参数为空，则查询所有列。 |
| predicates | dataAbility.DataAbilityPredicates | 否 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | | predicates | dataAbility.DataAbilityPredicates | 否 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | -------------- | | ------------------- | -------------- |
| Promise\<ResultSet> | 返回查询结果。 | | Promise\<ResultSet> | 返回查询结果。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataAbility' import ohos_data_ability from '@ohos.data.dataAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
var cars=new Array("value1", "value2", "value3", "value4"); var cars=new Array("value1", "value2", "value3", "value4");
let da = new ohos_data_ability.DataAbilityPredicates() let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.query( DAHelper.query(
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
cars, cars,
da da
).then((data) => { ).then((data) => {
console.info("==========================>queryCallback=======================>"); console.info("==========================>queryCallback=======================>");
}); });
``` ```
## DataAbilityHelper.call ## DataAbilityHelper.call
call(uri: string, method: string, arg: string, extras: PacMap): Promise\<PacMap> call(uri: string, method: string, arg: string, extras: PacMap): Promise\<PacMap>
调用DataAbility的扩展接口，使用Promise方式作为异步方法。 调用DataAbility的扩展接口，使用Promise方式作为异步方法。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ | | ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx" | | uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx" |
| method | string | 是 | 被调用的方法名。 | | method | string | 是 | 被调用的方法名。 |
| arg | string | 是 |需传入的参数。 | | arg | string | 是 |需传入的参数。 |
| extras | [PacMap](#pacmap) | 是 | 键值对参数。 | | extras | [PacMap](#pacmap) | 是 | 键值对参数。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|------ | ------- | |------ | ------- |
|Promise\<[PacMap](#pacmap)> | 调用的返回值。 | |Promise\<[PacMap](#pacmap)> | 调用的返回值。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility"); let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility");
dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", "method", "arg", {"key1":"value1"}).then((data) => { dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", "method", "arg", {"key1":"value1"}).then((data) => {
console.info('Operation succeeded: ' + data); console.info('Operation succeeded: ' + data);
}).catch((error) => { }).catch((error) => {
console.error('Operation failed. Cause: ' + error); console.error('Operation failed. Cause: ' + error);
}); });
``` ```
## DataAbilityHelper.call ## DataAbilityHelper.call
call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCallback\<PacMap>): void call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCallback\<PacMap>): void
调用DataAbility的扩展接口，使用callback方式作为异步方法。 调用DataAbility的扩展接口，使用callback方式作为异步方法。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ | | ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx" | | uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx" |
| method | string | 是 | 被调用的方法名。 | | method | string | 是 | 被调用的方法名。 |
| arg | string | 是 |需传入的参数。 | | arg | string | 是 |需传入的参数。 |
| extras | [PacMap](#pacmap) | 是 | 键值对参数。 | | extras | [PacMap](#pacmap) | 是 | 键值对参数。 |
| callback | AsyncCallback\<[PacMap](#pacmap)> | 是 | 返回值。 | | callback | AsyncCallback\<[PacMap](#pacmap)> | 是 | 返回值。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility"); let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility");
dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", "method", "arg", {"key1":"value1"}, (err, data) => { dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", "method", "arg", {"key1":"value1"}, (err, data) => {
if (err) { if (err) {
console.error('Operation failed. Cause: ' + err); console.error('Operation failed. Cause: ' + err);
return; return;
} }
console.info('Operation succeeded: ' + data); console.info('Operation succeeded: ' + data);
}); });
``` ```
## DataAbilityHelper.executeBatch ## DataAbilityHelper.executeBatch
executeBatch(uri: string, operations: Array\<DataAbilityOperation>, callback: AsyncCallback\<Array\<DataAbilityResult>>): void; executeBatch(uri: string, operations: Array\<DataAbilityOperation>, callback: AsyncCallback\<Array\<DataAbilityResult>>): void;
查询数据库中的数据。 查询数据库中的数据。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ | | ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。| | uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。|
| operations | Array\<[DataAbilityOperation](#dataabilityoperation)> | 是 | 指示数据操作列表，其中可以包含对数据库的多个操作。 | | operations | Array\<[DataAbilityOperation](js-apis-inner-ability-dataAbilityOperation.md)> | 是 | 指示数据操作列表，其中可以包含对数据库的多个操作。 |
| callback | AsyncCallback\<Array\<[DataAbilityResult](#dataabilityresult)>> | 是 |在数组 DataAbilityResult中返回每个操作的结果。 | | callback | AsyncCallback\<Array\<[DataAbilityResult](js-apis-inner-ability-dataAbilityResult.md)>> | 是 |在数组 DataAbilityResult中返回每个操作的结果。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
// 根据DataAbilityOperation列表选择要对数据库做的操作 // 根据DataAbilityOperation列表选择要对数据库做的操作
let op=new Array(); let op=new Array();
let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility"); let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility");
dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbility", op, (err, data) => { dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbility", op, (err, data) => {
if (err) { if (err) {
console.error('Operation failed. Cause: ' + err); console.error('Operation failed. Cause: ' + err);
return; return;
} }
console.info('Operation succeeded: ' + data); console.info('Operation succeeded: ' + data);
}); });
``` ```
## DataAbilityHelper.executeBatch ## DataAbilityHelper.executeBatch
executeBatch(uri: string, operations: Array\<DataAbilityOperation>): Promise\<Array\<DataAbilityResult>>; executeBatch(uri: string, operations: Array\<DataAbilityOperation>): Promise\<Array\<DataAbilityResult>>;
查询数据库中的数据。 查询数据库中的数据。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | -------------------------------| ---- | ------------------------------------------------ | | ---------- | -------------------------------| ---- | ------------------------------------------------ |
| uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。| | uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。|
| operations | Array\<[DataAbilityOperation](#dataabilityoperation)> | 是 | 指示数据操作列表，其中可以包含对数据库的多个操作。 | | operations | Array\<[DataAbilityOperation](js-apis-inner-ability-dataAbilityOperation.md)> | 是 | 指示数据操作列表，其中可以包含对数据库的多个操作。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|------ | ------- | |------ | ------- |
|Promise\<Array\<[DataAbilityResult](#dataabilityresult)>> | 在数组 DataAbilityResult中返回每个操作的结果。 | |Promise\<Array\<[DataAbilityResult](js-apis-inner-ability-dataAbilityResult.md)>> | 在数组 DataAbilityResult中返回每个操作的结果。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
// 根据DataAbilityOperation列表选择要对数据库做的操作 // 根据DataAbilityOperation列表选择要对数据库做的操作
let op=new Array(); let op=new Array();
let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility"); let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility");
dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbility",op ).then((data) => { dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbility",op ).then((data) => {
console.info('Operation succeeded: ' + data); console.info('Operation succeeded: ' + data);
}).catch((error) => { }).catch((error) => {
console.error('Operation failed. Cause: ' + error); console.error('Operation failed. Cause: ' + error);
}); });
``` ```
## PacMap ## PacMap
[key: string]: number | string | boolean | Array\<string | number | boolean> | null; [key: string]: number | string | boolean | Array\<string | number | boolean> | null;
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| ------ | ------ | ------ | ------ | | ------ | ------ | ------ | ------ |
| [key: string] | number \| string \| boolean \| Array\<string \| number \| boolean\> \| null | Yes| 数据存储在键值对中。| | [key: string] | number \| string \| boolean \| Array\<string \| number \| boolean\> \| null | Yes| 数据存储在键值对中。|
\ No newline at end of file
## DataAbilityOperation
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 类型 | 可读 | 可写 | 必填| 说明 |
| -------- | -------- | -------- | -------- | --------| -------- |
| uri | string | 是 | 否 | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。 |
| type | featureAbility.DataAbilityOperationType | 是 | 否 | 是 | 指示操作类型。 |
| valuesBucket? | rdb.ValuesBucket | 是 | 否 | 否 | 指示要设置的数据值。 |
| valueBackReferences? | rdb.ValuesBucket | 是 | 否 | 否 | 指示包含一组键值对的valuesBucket对象。 |
| predicates? | dataAbility.DataAbilityPredicates | 是 | 否 | 否 | 指示要设置的筛选条件。如果此参数为空，则所有数据记录。 |
| predicatesBackReferences? | Map\<number, number> | 是 | 否 | 否 | 指示用作谓词中筛选条件的反向引用。 |
| interrupted? | boolean | 是 | 否 | 否 | 指定是否可以中断批处理操作。 |
| expectedCount? | number | 是 | 否 | 否 | 指示要更新或删除的预期行数。 |
## DataAbilityResult
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 类型 | 可读 | 可写 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | -------- | -------- |
| uri? | string | 是 | 否 | 否 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。 |
| count? | number | 是 | 否 | 否 | 指示受操作影响的行数。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityOperation.md 0 → 100644
浏览文件 @ 0612bb09
# DataAbilityOperation
定义dataAbility数据操作方式。
> **说明：**
>
> 本接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本接口仅可在FA模型下使用
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 类型 | 可读 | 可写 | 必填| 说明 |
| -------- | -------- | -------- | -------- | --------| -------- |
| uri | string | 是 | 否 | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。 |
| type | featureAbility.DataAbilityOperationType | 是 | 否 | 是 | 指示操作类型。 |
| valuesBucket? | rdb.ValuesBucket | 是 | 否 | 否 | 指示要设置的数据值。 |
| valueBackReferences? | rdb.ValuesBucket | 是 | 否 | 否 | 指示包含一组键值对的valuesBucket对象。 |
| predicates? | dataAbility.DataAbilityPredicates | 是 | 否 | 否 | 指示要设置的筛选条件。如果此参数为空，则所有数据记录。 |
| predicatesBackReferences? | Map\<number, number> | 是 | 否 | 否 | 指示用作谓词中筛选条件的反向引用。 |
| interrupted? | boolean | 是 | 否 | 否 | 指定是否可以中断批处理操作。 |
| expectedCount? | number | 是 | 否 | 否 | 指示要更新或删除的预期行数。 |
**示例：**
```ts
import featureAbility from '@ohos.ability.featureAbility'
let dataAbilityUri = ("dataability:///com.example.myapplication.TestDataAbility");
let DAHelper;
try {
DAHelper = featureAbility.acquireDataAbilityHelper(dataAbilityUri);
if(DAHelper == null){
console.error('DAHelper is null');
return;
}
} catch (err) {
console.error('acquireDataAbilityHelper fail, error:' + JSON.stringify(err));
return;
}
let valueBucket = {
"name": "DataAbilityHelperTest",
"age": 24,
"salary": 2024.20,
};
let dataAbilityOperation = {
uri: dataAbilityUri,
type: featureAbility.DataAbilityOperationType.TYPE_INSERT,
valuesBucket: valueBucket,
predicates: null,
expectedCount: 1,
PredicatesBackReferences: {},
interrupted: true
}
let operations = [
dataAbilityOperation
];
try {
DAHelper.executeBatch(dataAbilityUri, operations,
(err, data) => {
console.log("executeBatch, data: " + JSON.stringify(data));
}
);
} catch (err) {
console.error('executeBatch fail: ' + JSON.stringify(err));
}
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityResult.md 0 → 100644
浏览文件 @ 0612bb09
## DataAbilityResult
定义dataAbility数据操作结果。
> **说明：**
>
> 本接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本接口仅可在FA模型下使用
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 类型 | 可读 | 可写 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | -------- | -------- |
| uri? | string | 是 | 否 | 否 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。 |
| count? | number | 是 | 否 | 否 | 指示受操作影响的行数。 |
**示例：**
```ts
import featureAbility from '@ohos.ability.featureAbility'
let dataAbilityUri = ("dataability:///com.example.myapplication.TestDataAbility");
let DAHelper;
try {
DAHelper = featureAbility.acquireDataAbilityHelper(dataAbilityUri);
if(DAHelper == null){
console.error('DAHelper is null');
return;
}
} catch (err) {
console.error('acquireDataAbilityHelper fail, error:' + JSON.stringify(err));
return;
}
let valueBucket = {
"name": "DataAbilityHelperTest",
"age": 24,
"salary": 2024.20,
};
let operations = [
{
uri: dataAbilityUri,
type: featureAbility.DataAbilityOperationType.TYPE_INSERT,
valuesBucket: valueBucket,
predicates: null,
expectedCount: 1,
PredicatesBackReferences: {},
interrupted: true,
},
{
uri: dataAbilityUri,
type: featureAbility.DataAbilityOperationType.TYPE_INSERT,
valuesBucket: valueBucket,
predicates: null,
expectedCount: 1,
PredicatesBackReferences: {},
interrupted: true,
}
];
try {
let promise = DAHelper.executeBatch(dataAbilityUri, operations).then((data) => {
for (let i = 0; i < data.length; i++) {
let dataAbilityResult = data[i];
console.log('dataAbilityResult.uri: ' + dataAbilityResult.uri);
console.log('dataAbilityResult.count: ' + dataAbilityResult.count);
}
}).catch(err => {
console.error('executeBatch error: ' + JSON.stringify(err));
});
} catch (err) {
console.error('executeBatch error: ' + JSON.stringify(err));
}
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-ability-startAbilityParameter.md 0 → 100644
浏览文件 @ 0612bb09
# StartAbilityParameter
定义启动Ability参数。
> **说明：**
>
> 本接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本接口仅可在FA模型下使用
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 类型 | 可读| 可写 | 必填 | 说明 |
| ------------------- | -------- | -------------------- | ---- | -------------------------------------- |
| want | [Want](js-apis-application-want.md)| 是 | 否 | 是 | 表示需要包含有关目标启动能力的信息。 |
| abilityStartSetting | {[key: string]: any} | 是 |否 | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。 |
**示例：**
```ts
import featureAbility from '@ohos.ability.featureAbility'
let Want = {
bundleName: "com.example.abilityStartSettingApp2",
abilityName: "com.example.abilityStartSettingApp.MainAbility",
}
let abilityStartSetting ={
[featureAbility.AbilityStartSetting.BOUNDS_KEY] : [100,200,300,400],
[featureAbility.AbilityStartSetting.WINDOW_MODE_KEY] :
featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED,
[featureAbility.AbilityStartSetting.DISPLAY_ID_KEY] : 1,
}
let startAbilityParameter = {
want:Want,
abilityStartSetting:abilityStartSetting
}
featureAbility.startAbility(startAbilityParameter, (err,data)=>{
console.log('errCode : ' + JSON.stringify(err));
console.log('data : ' + JSON.stringify(data));
} catch(error) {
console.log("startAbility error: " + JSON.stringify(error));
}
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-app-ability-Want.md → zh-cn/application-dev/reference/apis/js-apis-inner-ability-want.md
浏览文件 @ 0612bb09
...@@ -4,30 +4,28 @@ Want是对象间信息传递的载体, 可以用于应用组件间的信息传 ...@@ -4,30 +4,28 @@ Want是对象间信息传递的载体, 可以用于应用组件间的信息传
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ | | ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| deviceId | 是 | 否 | string | 否 | 表示运行指定Ability的设备ID。 | | deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 |
| bundleName | 是 | 否 | string | 否 | 表示包名。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 | | bundleName | 只读 | string | 否 | 表示包名。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| abilityName | 是 | 否 | string | 否 | 表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 | | abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 |
| uri | 是 | 否 | string | 否 | 表示Uri。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 | | 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。 | | 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说明)。 | | 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。 |
| 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）。 |
具体字段描述参考ability/want.d.ts文件
**示例：** **示例：**
- 基础用法 - 基础用法
``` ts ```ts
var want = { var want = {
"deviceId": "", // deviceId为空表示本设备 "deviceId": "", // deviceId为空表示本设备
"bundleName": "com.extreme.test", "bundleName": "com.extreme.test",
...@@ -42,7 +40,7 @@ Want是对象间信息传递的载体, 可以用于应用组件间的信息传 ...@@ -42,7 +40,7 @@ Want是对象间信息传递的载体, 可以用于应用组件间的信息传
- 传递FD数据，FD表示文件描述符(FileDescriptor) - 传递FD数据，FD表示文件描述符(FileDescriptor)
``` ts ```ts
import fileio from '@ohos.fileio'; import fileio from '@ohos.fileio';
var fd; var fd;
try { try {
...@@ -64,4 +62,4 @@ Want是对象间信息传递的载体, 可以用于应用组件间的信息传 ...@@ -64,4 +62,4 @@ Want是对象间信息传递的载体, 可以用于应用组件间的信息传
console.log("error.code = " + error.code) console.log("error.code = " + error.code)
}) })
``` ```
<!--no_check--> <!--no_check-->
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-app-appVersionInfo.md 0 → 100644
浏览文件 @ 0612bb09
# AppVersionInfo<sup>7+</sup>
定义应用版本信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | ------ | ---- | ---- | ------- |
| appName | string | 是 | 否 | 模块名称。 |
| versionCode | number | 是 | 否 | 模块描述信息。 |
| versionName | string | 是 | 否 | 描述信息ID。 |
**示例：**
```ts
let appName;
let versionCode;
let versionName;
this.context.getAppVersionInfo((error, data) => {
console.info('getAppVersionInfo data is:' + JSON.stringify(data));
appName = data.appName;
versionCode = data.versionCode;
versionName = data.versionName;
});
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-Context.md → zh-cn/application-dev/reference/apis/js-apis-inner-app-context.md
浏览文件 @ 0612bb09
...@@ -11,7 +11,7 @@ Context模块提供了ability或application的上下文的能力，包括允许 ...@@ -11,7 +11,7 @@ Context模块提供了ability或application的上下文的能力，包括允许
Context对象是在featureAbility中创建实例，并通过featureAbility的getContext()接口返回，因此在使用Context时，必须导入@ohos.ability.featureAbility库。示例如下： Context对象是在featureAbility中创建实例，并通过featureAbility的getContext()接口返回，因此在使用Context时，必须导入@ohos.ability.featureAbility库。示例如下：
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getOrCreateLocalDir().then((data) => { context.getOrCreateLocalDir().then((data) => {
...@@ -31,13 +31,13 @@ getOrCreateLocalDir(callback: AsyncCallback\<string>): void ...@@ -31,13 +31,13 @@ getOrCreateLocalDir(callback: AsyncCallback\<string>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------- | | -------- | ---------------------- | ---- | ------------- |
| callback | AsyncCallback\<string> | 是 | 返回应用程序的本地根目录。 | | callback | AsyncCallback\<string> | 是 | 返回应用程序的本地根目录。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getOrCreateLocalDir((err, data)=>{ context.getOrCreateLocalDir((err, data)=>{
...@@ -65,7 +65,7 @@ getOrCreateLocalDir(): Promise\<string> ...@@ -65,7 +65,7 @@ getOrCreateLocalDir(): Promise\<string>
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getOrCreateLocalDir().then((data) => { context.getOrCreateLocalDir().then((data) => {
...@@ -73,8 +73,6 @@ context.getOrCreateLocalDir().then((data) => { ...@@ -73,8 +73,6 @@ context.getOrCreateLocalDir().then((data) => {
}); });
``` ```
## Context.verifyPermission<sup>7+</sup> ## Context.verifyPermission<sup>7+</sup>
verifyPermission(permission: string, options: PermissionOptions, callback: AsyncCallback\<number>): void verifyPermission(permission: string, options: PermissionOptions, callback: AsyncCallback\<number>): void
...@@ -85,7 +83,7 @@ verifyPermission(permission: string, options: PermissionOptions, callback: Async ...@@ -85,7 +83,7 @@ verifyPermission(permission: string, options: PermissionOptions, callback: Async
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | --------------------------------------- | ---- | -------------------- | | ---------- | --------------------------------------- | ---- | -------------------- |
| permission | string | 是 | 指定权限的名称。 | | permission | string | 是 | 指定权限的名称。 |
| options | [PermissionOptions](#permissionoptions7) | 是 | 权限选项。 | | options | [PermissionOptions](#permissionoptions7) | 是 | 权限选项。 |
...@@ -93,7 +91,7 @@ verifyPermission(permission: string, options: PermissionOptions, callback: Async ...@@ -93,7 +91,7 @@ verifyPermission(permission: string, options: PermissionOptions, callback: Async
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import bundle from '@ohos.bundle'; import bundle from '@ohos.bundle';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
...@@ -116,14 +114,14 @@ verifyPermission(permission: string, callback: AsyncCallback\<number>): void ...@@ -116,14 +114,14 @@ verifyPermission(permission: string, callback: AsyncCallback\<number>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | ---------------------- | ---- | -------------------- | | ---------- | ---------------------- | ---- | -------------------- |
| permission | string | 是 | 指定权限的名称。 | | permission | string | 是 | 指定权限的名称。 |
| callback | AsyncCallback\<number> | 是 | 返回权限验证结果，0有权限，-1无权限。 | | callback | AsyncCallback\<number> | 是 | 返回权限验证结果，0有权限，-1无权限。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.verifyPermission("com.example.permission", (err, data) =>{ context.verifyPermission("com.example.permission", (err, data) =>{
...@@ -141,7 +139,7 @@ verifyPermission(permission: string, options?: PermissionOptions): Promise\<numb ...@@ -141,7 +139,7 @@ verifyPermission(permission: string, options?: PermissionOptions): Promise\<numb
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | --------------------------------------- | ---- | -------- | | ---------- | --------------------------------------- | ---- | -------- |
| permission | string | 是 | 指定权限的名称。 | | permission | string | 是 | 指定权限的名称。 |
| options | [PermissionOptions](#permissionoptions) | 否 | 权限选项。 | | options | [PermissionOptions](#permissionoptions) | 否 | 权限选项。 |
...@@ -154,7 +152,7 @@ verifyPermission(permission: string, options?: PermissionOptions): Promise\<numb ...@@ -154,7 +152,7 @@ verifyPermission(permission: string, options?: PermissionOptions): Promise\<numb
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
var Permission = {pid:1}; var Permission = {pid:1};
...@@ -175,7 +173,7 @@ requestPermissionsFromUser(permissions: Array\<string>, requestCode: number, res ...@@ -175,7 +173,7 @@ requestPermissionsFromUser(permissions: Array\<string>, requestCode: number, res
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------------- | ---------------------------------------- | ---- | ----------------------------------- | | -------------- | ---------------------------------------- | ---- | ----------------------------------- |
| permissions | Array\<string> | 是 | 指示要请求的权限列表。此参数不能为null。 | | permissions | Array\<string> | 是 | 指示要请求的权限列表。此参数不能为null。 |
| requestCode | number | 是 | 指示要传递给PermissionRequestResult的请求代码。 | | requestCode | number | 是 | 指示要传递给PermissionRequestResult的请求代码。 |
...@@ -183,7 +181,7 @@ requestPermissionsFromUser(permissions: Array\<string>, requestCode: number, res ...@@ -183,7 +181,7 @@ requestPermissionsFromUser(permissions: Array\<string>, requestCode: number, res
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.requestPermissionsFromUser( context.requestPermissionsFromUser(
...@@ -210,7 +208,7 @@ requestPermissionsFromUser(permissions: Array\<string>, requestCode: number): Pr ...@@ -210,7 +208,7 @@ requestPermissionsFromUser(permissions: Array\<string>, requestCode: number): Pr
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------------- | ------------------- | ----- | -------------------------------------------- | | -------------- | ------------------- | ----- | -------------------------------------------- |
| permissions | Array\<string> | 是 | 指示要请求的权限列表。此参数不能为null。 | | permissions | Array\<string> | 是 | 指示要请求的权限列表。此参数不能为null。 |
| requestCode | number | 是 | 指示要传递给PermissionRequestResult的请求代码。 | | requestCode | number | 是 | 指示要传递给PermissionRequestResult的请求代码。 |
...@@ -223,7 +221,7 @@ requestPermissionsFromUser(permissions: Array\<string>, requestCode: number): Pr ...@@ -223,7 +221,7 @@ requestPermissionsFromUser(permissions: Array\<string>, requestCode: number): Pr
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.requestPermissionsFromUser( context.requestPermissionsFromUser(
...@@ -250,13 +248,13 @@ getApplicationInfo(callback: AsyncCallback\<ApplicationInfo>): void ...@@ -250,13 +248,13 @@ getApplicationInfo(callback: AsyncCallback\<ApplicationInfo>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ------------------------------- | ---- | ------------ | | -------- | ------------------------------- | ---- | ------------ |
| callback | AsyncCallback\<ApplicationInfo> | 是 | 返回当前应用程序的信息。 | | callback | AsyncCallback\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)> | 是 | 返回当前应用程序的信息。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getApplicationInfo((err, data) => { context.getApplicationInfo((err, data) => {
...@@ -278,11 +276,11 @@ getApplicationInfo(): Promise\<ApplicationInfo> ...@@ -278,11 +276,11 @@ getApplicationInfo(): Promise\<ApplicationInfo>
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------- | --------- | | ------------------------- | --------- |
| Promise\<ApplicationInfo> | 当前应用程序的信息 | | Promise\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)> | 当前应用程序的信息 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getApplicationInfo().then((data) => { context.getApplicationInfo().then((data) => {
...@@ -302,13 +300,13 @@ getBundleName(callback: AsyncCallback\<string>): void ...@@ -302,13 +300,13 @@ getBundleName(callback: AsyncCallback\<string>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------ | | -------- | ---------------------- | ---- | ------------------ |
| callback | AsyncCallback\<string> | 是 | 返回当前ability的捆绑包名称。 | | callback | AsyncCallback\<string> | 是 | 返回当前ability的捆绑包名称。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getBundleName((err, data) => { context.getBundleName((err, data) => {
...@@ -334,7 +332,7 @@ getBundleName(): Promise\<string> ...@@ -334,7 +332,7 @@ getBundleName(): Promise\<string>
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getBundleName().then((data) => { context.getBundleName().then((data) => {
...@@ -352,13 +350,13 @@ getDisplayOrientation(callback: AsyncCallback\<bundle.DisplayOrientation>): void ...@@ -352,13 +350,13 @@ getDisplayOrientation(callback: AsyncCallback\<bundle.DisplayOrientation>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ------------------------------------------------------------ | ---- | ------------------ | | -------- | ------------------------------------------------------------ | ---- | ------------------ |
| callback | AsyncCallback\<[bundle.DisplayOrientation](js-apis-Bundle.md#displayorientation)> | 是 | 表示屏幕显示方向。 | | callback | AsyncCallback\<[bundle.DisplayOrientation](js-apis-Bundle.md#displayorientation)> | 是 | 表示屏幕显示方向。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getDisplayOrientation((err, data) => { context.getDisplayOrientation((err, data) => {
...@@ -382,7 +380,7 @@ getDisplayOrientation(): Promise\<bundle.DisplayOrientation>; ...@@ -382,7 +380,7 @@ getDisplayOrientation(): Promise\<bundle.DisplayOrientation>;
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getDisplayOrientation().then((data) => { context.getDisplayOrientation().then((data) => {
...@@ -400,13 +398,13 @@ getExternalCacheDir(callback: AsyncCallback\<string>): void ...@@ -400,13 +398,13 @@ getExternalCacheDir(callback: AsyncCallback\<string>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------ | | -------- | ---------------------- | ---- | ------------------ |
| callback | AsyncCallback\<string> | 是 | 返回应用程序的缓存目录的绝对路径。 | | callback | AsyncCallback\<string> | 是 | 返回应用程序的缓存目录的绝对路径。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getExternalCacheDir((err, data) => { context.getExternalCacheDir((err, data) => {
...@@ -430,7 +428,7 @@ getExternalCacheDir(): Promise\<string>; ...@@ -430,7 +428,7 @@ getExternalCacheDir(): Promise\<string>;
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getExternalCacheDir().then((data) => { context.getExternalCacheDir().then((data) => {
...@@ -448,14 +446,14 @@ setDisplayOrientation(orientation: bundle.DisplayOrientation, callback: AsyncCal ...@@ -448,14 +446,14 @@ setDisplayOrientation(orientation: bundle.DisplayOrientation, callback: AsyncCal
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ---------------------------------------- | ---- | ------------ | | ----------- | ---------------------------------------- | ---- | ------------ |
| orientation | [bundle.DisplayOrientation](js-apis-Bundle.md#displayorientation) | 是 | 指示当前能力的新方向。。 | | orientation | [bundle.DisplayOrientation](js-apis-Bundle.md#displayorientation) | 是 | 指示当前能力的新方向。。 |
| callback | AsyncCallback\<void> | 是 | 表示屏幕显示方向。 | | callback | AsyncCallback\<void> | 是 | 表示屏幕显示方向。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import bundle from '@ohos.bundle'; import bundle from '@ohos.bundle';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
...@@ -482,7 +480,7 @@ setDisplayOrientation(orientation: bundle.DisplayOrientation): Promise\<void>; ...@@ -482,7 +480,7 @@ setDisplayOrientation(orientation: bundle.DisplayOrientation): Promise\<void>;
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import bundle from '@ohos.bundle'; import bundle from '@ohos.bundle';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
...@@ -502,14 +500,14 @@ setShowOnLockScreen(show: boolean, callback: AsyncCallback\<void>): void ...@@ -502,14 +500,14 @@ setShowOnLockScreen(show: boolean, callback: AsyncCallback\<void>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | ---------------------------------------- | | -------- | -------------------- | ---- | ---------------------------------------- |
| show | boolean | 是 | 指定是否在锁屏顶部显示此功能。值true表示在锁屏上显示，值false表示不显示。 | | show | boolean | 是 | 指定是否在锁屏顶部显示此功能。值true表示在锁屏上显示，值false表示不显示。 |
| callback | AsyncCallback\<void> | 是 | 返回回调结果。 | | callback | AsyncCallback\<void> | 是 | 返回回调结果。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
var show=true var show=true
...@@ -528,7 +526,7 @@ setShowOnLockScreen(show: boolean): Promise\<void>; ...@@ -528,7 +526,7 @@ setShowOnLockScreen(show: boolean): Promise\<void>;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---- | ------- | ---- | ---------------------------------------- | | ---- | ------- | ---- | ---------------------------------------- |
| show | boolean | 是 | 指定是否在锁屏顶部显示此功能。值true表示在锁屏上显示，值false表示不显示。 | | show | boolean | 是 | 指定是否在锁屏顶部显示此功能。值true表示在锁屏上显示，值false表示不显示。 |
...@@ -540,7 +538,7 @@ setShowOnLockScreen(show: boolean): Promise\<void>; ...@@ -540,7 +538,7 @@ setShowOnLockScreen(show: boolean): Promise\<void>;
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
var show=true var show=true
...@@ -559,14 +557,14 @@ setWakeUpScreen(wakeUp: boolean, callback: AsyncCallback\<void>): void ...@@ -559,14 +557,14 @@ setWakeUpScreen(wakeUp: boolean, callback: AsyncCallback\<void>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | --------------------------------- | | -------- | -------------------- | ---- | --------------------------------- |
| wakeUp | boolean | 是 | 指定是否唤醒屏幕。值true表示唤醒它，值false表示不唤醒它。 | | wakeUp | boolean | 是 | 指定是否唤醒屏幕。值true表示唤醒它，值false表示不唤醒它。 |
| callback | AsyncCallback\<void> | 是 | 返回回调结果。 | | callback | AsyncCallback\<void> | 是 | 返回回调结果。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
var wakeUp=true var wakeUp=true
...@@ -585,7 +583,7 @@ setWakeUpScreen(wakeUp: boolean): Promise\<void>; ...@@ -585,7 +583,7 @@ setWakeUpScreen(wakeUp: boolean): Promise\<void>;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ------ | ------- | ---- | --------------------------------- | | ------ | ------- | ---- | --------------------------------- |
| wakeUp | boolean | 是 | 指定是否唤醒屏幕。值true表示唤醒它，值false表示不唤醒它。 | | wakeUp | boolean | 是 | 指定是否唤醒屏幕。值true表示唤醒它，值false表示不唤醒它。 |
...@@ -597,7 +595,7 @@ setWakeUpScreen(wakeUp: boolean): Promise\<void>; ...@@ -597,7 +595,7 @@ setWakeUpScreen(wakeUp: boolean): Promise\<void>;
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
var wakeUp=true var wakeUp=true
...@@ -619,13 +617,13 @@ getProcessInfo(callback: AsyncCallback\<ProcessInfo>): void ...@@ -619,13 +617,13 @@ getProcessInfo(callback: AsyncCallback\<ProcessInfo>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | --------------------------- | ---- | ---------- | | -------- | --------------------------- | ---- | ---------- |
| callback | AsyncCallback\<ProcessInfo> | 是 | 返回当前进程的信息。 | | callback | AsyncCallback\<[ProcessInfo](js-apis-inner-app-processInfo.md)> | 是 | 返回当前进程的信息。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getProcessInfo((err, data) => { context.getProcessInfo((err, data) => {
...@@ -647,11 +645,11 @@ getProcessInfo(): Promise\<ProcessInfo> ...@@ -647,11 +645,11 @@ getProcessInfo(): Promise\<ProcessInfo>
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ------- | | --------------------- | ------- |
| Promise\<ProcessInfo> | 当前进程的信息 | | Promise\<[ProcessInfo](js-apis-inner-app-processInfo.md)> | 当前进程的信息 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getProcessInfo().then((data) => { context.getProcessInfo().then((data) => {
...@@ -673,13 +671,13 @@ getElementName(callback: AsyncCallback\<ElementName>): void ...@@ -673,13 +671,13 @@ getElementName(callback: AsyncCallback\<ElementName>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | --------------------------- | ---- | -------------------------------------- | | -------- | --------------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback\<ElementName> | 是 | 返回当前ability的ohos.bundle.ElementName对象。 | | callback | AsyncCallback\<[ElementName](js-apis-bundle-ElementName.md)> | 是 | 返回当前ability的ohos.bundle.ElementName对象。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getElementName((err, data) => { context.getElementName((err, data) => {
...@@ -703,11 +701,11 @@ getElementName(): Promise\<ElementName> ...@@ -703,11 +701,11 @@ getElementName(): Promise\<ElementName>
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ------------------------------------ | | --------------------- | ------------------------------------ |
| Promise\<ElementName> | 当前ability的ohos.bundle.ElementName对象。 | | Promise\<[ElementName](js-apis-bundle-ElementName.md)> | 当前ability的ohos.bundle.ElementName对象。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getElementName().then((data) => { context.getElementName().then((data) => {
...@@ -725,13 +723,13 @@ getProcessName(callback: AsyncCallback\<string>): void ...@@ -725,13 +723,13 @@ getProcessName(callback: AsyncCallback\<string>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ---------- | | -------- | ---------------------- | ---- | ---------- |
| callback | AsyncCallback\<string> | 是 | 返回当前进程的名称。 | | callback | AsyncCallback\<string> | 是 | 返回当前进程的名称。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getProcessName((err, data) => { context.getProcessName((err, data) => {
...@@ -757,7 +755,7 @@ getProcessName(): Promise\<string> ...@@ -757,7 +755,7 @@ getProcessName(): Promise\<string>
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getProcessName().then((data) => { context.getProcessName().then((data) => {
...@@ -777,13 +775,13 @@ getCallingBundle(callback: AsyncCallback\<string>): void ...@@ -777,13 +775,13 @@ getCallingBundle(callback: AsyncCallback\<string>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ---------------- | | -------- | ---------------------- | ---- | ---------------- |
| callback | AsyncCallback\<string> | 是 | 返回调用ability的包名称。 | | callback | AsyncCallback\<string> | 是 | 返回调用ability的包名称。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getCallingBundle((err, data) => { context.getCallingBundle((err, data) => {
...@@ -809,7 +807,7 @@ getCallingBundle(): Promise\<string> ...@@ -809,7 +807,7 @@ getCallingBundle(): Promise\<string>
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getCallingBundle().then((data) => { context.getCallingBundle().then((data) => {
...@@ -827,13 +825,13 @@ getCacheDir(callback: AsyncCallback\<string>): void ...@@ -827,13 +825,13 @@ getCacheDir(callback: AsyncCallback\<string>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | --------------- | | -------- | ---------------------- | ---- | --------------- |
| callback | AsyncCallback\<string> | 是 | 返回该应用程序的内部存储目录。 | | callback | AsyncCallback\<string> | 是 | 返回该应用程序的内部存储目录。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getCacheDir((err, data) => { context.getCacheDir((err, data) => {
...@@ -857,7 +855,7 @@ getCacheDir(): Promise\<string> ...@@ -857,7 +855,7 @@ getCacheDir(): Promise\<string>
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getCacheDir().then((data) => { context.getCacheDir().then((data) => {
...@@ -875,13 +873,13 @@ getFilesDir(callback: AsyncCallback\<string>): void ...@@ -875,13 +873,13 @@ getFilesDir(callback: AsyncCallback\<string>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------- | | -------- | ---------------------- | ---- | ------------------- |
| callback | AsyncCallback\<string> | 是 | 返回内部存储器上此应用程序的文件目录。 | | callback | AsyncCallback\<string> | 是 | 返回内部存储器上此应用程序的文件目录。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getFilesDir((err, data) => { context.getFilesDir((err, data) => {
...@@ -905,7 +903,7 @@ getFilesDir(): Promise\<string> ...@@ -905,7 +903,7 @@ getFilesDir(): Promise\<string>
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getFilesDir().then((data) => { context.getFilesDir().then((data) => {
...@@ -925,13 +923,13 @@ getOrCreateDistributedDir(callback: AsyncCallback\<string>): void ...@@ -925,13 +923,13 @@ getOrCreateDistributedDir(callback: AsyncCallback\<string>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ---------------------------------------- | | -------- | ---------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback\<string> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回Ability或应用的分布式文件路径。如果分布式文件路径不存在，系统将创建一个路径并返回创建的路径。 | | callback | AsyncCallback\<string> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回Ability或应用的分布式文件路径。如果分布式文件路径不存在，系统将创建一个路径并返回创建的路径。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getOrCreateDistributedDir((err, data) => { context.getOrCreateDistributedDir((err, data) => {
...@@ -957,7 +955,7 @@ getOrCreateDistributedDir(): Promise\<string> ...@@ -957,7 +955,7 @@ getOrCreateDistributedDir(): Promise\<string>
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getOrCreateDistributedDir().then((data) => { context.getOrCreateDistributedDir().then((data) => {
...@@ -975,13 +973,13 @@ getAppType(callback: AsyncCallback\<string>): void ...@@ -975,13 +973,13 @@ getAppType(callback: AsyncCallback\<string>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | -------------------------------- | | -------- | ---------------------- | ---- | -------------------------------- |
| callback | AsyncCallback\<string> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回此应用程序的类型。 | | callback | AsyncCallback\<string> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回此应用程序的类型。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getAppType((err, data) => { context.getAppType((err, data) => {
...@@ -1005,7 +1003,7 @@ getAppType(): Promise\<string> ...@@ -1005,7 +1003,7 @@ getAppType(): Promise\<string>
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getAppType().then((data) => { context.getAppType().then((data) => {
...@@ -1023,13 +1021,13 @@ getHapModuleInfo(callback: AsyncCallback\<HapModuleInfo>): void ...@@ -1023,13 +1021,13 @@ getHapModuleInfo(callback: AsyncCallback\<HapModuleInfo>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------------------------- | ---- | --------------------------------------- | | -------- | ---------------------------------------- | ---- | --------------------------------------- |
| callback | AsyncCallback\<[HapModuleInfo](js-apis-bundle-HapModuleInfo.md)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回应用的ModuleInfo对象。 | | callback | AsyncCallback\<[HapModuleInfo](js-apis-bundle-HapModuleInfo.md)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回应用的ModuleInfo对象。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getHapModuleInfo((err, data) => { context.getHapModuleInfo((err, data) => {
...@@ -1053,7 +1051,7 @@ getHapModuleInfo(): Promise\<HapModuleInfo> ...@@ -1053,7 +1051,7 @@ getHapModuleInfo(): Promise\<HapModuleInfo>
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getHapModuleInfo().then((data) => { context.getHapModuleInfo().then((data) => {
...@@ -1071,13 +1069,13 @@ getAppVersionInfo(callback: AsyncCallback\<AppVersionInfo>): void ...@@ -1071,13 +1069,13 @@ getAppVersionInfo(callback: AsyncCallback\<AppVersionInfo>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------------------------- | ---- | ------------------------------ | | -------- | ---------------------------------------- | ---- | ------------------------------ |
| callback | AsyncCallback\<[AppVersionInfo](#appversioninfo)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回应用版本信息。 | | callback | AsyncCallback\<[AppVersionInfo](js-apis-inner-app-appVersionInfo.md)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回应用版本信息。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getAppVersionInfo((err, data) => { context.getAppVersionInfo((err, data) => {
...@@ -1097,11 +1095,11 @@ getAppVersionInfo(): Promise\<AppVersionInfo> ...@@ -1097,11 +1095,11 @@ getAppVersionInfo(): Promise\<AppVersionInfo>
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | --------- | | ---------------------------------------- | --------- |
| Promise\<[AppVersionInfo](#appversioninfo)> | 返回应用版本信息。 | | Promise\<[AppVersionInfo](js-apis-inner-app-appVersionInfo.md)> | 返回应用版本信息。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getAppVersionInfo().then((data) => { context.getAppVersionInfo().then((data) => {
...@@ -1119,13 +1117,13 @@ getAbilityInfo(callback: AsyncCallback\<AbilityInfo>): void ...@@ -1119,13 +1117,13 @@ getAbilityInfo(callback: AsyncCallback\<AbilityInfo>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------------------------- | ---- | --------------------------------------- | | -------- | ---------------------------------------- | ---- | --------------------------------------- |
| callback | AsyncCallback\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回当前归属Ability详细信息。 | | callback | AsyncCallback\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回当前归属Ability详细信息。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getAbilityInfo((err, data) => { context.getAbilityInfo((err, data) => {
...@@ -1149,7 +1147,7 @@ getAbilityInfo(): Promise\<AbilityInfo> ...@@ -1149,7 +1147,7 @@ getAbilityInfo(): Promise\<AbilityInfo>
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.getAbilityInfo().then((data) => { context.getAbilityInfo().then((data) => {
...@@ -1173,7 +1171,7 @@ getApplicationContext(): Context ...@@ -1173,7 +1171,7 @@ getApplicationContext(): Context
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext().getApplicationContext(); var context = featureAbility.getContext().getApplicationContext();
``` ```
...@@ -1188,13 +1186,13 @@ isUpdatingConfigurations(callback: AsyncCallback\<boolean>): void; ...@@ -1188,13 +1186,13 @@ isUpdatingConfigurations(callback: AsyncCallback\<boolean>): void;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | ----------------------------- | | -------- | ----------------------- | ---- | ----------------------------- |
| callback | AsyncCallback\<boolean> | 是 | 如果该能力的配置正在更改，则为true，否则为false。 | | callback | AsyncCallback\<boolean> | 是 | 如果该能力的配置正在更改，则为true，否则为false。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.isUpdatingConfigurations((err, data) => { context.isUpdatingConfigurations((err, data) => {
...@@ -1218,7 +1216,7 @@ isUpdatingConfigurations(): Promise\<boolean>; ...@@ -1218,7 +1216,7 @@ isUpdatingConfigurations(): Promise\<boolean>;
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.isUpdatingConfigurations().then((data) => { context.isUpdatingConfigurations().then((data) => {
...@@ -1236,13 +1234,13 @@ printDrawnCompleted(callback: AsyncCallback\<void>): void; ...@@ -1236,13 +1234,13 @@ printDrawnCompleted(callback: AsyncCallback\<void>): void;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | ----------- | | -------- | -------------------- | ---- | ----------- |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 | | callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 |
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.printDrawnCompleted((err) => { context.printDrawnCompleted((err) => {
...@@ -1266,7 +1264,7 @@ printDrawnCompleted(): Promise\<void>; ...@@ -1266,7 +1264,7 @@ printDrawnCompleted(): Promise\<void>;
**示例：** **示例：**
```js ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext(); var context = featureAbility.getContext();
context.printDrawnCompleted().then((data) => { context.printDrawnCompleted().then((data) => {
...@@ -1279,20 +1277,20 @@ context.printDrawnCompleted().then((data) => { ...@@ -1279,20 +1277,20 @@ context.printDrawnCompleted().then((data) => {
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | ---- |-------- | ------ | ---- | ----- | | ---- | ---- | ------ | ---- | ----- |
| pid | 是 | 否 | number | 否 | 进程id。 | | pid | 只读 | number | 否 | 进程id。 |
| uid | 是 | 否 | number | 否 | 用户id。 | | uid | 只读 | number | 否 | 用户id。 |
## PermissionRequestResult<sup>7+</sup> ## PermissionRequestResult<sup>7+</sup>
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | ---- |-------- | -------------- | ---- | ---------- | | ----------- | ---- | -------------- | ---- | ---------- |
| requestCode | 是 | 否 | number | 是 | 用户传入的请求代码。 | | requestCode | 只读 | number | 是 | 用户传入的请求代码。 |
| permissions | 是 | 否 | Array\<string> | 是 | 用户传入的权限。 | | permissions | 只读 | Array\<string> | 是 | 用户传入的权限。 |
| authResults | 是 | 否 | Array\<number> | 是 | 请求权限的结果。 | | authResults | 只读 | Array\<number> | 是 | 请求权限的结果。 |
## AppVersionInfo<sup>7+</sup> ## AppVersionInfo<sup>7+</sup>
...@@ -1302,4 +1300,4 @@ context.printDrawnCompleted().then((data) => { ...@@ -1302,4 +1300,4 @@ context.printDrawnCompleted().then((data) => {
| ----------- | ------ | ---- | ---- | ------- | | ----------- | ------ | ---- | ---- | ------- |
| appName | string | 是 | 否 | 模块名称。 | | appName | string | 是 | 否 | 模块名称。 |
| versionCode | number | 是 | 否 | 模块描述信息。 | | versionCode | number | 是 | 否 | 模块描述信息。 |
| versionName | string | 是 | 否 | 描述信息ID。 | | versionName | string | 是 | 否 | 描述信息ID。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-app-processInfo.md 0 → 100644
浏览文件 @ 0612bb09
# ProcessInfo<sup>7+</sup>
定义进程信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| pid | number | 是 | 否 | 进程ID。 |
| processName | string | 是 | 否 | 进程名称。 |
**示例：**
```ts
import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext();
context.getProcessInfo((err, data) => {
console.info("getProcessInfo err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
let pid = data.pid;
let processName = data.processName;
});
```
zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md → zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityDelegator.md
浏览文件 @ 0612bb09
...@@ -4,12 +4,12 @@ AbilityDelegator提供添加用于监视指定ability的生命周期状态更改 ...@@ -4,12 +4,12 @@ AbilityDelegator提供添加用于监视指定ability的生命周期状态更改
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 8开始支持，从API version 9废弃，替换木块为[@ohos.app.ability.abilityDelegatorRegistry (AbilityDelegatorRegistry)](js-apis-app-ability-abilityDelegator.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 使用说明 ## 使用说明
通过AbilityDelegatorRegistry中getAbilityDelegator方法获取。 通过AbilityDelegatorRegistry中getAbilityDelegator方法获取。
```js ```ts
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'
var abilityDelegator; var abilityDelegator;
...@@ -32,12 +32,12 @@ addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): void ...@@ -32,12 +32,12 @@ addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | | -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | | monitor | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor)实例 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法 | | callback | AsyncCallback\<void> | 是 | 表示指定的回调方法 |
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
...@@ -67,7 +67,7 @@ addAbilityMonitor(monitor: AbilityMonitor): Promise\<void>; ...@@ -67,7 +67,7 @@ addAbilityMonitor(monitor: AbilityMonitor): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | | monitor | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor)实例 |
**返回值：** **返回值：**
...@@ -77,7 +77,7 @@ addAbilityMonitor(monitor: AbilityMonitor): Promise\<void>; ...@@ -77,7 +77,7 @@ addAbilityMonitor(monitor: AbilityMonitor): Promise\<void>;
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
...@@ -109,12 +109,12 @@ removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): v ...@@ -109,12 +109,12 @@ removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): v
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | | monitor | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor)实例 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法 | | callback | AsyncCallback\<void> | 是 | 表示指定的回调方法 |
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
...@@ -146,7 +146,7 @@ removeAbilityMonitor(monitor: AbilityMonitor): Promise\<void>; ...@@ -146,7 +146,7 @@ removeAbilityMonitor(monitor: AbilityMonitor): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | | monitor | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor)实例 |
**返回值：** **返回值：**
...@@ -156,7 +156,7 @@ removeAbilityMonitor(monitor: AbilityMonitor): Promise\<void>; ...@@ -156,7 +156,7 @@ removeAbilityMonitor(monitor: AbilityMonitor): Promise\<void>;
- 示例 - 示例
```js ```ts
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
...@@ -188,12 +188,12 @@ waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<UIAbility>) ...@@ -188,12 +188,12 @@ waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<UIAbility>)
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | | monitor | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor)实例 |
| callback | AsyncCallback\<[UIAbility](js-apis-application-ability.md#Ability)> | 是 | 表示指定的回调方法 | | callback | AsyncCallback\<[UIAbility](js-apis-app-ability-uiAbility.md)> | 是 | 表示指定的回调方法 |
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
...@@ -223,13 +223,13 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCall ...@@ -223,13 +223,13 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCall
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | | monitor | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor)实例 |
| timeout | number | 否 | 最大等待时间，单位毫秒（ms） | | timeout | number | 否 | 最大等待时间，单位毫秒（ms） |
| callback | AsyncCallback\<[UIAbility](js-apis-application-ability.md#Ability)> | 是 | 表示指定的回调方法 | | callback | AsyncCallback\<[UIAbility](js-apis-app-ability-uiAbility.md)> | 是 | 表示指定的回调方法 |
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var timeout = 100; var timeout = 100;
...@@ -262,18 +262,18 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise\<UIAbilit ...@@ -262,18 +262,18 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise\<UIAbilit
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | | monitor | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-inner-application-abilityMonitor.md#AbilityMonitor)实例 |
| timeout | number | 否 | 最大等待时间，单位毫秒（ms） | | timeout | number | 否 | 最大等待时间，单位毫秒（ms） |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------------------------------- | -------------------------- | | ----------------------------------------------------------- | -------------------------- |
| Promise\<[UIAbility](js-apis-application-ability.md#Ability)> | 以Promise形式返回Ability。 | | Promise\<[UIAbility](js-apis-app-ability-uiAbility.md)> | 以Promise形式返回Ability。 |
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
...@@ -305,11 +305,11 @@ getAppContext(): Context; ...@@ -305,11 +305,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; var abilityDelegator;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
...@@ -330,17 +330,17 @@ getAbilityState(ability: UIAbility): number; ...@@ -330,17 +330,17 @@ getAbilityState(ability: UIAbility): number;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------------------- | ---- | --------------- | | ------- | ------------------------------------------------- | ---- | --------------- |
| ability | [UIAbility](js-apis-application-ability.md#Ability) | 是 | 指定Ability对象 | | ability | [UIAbility](js-apis-app-ability-uiAbility.md) | 是 | 指定Ability对象 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------------------------------------------------------------ | | ------ | ------------------------------------------------------------ |
| number | 指定ability的生命周期状态。状态枚举值使用[AbilityLifecycleState](js-apis-abilityDelegatorRegistry.md#AbilityLifecycleState)。 | | number | 指定ability的生命周期状态。状态枚举值使用[AbilityLifecycleState](js-apis-application-abilityDelegatorRegistry.md#AbilityLifecycleState)。 |
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var ability; var ability;
...@@ -367,11 +367,11 @@ getCurrentTopAbility(callback: AsyncCallback\<UIAbility>): void; ...@@ -367,11 +367,11 @@ getCurrentTopAbility(callback: AsyncCallback\<UIAbility>): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------ | | -------- | ------------------------------------------------------------ | ---- | ------------------ |
| callback | AsyncCallback\<[UIAbility](js-apis-application-ability.md#Ability)> | 是 | 表示指定的回调方法 | | callback | AsyncCallback\<[UIAbility](js-apis-app-ability-uiAbility.md)> | 是 | 表示指定的回调方法 |
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var ability; var ability;
...@@ -396,11 +396,11 @@ getCurrentTopAbility(): Promise\<UIAbility>; ...@@ -396,11 +396,11 @@ getCurrentTopAbility(): Promise\<UIAbility>;
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------------------------------- | -------------------------------------- | | ----------------------------------------------------------- | -------------------------------------- |
| Promise\<[UIAbility](js-apis-application-ability.md#Ability)> | 以Promise形式返回当前应用顶部ability。 | | Promise\<[UIAbility](js-apis-app-ability-uiAbility.md)> | 以Promise形式返回当前应用顶部ability。 |
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var ability; var ability;
...@@ -425,12 +425,12 @@ startAbility(want: Want, callback: AsyncCallback\<void>): void; ...@@ -425,12 +425,12 @@ startAbility(want: Want, callback: AsyncCallback\<void>): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ------------------ | | -------- | -------------------------------------- | ---- | ------------------ |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability参数 | | want | [Want](js-apis-application-want.md) | 是 | 启动Ability参数 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法 | | callback | AsyncCallback\<void> | 是 | 表示指定的回调方法 |
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var want = { var want = {
bundleName: "bundleName", bundleName: "bundleName",
...@@ -457,7 +457,7 @@ startAbility(want: Want): Promise\<void>; ...@@ -457,7 +457,7 @@ startAbility(want: Want): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------------------------------- | ---- | --------------- | | ------ | -------------------------------------- | ---- | --------------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability参数 | | want | [Want](js-apis-application-want.md) | 是 | 启动Ability参数 |
**返回值：** **返回值：**
...@@ -467,7 +467,7 @@ startAbility(want: Want): Promise\<void>; ...@@ -467,7 +467,7 @@ startAbility(want: Want): Promise\<void>;
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var want = { var want = {
bundleName: "bundleName", bundleName: "bundleName",
...@@ -499,7 +499,7 @@ doAbilityForeground(ability: UIAbility, callback: AsyncCallback\<void>): void; ...@@ -499,7 +499,7 @@ doAbilityForeground(ability: UIAbility, callback: AsyncCallback\<void>): void;
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var ability; var ability;
...@@ -537,7 +537,7 @@ doAbilityForeground(ability: UIAbility): Promise\<void>; ...@@ -537,7 +537,7 @@ doAbilityForeground(ability: UIAbility): Promise\<void>;
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var ability; var ability;
...@@ -570,7 +570,7 @@ doAbilityBackground(ability: UIAbility, callback: AsyncCallback\<void>): void; ...@@ -570,7 +570,7 @@ doAbilityBackground(ability: UIAbility, callback: AsyncCallback\<void>): void;
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var ability; var ability;
...@@ -608,7 +608,7 @@ doAbilityBackground(ability: UIAbility): Promise\<void>; ...@@ -608,7 +608,7 @@ doAbilityBackground(ability: UIAbility): Promise\<void>;
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var ability; var ability;
...@@ -640,7 +640,7 @@ printSync(msg: string): void; ...@@ -640,7 +640,7 @@ printSync(msg: string): void;
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var msg = "msg"; var msg = "msg";
...@@ -667,7 +667,7 @@ print(msg: string, callback: AsyncCallback\<void>): void; ...@@ -667,7 +667,7 @@ print(msg: string, callback: AsyncCallback\<void>): void;
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var msg = "msg"; var msg = "msg";
...@@ -701,7 +701,7 @@ print(msg: string): Promise\<void>; ...@@ -701,7 +701,7 @@ print(msg: string): Promise\<void>;
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var msg = "msg"; var msg = "msg";
...@@ -726,11 +726,11 @@ executeShellCommand(cmd: string, callback: AsyncCallback\<ShellCmdResult>): void ...@@ -726,11 +726,11 @@ executeShellCommand(cmd: string, callback: AsyncCallback\<ShellCmdResult>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------ | | -------- | ------------------------------------------------------------ | ---- | ------------------ |
| cmd | string | 是 | shell命令字符串 | | cmd | string | 是 | shell命令字符串 |
| callback | AsyncCallback\<[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)> | 是 | 表示指定的回调方法 | | callback | AsyncCallback\<[ShellCmdResult](js-apis-inner-application-shellCmdResult.md#ShellCmdResult)> | 是 | 表示指定的回调方法 |
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var cmd = "cmd"; var cmd = "cmd";
...@@ -756,11 +756,11 @@ executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback\<S ...@@ -756,11 +756,11 @@ executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback\<S
| ----------- | ------------------------------------------------------------ | ---- | ----------------------------- | | ----------- | ------------------------------------------------------------ | ---- | ----------------------------- |
| cmd | string | 是 | shell命令字符串 | | cmd | string | 是 | shell命令字符串 |
| timeoutSecs | number | 否 | 设定命令超时时间，单位秒（s） | | timeoutSecs | number | 否 | 设定命令超时时间，单位秒（s） |
| callback | AsyncCallback\<[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)> | 是 | 表示指定的回调方法 | | callback | AsyncCallback\<[ShellCmdResult](js-apis-inner-application-shellCmdResult.md#ShellCmdResult)> | 是 | 表示指定的回调方法 |
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var cmd = "cmd"; var cmd = "cmd";
var timeout = 100; var timeout = 100;
...@@ -792,11 +792,11 @@ executeShellCommand(cmd: string, timeoutSecs?: number): Promise\<ShellCmdResult> ...@@ -792,11 +792,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#ShellCmdResult)> | 以Promise形式返回Shell命令执行结果[ShellCmdResult](js-apis-inner-application-shellCmdResult.md#ShellCmdResult)对象。 |
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var cmd = "cmd"; var cmd = "cmd";
var timeout = 100; var timeout = 100;
...@@ -827,7 +827,7 @@ finishTest(msg: string, code: number, callback: AsyncCallback\<void>): void; ...@@ -827,7 +827,7 @@ finishTest(msg: string, code: number, callback: AsyncCallback\<void>): void;
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var msg = "msg"; var msg = "msg";
...@@ -862,7 +862,7 @@ finishTest(msg: string, code: number): Promise\<void>; ...@@ -862,7 +862,7 @@ finishTest(msg: string, code: number): Promise\<void>;
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var msg = "msg"; var msg = "msg";
...@@ -884,12 +884,12 @@ addAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\<vo ...@@ -884,12 +884,12 @@ addAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\<vo
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | | -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 | | monitor | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) | 是 | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) 实例 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法 | | callback | AsyncCallback\<void> | 是 | 表示指定的回调方法 |
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var monitor = { var monitor = {
...@@ -917,7 +917,7 @@ addAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\<void>; ...@@ -917,7 +917,7 @@ addAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 | | monitor | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) | 是 | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) 实例 |
**返回值：** **返回值：**
...@@ -927,7 +927,7 @@ addAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\<void>; ...@@ -927,7 +927,7 @@ addAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\<void>;
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var monitor = { var monitor = {
...@@ -953,12 +953,12 @@ removeAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\ ...@@ -953,12 +953,12 @@ removeAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | | -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 | | monitor | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) | 是 | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) 实例 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法 | | callback | AsyncCallback\<void> | 是 | 表示指定的回调方法 |
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var monitor = { var monitor = {
...@@ -986,7 +986,7 @@ removeAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\<void>; ...@@ -986,7 +986,7 @@ removeAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 | | monitor | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) | 是 | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) 实例 |
**返回值：** **返回值：**
...@@ -996,7 +996,7 @@ removeAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\<void>; ...@@ -996,7 +996,7 @@ removeAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\<void>;
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var monitor = { var monitor = {
...@@ -1022,12 +1022,12 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\<A ...@@ -1022,12 +1022,12 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\<A
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | | -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 | | monitor | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) | 是 | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) 实例 |
| callback | AsyncCallback\<AbilityStage> | 是 | 成功返回AbilityStage对象，失败返回空。 | | callback | AsyncCallback\<AbilityStage> | 是 | 成功返回AbilityStage对象，失败返回空。 |
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
...@@ -1057,7 +1057,7 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout?: number): Promise ...@@ -1057,7 +1057,7 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout?: number): Promise
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 | | monitor | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) | 是 | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) 实例 |
| timeout | number | 否 | 超时最大等待时间，以毫秒为单位。 | | timeout | number | 否 | 超时最大等待时间，以毫秒为单位。 |
**返回值：** **返回值：**
...@@ -1068,7 +1068,7 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout?: number): Promise ...@@ -1068,7 +1068,7 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout?: number): Promise
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
...@@ -1098,13 +1098,13 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout: number, callback: ...@@ -1098,13 +1098,13 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout: number, callback:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| monitor | [AbilityStageMonitor](#abilitystagemonitor) | 是 | [AbilityStageMonitor](#abilitystagemonitor) 实例 | | monitor | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) | 是 | [AbilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md) 实例 |
| timeout | number | 否 | 超时最大等待时间，以毫秒为单位。 | | timeout | number | 否 | 超时最大等待时间，以毫秒为单位。 |
| callback | AsyncCallback\<AbilityStage> | 是 | 成功返回AbilityStage对象，失败返回空。 | | callback | AsyncCallback\<AbilityStage> | 是 | 成功返回AbilityStage对象，失败返回空。 |
**示例：** **示例：**
```js ```ts
var abilityDelegator; var abilityDelegator;
var timeout = 100; var timeout = 100;
...@@ -1121,16 +1121,4 @@ abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); ...@@ -1121,16 +1121,4 @@ abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityStageMonitor(monitor, timeout, (err : any, data : any) => { abilityDelegator.waitAbilityStageMonitor(monitor, timeout, (err : any, data : any) => {
console.info("waitAbilityStageMonitor callback"); console.info("waitAbilityStageMonitor callback");
}); });
``` ```
\ No newline at end of file
## AbilityStageMonitor
提供用于匹配满足指定条件的受监视的AbilityStage对象的方法。最近匹配的AbilityStage对象将保存在AbilityStageMonitor对象中。
系统能力：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------------------------------------------ | -------- | ---- | ---- | ------------------------------------------------------------ |
| moduleName<sup>9+</sup> | string | 是 | 是 | 要监视的abilityStage的模块名。 |
| srcEntrance<sup>9+</sup> | string | 是 | 是 | 要监视的abilityStage的源路径。 |
zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md → zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityDelegatorArgs.md
浏览文件 @ 0612bb09
# AbilityDelegatorArgs # AbilityDelegatorArgs
AbilityDelegatorArgs模块提供在应用程序启动期间，用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力。 AbilityDelegatorArgs模块提供在应用程序启动期间，用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力。
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 使用说明 ## 使用说明
通过AbilityDelegatorRegistry中getArguments方法获取。 通过AbilityDelegatorRegistry中getArguments方法获取。
```js ## AbilityDelegatorArgs
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry';
测试参数信息
var args = AbilityDelegatorRegistry.getArguments();
``` **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
## AbilityDelegatorArgs | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------- | ---------------------- | ---- | ---- | ------------------------------------------------------------ |
测试参数信息 | bundleName | string | 是 | 是 | 当前被测试应用的包名 |
| parameters | {[key:string]: string} | 是 | 是 | 当前启动单元测试的参数 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core | testCaseNames | string | 是 | 是 | 测试用例名称 |
| testRunnerClassName | string | 是 | 是 | 执行测试用例的测试执行器的名称 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------- | ---------------------- | ---- | ---- | ------------------------------------------------------------ | **示例：**
| bundleName | string | 是 | 是 | 当前被测试应用的包名 |
| parameters | {[key:string]: string} | 是 | 是 | 当前启动单元测试的参数 | ```ts
| testCaseNames | string | 是 | 是 | 测试用例名称 | import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry';
| testRunnerClassName | string | 是 | 是 | 执行测试用例的测试执行器的名称 |
var args = AbilityDelegatorRegistry.getArguments();
```
zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityMonitor.md 0 → 100644
浏览文件 @ 0612bb09
# AbilityMonitor
AbilityMonitor模块提供匹配满足指定条件的受监视能力对象的方法的能力，最近匹配的ability对象将保存在AbilityMonitor对象中。
> **说明：**
>
> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 使用说明
通过abilityDelegator中的addAbilityMonitor来设置。
## AbilityMonitor
Ability监听器
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------------------------------------------ | -------- | ---- | ---- | ------------------------------------------------------------ |
| abilityName | string | 是 | 是 | 当前AbilityMonitor绑定的ability名称 |
| onAbilityCreate?:(data: [UIAbility](js-apis-app-ability-uiAbility.md)) | function | 是 | 是 | ability被启动初始化时的回调函数<br/>不设置该属性则不能收到该生命周期回调 |
| onAbilityForeground?:(data: [UIAbility](js-apis-app-ability-uiAbility.md)) | function | 是 | 是 | ability状态变成前台时的回调函数<br/>不设置该属性则不能收到该生命周期回调 |
| onAbilityBackground?:(data: [UIAbility](js-apis-app-ability-uiAbility.md)) | function | 是 | 是 | ability状态变成后台时的回调函数<br/>不设置该属性则不能收到该生命周期回调 |
| onAbilityDestroy?:(data: [UIAbility](js-apis-app-ability-uiAbility.md)) | function | 是 | 是 | ability被销毁前的回调函数<br/>不设置该属性则不能收到该生命周期回调<br/> |
| onWindowStageCreate?:(data: [UIAbility](js-apis-app-ability-uiAbility.md)) | function | 是 | 是 | window stage被创建时的回调函数<br/>不设置该属性则不能收到该生命周期回调<br/> |
| onWindowStageRestore?:(data: [UIAbility](js-apis-app-ability-uiAbility.md)) | function | 是 | 是 | window stage被重载时的回调函数<br/>不设置该属性则不能收到该生命周期回调<br/> |
| onWindowStageDestroy?:(data: [UIAbility](js-apis-app-ability-uiAbility.md)) | function | 是 | 是 | window stage被销毁前的回调函数<br/>不设置该属性则不能收到该生命周期回调<br/> |
**示例：**
```ts
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'
var abilityDelegator;
function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback");
}
var monitor = {
abilityName: "abilityname",
onAbilityCreate: onAbilityCreateCallback
}
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.addAbilityMonitor(monitor, (err : any) => {
console.info("addAbilityMonitor callback");
});
```
zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md → zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityRunningInfo.md
浏览文件 @ 0612bb09
...@@ -10,13 +10,6 @@ AbilityRunningInfo模块提供对Ability运行的相关信息和状态的定义 ...@@ -10,13 +10,6 @@ AbilityRunningInfo模块提供对Ability运行的相关信息和状态的定义
通过abilityManager中getAbilityRunningInfos方法获取。 通过abilityManager中getAbilityRunningInfos方法获取。
```js
import abilitymanager from '@ohos.application.abilityManager';
abilitymanager.getAbilityRunningInfos((err,data) => {
console.log("getAbilityRunningInfos err: " + err + " data: " + JSON.stringify(data));
});
```
## 属性 ## 属性
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
...@@ -30,4 +23,22 @@ abilitymanager.getAbilityRunningInfos((err,data) => { ...@@ -30,4 +23,22 @@ abilitymanager.getAbilityRunningInfos((err,data) => {
| uid | number | 是 | 否 | 用户ID。 | | uid | number | 是 | 否 | 用户ID。 |
| processName | string | 是 | 否 | 进程名称。 | | processName | string | 是 | 否 | 进程名称。 |
| startTime | number | 是 | 否 | Ability启动时间。 | | startTime | number | 是 | 否 | Ability启动时间。 |
| abilityState | [abilityManager.AbilityState](js-apis-application-abilityManager.md#abilitystate) | 是 | 否 | Ability状态。 | | abilityState | [abilityManager.AbilityState](js-apis-app-ability-abilityManager.md#abilitystate) | 是 | 否 | Ability状态。 |
\ No newline at end of file
**示例：**
```ts
import abilitymanager from '@ohos.application.abilityManager';
abilitymanager.getAbilityRunningInfos((err,data) => {
console.log("getAbilityRunningInfos err: " + err + " data: " + JSON.stringify(data));
for (let i = 0; i < data.length; i++) {
let abilityinfo = data[i];
console.log("abilityinfo.ability: " + JSON.stringify(abilityinfo.ability));
console.log("abilityinfo.pid: " + JSON.stringify(abilityinfo.pid));
console.log("abilityinfo.uid: " + JSON.stringify(abilityinfo.uid));
console.log("abilityinfo.processName: " + JSON.stringify(abilityinfo.processName));
console.log("abilityinfo.startTime: " + JSON.stringify(abilityinfo.startTime));
console.log("abilityinfo.abilityState: " + JSON.stringify(abilityinfo.abilityState));
}
});
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md → zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageContext.md
浏览文件 @ 0612bb09
...@@ -13,7 +13,7 @@ AbilityStageContext提供允许访问特定于abilityStage的资源的能力， ...@@ -13,7 +13,7 @@ AbilityStageContext提供允许访问特定于abilityStage的资源的能力，
通过AbilityStage实例来获取。 通过AbilityStage实例来获取。
```js ```ts
import AbilityStage from '@ohos.application.AbilityStage'; import AbilityStage from '@ohos.application.AbilityStage';
class MyAbilityStage extends AbilityStage { class MyAbilityStage extends AbilityStage {
onCreate() { onCreate() {
......
zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageMonitor.md 0 → 100644
浏览文件 @ 0612bb09
# AbilityStageMonitor
提供用于匹配满足指定条件的受监视的AbilityStage对象的方法。最近匹配的AbilityStage对象将保存在AbilityStageMonitor对象中。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------------------------------------------ | -------- | ---- | ---- | ------------------------------------------------------------ |
| moduleName<sup>9+</sup> | string | 是 | 是 | 要监视的abilityStage的模块名。 |
| srcEntrance<sup>9+</sup> | string | 是 | 是 | 要监视的abilityStage的源路径。 |
**示例：**
```ts
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'
let monitor = {
moduleName: "feature_as1",
srcEntrance: "./ets/Application/MyAbilityStage.ts",
};
let abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityStageMonitor(monitor, (error, data) => {
console.info("stageMonitor waitAbilityStageMonitor, abilityStage = " + JSON.stringify(data));
});
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStateData.md 0 → 100644
浏览文件 @ 0612bb09
# AbilityStateData
定义Ability状态信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------------------- | ---------| ---- | ---- | ------------------------- |
| pid<sup>8+</sup> | number | 是 | 否 | 进程ID。 |
| bundleName<sup>8+</sup> | string | 是 | 否 | 应用包名。 |
| abilityName<sup>8+</sup> | string | 是 | 否 | Ability名称。 |
| uid<sup>8+</sup> | number | 是 | 否 | 用户ID。 |
| state<sup>8+</sup> | number | 是 | 否 | Ability状态。 |
| moduleName<sup>9+</sup> | string | 是 | 否 | Ability所属的HAP包的名称。 |
| abilityType<sup>8+</sup> | string | 是 | 否 | 能力类型、页面或服务等。 |
**示例：**
```ts
import appManager from "@ohos.application.appManager"
appManager.getForegroundApplications((error, data) => {
for(let i=0; i<data.length; i++) {
let appStateData = data[i];
console.info('appStateData.pid: ' + appStateData.pid);
console.info('appStateData.bundleName: ' + appStateData.bundleName);
console.info('appStateData.abilityName: ' + appStateData.abilityName);
console.info('appStateData.uid: ' + appStateData.uid);
console.info('appStateData.state: ' + appStateData.state);
console.info('appStateData.moduleName: ' + appStateData.moduleName);
console.info('appStateData.abilityType: ' + appStateData.abilityType);
}
});
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-accessibility-extension-context.md → zh-cn/application-dev/reference/apis/js-apis-inner-application-accessibilityExtensionContext.md
浏览文件 @ 0612bb09
...@@ -13,7 +13,7 @@ AccessibilityExtensionContext是AccessibilityExtensionAbility上下文环境， ...@@ -13,7 +13,7 @@ AccessibilityExtensionContext是AccessibilityExtensionAbility上下文环境，
在使用AccessibilityExtensionContext的功能前，需要通过AccessibilityExtensionAbility子类实例获取AccessibilityExtensionContex的实例。 在使用AccessibilityExtensionContext的功能前，需要通过AccessibilityExtensionAbility子类实例获取AccessibilityExtensionContex的实例。
```js ```ts
import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtensionAbility' import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtensionAbility'
let axContext; let axContext;
class MainAbility extends AccessibilityExtensionAbility { class MainAbility extends AccessibilityExtensionAbility {
......
zh-cn/application-dev/reference/apis/js-apis-inner-application-appStateData.md 0 → 100644
浏览文件 @ 0612bb09
# AppStateData
定义应用状态信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| bundleName<sup>8+</sup> | 只读 | string | 否 | 包名。 |
| uid<sup>8+</sup> | 只读 | number | 否 | 用户ID。 |
| state<sup>8+</sup> | 只读 | number | 否 | 应用状态。 |
**示例：**
```ts
import appManager from "@ohos.application.appManager"
appManager.getForegroundApplications((error, data) => {
for(let i=0; i<data.length; i++) {
let appStateData = data[i];
console.info('appStateData.bundleName: ' + appStateData.bundleName);
console.info('appStateData.uid: ' + appStateData.uid);
console.info('appStateData.state: ' + appStateData.state);
}
});
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-application-applicationContext.md → zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationContext.md
浏览文件 @ 0612bb09
...@@ -11,7 +11,7 @@ ApplicationContext模块提供开发者应用级别的的上下文的能力， ...@@ -11,7 +11,7 @@ ApplicationContext模块提供开发者应用级别的的上下文的能力，
在使用ApplicationContext的功能前，需要通过context的实例获取。 在使用ApplicationContext的功能前，需要通过context的实例获取。
```js ```ts
let applicationContext = this.context.getApplicationContext(); let applicationContext = this.context.getApplicationContext();
``` ```
...@@ -27,7 +27,7 @@ registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): **number** ...@@ -27,7 +27,7 @@ registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): **number**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------------------ | -------- | ---- | ------------------------------ | | ------------------------ | -------- | ---- | ------------------------------ |
| callback | [AbilityLifecycleCallback](js-apis-application-abilityLifecycleCallback.md) | 是 | 回调方法，返回注册监听事件的ID。 | | callback | [AbilityLifecycleCallback](js-apis-app-ability-abilityLifecycleCallback.md) | 是 | 回调方法，返回注册监听事件的ID。 |
**返回值：** **返回值：**
...@@ -37,7 +37,7 @@ registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): **number** ...@@ -37,7 +37,7 @@ registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): **number**
**示例：** **示例：**
```js ```ts
import Ability from "@ohos.application.Ability"; import Ability from "@ohos.application.Ability";
var lifecycleId; var lifecycleId;
...@@ -104,7 +104,7 @@ unregisterAbilityLifecycleCallback(callbackId: **number**, callback: AsyncCallb ...@@ -104,7 +104,7 @@ unregisterAbilityLifecycleCallback(callbackId: **number**, callback: AsyncCallb
**示例：** **示例：**
```js ```ts
import Ability from "@ohos.application.Ability"; import Ability from "@ohos.application.Ability";
var lifecycleId; var lifecycleId;
...@@ -132,7 +132,7 @@ registerEnvironmentCallback(callback: EnvironmentCallback): **number**; ...@@ -132,7 +132,7 @@ registerEnvironmentCallback(callback: EnvironmentCallback): **number**;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------------------ | -------- | ---- | ------------------------------ | | ------------------------ | -------- | ---- | ------------------------------ |
| callback | [EnvironmentCallback](js-apis-application-EnvironmentCallback.md) | 是 | 回调方法，返回注册监听事件的ID。 | | callback | [EnvironmentCallback](js-apis-app-ability-environmentCallback.md) | 是 | 回调方法，返回注册监听事件的ID。 |
**返回值：** **返回值：**
...@@ -142,7 +142,7 @@ registerEnvironmentCallback(callback: EnvironmentCallback): **number**; ...@@ -142,7 +142,7 @@ registerEnvironmentCallback(callback: EnvironmentCallback): **number**;
**示例：** **示例：**
```js ```ts
import Ability from "@ohos.application.Ability"; import Ability from "@ohos.application.Ability";
var callbackId; var callbackId;
...@@ -182,310 +182,17 @@ unregisterEnvironmentCallback(callbackId: **number**, callback: AsyncCallback<* ...@@ -182,310 +182,17 @@ unregisterEnvironmentCallback(callbackId: **number**, callback: AsyncCallback<*
**示例：** **示例：**
```js ```ts
let applicationContext = this.context.getApplicationContext();
let callbackId = 1;
applicationContext.unregisterEnvironmentCallback(callbackId, (error, data) => {
console.log("unregisterEnvironmentCallback success, err: " + JSON.stringify(error));
});
```
## ApplicationContext.on
on(type: "abilityLifecycle", callback: AbilityLifecycleCallback): **number**;
注册监听应用内生命周期
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------------------ | -------- | ---- | ------------------------------ |
| type | string | 是 | 调用接口类型 |
| callback | [AbilityLifecycleCallback](js-apis-application-abilityLifecycleCallback.md) | 是 | 回调方法，返回注册监听事件的ID。 |
**返回值：**
| 类型 | 说明 |
| ------ | ------------------------------ |
| number | 返回的此次注册监听生命周期的ID（每次注册该ID会自增+1，当超过监听上限数量2^63-1时，返回-1）。|
**示例：**
```js
import Ability from "@ohos.application.Ability"; import Ability from "@ohos.application.Ability";
var lifecycleId; var callbackId;
export default class MyAbility extends Ability { export default class MyAbility extends Ability {
onCreate() {
console.log("MyAbility onCreate")
let AbilityLifecycleCallback = {
onAbilityCreate(ability){
console.log("AbilityLifecycleCallback onAbilityCreate ability:" + JSON.stringify(ability));
},
onWindowStageCreate(ability, windowStage){
console.log("AbilityLifecycleCallback onWindowStageCreate ability:" + JSON.stringify(ability));
console.log("AbilityLifecycleCallback onWindowStageCreate windowStage:" + JSON.stringify(windowStage));
},
onWindowStageActive(ability, windowStage){
console.log("AbilityLifecycleCallback onWindowStageActive ability:" + JSON.stringify(ability));
console.log("AbilityLifecycleCallback onWindowStageActive windowStage:" + JSON.stringify(windowStage));
},
onWindowStageInactive(ability, windowStage){
console.log("AbilityLifecycleCallback onWindowStageInactive ability:" + JSON.stringify(ability));
console.log("AbilityLifecycleCallback onWindowStageInactive windowStage:" + JSON.stringify(windowStage));
},
onWindowStageDestroy(ability, windowStage){
console.log("AbilityLifecycleCallback onWindowStageDestroy ability:" + JSON.stringify(ability));
console.log("AbilityLifecycleCallback onWindowStageDestroy windowStage:" + JSON.stringify(windowStage));
},
onAbilityDestroy(ability){
console.log("AbilityLifecycleCallback onAbilityDestroy ability:" + JSON.stringify(ability));
},
onAbilityForeground(ability){
console.log("AbilityLifecycleCallback onAbilityForeground ability:" + JSON.stringify(ability));
},
onAbilityBackground(ability){
console.log("AbilityLifecycleCallback onAbilityBackground ability:" + JSON.stringify(ability));
},
onAbilityContinue(ability){
console.log("AbilityLifecycleCallback onAbilityContinue ability:" + JSON.stringify(ability));
}
}
// 1.通过context属性获取applicationContext
let applicationContext = this.context.getApplicationContext();
// 2.通过applicationContext注册监听应用内生命周期
try {
lifecycleId = applicationContext.on("abilityLifecycle", AbilityLifecycleCallback);
console.log("registerAbilityLifecycleCallback number: " + JSON.stringify(lifecycleId));
} catch (paramError) {
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
},
onDestroy() { onDestroy() {
let applicationContext = this.context.getApplicationContext(); let applicationContext = this.context.getApplicationContext();
try { applicationContext.unregisterEnvironmentCallback(callbackId, (error, data) => {
applicationContext.off("abilityLifecycle", lifecycleId, (error, data) => { console.log("unregisterEnvironmentCallback success, err: " + JSON.stringify(error));
console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error));
});
} catch (paramError) {
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
}
}
```
## ApplicationContext.off
off(type: "abilityLifecycle", callbackId: **number**, callback: AsyncCallback<**void**>): **void**;
取消监听应用内生命周期
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------- | -------- | ---- | -------------------------- |
| type | string | 是 | 调用接口类型 |
| callbackId | number | 是 | 注册监听应用内生命周期的ID。 |
| callback | AsyncCallback\<void> | 是 | 回调方法。 |
**示例：**
```js
let applicationContext = this.context.getApplicationContext();
let lifecycleId = 1;
console.log("stage applicationContext: " + JSON.stringify(applicationContext));
try {
applicationContext.off("abilityLifecycle", lifecycleId, (error, data) => {
console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error));
});
} catch (paramError) {
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## ApplicationContext.off
off(type: "abilityLifecycle", callbackId: **number**, callback: AsyncCallback<**void**>): Promise&lt;void&gt;;
取消监听应用内生命周期
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------- | -------- | ---- | -------------------------- |
| type | string | 是 | 调用接口类型 |
| callbackId | number | 是 | 注册监听应用内生命周期的ID。 |
| callback | AsyncCallback\<void> | 是 | 回调方法。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | Promise形式返回执行结果。 |
**示例：**
```js
let applicationContext = this.context.getApplicationContext();
let lifecycleId = 1;
console.log("stage applicationContext: " + JSON.stringify(applicationContext));
try {
applicationContext.off("abilityLifecycle", lifecycleId)
.then((data) => {
console.log("unregisterAbilityLifecycleCallback success");
})
.catch((error) => {
console.log("unregisterAbilityLifecycleCallback failed, err.code: " + JSON.stringify(err.code) +
"err.message: " + JSON.stringify(err.message));
}); });
} catch (paramError) {
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## ApplicationContext.on
on(type: "environment", callback: EnvironmentCallback): **number**;
注册对系统环境变化的监听。使用callback异步回调。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------------------ | -------- | ---- | ------------------------------ |
| callback | [EnvironmentCallback](js-apis-application-EnvironmentCallback.md) | 是 | 回调方法，返回注册监听事件的ID。 |
**返回值：**
| 类型 | 说明 |
| ------ | ------------------------------ |
| number | 返回的此次注册监听系统环境变化的ID（每次注册该ID会自增+1，当超过监听上限数量2^63-1时，返回-1）。|
**示例：**
```js
import Ability from "@ohos.application.Ability";
var callbackId;
export default class MyAbility extends Ability {
onCreate() {
console.log("MyAbility onCreate")
globalThis.applicationContext = this.context.getApplicationContext();
let EnvironmentCallback = {
onConfigurationUpdated(config){
console.log("onConfigurationUpdated config:" + JSON.stringify(config));
},
}
// 1.获取applicationContext
let applicationContext = globalThis.applicationContext;
try {
// 2.通过applicationContext注册监听应用内生命周期
callbackId = applicationContext.on("environment", EnvironmentCallback);
console.log("registerEnvironmentCallback number: " + JSON.stringify(callbackId));
} catch (paramError) {
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
}
onDestroy() {
let applicationContext = globalThis.applicationContext;
try {
applicationContext.off("environment", callbackId, (error, data) => {
console.log("unregisterEnvironmentCallback success, err: " + JSON.stringify(error));
});
} catch (paramError) {
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
} }
} }
``` ```
\ No newline at end of file
## ApplicationContext.off
off("environment", callbackId: **number**, callback: AsyncCallback<**void**>): **void**;
取消对系统环境变化的监听。使用callback异步回调。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------- | -------- | ---- | -------------------------- |
| callbackId | number | 是 | 注册监听系统环境变化的ID。 |
| callback | AsyncCallback\<void> | 是 | 回调方法。 |
**示例：**
```js
let applicationContext = this.context.getApplicationContext();
let callbackId = 1;
try {
applicationContext.off("environment", callbackId, (error, data) => {
console.log("unregisterEnvironmentCallback success, err: " + JSON.stringify(error));
});
} catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message);
}
```
## getProcessRunningInfomation
getProcessRunningInformation(callback: AsyncCallback&lt;Array&lt;ProcessRunningInformation&gt;&gt;): void;
获取正在运行的进程信息
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------------------ | -------- | ---- | ------------------------------ |
| callback | AsyncCallback&lt;Array&lt;[ProcessRunningInformation](js-apis-processrunninginformation.md)&gt;&gt; | 是 | 回调方法，返回正在运行的进程信息。 |
**示例：**
```js
let applicationContext = this.context.getApplicationContext();
applicationContext.getProcessRunningInfomation((err, datas) => {
for (let data of datas) {
console.log("ProcessRunningInformation: " + JSON.stringify(data));
}
})
```
## killProcessesBySelf
killProcessesBySelf(callback: AsyncCallback&lt;void&gt;): void;
杀死自身运行的进程
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------------------ | -------- | ---- | ------------------------------ |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调方法，返回处理信息。 |
**示例：**
```js
let applicationContext = this.context.getApplicationContext();
applicationContext.killProcessesBySelf((err, datas) => {
console.log("killProcessesBySelf success, err: " + JSON.stringify(err));
})
```
zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationStateObserver.md 0 → 100644
浏览文件 @ 0612bb09
# ApplicationStateObserver
定义应用状态监听。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------------------- | ---------| ---- | ---- | ------------------------- |
| onForegroundApplicationChanged<sup>8+</sup> | AsyncCallback\<void> | 是 | 否 | 应用前后台状态发生变化时执行的回调函数。 |
| onAbilityStateChanged<sup>8+</sup> | AsyncCallback\<void> | 是 | 否 | ability状态发生变化时执行的回调函数。 |
| onProcessCreated<sup>8+</sup> | AsyncCallback\<void> | 是 | 否 | 进程创建时执行的回调函数。 |
| onProcessDied<sup>8+</sup> | AsyncCallback\<void> | 是 | 否 | 进程销毁时执行的回调函数。 |
| onProcessStateChanged<sup>8+</sup> | AsyncCallback\<void> | 是 | 否 | 进程状态更新时执行的回调函数。 |
**示例：**
```ts
import appManager from "@ohos.application.appManager"
let applicationStateObserver = {
onForegroundApplicationChanged(appStateData) {
console.log('onForegroundApplicationChanged appStateData: ' + JSON.stringify(appStateData));
},
onAbilityStateChanged(abilityStateData) {
console.log('onAbilityStateChanged onAbilityStateChanged: ' + JSON.stringify(abilityStateData));
},
onProcessCreated(processData) {
console.log('onProcessCreated onProcessCreated: ' + JSON.stringify(processData));
},
onProcessDied(processData) {
console.log('onProcessDied onProcessDied: ' + JSON.stringify(processData));
},
onProcessStateChanged(processData) {
console.log('onProcessStateChanged onProcessStateChanged: ' + JSON.stringify(processData));
}
}
let observerCode = appManager.registerApplicationStateObserver(applicationStateObserver);
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-application-baseContext.md 0 → 100644
浏览文件 @ 0612bb09
# BaseContext
BaseContext抽象类用于表示继承的子类Context是Stage模型还是FA模型。
> **说明：**
>
> 本模块首批接口从API version 8 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | ------ | ---- | ---- | ------- |
| stageMode | boolean | 是 | 是 | 表示Stage模型还是FA模型。 |
**示例：**
```ts
class MyContext extends BaseContext {
constructor(stageMode) {
this.stageMode = stageMode;
}
}
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-application-context.md 0 → 100644
浏览文件 @ 0612bb09
# Context模块
Context模块提供了ability或application的上下文的能力，包括允许访问特定于应用程序的资源、请求和验证权限等。
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 属性
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | ------ | ---- | ---- | ------- |
| resourceManager | resmgr.ResourceManager | 是 | 否 | 资源管理对象。 |
| applicationInfo | ApplicationInfo | 是 | 否 | 当前应用程序的信息。 |
| cacheDir | string | 是 | 否 | 缓存目录。 |
| tempDir | string | 是 | 否 | 临时目录。 |
| filesDir | string | 是 | 否 | 文件目录。 |
| databaseDir | string | 是 | 否 | 数据库目录。 |
| preferencesDir | string | 是 | 否 | preferences目录。 |
| bundleCodeDir | string | 是 | 否 | 安装包目录。 |
| distributedFilesDir | string | 是 | 否 | 分布式文件目录。 |
| eventHub | string | 是 | 否 | 事件中心，提供订阅、取消订阅、触发事件对象。 |
| area | [AreaMode](#areamode) | 是 | 否 | 文件分区信息。 |
## Context.createBundleContext
createBundleContext(bundleName: string): Context;
根据包名创建安装包的上下文Context。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------- |
| bundleName | string | 是 | 包名。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Context | 安装包的上下文Context。 |
**示例：**
```ts
let bundleContext = this.context.createBundleContext("com.example.test");
```
## Context.createModuleContext
createModuleContext(moduleName: string): Context;
根据模块名创建上下文Context。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------- |
| moduleName | string | 是 | 模块名。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Context | 上下文Context。 |
**示例：**
```ts
let moduleContext = this.context.createModuleContext("entry");
```
createModuleContext(bundleName: string, moduleName: string): Context;
根据包名和模块名创建上下文Context。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------- |
| bundleName | string | 是 | 包名。 |
| moduleName | string | 是 | 模块名。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Context | 上下文Context。 |
**示例：**
```ts
let moduleContext = this.context.createModuleContext("com.example.test", "entry");
```
## Context.getApplicationContext
getApplicationContext(): ApplicationContext;
获取应用上下文Context。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Context | 应用上下文Context。 |
**示例：**
```ts
let applicationContext = this.context.getApplicationContext();
```
## AreaMode
文件分区
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| EL1 | 0 | 设备级加密区。 |
| EL2 | 1 | 用户凭据加密区。 |
zh-cn/application-dev/reference/apis/js-apis-inner-application-continueCallback.md 0 → 100644
浏览文件 @ 0612bb09
# ContinueCallback
表示迁移完成后，返回迁移结果回调函数。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------------------- | -------- | ---- | ---- | ------------------ |
| onContinueDone | function | 是 | 否 | 通知迁移完成，返回迁移结果。 |
**示例：**
```ts
import distributedMissionManager from '@ohos.distributedMissionManager';
let continueDeviceInfo = {
srcDeviceId: "123",
dstDeviceId: "456",
missionId: 123,
wantParam: {
"key":"value"
}
};
let continueCallback = {
onContinueDone(result) {
console.log('onContinueDone, result: ' + JSON.stringify(result));
}
}
distributedMissionManager.continueMission(continueDeviceInfo, continueCallback, (error) => {
if (error.code != 0) {
console.error('continueMission failed, cause: ' + JSON.stringify(error))
}
console.info('continueMission finished')
})
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-application-continueDeviceInfo.md 0 → 100644
浏览文件 @ 0612bb09
# ContinueDeviceInfo
表示发起任务迁移时所需参数的枚举。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | ------ | ---- | ---- | ------- |
| srcDeviceId | string | 是 | 是 | 表示任务迁移源设备ID。 |
| dstDeviceId | string | 是 | 是 | 表示任务迁移目标设备ID。 |
| missionId | number | 是 | 是 | 表示任务ID。 |
| wantParam | {[key: string]: any} | 是 | 是 | 表示扩展参数。 |
**示例：**
```ts
import distributedMissionManager from '@ohos.distributedMissionManager';
let continueDeviceInfo = {
srcDeviceId: "123",
dstDeviceId: "456",
missionId: 123,
wantParam: {
"key":"value"
}
};
let continueCallback = {
onContinueDone(result) {
console.log('onContinueDone, result: ' + JSON.stringify(result));
}
}
distributedMissionManager.continueMission(continueDeviceInfo, continueCallback, (error) => {
if (error.code != 0) {
console.error('continueMission failed, cause: ' + JSON.stringify(error))
}
console.info('continueMission finished')
})
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-application-errorObserver.md 0 → 100644
浏览文件 @ 0612bb09
# ErrorObserver
定义异常监听。
## onUnhandledException
onUnhandledException(errMsg: string): void;
将在js运行时引发用户未捕获的异常时调用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| errMsg | string | 否 | 有关异常的消息和错误堆栈跟踪。 |
**示例：**
```ts
import errorManager from '@ohos.application.errorManager';
let observer = {
onUnhandledException(errorMsg) {
console.log('onUnhandledException, errorMsg: ' + JSON.stringify(errorMsg));
}
}
errorManager.registerErrorObserver(observer)
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-eventhub.md → zh-cn/application-dev/reference/apis/js-apis-inner-application-eventHub.md
浏览文件 @ 0612bb09
...@@ -11,7 +11,7 @@ EventHub模块提供了事件中心，提供订阅、取消订阅、触发事件 ...@@ -11,7 +11,7 @@ EventHub模块提供了事件中心，提供订阅、取消订阅、触发事件
在使用eventHub的功能前，需要通过Ability实例的成员变量context获取。 在使用eventHub的功能前，需要通过Ability实例的成员变量context获取。
```js ```ts
import Ability from '@ohos.application.Ability'; import Ability from '@ohos.application.Ability';
export default class MainAbility extends Ability { export default class MainAbility extends Ability {
func1(){ func1(){
...@@ -40,7 +40,7 @@ on(event: string, callback: Function): void; ...@@ -40,7 +40,7 @@ on(event: string, callback: Function): void;
**示例：** **示例：**
```js ```ts
import Ability from '@ohos.application.Ability'; import Ability from '@ohos.application.Ability';
export default class MainAbility extends Ability { export default class MainAbility extends Ability {
...@@ -78,7 +78,7 @@ off(event: string, callback?: Function): void; ...@@ -78,7 +78,7 @@ off(event: string, callback?: Function): void;
**示例：** **示例：**
```js ```ts
import Ability from '@ohos.application.Ability'; import Ability from '@ohos.application.Ability';
export default class MainAbility extends Ability { export default class MainAbility extends Ability {
...@@ -116,7 +116,7 @@ emit(event: string, ...args: Object[]): void; ...@@ -116,7 +116,7 @@ emit(event: string, ...args: Object[]): void;
**示例：** **示例：**
```js ```ts
import Ability from '@ohos.application.Ability'; import Ability from '@ohos.application.Ability';
export default class MainAbility extends Ability { export default class MainAbility extends Ability {
......
zh-cn/application-dev/reference/apis/js-apis-extension-context.md → zh-cn/application-dev/reference/apis/js-apis-inner-application-extensionContext.md
浏览文件 @ 0612bb09
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
ExtensionContext是Extension的上下文环境，继承自Context。 ExtensionContext是Extension的上下文环境，继承自Context。
ExtensionContext模块提供访问特定Extension的资源的能力，对于拓展的Extension，可直接将ExtensionContext作为上下文环境，或者定义一个继承自ExtensionContext的类型作为上下文环境。如：ServiceExtension提供了ServiceExtensionContext，它在ExtensionContext的基础上扩展了启动、停止、绑定、解绑Ability的能力，详见[ServiceExtensionContext](js-apis-service-extension-context.md)。 ExtensionContext模块提供访问特定Extension的资源的能力，对于拓展的Extension，可直接将ExtensionContext作为上下文环境，或者定义一个继承自ExtensionContext的类型作为上下文环境。如：ServiceExtension提供了ServiceExtensionContext，它在ExtensionContext的基础上扩展了启动、停止、绑定、解绑Ability的能力，详见[ServiceExtensionContext](js-apis-inner-application-serviceExtensionContext.md)。
> **说明：** > **说明：**
> >
...@@ -13,10 +13,10 @@ ExtensionContext模块提供访问特定Extension的资源的能力，对于拓 ...@@ -13,10 +13,10 @@ ExtensionContext模块提供访问特定Extension的资源的能力，对于拓
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统能力**：SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 所属Hap包的信息。<br>(详见SDK目录下的 `api\bundle\hapModuleInfo.d.ts`) | | currentHapModuleInfo | [HapModuleInfo](js-apis-bundle-HapModuleInfo.md) | 是 | 否 | 所属Hap包的信息。<br>(详见SDK目录下的 `api\bundle\hapModuleInfo.d.ts`) |
| config | Configuration | 是 | 否 | 所属Module的配置信息。<br>(详见SDK目录下的 `api\@ohos.application.Configuration.d.ts`) | | config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 否 | 所属Module的配置信息。<br>(详见SDK目录下的 `api\@ohos.app.ability.Configuration.d.ts`) |
| extensionAbilityInfo | [ExtensionAbilityInfo](js-apis-bundleManager-extensionAbilityInfo.md) | 是 | 否 | 所属Extension的信息。<br>(详见SDK目录下的 `api\bundle\extensionAbilityInfo.d.ts`) | | extensionAbilityInfo | [ExtensionAbilityInfo](js-apis-bundleManager-extensionAbilityInfo.md) | 是 | 否 | 所属Extension的信息。<br>(详见SDK目录下的 `api\bundle\extensionAbilityInfo.d.ts`) |
## 使用场景 ## 使用场景
...@@ -30,7 +30,7 @@ ExtensionContext主要用于查询所属Extension的信息、Module的配置信 ...@@ -30,7 +30,7 @@ ExtensionContext主要用于查询所属Extension的信息、Module的配置信
**示例：** **示例：**
三个Module内都定义一个相同名称的ServiceExtension： 三个Module内都定义一个相同名称的ServiceExtension：
``` js ```ts
import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility' import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility'
import Want from '@ohos.application.Want' import Want from '@ohos.application.Want'
export default class TheServiceExtension extends ServiceExtension { export default class TheServiceExtension extends ServiceExtension {
...@@ -60,7 +60,7 @@ export default class TheServiceExtension extends ServiceExtension { ...@@ -60,7 +60,7 @@ export default class TheServiceExtension extends ServiceExtension {
``` ```
在entry的MainAbility的onCreate回调内启动ServiceExtension 在entry的MainAbility的onCreate回调内启动ServiceExtension
``` js ```ts
import Ability from '@ohos.app.ability.Ability' import Ability from '@ohos.app.ability.Ability'
export default class MainAbility extends Ability { export default class MainAbility extends Ability {
onCreate(want, launchParam) { onCreate(want, launchParam) {
...@@ -76,7 +76,7 @@ export default class MainAbility extends Ability { ...@@ -76,7 +76,7 @@ export default class MainAbility extends Ability {
``` ```
在entry内新建一个ServiceModule.ts，专用于执行业务逻辑 在entry内新建一个ServiceModule.ts，专用于执行业务逻辑
``` js ```ts
export default class ServiceModel { export default class ServiceModel {
moduleName: string; moduleName: string;
...@@ -110,4 +110,4 @@ export default class ServiceModel { ...@@ -110,4 +110,4 @@ export default class ServiceModel {
} }
} }
}; };
``` ```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md → zh-cn/application-dev/reference/apis/js-apis-inner-application-extensionRunningInfo.md
浏览文件 @ 0612bb09
...@@ -11,19 +11,11 @@ ExtensionRunningInfo模块提供对Extension运行的相关信息和类型进行 ...@@ -11,19 +11,11 @@ ExtensionRunningInfo模块提供对Extension运行的相关信息和类型进行
通过abilityManager中方法获取。 通过abilityManager中方法获取。
```js
import abilityManager from '@ohos.application.abilityManager';
let upperLimit=1
abilityManager.getExtensionRunningInfos(upperLimit, (err,data) => {
console.log("getExtensionRunningInfos err: " + err + " data: " + JSON.stringify(data));
});
```
## 属性 ## 属性
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| extension | ElementName | 是 | 否 | Extension匹配信息。 | | extension | ElementName | 是 | 否 | Extension匹配信息。 |
| pid | number | 是 | 否 | 进程ID。 | | pid | number | 是 | 否 | 进程ID。 |
...@@ -31,4 +23,23 @@ abilityManager.getExtensionRunningInfos(upperLimit, (err,data) => { ...@@ -31,4 +23,23 @@ abilityManager.getExtensionRunningInfos(upperLimit, (err,data) => {
| processName | string | 是 | 否 | 进程名称。 | | processName | string | 是 | 否 | 进程名称。 |
| startTime | number | 是 | 否 | Extension启动时间。 | | startTime | number | 是 | 否 | Extension启动时间。 |
| clientPackage | Array&lt;String&gt; | 是 | 否 | 表示当期进程下的所有包名。 | | clientPackage | Array&lt;String&gt; | 是 | 否 | 表示当期进程下的所有包名。 |
| type | [bundle.ExtensionAbilityType](js-apis-bundleManager.md#extensionabilitytype) | 是 | 否 | Extension类型。 | | type | [bundle.ExtensionAbilityType](js-apis-Bundle.md) | 是 | 否 | Extension类型。 |
\ No newline at end of file
**示例：**
```ts
import abilityManager from '@ohos.application.abilityManager';
let upperLimit=1;
abilityManager.getExtensionRunningInfos(upperLimit, (err,data) => {
console.log("getExtensionRunningInfos err: " + err + " data: " + JSON.stringify(data));
for (let i=0; i<data.length; i++) {
let extensionRunningInfo = data[i];
console.log("extensionRunningInfo.extension: " + JSON.stringify(extensionRunningInfo.extension));
console.log("extensionRunningInfo.pid: " + JSON.stringify(extensionRunningInfo.pid));
console.log("extensionRunningInfo.uid: " + JSON.stringify(extensionRunningInfo.uid));
console.log("extensionRunningInfo.processName: " + JSON.stringify(extensionRunningInfo.processName));
console.log("extensionRunningInfo.startTime: " + JSON.stringify(extensionRunningInfo.startTime));
console.log("extensionRunningInfo.clientPackage: " + JSON.stringify(extensionRunningInfo.clientPackage));
console.log("extensionRunningInfo.type: " + JSON.stringify(extensionRunningInfo.type));
}
});
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md → zh-cn/application-dev/reference/apis/js-apis-inner-application-formExtensionContext.md
浏览文件 @ 0612bb09
...@@ -12,7 +12,8 @@ FormExtensionContext模块提供FormExtension具有的接口和能力。 ...@@ -12,7 +12,8 @@ FormExtensionContext模块提供FormExtension具有的接口和能力。
## 使用说明 ## 使用说明
在使用FormExtensionContext的功能前，需要通过FormExtension获取。 在使用FormExtensionContext的功能前，需要通过FormExtension获取。
```js
```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import formBindingData from '@ohos.app.form.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
...@@ -25,7 +26,6 @@ export default class MyFormExtensionAbility extends FormExtensionAbility { ...@@ -25,7 +26,6 @@ export default class MyFormExtensionAbility extends FormExtensionAbility {
return obj1; return obj1;
} }
} }
``` ```
## startAbility ## startAbility
...@@ -42,12 +42,12 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void ...@@ -42,12 +42,12 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------| --------------------------------- | ---- | -------------------------------------- | | ------| --------------------------------- | ---- | -------------------------------------- |
| want| [Want](js-apis-application-Want.md) | 是 | 包含bundleName，abilityName以及用户自定参数用于拉起Ability。 | | want| [Want](js-apis-application-want.md) | 是 | 包含bundleName，abilityName以及用户自定参数用于拉起Ability。 |
| callback| AsyncCallback&lt;void&gt; | 是 | 回调函数。当拉起一个卡片所属应用的Ability成功，err为undefined，否则为错误对象。 | | callback| AsyncCallback&lt;void&gt; | 是 | 回调函数。当拉起一个卡片所属应用的Ability成功，err为undefined，否则为错误对象。 |
**示例：** **示例：**
```js ```ts
var want = { var want = {
deviceId: "", deviceId: "",
bundleName: "com.example.formstartability", bundleName: "com.example.formstartability",
...@@ -81,7 +81,7 @@ startAbility(want: Want): Promise&lt;void&gt; ...@@ -81,7 +81,7 @@ startAbility(want: Want): Promise&lt;void&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------| --------------------------------- | ---- | -------------------------------------- | | ------| --------------------------------- | ---- | -------------------------------------- |
| want| [Want](js-apis-application-Want.md) | 是 | 包含bundleName，abilityName以及用户自定参数用于拉起Ability。 | | want| [Want](js-apis-application-want.md) | 是 | 包含bundleName，abilityName以及用户自定参数用于拉起Ability。 |
**返回值：** **返回值：**
...@@ -91,7 +91,7 @@ startAbility(want: Want): Promise&lt;void&gt; ...@@ -91,7 +91,7 @@ startAbility(want: Want): Promise&lt;void&gt;
**示例：** **示例：**
```js ```ts
var want = { var want = {
deviceId: "", deviceId: "",
bundleName: "com.example.formstartability", bundleName: "com.example.formstartability",
......
zh-cn/application-dev/reference/apis/js-apis-inner-application-missionCallbacks.md 0 → 100644
浏览文件 @ 0612bb09
# MissionCallbacks
表示开始同步后，建立的回调函数。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------------------- | -------- | ---- | ---- | ------------------ |
| notifyMissionsChanged | function | 是 | 否 | 通知任务变化，返回设备ID。 |
| notifySnapshot | function | 是 | 否 | 通知快照变化，返回设备ID，任务ID |
| notifyNetDisconnect | function | 是 | 否 | 通知断开连接，返回设备ID，网络状态 |
**示例：**
```ts
import distributedMissionManager from '@ohos.distributedMissionManager';
let missionDeviceInfo = {
deviceId: "123456"
};
let missionCallback = {
notifyMissionsChanged: function (deviceId) {
console.log("notifyMissionsChanged deviceId: " + JSON.stringify(deviceId));
},
notifySnapshot: function (mission, deviceId) {
console.log("notifySnapshot mission: " + JSON.stringify(mission));
console.log("notifySnapshot deviceId: " + JSON.stringify(deviceId));
},
notifyNetDisconnect: function (mission, state) {
console.log("notifyNetDisconnect mission: " + JSON.stringify(mission));
console.log("notifyNetDisconnect state: " + JSON.stringify(state));
}
};
distributedMissionManager.registerMissionListener(missionDeviceInfo, missionCallback);
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-application-missionDeviceInfo.md 0 → 100644
浏览文件 @ 0612bb09
# MissionDeviceInfo
表示注册监听时所需参数的枚举。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | ------ | ---- | ---- | ------- |
| deviceId | string | 是 | 是 | 表示设备ID。 |
**示例：**
```ts
import distributedMissionManager from '@ohos.distributedMissionManager';
let missionDeviceInfo = {
deviceId: "123456"
};
let missionCallback = {
notifyMissionsChanged: function (deviceId) {
console.log("notifyMissionsChanged deviceId: " + JSON.stringify(deviceId));
},
notifySnapshot: function (mission, deviceId) {
console.log("notifySnapshot mission: " + JSON.stringify(mission));
console.log("notifySnapshot deviceId: " + JSON.stringify(deviceId));
},
notifyNetDisconnect: function (mission, state) {
console.log("notifyNetDisconnect mission: " + JSON.stringify(mission));
console.log("notifyNetDisconnect state: " + JSON.stringify(state));
}
};
distributedMissionManager.registerMissionListener(missionDeviceInfo, missionCallback);
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-application-missionInfo.md 0 → 100644
浏览文件 @ 0612bb09
# MissionInfo
表示Ability对应任务信息的枚举。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口，三方应用不支持调用。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| missionId | number | 是 | 是 | 表示任务ID。|
| runningState | number | 是 | 是 | 表示运行状态。 |
| lockedState | boolean | 是 | 是 | 表示锁定状态。 |
| timestamp | string | 是 | 是 | 表示任务的最近创建或更新时间。 |
| want | [Want](js-apis-application-want.md) | 是 | 是 | 表示任务的Want信息。 |
| label | string | 是 | 是 | 表示任务的标签。 |
| iconPath | string | 是 | 是 | 表示任务的图标路径。 |
| continuable | boolean | 是 | 是 | 表示任务是否可以迁移。 |
**示例：**
```ts
import missionManager from '@ohos.application.missionManager'
missionManager.getMissionInfo("12345", 1, (error, data) => {
console.info('getMissionInfo missionId is:' + JSON.stringify(data.missionId));
console.info('getMissionInfo runningState is:' + JSON.stringify(data.runningState));
console.info('getMissionInfo lockedState is:' + JSON.stringify(data.lockedState));
console.info('getMissionInfo timestamp is:' + JSON.stringify(data.timestamp));
console.info('getMissionInfo want is:' + JSON.stringify(data.want));
console.info('getMissionInfo label is:' + JSON.stringify(data.label));
console.info('getMissionInfo iconPath is:' + JSON.stringify(data.iconPath));
console.info('getMissionInfo continuable is:' + JSON.stringify(data.continuable));
});
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-application-missionListener.md 0 → 100644
浏览文件 @ 0612bb09
# MissionListener
定义系统任务状态监听。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| onMissionCreated | 只读 | function | 否 | 表示当系统创建任务时回调执行。 |
| onMissionDestroyed | 只读 | function | 否 | 表示当系统销毁任务时回调执行。 |
| onMissionSnapshotChanged | 只读 | function | 否 | 表示当系统更新任务缩略图时回调执行。 |
| onMissionMovedToFront | 只读 | function | 否 | 表示当系统将任务移动到前台时回调执行。 |
| onMissionLabelUpdated | 只读 | function | 否 | 表示当系统更新任务标签时回调执行。 |
| onMissionIconUpdated | 只读 | function | 否 | 表示当系统更新任务图标时回调执行。 |
| onMissionClosed | 只读 | function | 否 | 表示当系统关闭任务时回调执行。 |
**示例：**
```ts
import missionManager from '@ohos.application.missionManager'
let listener = {
onMissionCreated: function (mission) {
console.log("onMissionCreated mission: " + JSON.stringify(mission));
},
onMissionDestroyed: function (mission) {
console.log("onMissionDestroyed mission: " + JSON.stringify(mission));
},
onMissionSnapshotChanged: function (mission) {
console.log("onMissionSnapshotChanged mission: " + JSON.stringify(mission));
},
onMissionMovedToFront: function (mission) {
console.log("onMissionMovedToFront mission: " + JSON.stringify(mission));
},
onMissionIconUpdated: function (mission, icon) {
console.log("onMissionIconUpdated mission: " + JSON.stringify(mission));
},
onMissionClosed: function (mission) {
console.log("onMissionClosed mission: " + JSON.stringify(mission));
}
};
let listenerid = missionManager.registerMissionListener(listener);
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-application-missionParameter.md 0 → 100644
浏览文件 @ 0612bb09
# MissionParameter
表示同步时所需参数的枚举。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ----------- | ------- | ---- | ---- | ----------- |
| deviceId | string | 是 | 是 | 表示设备ID。 |
| fixConflict | boolean | 是 | 是 | 表示是否存在版本冲突。 |
| tag | number | 是 | 是 | 表示特定的标签。 |
**示例：**
```ts
import distributedMissionManager from '@ohos.distributedMissionManager';
let missionParameter = {
deviceId: "123456",
fixConflict: true,
tag: 123
};
try {
distributedMissionManager.startSyncRemoteMissions(missionParameter,
(err, data) => {
console.log("startSyncRemoteMissions, data: " + JSON.stringify(data));
}
);
} catch (err) {
console.error('startSyncRemoteMissions fail: ' + JSON.stringify(err));
}
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-application-MissionSnapshot.md → zh-cn/application-dev/reference/apis/js-apis-inner-application-missionSnapshot.md 100755 → 100644
浏览文件 @ 0612bb09
...@@ -7,11 +7,19 @@ MissionSnapshot模块提供设置与任务对应的任务快照的任务元素 ...@@ -7,11 +7,19 @@ MissionSnapshot模块提供设置与任务对应的任务快照的任务元素
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口均为系统接口，三方应用不支持调用 > 本模块接口均为系统接口，三方应用不支持调用
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ability | ElementName | 是 | 是 | 表示Ability任务元素名称。 |
| snapshot | [image.PixelMap](js-apis-image.md) | 是 | 是 | 表示任务快照。 |
## 使用说明 ## 使用说明
通过missionManager中的getMissionSnapShot来获取。 通过missionManager中的getMissionSnapShot来获取。
```js **示例：**
```ts
import ElementName from '@ohos.bundle'; import ElementName from '@ohos.bundle';
import image from '@ohos.multimedia.image'; import image from '@ohos.multimedia.image';
import missionManager from '@ohos.application.missionManager'; import missionManager from '@ohos.application.missionManager';
...@@ -27,14 +35,4 @@ missionManager.getMissionInfos("", 10, (error, missions) => { ...@@ -27,14 +35,4 @@ missionManager.getMissionInfos("", 10, (error, missions) => {
console.log("bundleName = " + snapshot.ability.bundleName); console.log("bundleName = " + snapshot.ability.bundleName);
}) })
}) })
``` ```
## MissionSnapshot \ No newline at end of file
表示任务对应的任务快照的枚举。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ability | ElementName | 是 | 是 | 表示Ability任务元素名称。 |
| snapshot | [image.PixelMap](js-apis-image.md) | 是 | 是 | 表示任务快照。 |
zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md → zh-cn/application-dev/reference/apis/js-apis-inner-application-permissionRequestResult.md
浏览文件 @ 0612bb09
...@@ -7,11 +7,21 @@ PermissionRequestResult模块提供了权限请求结果的能力。 ...@@ -7,11 +7,21 @@ PermissionRequestResult模块提供了权限请求结果的能力。
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。 > 本模块接口仅可在Stage模型下使用。
## 属性
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| permissions | Array&lt;string&gt; | 是 | 否 | 用户传入的权限。|
| authResults | Array&lt;number&gt; | 是 | 否 | 相应请求权限的结果。0表示授权成功，非0表示失败。 |
## 使用说明 ## 使用说明
通过AbilityContext实例来获取。 通过AbilityContext实例来获取。
```js **示例：**
```ts
import Ability from '@ohos.application.Ability' import Ability from '@ohos.application.Ability'
export default class MainAbility extends Ability { export default class MainAbility extends Ability {
onWindowStageCreate(windowStage) { onWindowStageCreate(windowStage) {
...@@ -27,14 +37,4 @@ export default class MainAbility extends Ability { ...@@ -27,14 +37,4 @@ export default class MainAbility extends Ability {
}); });
} }
} }
``` ```
\ No newline at end of file
## 属性
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| permissions | Array&lt;string&gt; | 是 | 否 | 用户传入的权限。|
| authResults | Array&lt;number&gt; | 是 | 否 | 相应请求权限的结果。0表示授权成功，非0表示失败。 |
zh-cn/application-dev/reference/apis/js-apis-inner-application-processData.md 0 → 100644
浏览文件 @ 0612bb09
# ProcessData
定义进程数据。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------------------- | ---------| ---- | ---- | ------------------------- |
| pid<sup>8+</sup> | number | 是 | 否 | 进程ID。 |
| bundleName<sup>8+</sup> | string | 是 | 否 | 应用包名。 |
| uid<sup>8+</sup> | number | 是 | 否 | 用户ID。 |
| isContinuousTask<sup>9+</sup> | boolean | 是 | 否 | 判断过程是否为连续任务。 |
| isKeepAlive<sup>9+</sup> | boolean | 是 | 否 | 判断该过程是否保持活跃。 |
**示例：**
```ts
import appManager from '@ohos.application.appManager'
let applicationStateObserver = {
onForegroundApplicationChanged(appStateData) {
console.log('onForegroundApplicationChanged appStateData: ' + JSON.stringify(appStateData));
},
onAbilityStateChanged(abilityStateData) {
console.log('onAbilityStateChanged onAbilityStateChanged: ' + JSON.stringify(abilityStateData));
},
onProcessCreated(processData) {
console.log('onProcessCreated onProcessCreated: ' + JSON.stringify(processData));
},
onProcessDied(processData) {
console.log('onProcessDied onProcessDied: ' + JSON.stringify(processData));
},
onProcessStateChanged(processData) {
console.log('onProcessStateChanged processData.pid : ' + JSON.stringify(processData.pid));
console.log('onProcessStateChanged processData.bundleName : ' + JSON.stringify(processData.bundleName));
console.log('onProcessStateChanged processData.uid : ' + JSON.stringify(processData.uid));
console.log('onProcessStateChanged processData.isContinuousTask : ' + JSON.stringify(processData.isContinuousTask));
console.log('onProcessStateChanged processData.isKeepAlive : ' + JSON.stringify(processData.isKeepAlive));
}
}
let observerCode = appManager.registerApplicationStateObserver(applicationStateObserver);
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md → zh-cn/application-dev/reference/apis/js-apis-inner-application-processRunningInfo.md
浏览文件 @ 0612bb09
...@@ -3,22 +3,9 @@ ...@@ -3,22 +3,9 @@
本模块提供对进程运行信息进行设置和查询的能力。 本模块提供对进程运行信息进行设置和查询的能力。
> **说明：** > **说明：**
> - 本模块接口从API version 9 开始废弃，建议使用[ProcessRunningInformation<sup>9+</sup>](js-apis-processrunninginformation.md)替代。 > - 本模块接口从API version 9 开始废弃，建议使用[ProcessRunningInformation<sup>9+</sup>](js-apis-inner-application-processRunningInformation.md)替代。
> - 本模块首批接口从API version 8 开始支持。 > - 本模块首批接口从API version 8 开始支持。
## 使用说明
通过appManager中[getProcessRunningInfos](js-apis-appmanager.md#appmanagergetprocessrunninginfosdeprecated)方法来获取。
```js
import appManager from '@ohos.application.appManager';
app.getProcessRunningInfos().then((data) => {
console.log('success:' + JSON.stringify(data));
}).catch((error) => {
console.log('failed:' + JSON.stringify(error));
});
```
## 属性 ## 属性
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission
...@@ -29,3 +16,17 @@ app.getProcessRunningInfos().then((data) => { ...@@ -29,3 +16,17 @@ app.getProcessRunningInfos().then((data) => {
| uid | number | 是 | 否 | 用户ID。 | | uid | number | 是 | 否 | 用户ID。 |
| processName | string | 是 | 否 | 进程名称。 | | processName | string | 是 | 否 | 进程名称。 |
| bundleNames | Array&lt;string&gt; | 是 | 否 | 进程中所有运行的包名称。 | | bundleNames | Array&lt;string&gt; | 是 | 否 | 进程中所有运行的包名称。 |
## 使用说明
通过appManager中[getProcessRunningInfos](js-apis-application-appManager.md##appManager.getProcessRunningInfos<sup>(deprecated)</sup>)方法来获取。
**示例：**
```ts
import appManager from '@ohos.application.appManager';
app.getProcessRunningInfos().then((data) => {
console.log('success:' + JSON.stringify(data));
}).catch((error) => {
console.log('failed:' + JSON.stringify(error));
});
```
zh-cn/application-dev/reference/apis/js-apis-processrunninginformation.md → zh-cn/application-dev/reference/apis/js-apis-inner-application-processRunningInformation.md 100755 → 100644
浏览文件 @ 0612bb09
...@@ -8,9 +8,9 @@ ProcessRunningInformation模块提供对进程运行信息进行设置和查询 ...@@ -8,9 +8,9 @@ ProcessRunningInformation模块提供对进程运行信息进行设置和查询
## 使用说明 ## 使用说明
通过[appManager](js-apis-appmanager.md#appmanagergetprocessrunninginformation9)来获取。 通过[appManager](js-apis-application-appManager.md#appmanagergetprocessrunninginformation9)来获取。
```js ```ts
import appManager from '@ohos.application.appManager'; import appManager from '@ohos.application.appManager';
appManager.getProcessRunningInformation((error,data) => { appManager.getProcessRunningInformation((error,data) => {
console.log("getProcessRunningInformation error: " + error.code + " data: " + JSON.stringify(data)); console.log("getProcessRunningInformation error: " + error.code + " data: " + JSON.stringify(data));
......
zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md → zh-cn/application-dev/reference/apis/js-apis-inner-application-serviceExtensionContext.md
浏览文件 @ 0612bb09
...@@ -38,15 +38,32 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void; ...@@ -38,15 +38,32 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | | want | [Want](js-apis-application-want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，返回接口调用是否成功的结果。 | | callback | AsyncCallback&lt;void&gt; | 否 | 回调函数，返回接口调用是否成功的结果。 |
**错误码：** **错误码：**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000010 | Can not operation with continue flag. |
| 16000011 | Context does not exist. |
| 16000051 | Network error. The network is abnormal. |
| 16000052 | Free install not support. The application does not support freeinstall |
| 16000053 | Not top ability. The application is not top ability. |
| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. |
| 16000055 | Free install timeout. |
| 16000056 | Can not free install other ability. |
| 16000057 | Not support cross device free install. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -88,8 +105,8 @@ startAbility(want: Want, options?: StartOptions): Promise\<void>; ...@@ -88,8 +105,8 @@ startAbility(want: Want, options?: StartOptions): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | | want | [Want](js-apis-application-want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 | | options | [StartOptions](js-apis-app-ability-startOptions.md) | 是 | 启动Ability所携带的参数。 |
**返回值：** **返回值：**
...@@ -101,8 +118,25 @@ startAbility(want: Want, options?: StartOptions): Promise\<void>; ...@@ -101,8 +118,25 @@ startAbility(want: Want, options?: StartOptions): Promise\<void>;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000010 | Can not operation with continue flag. |
| 16000011 | Context does not exist. |
| 16000051 | Network error. The network is abnormal. |
| 16000052 | Free install not support. The application does not support freeinstall |
| 16000053 | Not top ability. The application is not top ability. |
| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. |
| 16000055 | Free install timeout. |
| 16000056 | Can not free install other ability. |
| 16000057 | Not support cross device free install. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -147,16 +181,33 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback&lt;void& ...@@ -147,16 +181,33 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback&lt;void&
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | | want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 | | options | [StartOptions](js-apis-app-ability-startOptions.md) | 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动结果。 | | callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动结果。 |
**错误码：** **错误码：**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000010 | Can not operation with continue flag. |
| 16000011 | Context does not exist. |
| 16000051 | Network error. The network is abnormal. |
| 16000052 | Free install not support. The application does not support freeinstall |
| 16000053 | Not top ability. The application is not top ability. |
| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. |
| 16000055 | Free install timeout. |
| 16000056 | Can not free install other ability. |
| 16000057 | Not support cross device free install. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -202,7 +253,7 @@ startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\< ...@@ -202,7 +253,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)。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 | | callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
...@@ -210,8 +261,26 @@ startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\< ...@@ -210,8 +261,26 @@ startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\<
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000006 | Can not cross user operations. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000010 | Can not operation with continue flag. |
| 16000011 | Context does not exist. |
| 16000051 | Network error. The network is abnormal. |
| 16000052 | Free install not support. The application does not support freeinstall |
| 16000053 | Not top ability. The application is not top ability. |
| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. |
| 16000055 | Free install timeout. |
| 16000056 | Can not free install other ability. |
| 16000057 | Not support cross device free install. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -255,17 +324,35 @@ startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, ca ...@@ -255,17 +324,35 @@ 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)。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 | | options | [StartOptions](js-apis-app-ability-startOptions.md) | 否 | 启动Ability所携带的参数。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 | | callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**错误码：** **错误码：**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000006 | Can not cross user operations. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000010 | Can not operation with continue flag. |
| 16000011 | Context does not exist. |
| 16000051 | Network error. The network is abnormal. |
| 16000052 | Free install not support. The application does not support freeinstall |
| 16000053 | Not top ability. The application is not top ability. |
| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. |
| 16000055 | Free install timeout. |
| 16000056 | Can not free install other ability. |
| 16000057 | Not support cross device free install. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -313,9 +400,9 @@ startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): ...@@ -313,9 +400,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)。。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 | | options | [StartOptions](js-apis-app-ability-startOptions.md) | 否 | 启动Ability所携带的参数。 |
**返回值：** **返回值：**
...@@ -327,8 +414,26 @@ startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): ...@@ -327,8 +414,26 @@ startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions):
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000006 | Can not cross user operations. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000010 | Can not operation with continue flag. |
| 16000011 | Context does not exist. |
| 16000051 | Network error. The network is abnormal. |
| 16000052 | Free install not support. The application does not support freeinstall |
| 16000053 | Not top ability. The application is not top ability. |
| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. |
| 16000055 | Free install timeout. |
| 16000056 | Can not free install other ability. |
| 16000057 | Not support cross device free install. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -375,15 +480,25 @@ startServiceExtensionAbility(want: Want, callback: AsyncCallback\<void>): void; ...@@ -375,15 +480,25 @@ 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的回调函数。 | | callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**错误码：** **错误码：**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000002 | Ability type error. The specified ability type is wrong. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000011 | Context does not exist. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -426,7 +541,7 @@ startServiceExtensionAbility(want: Want): Promise\<void>; ...@@ -426,7 +541,7 @@ startServiceExtensionAbility(want: Want): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | | want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
**返回值：** **返回值：**
...@@ -438,8 +553,18 @@ startServiceExtensionAbility(want: Want): Promise\<void>; ...@@ -438,8 +553,18 @@ startServiceExtensionAbility(want: Want): Promise\<void>;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000002 | Ability type error. The specified ability type is wrong. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000011 | Context does not exist. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -484,7 +609,7 @@ startServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: ...@@ -484,7 +609,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)。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 | | callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
...@@ -492,8 +617,19 @@ startServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: ...@@ -492,8 +617,19 @@ startServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback:
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000002 | Ability type error. The specified ability type is wrong. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000006 | Can not cross user operations. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000011 | Context does not exist. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -540,7 +676,7 @@ startServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\ ...@@ -540,7 +676,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)。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
**返回值：** **返回值：**
...@@ -553,8 +689,19 @@ startServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\ ...@@ -553,8 +689,19 @@ startServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000002 | Ability type error. The specified ability type is wrong. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000006 | Can not cross user operations. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000011 | Context does not exist. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -598,15 +745,22 @@ stopServiceExtensionAbility(want: Want, callback: AsyncCallback\<void>): void; ...@@ -598,15 +745,22 @@ 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的回调函数。 | | callback | AsyncCallback\<void\> | 是 | 停止Ability的回调函数。 |
**错误码：** **错误码：**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000002 | Ability type error. The specified ability type is wrong. |
| 16000004 | Visibility verification failed. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000011 | Context does not exist. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -649,7 +803,7 @@ stopServiceExtensionAbility(want: Want): Promise\<void>; ...@@ -649,7 +803,7 @@ stopServiceExtensionAbility(want: Want): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 停止Ability的want信息。 | | want | [Want](js-apis-application-want.md) | 是 | 停止Ability的want信息。 |
**返回值：** **返回值：**
...@@ -661,8 +815,15 @@ stopServiceExtensionAbility(want: Want): Promise\<void>; ...@@ -661,8 +815,15 @@ stopServiceExtensionAbility(want: Want): Promise\<void>;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000002 | Ability type error. The specified ability type is wrong. |
| 16000004 | Visibility verification failed. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000011 | Context does not exist. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -707,7 +868,7 @@ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: ...@@ -707,7 +868,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)。 | | accountId | number | 是 | 需要停止的系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| callback | AsyncCallback\<void\> | 是 | 停止Ability的回调函数。 | | callback | AsyncCallback\<void\> | 是 | 停止Ability的回调函数。 |
...@@ -715,8 +876,16 @@ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: ...@@ -715,8 +876,16 @@ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback:
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000002 | Ability type error. The specified ability type is wrong. |
| 16000004 | Visibility verification failed. |
| 16000006 | Can not cross user operations. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000011 | Context does not exist. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -762,7 +931,7 @@ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\< ...@@ -762,7 +931,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)。 | | accountId | number | 是 | 需要停止的系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
**返回值：** **返回值：**
...@@ -775,8 +944,16 @@ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\< ...@@ -775,8 +944,16 @@ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\<
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000002 | Ability type error. The specified ability type is wrong. |
| 16000004 | Visibility verification failed. |
| 16000006 | Can not cross user operations. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000011 | Context does not exist. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -820,14 +997,18 @@ terminateSelf(callback: AsyncCallback&lt;void&gt;): void; ...@@ -820,14 +997,18 @@ terminateSelf(callback: AsyncCallback&lt;void&gt;): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，返回接口调用是否成功的结果。 | | callback | AsyncCallback&lt;void&gt; | 否 | 回调函数，返回接口调用是否成功的结果。 |
**错误码：** **错误码：**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000011 | Context does not exist. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -864,8 +1045,12 @@ terminateSelf(): Promise&lt;void&gt;; ...@@ -864,8 +1045,12 @@ terminateSelf(): Promise&lt;void&gt;;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000011 | Context does not exist. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -894,8 +1079,8 @@ connectServiceExtensionAbility(want: Want, options: ConnectOptions): number; ...@@ -894,8 +1079,8 @@ connectServiceExtensionAbility(want: Want, options: ConnectOptions): number;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | | want | [Want](js-apis-application-want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 |
| options | [ConnectOptions](js-apis-featureAbility.md#connectoptions) | 是 | ConnectOptions类型的回调函数，返回服务连接成功、断开或连接失败后的信息。 | | options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 是 | ConnectOptions类型的回调函数，返回服务连接成功、断开或连接失败后的信息。 |
**返回值：** **返回值：**
...@@ -907,8 +1092,13 @@ connectServiceExtensionAbility(want: Want, options: ConnectOptions): number; ...@@ -907,8 +1092,13 @@ connectServiceExtensionAbility(want: Want, options: ConnectOptions): number;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000002 | Ability type error. The specified ability type is wrong. |
| 16000004 | Visibility verification failed. |
| 16000011 | Context does not exist. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -947,9 +1137,9 @@ connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options ...@@ -947,9 +1137,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)。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| options | ConnectOptions | 是 | 远端对象实例。 | | options | ConnectOptions | 否 | 远端对象实例。 |
**返回值：** **返回值：**
...@@ -961,8 +1151,14 @@ connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options ...@@ -961,8 +1151,14 @@ connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000002 | Ability type error. The specified ability type is wrong. |
| 16000004 | Visibility verification failed. |
| 16000006 | Can not cross user operations. |
| 16000011 | Context does not exist. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -1004,14 +1200,18 @@ disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback&lt; ...@@ -1004,14 +1200,18 @@ disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback&lt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| connection | number | 是 | 在connectAbility中返回的number。 | | connection | number | 是 | 在connectAbility中返回的number。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，返回接口调用是否成功的结果。 | | callback | AsyncCallback&lt;void&gt; | 否 | 回调函数，返回接口调用是否成功的结果。 |
**错误码：** **错误码：**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000003 | Input error. The specified id does not exist. |
| 16000011 | Context does not exist. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -1063,8 +1263,12 @@ disconnectServiceExtensionAbility(connection: number): Promise&lt;void&gt;; ...@@ -1063,8 +1263,12 @@ disconnectServiceExtensionAbility(connection: number): Promise&lt;void&gt;;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000003 | Input error. The specified id does not exist. |
| 16000011 | Context does not exist. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -1104,7 +1308,7 @@ startAbilityByCall(want: Want): Promise&lt;Caller&gt;; ...@@ -1104,7 +1308,7 @@ startAbilityByCall(want: Want): Promise&lt;Caller&gt;;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| 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。 |
**返回值：** **返回值：**
...@@ -1116,8 +1320,15 @@ startAbilityByCall(want: Want): Promise&lt;Caller&gt;; ...@@ -1116,8 +1320,15 @@ startAbilityByCall(want: Want): Promise&lt;Caller&gt;;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------- | | ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. | | 401 | Invalid input parameter. |
| 其他ID | 见[元能力子系统错误码](../errorcodes/errorcode-ability.md) | | 16000001 | Input error. The specified ability name does not exist. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000050 | Internal Error. |
**示例：** **示例：**
...@@ -1184,5 +1395,4 @@ startAbilityByCall(want: Want): Promise&lt;Caller&gt;; ...@@ -1184,5 +1395,4 @@ startAbilityByCall(want: Want): Promise&lt;Caller&gt;;
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message)); ' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
\ No newline at end of file
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-application-shellCmdResult.md → zh-cn/application-dev/reference/apis/js-apis-inner-application-shellCmdResult.md
浏览文件 @ 0612bb09
# ShellCmdResult # ShellCmdResult
本模块提供Shell命令执行结果的能力。 本模块提供Shell命令执行结果的能力。
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 使用说明 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
通过abilityDelegator中的[executeShellCommand](js-apis-application-abilityDelegator.md#executeshellcommand)方法来获取。 | 名称 | 类型 | 可读 | 可写 | 说明 |
| --------- | ------ | ---- | ---- | ------------------------------------------------------------ |
```js | stdResult | string | 是 | 是 | 标准输出内容。 |
import AbilityDelegatorRegistry from "@ohos.application.abilityDelegatorRegistry"; | exitCode | number | 是 | 是 | 结果码。 |
let abilityDelegator;
let cmd = "cmd"; ## 使用说明
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); 通过abilityDelegator中的[executeShellCommand](js-apis-inner-application-abilityDelegator.md#executeshellcommand)方法来获取。
abilityDelegator.executeShellCommand(cmd, (err: any, data: any) => {
console.info("executeShellCommand callback, failed: ", err); **示例：**
console.info("executeShellCommand callback, success: ", data); ```ts
}); import AbilityDelegatorRegistry from "@ohos.application.abilityDelegatorRegistry";
``` let abilityDelegator;
let cmd = "cmd";
## ShellCmdResult
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
Shell命令执行结果 abilityDelegator.executeShellCommand(cmd, (err: any, data: any) => {
console.info("executeShellCommand callback, failed: ", err);
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core console.info("executeShellCommand callback, success: ", data);
});
| 名称 | 类型 | 可读 | 可写 | 说明 | ```
| --------- | ------ | ---- | ---- | ------------------------------------------------------------ | \ No newline at end of file
| stdResult | string | 是 | 是 | 标准输出内容。 |
| exitCode | number | 是 | 是 | 结果码。 |
zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md 0 → 100644
浏览文件 @ 0612bb09
# UIAbilityContext
UIAbilityContext是Ability的上下文环境，继承自Context。
UIAbilityContext模块提供允许访问特定Ability的资源的能力，包括对Ability的启动、停止的设置、获取caller通信接口、拉起弹窗请求用户授权等。
> **说明：**
>
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 本模块接口仅可在Stage模型下使用。
## 属性
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| abilityInfo | [AbilityInfo](js-apis-bundleManager-abilityInfo.md) | 是 | 否 | Abilityinfo相关信息 |
| currentHapModuleInfo | [HapModuleInfo](js-apis-bundleManager-hapModuleInfo.md) | 是 | 否 | 当前hap包的信息 |
| config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 否 | 表示配置信息。 |
## AbilityContext.startAbility
startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void;
启动Ability（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动结果 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000010 | Can not operation with continue flag. |
| 16000011 | Context does not exist. |
| 16000051 | Network error. The network is abnormal. |
| 16000052 | Free install not support. The application does not support freeinstall |
| 16000053 | Not top ability. The application is not top ability. |
| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. |
| 16000055 | Free install timeout. |
| 16000056 | Can not free install other ability. |
| 16000057 | Not support cross device free install. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
bundleName: "com.example.myapp",
abilityName: "MyAbility"
};
try {
this.context.startAbility(want, (error) => {
if (error.code) {
// 处理业务逻辑错误
console.log('startAbility failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
return;
}
// 执行正常业务
console.log('startAbility succeed');
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.startAbility
startAbility(want: Want, options: StartOptions, callback: AsyncCallback&lt;void&gt;): void;
启动Ability（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-app-ability-startOptions.md) | 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动结果。 |
**错误码：**
| 错误码ID | 错误信息
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000010 | Can not operation with continue flag. |
| 16000011 | Context does not exist. |
| 16000051 | Network error. The network is abnormal. |
| 16000052 | Free install not support. The application does not support freeinstall |
| 16000053 | Not top ability. The application is not top ability. |
| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. |
| 16000055 | Free install timeout. |
| 16000056 | Can not free install other ability. |
| 16000057 | Not support cross device free install. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
deviceId: "",
bundleName: "com.extreme.test",
abilityName: "MainAbility"
};
var options = {
windowMode: 0
};
try {
this.context.startAbility(want, options, (error) => {
if (error.code) {
// 处理业务逻辑错误
console.log('startAbility failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
return;
}
// 执行正常业务
console.log('startAbility succeed');
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.startAbility
startAbility(want: Want, options?: StartOptions): Promise&lt;void&gt;;
启动Ability（promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-app-ability-startOptions.md) | 否 | 启动Ability所携带的参数。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | Promise形式返回启动结果。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000010 | Can not operation with continue flag. |
| 16000011 | Context does not exist. |
| 16000051 | Network error. The network is abnormal. |
| 16000052 | Free install not support. The application does not support freeinstall |
| 16000053 | Not top ability. The application is not top ability. |
| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. |
| 16000055 | Free install timeout. |
| 16000056 | Can not free install other ability. |
| 16000057 | Not support cross device free install. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
bundleName: "com.example.myapp",
abilityName: "MyAbility"
};
var options = {
windowMode: 0,
};
try {
this.context.startAbility(want, options)
.then((data) => {
// 执行正常业务
console.log('startAbility succeed');
})
.catch((error) => {
// 处理业务逻辑错误
console.log('startAbility failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.startAbilityForResult
startAbilityForResult(want: Want, callback: AsyncCallback&lt;AbilityResult&gt;): void;
启动Ability并在该Ability退出的时候返回执行结果（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |[Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| callback | AsyncCallback&lt;[AbilityResult](js-apis-inner-ability-abilityResult.md)&gt; | 是 | 执行结果回调函数。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000010 | Can not operation with continue flag. |
| 16000011 | Context does not exist. |
| 16000051 | Network error. The network is abnormal. |
| 16000052 | Free install not support. The application does not support freeinstall |
| 16000053 | Not top ability. The application is not top ability. |
| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. |
| 16000055 | Free install timeout. |
| 16000056 | Can not free install other ability. |
| 16000057 | Not support cross device free install. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
deviceId: "",
bundleName: "com.extreme.test",
abilityName: "MainAbility"
};
try {
this.context.startAbilityForResult(want, (error, result) => {
if (error.code) {
// 处理业务逻辑错误
console.log('startAbilityForResult failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
return;
}
// 执行正常业务
console.log("startAbilityForResult succeed, result.resultCode = " +
result.resultCode)
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.startAbilityForResult
startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback&lt;AbilityResult&gt;): void;
启动Ability并在该Ability退出的时候返回执行结果（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |[Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-app-ability-startOptions.md) | 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback&lt;[AbilityResult](js-apis-inner-ability-abilityResult.md)&gt; | 是 | 执行结果回调函数。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000010 | Can not operation with continue flag. |
| 16000011 | Context does not exist. |
| 16000051 | Network error. The network is abnormal. |
| 16000052 | Free install not support. The application does not support freeinstall |
| 16000053 | Not top ability. The application is not top ability. |
| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. |
| 16000055 | Free install timeout. |
| 16000056 | Can not free install other ability. |
| 16000057 | Not support cross device free install. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
deviceId: "",
bundleName: "com.extreme.test",
abilityName: "MainAbility"
};
var options = {
windowMode: 0,
};
try {
this.context.startAbilityForResult(want, options, (error, result) => {
if (error.code) {
// 处理业务逻辑错误
console.log('startAbilityForResult failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
return;
}
// 执行正常业务
console.log("startAbilityForResult succeed, result.resultCode = " +
result.resultCode)
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.startAbilityForResult
startAbilityForResult(want: Want, options?: StartOptions): Promise&lt;AbilityResult&gt;;
启动Ability并在该Ability退出的时候返回执行结果（promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-app-ability-startOptions.md) | 否 | 启动Ability所携带的参数。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[AbilityResult](js-apis-inner-ability-abilityResult.md)&gt; | Promise形式返回执行结果。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000010 | Can not operation with continue flag. |
| 16000011 | Context does not exist. |
| 16000051 | Network error. The network is abnormal. |
| 16000052 | Free install not support. The application does not support freeinstall |
| 16000053 | Not top ability. The application is not top ability. |
| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. |
| 16000055 | Free install timeout. |
| 16000056 | Can not free install other ability. |
| 16000057 | Not support cross device free install. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
bundleName: "com.example.myapp",
abilityName: "MyAbility"
};
var options = {
windowMode: 0,
};
try {
this.context.startAbilityForResult(want, options)
.then((result) => {
// 执行正常业务
console.log("startAbilityForResult succeed, result.resultCode = " + result.resultCode);
})
.catch((error) => {
// 处理业务逻辑错误
console.log('startAbilityForResult failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.startAbilityForResultWithAccount
startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncCallback\<AbilityResult>): void;
启动一个Ability并在该Ability帐号销毁时返回执行结果（callback形式）。
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| callback | AsyncCallback\<AbilityResult\> | 是 | 启动Ability的回调函数，返回Ability结果。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000006 | Can not cross user operations. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000010 | Can not operation with continue flag. |
| 16000011 | Context does not exist. |
| 16000051 | Network error. The network is abnormal. |
| 16000052 | Free install not support. The application does not support freeinstall |
| 16000053 | Not top ability. The application is not top ability. |
| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. |
| 16000055 | Free install timeout. |
| 16000056 | Can not free install other ability. |
| 16000057 | Not support cross device free install. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
deviceId: "",
bundleName: "com.extreme.test",
abilityName: "MainAbility"
};
var accountId = 100;
try {
this.context.startAbilityForResultWithAccount(want, accountId, (error, result) => {
if (error.code) {
// 处理业务逻辑错误
console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
return;
}
// 执行正常业务
console.log("startAbilityForResultWithAccount succeed, result.resultCode = " +
result.resultCode)
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.startAbilityForResultWithAccount
startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback\<void\>): void;
启动一个Ability并在该Ability帐号销毁时返回执行结果（callback形式）。
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| options | [StartOptions](js-apis-app-ability-startOptions.md) | 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000006 | Can not cross user operations. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000010 | Can not operation with continue flag. |
| 16000011 | Context does not exist. |
| 16000051 | Network error. The network is abnormal. |
| 16000052 | Free install not support. The application does not support freeinstall |
| 16000053 | Not top ability. The application is not top ability. |
| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. |
| 16000055 | Free install timeout. |
| 16000056 | Can not free install other ability. |
| 16000057 | Not support cross device free install. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
deviceId: "",
bundleName: "com.extreme.test",
abilityName: "MainAbility"
};
var accountId = 100;
var options = {
windowMode: 0
};
try {
this.context.startAbilityForResultWithAccount(want, accountId, options, (error, result) => {
if (error.code) {
// 处理业务逻辑错误
console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
return;
}
// 执行正常业务
console.log("startAbilityForResultWithAccount succeed, result.resultCode = " +
result.resultCode)
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.startAbilityForResultWithAccount
startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartOptions): Promise\<AbilityResult\>;
启动一个Ability并在该Ability帐号销毁时返回执行结果（promise形式）。
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| options | [StartOptions](js-apis-app-ability-startOptions.md) | 否 | 启动Ability所携带的参数。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;AbilityResult&gt; | 返回一个Promise，包含Ability结果。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000006 | Can not cross user operations. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000010 | Can not operation with continue flag. |
| 16000011 | Context does not exist. |
| 16000051 | Network error. The network is abnormal. |
| 16000052 | Free install not support. The application does not support freeinstall |
| 16000053 | Not top ability. The application is not top ability. |
| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. |
| 16000055 | Free install timeout. |
| 16000056 | Can not free install other ability. |
| 16000057 | Not support cross device free install. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
deviceId: "",
bundleName: "com.extreme.test",
abilityName: "MainAbility"
};
var accountId = 100;
var options = {
windowMode: 0
};
try {
this.context.startAbilityForResultWithAccount(want, accountId, options)
.then((result) => {
// 执行正常业务
console.log("startAbilityForResultWithAccount succeed, result.resultCode = " +
result.resultCode)
})
.catch((error) => {
// 处理业务逻辑错误
console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.startServiceExtensionAbility
startServiceExtensionAbility(want: Want, callback: AsyncCallback\<void>): void;
启动一个新的ServiceExtensionAbility（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000002 | Ability type error. The specified ability type is wrong. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000011 | Context does not exist. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
deviceId: "",
bundleName: "com.extreme.test",
abilityName: "MainAbility"
};
try {
this.context.startServiceExtensionAbility(want, (error) => {
if (error.code) {
// 处理业务逻辑错误
console.log('startServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
return;
}
// 执行正常业务
console.log('startServiceExtensionAbility succeed');
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.startServiceExtensionAbility
startServiceExtensionAbility(want: Want): Promise\<void>;
启动一个新的ServiceExtensionAbility（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000002 | Ability type error. The specified ability type is wrong. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000011 | Context does not exist. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
deviceId: "",
bundleName: "com.extreme.test",
abilityName: "MainAbility"
};
try {
this.context.startServiceExtensionAbility(want)
.then((data) => {
// 执行正常业务
console.log('startServiceExtensionAbility succeed');
})
.catch((error) => {
// 处理业务逻辑错误
console.log('startServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.startServiceExtensionAbilityWithAccount
startServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\<void>): void;
启动一个新的ServiceExtensionAbility（callback形式）。
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000002 | Ability type error. The specified ability type is wrong. |
| 16000004 | Visibility verification failed. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000011 | Context does not exist. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
deviceId: "",
bundleName: "com.extreme.test",
abilityName: "MainAbility"
};
var accountId = 100;
try {
this.context.startServiceExtensionAbilityWithAccount(want, accountId, (error) => {
if (error.code) {
// 处理业务逻辑错误
console.log('startServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
return;
}
// 执行正常业务
console.log('startServiceExtensionAbilityWithAccount succeed');
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.startServiceExtensionAbilityWithAccount
startServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\<void>;
启动一个新的ServiceExtensionAbility（Promise形式）。
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000002 | Ability type error. The specified ability type is wrong. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000006 | Can not cross user operations. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000011 | Context does not exist. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
deviceId: "",
bundleName: "com.extreme.test",
abilityName: "MainAbility"
};
var accountId = 100;
try {
this.context.startServiceExtensionAbilityWithAccount(want, accountId)
.then((data) => {
// 执行正常业务
console.log('startServiceExtensionAbilityWithAccount succeed');
})
.catch((error) => {
// 处理业务逻辑错误
console.log('startServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.stopServiceExtensionAbility
stopServiceExtensionAbility(want: Want, callback: AsyncCallback\<void>): void;
停止同一应用程序内的服务（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000002 | Ability type error. The specified ability type is wrong. |
| 16000004 | Visibility verification failed. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000011 | Context does not exist. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
deviceId: "",
bundleName: "com.extreme.test",
abilityName: "MainAbility"
};
try {
this.context.stopServiceExtensionAbility(want, (error) => {
if (error.code) {
// 处理业务逻辑错误
console.log('stopServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
return;
}
// 执行正常业务
console.log('stopServiceExtensionAbility succeed');
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.stopServiceExtensionAbility
stopServiceExtensionAbility(want: Want): Promise\<void>;
停止同一应用程序内的服务（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000002 | Ability type error. The specified ability type is wrong. |
| 16000004 | Visibility verification failed. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000011 | Context does not exist. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
deviceId: "",
bundleName: "com.extreme.test",
abilityName: "MainAbility"
};
try {
this.context.stopServiceExtensionAbility(want)
.then((data) => {
// 执行正常业务
console.log('stopServiceExtensionAbility succeed');
})
.catch((error) => {
// 处理业务逻辑错误
console.log('stopServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.stopServiceExtensionAbilityWithAccount
stopServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\<void>): void;
使用帐户停止同一应用程序内的服务（callback形式）。
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000002 | Ability type error. The specified ability type is wrong. |
| 16000004 | Visibility verification failed. |
| 16000006 | Can not cross user operations. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000011 | Context does not exist. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
deviceId: "",
bundleName: "com.extreme.test",
abilityName: "MainAbility"
};
var accountId = 100;
try {
this.context.stopServiceExtensionAbilityWithAccount(want, accountId, (error) => {
if (error.code) {
// 处理业务逻辑错误
console.log('stopServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
return;
}
// 执行正常业务
console.log('stopServiceExtensionAbilityWithAccount succeed');
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.stopServiceExtensionAbilityWithAccount
stopServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\<void>;
使用帐户停止同一应用程序内的服务（Promise形式）。
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000002 | Ability type error. The specified ability type is wrong. |
| 16000004 | Visibility verification failed. |
| 16000006 | Can not cross user operations. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000011 | Context does not exist. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
deviceId: "",
bundleName: "com.extreme.test",
abilityName: "MainAbility"
};
var accountId = 100;
try {
this.context.stopServiceExtensionAbilityWithAccount(want, accountId)
.then((data) => {
// 执行正常业务
console.log('stopServiceExtensionAbilityWithAccount succeed');
})
.catch((error) => {
// 处理业务逻辑错误
console.log('stopServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.terminateSelf
terminateSelf(callback: AsyncCallback&lt;void&gt;): void;
停止Ability自身（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，返回接口调用是否成功的结果。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000011 | Context does not exist. |
| 16000050 | Internal Error. |
**示例：**
```ts
this.context.terminateSelf((error) => {
if (error.code) {
// 处理业务逻辑错误
console.log('terminateSelf failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
return;
}
// 执行正常业务
console.log('terminateSelf succeed');
});
```
## AbilityContext.terminateSelf
terminateSelf(): Promise&lt;void&gt;;
停止Ability自身（promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 返回一个Promise，包含接口的结果。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000011 | Context does not exist. |
| 16000050 | Internal Error. |
**示例：**
```ts
this.context.terminateSelf().then((data) => {
// 执行正常业务
console.log('terminateSelf succeed');
}).catch((error) => {
// 处理业务逻辑错误
console.log('terminateSelf failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
});
```
## AbilityContext.terminateSelfWithResult
terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback&lt;void&gt;): void;
停止Ability，配合startAbilityForResult使用，返回给接口调用方AbilityResult信息（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 返回给调用startAbilityForResult&nbsp;接口调用方的相关信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回停止结果。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000011 | Context does not exist. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
bundleName: "com.extreme.myapplication",
abilityName: "SecondAbility"
}
var resultCode = 100;
// 返回给接口调用方AbilityResult信息
var abilityResult = {
want,
resultCode
}
try {
this.context.terminateSelfWithResult(abilityResult, (error) => {
if (error.code) {
// 处理业务逻辑错误
console.log('terminateSelfWithResult failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
return;
}
// 执行正常业务
console.log('terminateSelfWithResult succeed');
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.terminateSelfWithResult
terminateSelfWithResult(parameter: AbilityResult): Promise&lt;void&gt;;
停止Ability，配合startAbilityForResult使用，返回给接口调用方AbilityResult信息（promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 返回给startAbilityForResult&nbsp;调用方的信息。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | promise形式返回停止结果。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000011 | Context does not exist. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
bundleName: "com.extreme.myapplication",
abilityName: "SecondAbility"
}
var resultCode = 100;
// 返回给接口调用方AbilityResult信息
var abilityResult = {
want,
resultCode
}
try {
this.context.terminateSelfWithResult(abilityResult)
.then((data) => {
// 执行正常业务
console.log('terminateSelfWithResult succeed');
})
.catch((error) => {
// 处理业务逻辑错误
console.log('terminateSelfWithResult failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.connectServiceExtensionAbility
connectServiceExtensionAbility(want: Want, options: ConnectOptions): number;
使用AbilityInfo.AbilityType.SERVICE模板将当前Ability连接到一个Ability。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 否 | 远端对象实例。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 返回Ability连接的结果code。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000002 | Ability type error. The specified ability type is wrong. |
| 16000004 | Visibility verification failed. |
| 16000011 | Context does not exist. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
deviceId: "",
bundleName: "com.extreme.test",
abilityName: "MainAbility"
};
var options = {
onConnect(elementName, remote) { console.log('----------- onConnect -----------') },
onDisconnect(elementName) { console.log('----------- onDisconnect -----------') },
onFailed(code) { console.log('----------- onFailed -----------') }
}
var connection = null;
try {
connection = this.context.connectServiceExtensionAbility(want, options);
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.connectServiceExtensionAbilityWithAccount
connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options: ConnectOptions): number;
使用AbilityInfo.AbilityType.SERVICE模板和account将当前Ability连接到一个Ability。
**需要权限：** ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 否 | 远端对象实例。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 返回Ability连接的结果code。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000002 | Ability type error. The specified ability type is wrong. |
| 16000004 | Visibility verification failed. |
| 16000006 | Can not cross user operations. |
| 16000011 | Context does not exist. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
deviceId: "",
bundleName: "com.extreme.test",
abilityName: "MainAbility"
};
var accountId = 100;
var options = {
onConnect(elementName, remote) { console.log('----------- onConnect -----------') },
onDisconnect(elementName) { console.log('----------- onDisconnect -----------') },
onFailed(code) { console.log('----------- onFailed -----------') }
}
var connection = null;
try {
connection = this.context.connectServiceExtensionAbilityWithAccount(want, accountId, options);
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.disconnectServiceExtensionAbility
disconnectServiceExtensionAbility(connection: number): Promise\<void>;
断开连接（promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| connection | number | 是 | 连接的Ability的数字代码。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise\<void> | 返回执行结果。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000003 | Input error. The specified id does not exist. |
| 16000011 | Context does not exist. |
| 16000050 | Internal Error. |
**示例：**
```ts
// connection为connectServiceExtensionAbility中的返回值
var connection = 1;
try {
this.context.disconnectServiceExtensionAbility(connection)
.then((data) => {
// 执行正常业务
console.log('disconnectServiceExtensionAbility succeed');
})
.catch((error) => {
// 处理业务逻辑错误
console.log('disconnectServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.disconnectServiceExtensionAbility
disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback\<void>): void;
断开连接（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| connection | number | 是 | 连接的Ability的数字代码。 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000003 | Input error. The specified id does not exist. |
| 16000011 | Context does not exist. |
| 16000050 | Internal Error. |
**示例：**
```ts
// connection为connectServiceExtensionAbility中的返回值
var connection = 1;
try {
this.context.disconnectServiceExtensionAbility(connection, (error) => {
if (error.code) {
// 处理业务逻辑错误
console.log('disconnectServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
return;
}
// 执行正常业务
console.log('disconnectServiceExtensionAbility succeed');
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.startAbilityByCall
startAbilityByCall(want: Want): Promise&lt;Caller&gt;;
启动指定Ability至前台或后台，同时获取其Caller通信接口，调用方可使用Caller与被启动的Ability进行通信。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 传入需要启动的Ability的信息，包含abilityName、moduleName、bundleName、deviceId(可选)、parameters(可选)，其中deviceId缺省或为空表示启动本地Ability，parameters缺省或为空表示后台启动Ability。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;Caller&gt; | 获取要通讯的caller对象。 |
**示例：**
后台启动：
```ts
var caller = undefined;
// 后台启动Ability，不配置parameters
var wantBackground = {
bundleName: "com.example.myservice",
moduleName: "entry",
abilityName: "MainAbility",
deviceId: ""
};
try {
this.context.startAbilityByCall(wantBackground)
.then((obj) => {
// 执行正常业务
caller = obj;
console.log('startAbilityByCall succeed');
}).catch((error) => {
// 处理业务逻辑错误
console.log('startAbilityByCall failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
前台启动：
```ts
var caller = undefined;
// 前台启动Ability，将parameters中的"ohos.aafwk.param.callAbilityToForeground"配置为true
var wantForeground = {
bundleName: "com.example.myservice",
moduleName: "entry",
abilityName: "MainAbility",
deviceId: "",
parameters: {
"ohos.aafwk.param.callAbilityToForeground": true
}
};
try {
this.context.startAbilityByCall(wantForeground)
.then((obj) => {
// 执行正常业务
caller = obj;
console.log('startAbilityByCall succeed');
}).catch((error) => {
// 处理业务逻辑错误
console.log('startAbilityByCall failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.startAbilityWithAccount
startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\<void\>): void;
根据account启动Ability（callback形式）。
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000006 | Can not cross user operations. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000010 | Can not operation with continue flag. |
| 16000011 | Context does not exist. |
| 16000051 | Network error. The network is abnormal. |
| 16000052 | Free install not support. The application does not support freeinstall |
| 16000053 | Not top ability. The application is not top ability. |
| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. |
| 16000055 | Free install timeout. |
| 16000056 | Can not free install other ability. |
| 16000057 | Not support cross device free install. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
deviceId: "",
bundleName: "com.extreme.test",
abilityName: "MainAbility"
};
var accountId = 100;
try {
this.context.startAbilityWithAccount(want, accountId, (error) => {
if (error.code) {
// 处理业务逻辑错误
console.log('startAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
return;
}
// 执行正常业务
console.log('startAbilityWithAccount succeed');
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.startAbilityWithAccount
startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback\<void\>): void;
根据account启动Ability（callback形式）。
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。|
| options | [StartOptions](js-apis-app-ability-startOptions.md) | 否 | 启动Ability所携带的参数。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000006 | Can not cross user operations. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000010 | Can not operation with continue flag. |
| 16000011 | Context does not exist. |
| 16000051 | Network error. The network is abnormal. |
| 16000052 | Free install not support. The application does not support freeinstall |
| 16000053 | Not top ability. The application is not top ability. |
| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. |
| 16000055 | Free install timeout. |
| 16000056 | Can not free install other ability. |
| 16000057 | Not support cross device free install. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
deviceId: "",
bundleName: "com.extreme.test",
abilityName: "MainAbility"
};
var accountId = 100;
var options = {
windowMode: 0
};
try {
this.context.startAbilityWithAccount(want, accountId, options, (error) => {
if (error.code) {
// 处理业务逻辑错误
console.log('startAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
return;
}
// 执行正常业务
console.log('startAbilityWithAccount succeed');
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.startAbilityWithAccount
startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): Promise\<void\>;
根据account启动Ability（Promise形式）。
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| options | [StartOptions](js-apis-app-ability-startOptions.md) | 否 | 启动Ability所携带的参数。 |
**错误码：**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 201 | The application does not have permission to call the interface. |
| 401 | Invalid input parameter. |
| 16000001 | Input error. The specified ability name does not exist. |
| 16000004 | Visibility verification failed. |
| 16000005 | Static permission denied. The specified process does not have the permission. |
| 16000006 | Can not cross user operations. |
| 16000007 | Service busyness. There are concurrent tasks, waiting for retry. |
| 16000008 | Crowdtest App Expiration. |
| 16000009 | Can not start ability in wukong mode. |
| 16000010 | Can not operation with continue flag. |
| 16000011 | Context does not exist. |
| 16000051 | Network error. The network is abnormal. |
| 16000052 | Free install not support. The application does not support freeinstall |
| 16000053 | Not top ability. The application is not top ability. |
| 16000054 | Free install busyness. There are concurrent tasks, waiting for retry. |
| 16000055 | Free install timeout. |
| 16000056 | Can not free install other ability. |
| 16000057 | Not support cross device free install. |
| 16200001 | Caller released. The caller has been released. |
| 16000050 | Internal Error. |
**示例：**
```ts
var want = {
deviceId: "",
bundleName: "com.extreme.test",
abilityName: "MainAbility"
};
var accountId = 100;
var options = {
windowMode: 0
};
try {
this.context.startAbilityWithAccount(want, accountId, options)
.then((data) => {
// 执行正常业务
console.log('startAbilityWithAccount succeed');
})
.catch((error) => {
// 处理业务逻辑错误
console.log('startAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
});
} catch (paramError) {
// 处理入参错误异常
console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## AbilityContext.requestPermissionsFromUser
requestPermissionsFromUser(permissions: Array&lt;string&gt;, requestCallback: AsyncCallback&lt;PermissionRequestResult&gt;) : void;
拉起弹窗请求用户授权（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| permissions | Array&lt;string&gt; | 是 | 权限列表。 |
| callback | AsyncCallback&lt;[PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md)&gt; | 是 | 回调函数，返回接口调用是否成功的结果。 |
**示例：**
```ts
var permissions=['com.example.permission']
this.context.requestPermissionsFromUser(permissions,(result) => {
console.log('requestPermissionsFromUserresult:' + JSON.stringify(result));
});
```
## AbilityContext.requestPermissionsFromUser
requestPermissionsFromUser(permissions: Array&lt;string&gt;) : Promise&lt;PermissionRequestResult&gt;;
拉起弹窗请求用户授权（promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| permissions | Array&lt;string&gt; | 是 | 权限列表。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md)&gt; | 返回一个Promise，包含接口的结果。 |
**示例：**
```ts
var permissions=['com.example.permission']
this.context.requestPermissionsFromUser(permissions).then((data) => {
console.log('success:' + JSON.stringify(data));
}).catch((error) => {
console.log('failed:' + JSON.stringify(error));
});
```
## AbilityContext.setMissionLabel
setMissionLabel(label: string, callback:AsyncCallback&lt;void&gt;): void;
设置ability在任务中显示的名称（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| label | string | 是 | 显示名称。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，返回接口调用是否成功的结果。 |
**示例：**
```ts
this.context.setMissionLabel("test",(result) => {
console.log('requestPermissionsFromUserresult:' + JSON.stringify(result));
});
```
## AbilityContext.setMissionLabel
setMissionLabel(label: string): Promise&lt;void&gt;;
设置ability在任务中显示的名称（promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| label | string | 是 | 显示名称。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 返回一个Promise，包含接口的结果。 |
**示例：**
```ts
this.context.setMissionLabel("test").then(() => {
console.log('success');
}).catch((error) => {
console.log('failed:' + JSON.stringify(error));
});
```
## AbilityContext.setMissionIcon
setMissionIcon(icon: image.PixelMap, callback:AsyncCallback\<void>): void;
设置当前ability在任务中显示的图标（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| icon | image.PixelMap | 是 | 在最近的任务中显示的ability图标。 |
| callback | AsyncCallback\<void> | 是 | 指定的回调函数的结果。 |
**示例：**
```ts
import image from '@ohos.multimedia.image';
var imagePixelMap;
var color = new ArrayBuffer(0);
var initializationOptions = {
size: {
height: 100,
width: 100
}
};
image.createPixelMap(color, initializationOptions)
.then((data) => {
imagePixelMap = data;
})
.catch((err) => {
console.log('--------- createPixelMap fail, err: ---------', err)
});
this.context.setMissionIcon(imagePixelMap, (err) => {
console.log('---------- setMissionIcon fail, err: -----------', err);
})
```
## AbilityContext.setMissionIcon
setMissionIcon(icon: image.PixelMap): Promise\<void>;
设置当前ability在任务中显示的图标（promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| icon | image.PixelMap | 是 | 在最近的任务中显示的ability图标。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 返回一个Promise，包含接口的结果。 |
**示例：**
```ts
import image from '@ohos.multimedia.image';
var imagePixelMap;
var color = new ArrayBuffer(0);
var initializationOptions = {
size: {
height: 100,
width: 100
}
};
image.createPixelMap(color, initializationOptions)
.then((data) => {
imagePixelMap = data;
})
.catch((err) => {
console.log('--------- createPixelMap fail, err: ---------', err)
});
this.context.setMissionIcon(imagePixelMap)
.then(() => {
console.log('-------------- setMissionIcon success -------------');
})
.catch((err) => {
console.log('-------------- setMissionIcon fail, err: -------------', err);
});
```
## AbilityContext.restoreWindowStage
restoreWindowStage(localStorage: LocalStorage) : void;
恢复ability中的window stage数据。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| localStorage | image.LocalStorage | 是 | 用于恢复window stage的存储数据。 |
**示例：**
```ts
var storage = new LocalStorage();
this.context.restoreWindowStage(storage);
```
## AbilityContext.isTerminating
isTerminating(): boolean;
查询ability是否在terminating状态。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| bool | true：ability当前处于terminating状态；false：不处于terminating状态。 |
**示例：**
```ts
var isTerminating = this.context.isTerminating();
console.log('ability state :' + isTerminating);
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-triggerInfo.md 0 → 100644
浏览文件 @ 0612bb09
# TriggerInfo
定义触发WantAgent所需要的的信息
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ---------- | --- | ---- | -------------------- | ---- | ----------- |
| code | 是 | 是 | number | 是 | result code。 |
| want | 是 | 是 | Want | 否 | Want。 |
| permission | 是 | 是 | string | 否 | 权限定义。 |
| extraInfo | 是 | 是 | {[key: string]: any} | 否 | 额外数据。 |
**示例：**
```ts
import wantAgent from '@ohos.wantAgent';
let wantAgentInfo = {
wants: [
{
deviceId: "",
bundleName: "com.example.apicoverhaptest",
abilityName: "com.example.apicoverhaptest.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true.true,false}",
parameters: {
myKey0: 2222
}
}
],
operationType: wantAgent.OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG],
extraInfo:{
"key": "value"
}
}
let triggerInfo = {
code: 0,
want: {
deviceId: "",
bundleName: "com.example.apicoverhaptest",
abilityName: "com.example.apicoverhaptest.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true.true,false}",
parameters: {
myKey0: 2222
}
},
permission: ""
extraInfo:{
"key": "value"
}
}
wantAgent.trigger(wantAgentInfo, triggerInfo).then((data) =>{
console.info("trigger data: " + JSON.stringify(data));
}).catch((err) => {
console.error("trigger err: " + JSON.stringify(err));
})
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md 0 → 100644
浏览文件 @ 0612bb09
# WantAgentInfo
定义触发WantAgent所需要的的信息
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 |
| -------------- | --- | ---- | ------------------------------- | ---- | ---------------------- |
| wants | 是 | 是 | Array\<Want\> | 是 | 将被执行的动作列表。 |
| operationType | 是 | 是 | wantAgent.OperationType | 是 | 动作类型。 |
| requestCode | 是 | 是 | number | 是 | 使用者定义的一个私有值。 |
| wantAgentFlags | 是 | 是 | Array<[wantAgent.WantAgentFlags](js-apis-wantAgent.md#WantAgentFlags)> | 否 | 动作执行属性。 |
| extraInfo | 是 | 是 | {[key: string]: any} | 否 | 额外数据。 |
**示例：**
```ts
import wantAgent from '@ohos.wantAgent';
let wantAgentInfo = {
wants: [
{
deviceId: "",
bundleName: "com.example.apicoverhaptest",
abilityName: "com.example.apicoverhaptest.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true.true,false}",
parameters: {
myKey0: 2222
}
}
],
operationType: wantAgent.OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG],
extraInfo:{
"key": "value"
}
}
wantAgent.getWantAgent(wantAgentInfo).then((data) =>{
console.info("getWantAgent data: " + JSON.stringify(data));
}).catch((err) => {
console.error("getWantAgent err: " + JSON.stringify(err));
})
```
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或