diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-context.md b/zh-cn/application-dev/reference/apis/js-apis-ability-context.md index 5b6b53e8e33673af9da8d5f73924aac882bb9be2..75cf5b6e66ade013504dabb737581f82769c90b3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-context.md @@ -28,10 +28,10 @@ class MainAbility extends Ability { **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| abilityInfo | AbilityInfo | 是 | 否 | Abilityinfo相关信息 | -| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前hap包的信息 | +| abilityInfo | AbilityInfo | 是 | 否 | Abilityinfo相关信息 | +| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前hap包的信息 | ## AbilityContext.startAbility @@ -44,10 +44,10 @@ startAbility(want: Want, callback: AsyncCallback<void>): void **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | - | callback | AsyncCallback<void> | 是 | callback形式返回启动结果 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| callback | AsyncCallback<void> | 是 | callback形式返回启动结果 | **示例：** @@ -73,11 +73,11 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void& **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | - | options | StartOptions | 是 | 启动Ability所携带的参数。 | - | callback | AsyncCallback<void> | 是 | callback形式返回启动结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| options | StartOptions | 是 | 启动Ability所携带的参数。 | +| callback | AsyncCallback<void> | 是 | callback形式返回启动结果。 | **示例：** @@ -106,16 +106,16 @@ startAbility(want: Want, options?: StartOptions): Promise<void>; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | - | options | StartOptions | 否 | 启动Ability所携带的参数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| options | StartOptions | 否 | 启动Ability所携带的参数。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | Promise形式返回启动结果。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | Promise形式返回启动结果。 | **示例：** @@ -147,10 +147,10 @@ startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>): **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want |[Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | - | callback | AsyncCallback<[AbilityResult](js-apis-featureAbility.md#abilityresult)> | 是 | 执行结果回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want |[Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| callback | AsyncCallback<[AbilityResult](js-apis-featureAbility.md#abilityresult)> | 是 | 执行结果回调函数。 | **示例：** @@ -175,11 +175,11 @@ startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want |[Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | - | options | StartOptions | 是 | 启动Ability所携带的参数。 | - | callback | AsyncCallback<[AbilityResult](js-apis-featureAbility.md#abilityresult)> | 是 | 执行结果回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want |[Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| options | StartOptions | 是 | 启动Ability所携带的参数。 | +| callback | AsyncCallback<[AbilityResult](js-apis-featureAbility.md#abilityresult)> | 是 | 执行结果回调函数。 | **示例：** @@ -208,17 +208,17 @@ startAbilityForResult(want: Want, options?: StartOptions): Promise<AbilityRes **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | - | options | StartOptions | 否 | 启动Ability所携带的参数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| options | StartOptions | 否 | 启动Ability所携带的参数。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<[AbilityResult](js-apis-featureAbility.md#abilityresult)> | Promise形式返回执行结果。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<[AbilityResult](js-apis-featureAbility.md#abilityresult)> | Promise形式返回执行结果。 | **示例：** @@ -244,9 +244,9 @@ terminateSelf(callback: AsyncCallback<void>): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | 回调函数，返回接口调用是否成功的结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback<void> | 是 | 回调函数，返回接口调用是否成功的结果。 | **示例：** @@ -267,9 +267,9 @@ terminateSelf(): Promise<void>; **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | 返回一个Promise，包含接口的结果。 | **示例：** @@ -292,10 +292,10 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback<voi **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | parameter | [AbilityResult](js-apis-featureAbility.md#abilityresult) | 是 | 返回给调用startAbilityForResult 接口调用方的相关信息。 | - | callback | AsyncCallback<void> | 是 | callback形式返回停止结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| parameter | [AbilityResult](js-apis-featureAbility.md#abilityresult) | 是 | 返回给调用startAbilityForResult 接口调用方的相关信息。 | +| callback | AsyncCallback<void> | 是 | callback形式返回停止结果。 | **示例：** @@ -321,15 +321,15 @@ terminateSelfWithResult(parameter: AbilityResult): Promise<void>; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | parameter | [AbilityResult](js-apis-featureAbility.md#abilityresult) | 是 | 返回给startAbilityForResult 调用方的信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| parameter | [AbilityResult](js-apis-featureAbility.md#abilityresult) | 是 | 返回给startAbilityForResult 调用方的信息。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | promise形式返回停止结果。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | promise形式返回停止结果。 | **示例：** @@ -355,15 +355,15 @@ startAbilityByCall(want: Want): Promise<Caller>; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-Want.md) | 是 | 传入需要启动的ability的信息，包含ability名称、包名、设备ID，设备ID缺省或为空表示启动本地ability。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-Want.md) | 是 | 传入需要启动的ability的信息，包含ability名称、包名、设备ID，设备ID缺省或为空表示启动本地ability。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<Caller> | 获取要通讯的caller对象。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<Caller> | 获取要通讯的caller对象。 | **示例：** @@ -397,10 +397,10 @@ requestPermissionsFromUser(permissions: Array<string>, requestCallback: As **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | permissions | Array<string> | 是 | 权限列表。 | - | callback | AsyncCallback<[PermissionRequestResult](js-apis-permissionrequestresult.md)> | 是 | 回调函数，返回接口调用是否成功的结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| permissions | Array<string> | 是 | 权限列表。 | +| callback | AsyncCallback<[PermissionRequestResult](js-apis-permissionrequestresult.md)> | 是 | 回调函数，返回接口调用是否成功的结果。 | **示例：** @@ -423,15 +423,15 @@ requestPermissionsFromUser(permissions: Array<string>) : Promise<Permis **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | permissions | Array<string> | 是 | 权限列表。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| permissions | Array<string> | 是 | 权限列表。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<[PermissionRequestResult](js-apis-permissionrequestresult.md)> | 返回一个Promise，包含接口的结果。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<[PermissionRequestResult](js-apis-permissionrequestresult.md)> | 返回一个Promise，包含接口的结果。 | **示例：** @@ -456,10 +456,10 @@ setMissionLabel(label: string, callback:AsyncCallback<void>): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | label | string | 是 | 显示名称。 | - | callback | AsyncCallback<void> | 是 | 回调函数，返回接口调用是否成功的结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| label | string | 是 | 显示名称。 | +| callback | AsyncCallback<void> | 是 | 回调函数，返回接口调用是否成功的结果。 | **示例：** @@ -480,15 +480,15 @@ setMissionLabel(label: string): Promise<void> **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | label | string | 是 | 显示名称。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| label | string | 是 | 显示名称。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | 返回一个Promise，包含接口的结果。 | **示例：** @@ -500,3 +500,23 @@ setMissionLabel(label: string): Promise<void> }); ``` +## AbilityContext.isTerminating + +isTerminating(): boolean; + +查询ability是否在terminating状态。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| bool | true：ability当前处于terminating状态；false：不处于terminating状态。 | + +**示例：** + + ```js + var isTerminating = this.context.isTerminating(); + console.log('ability state :' + isTerminating); + ``` \ No newline at end of file