Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 fead2d6d 编写于 作者: M m00512953
浏览文件
操作

mingxihua@huawei.com.cn 

Signed-off-by: Nm00512953 <mingxihua@huawei.com>
上级 4945797a
展开全部 显示空白变更内容
内联 并排
Showing with 9203 addition and 4376 deletion
zh-cn/application-dev/reference/apis/js-apis-ability-Want.md 已删除 100644 → 0
浏览文件 @ 4945797a
# 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
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
...@@ -13,7 +13,7 @@ FeatureAbility模块的接口只能在Page类型的Ability调用 ...@@ -13,7 +13,7 @@ FeatureAbility模块的接口只能在Page类型的Ability调用
## 导入模块 ## 导入模块
``` ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
``` ```
...@@ -29,12 +29,12 @@ startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>) ...@@ -29,12 +29,12 @@ startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>)
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- | | --------- | ---------------------------------------- | ---- | -------------- |
| 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(
...@@ -72,11 +72,11 @@ startAbility(parameter: StartAbilityParameter): Promise\<number> ...@@ -72,11 +72,11 @@ startAbility(parameter: StartAbilityParameter): Promise\<number>
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- | | --------- | ---------------------------------------- | ---- | -------------- |
| 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(
...@@ -121,7 +121,7 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper ...@@ -121,7 +121,7 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper
**示例：** **示例：**
```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"
...@@ -140,12 +140,12 @@ startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\ ...@@ -140,12 +140,12 @@ startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- | | --------- | ---------------------------------------- | ---- | -------------- |
| 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(
...@@ -181,17 +181,17 @@ startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult> ...@@ -181,17 +181,17 @@ startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult>
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | ------------- | | --------- | ---------------------------------------- | ---- | ------------- |
| 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(
...@@ -237,12 +237,12 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void> ...@@ -237,12 +237,12 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------- | ---- | -------------- | | --------- | ------------------------------- | ---- | -------------- |
| 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(
...@@ -289,7 +289,7 @@ terminateSelfWithResult(parameter: AbilityResult): Promise\<void> ...@@ -289,7 +289,7 @@ terminateSelfWithResult(parameter: AbilityResult): Promise\<void>
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------- | ---- | ------------- | | --------- | ------------------------------- | ---- | ------------- |
| parameter | [AbilityResult](#abilityresult) | 是 | 表示被启动的Ability | | parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 表示被启动的Ability |
**返回值：** **返回值：**
...@@ -299,7 +299,7 @@ terminateSelfWithResult(parameter: AbilityResult): Promise\<void> ...@@ -299,7 +299,7 @@ terminateSelfWithResult(parameter: AbilityResult): Promise\<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(
...@@ -349,7 +349,7 @@ hasWindowFocus(callback: AsyncCallback\<boolean>): void ...@@ -349,7 +349,7 @@ hasWindowFocus(callback: AsyncCallback\<boolean>): void
**示例：** **示例：**
```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));
...@@ -372,7 +372,7 @@ hasWindowFocus(): Promise\<boolean> ...@@ -372,7 +372,7 @@ hasWindowFocus(): Promise\<boolean>
**示例：** **示例：**
```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));
...@@ -391,11 +391,11 @@ getWant(callback: AsyncCallback\<Want>): void ...@@ -391,11 +391,11 @@ getWant(callback: AsyncCallback\<Want>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | --------- | | -------- | ----------------------------- | ---- | --------- |
| 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));
...@@ -414,11 +414,11 @@ getWant(): Promise\<Want> ...@@ -414,11 +414,11 @@ getWant(): Promise\<Want>
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------- | ---------------- | | ----------------------- | ---------------- |
| 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));
...@@ -441,7 +441,7 @@ getContext(): Context ...@@ -441,7 +441,7 @@ getContext(): 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) => {
...@@ -465,7 +465,7 @@ terminateSelf(callback: AsyncCallback\<void>): void ...@@ -465,7 +465,7 @@ terminateSelf(callback: AsyncCallback\<void>): void
**示例：** **示例：**
```javascript ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
featureAbility.terminateSelf( featureAbility.terminateSelf(
(err) => { (err) => {
...@@ -490,7 +490,7 @@ terminateSelf(): Promise\<void> ...@@ -490,7 +490,7 @@ terminateSelf(): Promise\<void>
**示例：** **示例：**
```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=======================>");
...@@ -509,20 +509,8 @@ connectAbility(request: Want, options:ConnectOptions): number ...@@ -509,20 +509,8 @@ connectAbility(request: Want, options:ConnectOptions): number
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | -------------- | ---- | --------------------- | | ------- | -------------- | ---- | --------------------- |
| 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
| 参数名 | 可读|可写 | 类型 | 必填 | 说明 |
| ------------ | -- | -- | -------- | ---- | ------------------------- |
| onConnect<sup>7+</sup> | 是|否 | function | 是 | 连接成功时的回调函数。 |
| onDisconnect<sup>7+</sup> | 是|否 | function | 是 | 连接失败时的回调函数。 |
| onFailed<sup>7+</sup> | 是|否 | function | 是 | ConnectAbility调用失败时的回调函数。 |
**返回值：** **返回值：**
...@@ -532,7 +520,7 @@ ConnectOptions类型说明 ...@@ -532,7 +520,7 @@ ConnectOptions类型说明
**示例：** **示例：**
```javascript ```ts
import rpc from '@ohos.rpc'; import rpc from '@ohos.rpc';
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
function onConnectCallback(element, remote){ function onConnectCallback(element, remote){
...@@ -575,7 +563,7 @@ disconnectAbility(connection: number, callback:AsyncCallback\<void>): void ...@@ -575,7 +563,7 @@ disconnectAbility(connection: number, callback:AsyncCallback\<void>): void
**示例：** **示例：**
```javascript ```ts
import rpc from '@ohos.rpc'; import rpc from '@ohos.rpc';
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
function onConnectCallback(element, remote){ function onConnectCallback(element, remote){
...@@ -627,7 +615,7 @@ disconnectAbility(connection: number): Promise\<void> ...@@ -627,7 +615,7 @@ disconnectAbility(connection: number): Promise\<void>
**示例：** **示例：**
```javascript ```ts
import rpc from '@ohos.rpc'; import rpc from '@ohos.rpc';
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
function onConnectCallback(element, remote){ function onConnectCallback(element, remote){
...@@ -675,7 +663,7 @@ getWindow(callback: AsyncCallback\<window.Window>): void ...@@ -675,7 +663,7 @@ getWindow(callback: AsyncCallback\<window.Window>): void
**示例：** **示例：**
```javascript ```ts
featureAbility.getWindow((err, data) => { featureAbility.getWindow((err, data) => {
console.info("getWindow err: " + JSON.stringify(err) + "data: " + typeof(data)); console.info("getWindow err: " + JSON.stringify(err) + "data: " + typeof(data));
}); });
...@@ -697,143 +685,12 @@ getWindow(): Promise\<window.Window>; ...@@ -697,143 +685,12 @@ getWindow(): Promise\<window.Window>;
**示例：** **示例：**
```javascript ```ts
featureAbility.getWindow().then((data) => { featureAbility.getWindow().then((data) => {
console.info("getWindow data: " + typeof(data)); console.info("getWindow data: " + typeof(data));
}); });
``` ```
## ConnectOptions.onConnect<sup>7+</sup>
onConnect(elementName: ElementName, remote: rpc.IRemoteObject): void;
连接成功时的回调函数。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------- | ---- | -------- |
| elementName | ElementName | 是 | 元素名。 |
| remote | rpc.IRemoteObject | 是 | rpc远程对象。 |
**示例：**
```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,
},
);
```
## ConnectOptions.onDisconnect<sup>7+</sup>
onDisconnect(elementName: ElementName): void;
连接失败时的回调函数。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------- | ---- | ---- |
| elementName | ElementName | 是 | 元素名。 |
**示例：**
```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,
},
);
```
## 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 ## AbilityWindowConfiguration
使用时通过featureAbility.AbilityWindowConfiguration获取。 使用时通过featureAbility.AbilityWindowConfiguration获取。
...@@ -902,26 +759,6 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY ...@@ -902,26 +759,6 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
| TYPE_DELETE<sup>7+</sup> | 3 | 删除类型。 | | TYPE_DELETE<sup>7+</sup> | 3 | 删除类型。 |
| TYPE_ASSERT<sup>7+</sup> | 4 | 声明类型。 | | 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说明 ## flags说明
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
......
zh-cn/application-dev/reference/apis/js-apis-particleAbility.md → zh-cn/application-dev/reference/apis/js-apis-ability-particleAbility.md
浏览文件 @ fead2d6d
...@@ -13,7 +13,7 @@ particleAbility模块用来对Data和Service类型的Ability进行操作。 ...@@ -13,7 +13,7 @@ particleAbility模块用来对Data和Service类型的Ability进行操作。
## 导入模块 ## 导入模块
```js ```ts
import particleAbility from '@ohos.ability.particleAbility' import particleAbility from '@ohos.ability.particleAbility'
``` ```
...@@ -29,12 +29,12 @@ startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<void>): ...@@ -29,12 +29,12 @@ startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<void>):
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ----------------------------------------------- | ---- | ----------------- | | --------- | ----------------------------------------------- | ---- | ----------------- |
| 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'
...@@ -70,7 +70,7 @@ startAbility(parameter: StartAbilityParameter): Promise\<void>; ...@@ -70,7 +70,7 @@ startAbility(parameter: StartAbilityParameter): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ----------------------------------------------- | ---- | ----------------- | | --------- | ----------------------------------------------- | ---- | ----------------- |
| parameter | [StartAbilityParameter](js-apis-featureAbility.md#startabilityparameter) | 是 | 指示启动的ability | | parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 指示启动的ability |
**返回值：** **返回值：**
...@@ -80,7 +80,7 @@ startAbility(parameter: StartAbilityParameter): Promise\<void>; ...@@ -80,7 +80,7 @@ startAbility(parameter: StartAbilityParameter): Promise\<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'
...@@ -119,7 +119,7 @@ terminateSelf(callback: AsyncCallback\<void>): void ...@@ -119,7 +119,7 @@ terminateSelf(callback: AsyncCallback\<void>): void
**示例：** **示例：**
```js ```ts
import particleAbility from '@ohos.ability.particleAbility' import particleAbility from '@ohos.ability.particleAbility'
particleAbility.terminateSelf( particleAbility.terminateSelf(
...@@ -145,7 +145,7 @@ terminateSelf(): Promise\<void> ...@@ -145,7 +145,7 @@ terminateSelf(): Promise\<void>
**示例：** **示例：**
```js ```ts
import particleAbility from '@ohos.ability.particleAbility' import particleAbility from '@ohos.ability.particleAbility'
particleAbility.terminateSelf().then((data) => { particleAbility.terminateSelf().then((data) => {
...@@ -177,7 +177,7 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper ...@@ -177,7 +177,7 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper
**示例：** **示例：**
```js ```ts
import particleAbility from '@ohos.ability.particleAbility' import particleAbility from '@ohos.ability.particleAbility'
var uri = ""; var uri = "";
...@@ -205,7 +205,7 @@ startBackgroundRunning(id: number, request: NotificationRequest, callback: Async ...@@ -205,7 +205,7 @@ startBackgroundRunning(id: number, request: NotificationRequest, callback: Async
**示例**： **示例**：
```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';
...@@ -274,7 +274,7 @@ startBackgroundRunning(id: number, request: NotificationRequest): Promise&lt;voi ...@@ -274,7 +274,7 @@ startBackgroundRunning(id: number, request: NotificationRequest): Promise&lt;voi
**示例**： **示例**：
```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';
...@@ -330,7 +330,7 @@ cancelBackgroundRunning(callback: AsyncCallback&lt;void&gt;): void; ...@@ -330,7 +330,7 @@ cancelBackgroundRunning(callback: AsyncCallback&lt;void&gt;): void;
**示例**： **示例**：
```js ```ts
import particleAbility from '@ohos.ability.particleAbility'; import particleAbility from '@ohos.ability.particleAbility';
function callback(err, data) { function callback(err, data) {
...@@ -361,7 +361,7 @@ cancelBackgroundRunning(): Promise&lt;void&gt;; ...@@ -361,7 +361,7 @@ cancelBackgroundRunning(): Promise&lt;void&gt;;
**示例**： **示例**：
```js ```ts
import particleAbility from '@ohos.ability.particleAbility'; import particleAbility from '@ohos.ability.particleAbility';
particleAbility.cancelBackgroundRunning().then(() => { particleAbility.cancelBackgroundRunning().then(() => {
...@@ -384,7 +384,7 @@ connectAbility(request: Want, options:ConnectOptions): number ...@@ -384,7 +384,7 @@ connectAbility(request: Want, options:ConnectOptions): number
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | -------------- | ---- | ---------------------------- | | ------- | -------------- | ---- | ---------------------------- |
| request | [Want](js-apis-application-Want.md) | 是 | 表示被连接的ServiceAbility。 | | request | [Want](js-apis-application-want.md) | 是 | 表示被连接的ServiceAbility。 |
| options | ConnectOptions | 是 | 被指定的回调方法。 | | options | ConnectOptions | 是 | 被指定的回调方法。 |
...@@ -400,7 +400,7 @@ connectAbility(request: Want, options:ConnectOptions): number ...@@ -400,7 +400,7 @@ connectAbility(request: Want, options:ConnectOptions): number
**示例**： **示例**：
```js ```ts
import rpc from '@ohos.rpc' import rpc from '@ohos.rpc'
function onConnectCallback(element, remote) { function onConnectCallback(element, remote) {
...@@ -451,7 +451,7 @@ disconnectAbility(connection: number, callback:AsyncCallback\<void>): void; ...@@ -451,7 +451,7 @@ disconnectAbility(connection: number, callback:AsyncCallback\<void>): void;
**示例**： **示例**：
```js ```ts
import rpc from '@ohos.rpc' import rpc from '@ohos.rpc'
function onConnectCallback(element, remote) { function onConnectCallback(element, remote) {
...@@ -501,7 +501,7 @@ disconnectAbility(connection: number): Promise\<void>; ...@@ -501,7 +501,7 @@ disconnectAbility(connection: number): Promise\<void>;
**示例**： **示例**：
```js ```ts
import rpc from '@ohos.rpc' import rpc from '@ohos.rpc'
function onConnectCallback(element, remote) { function onConnectCallback(element, remote) {
......
zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
# 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
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
# 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
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
...@@ -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-appRecovery.md
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
# 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
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
# 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
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
# 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
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
...@@ -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-window.md#windowMode7) | 是 | 否 | number | 否 | 窗口模式。 |
| displayId | 是 | 否 | number | 否 | 显示ID。 | | displayId | 是 | 否 | number | 否 | 显示ID。 |
zh-cn/application-dev/reference/apis/js-apis-app-ability-want.md 0 → 100644
浏览文件 @ fead2d6d
# 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
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
...@@ -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/errcode-form.md)。 以下错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-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/errcode-form.md)。 以下错误码的详细介绍请参见[卡片错误码](../errorcodes/errcode-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
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
...@@ -8,7 +8,7 @@ AbilityDelegatorRegistry模块提供用于存储已注册的AbilityDelegator和A ...@@ -8,7 +8,7 @@ AbilityDelegatorRegistry模块提供用于存储已注册的AbilityDelegator和A
## 导入模块 ## 导入模块
```js ```ts
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'
``` ```
...@@ -38,18 +38,16 @@ getAbilityDelegator(): AbilityDelegator ...@@ -38,18 +38,16 @@ getAbilityDelegator(): AbilityDelegator
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------------------------ | ------------------------------------------------------------ | | ------------------------------------------------------------ | ------------------------------------------------------------ |
| [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
...@@ -62,11 +60,11 @@ getArguments(): AbilityDelegatorArgs ...@@ -62,11 +60,11 @@ getArguments(): AbilityDelegatorArgs
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------------------------ | ------------------------------------------------------------ | | ------------------------------------------------------------ | ------------------------------------------------------------ |
| [AbilityDelegatorArgs](js-apis-application-abilityDelegatorArgs.md#AbilityDelegatorArgs) | [AbilityDelegatorArgs](js-apis-application-abilityDelegatorArgs.md#AbilityDelegatorArgs)对象。可以用来获取测试参数。 | | [AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md#AbilityDelegatorArgs) | [AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md#AbilityDelegatorArgs)对象。可以用来获取测试参数。 |
**示例：** **示例：**
```js ```ts
var args = AbilityDelegatorRegistry.getArguments(); var args = AbilityDelegatorRegistry.getArguments();
console.info("getArguments bundleName:" + args.bundleName); console.info("getArguments bundleName:" + args.bundleName);
console.info("getArguments testCaseNames:" + args.testCaseNames); console.info("getArguments testCaseNames:" + args.testCaseNames);
......
zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md
浏览文件 @ fead2d6d
...@@ -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
浏览文件 @ fead2d6d
...@@ -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-configuration.md
浏览文件 @ fead2d6d
...@@ -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 | 是 | 否 | 指示指针类型设备是否已连接，如键鼠、触控板等。 |
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或