diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md index 6c4e6f0eefcbf84059e455902e9165ec330c4344..b66b1726be0906ff4964755eaa50a50b145b633a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md @@ -1,8 +1,6 @@ # @ohos.app.ability.AbilityConstant (AbilityConstant) -AbilityConstant是启动参数的接口。 - -AbilityConstant提供启动参数的接口的能力，包括设置初次开始原因的类型、上次退出原因的类型、继续结果的类型。 +AbilityConstant提供Ability相关的枚举，包括设置初次启动原因、上次退出原因、迁移结果、窗口类型等。 > **说明：** > @@ -19,14 +17,14 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant'; **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| launchReason | LaunchReason| 是 | 是 | 指示启动原因。 | -| lastExitReason | LastExitReason | 是 | 是 | 表示最后退出原因。 | +| launchReason | LaunchReason| 是 | 是 | 指示启动原因。 | +| lastExitReason | LastExitReason | 是 | 是 | 表示最后退出原因。 | ## AbilityConstant.LaunchReason -初次开始原因的类型。 +初次启动原因。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -41,7 +39,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant'; ## AbilityConstant.LastExitReason -上次退出原因的类型。 +上次退出原因。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -54,7 +52,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant'; ## AbilityConstant.OnContinueResult -继续结果的类型。 +迁移结果。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -80,7 +78,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant'; ## AbilityConstant.MemoryLevel -内存级别的类型。 +内存级别。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -92,7 +90,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant'; ## AbilityConstant.OnSaveResult -保存应用数据的结果类型。 +保存应用数据的结果。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -107,7 +105,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant'; ## AbilityConstant.StateType -保存应用数据场景原因类型。 +保存应用数据场景原因。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md index f148dca1d6c61519ce2b3224f4a72e9a252b63be..7b39d012c9ff117b63d14f3f8f4ebbbe411a0172 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md @@ -15,21 +15,21 @@ 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二级模块。 | +| 名称 | 类型 | 说明 | +| ----------- | -------------------- | ------------------------------------------------------------ | +| 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 diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-contextConstant.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-contextConstant.md index bd26f19fd954c7efd40dac5a30afb2f86e6ff831..7e1d461c0f594cbe7fa2719e72ba855eb49a0a9c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-contextConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-contextConstant.md @@ -1,6 +1,6 @@ # @ohos.app.ability.contextConstant (ContextConstant) -ContextConstant模块提供数据加密等级定义的能力。 +ContextConstant提供Context相关的枚举，当前仅包含数据加密等级的枚举。 > **说明：** > @@ -19,7 +19,7 @@ import contextConstant from '@ohos.app.ability.contextConstant'; **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 值 | 说明 | +| 名称 | 值 | 说明 | | -------- | -------- | -------- | -| EL1 | 0 | 设备级加密区。 | -| EL2 | 1 | 用户凭据加密区。 | +| EL1 | 0 | 设备级加密区，设备开机后可访问的数据区。 | +| EL2 | 1 | 用户级加密区，设备开机，首次输入密码后才能够访问的数据区。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-extensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-extensionAbility.md index ce4b0804fdd44bb423c57d4bf5db47095a7a8230..00f29740f754294aba76d816eb465a01c873f8a5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-extensionAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-extensionAbility.md @@ -1,6 +1,6 @@ # @ohos.app.ability.ExtensionAbility (扩展能力基类) -ExtensionAbility模块提供对ExtensionAbility生命周期、上下文环境等调用管理的能力，包括ExtensionAbility创建、销毁、转储客户端信息等。 +ExtensionAbility是特定场景扩展能力的基类，提供系统配置更新回调和系统内存调整回调。。 > **说明：** > @@ -16,7 +16,7 @@ import ExtensionAbility from '@ohos.app.ability.ExtensionAbility'; **系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore **示例：** - + ```ts class MyExtensionAbility extends ExtensionAbility { onConfigurationUpdated(config) { @@ -28,3 +28,4 @@ import ExtensionAbility from '@ohos.app.ability.ExtensionAbility'; } } ``` + diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-serviceExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-serviceExtensionAbility.md index ab0c36b020e631c89cd71d26d7e8f38f4cbd5d1c..a231e6b8956f5630ce592ea4c1abedef58f09591 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-serviceExtensionAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-serviceExtensionAbility.md @@ -1,6 +1,6 @@ # @ohos.app.ability.ServiceExtensionAbility (ServiceExtensionAbility) -ServiceExtensionAbility模块提供ServiceExtension服务扩展相关接口的能力。 +ServiceExtensionAbility模块提供后台服务相关扩展能力，提供后台服务创建、销毁、连接、断开等生命周期回调。 > **说明：** > @@ -23,9 +23,9 @@ import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility'; **系统API**: 此接口为系统接口，三方应用不支持调用。 -| 名称 | 类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| context | [ServiceExtensionContext](js-apis-inner-application-serviceExtensionContext.md) | 是 | 否 | ServiceExtension的上下文环境，继承自ExtensionContext。 | +| context | [ServiceExtensionContext](js-apis-inner-application-serviceExtensionContext.md) | 是 | 否 | ServiceExtension的上下文环境，继承自ExtensionContext。 | ## ServiceExtensionAbility.onCreate @@ -40,9 +40,9 @@ Extension生命周期回调，在创建时回调，执行初始化业务逻辑 **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-app-ability-want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-app-ability-want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | **示例：** @@ -88,10 +88,10 @@ Extension生命周期回调，如果是startAbility拉起的服务，会在onCre **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-app-ability-want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | - | startId | number | 是 | 返回拉起次数。首次拉起初始值返回1，多次之后自动递增。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-app-ability-want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | +| startId | number | 是 | 返回拉起次数。首次拉起初始值返回1，多次之后自动递增。 | **示例：** @@ -116,15 +116,15 @@ Extension生命周期回调，如果是connectAbility拉起的服务，会在onC **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-app-ability-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-app-ability-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | rpc.RemoteObject | 一个RemoteObject对象，用于和客户端进行通信。 | +| 类型 | 说明 | +| -------- | -------- | +| rpc.RemoteObject | 一个RemoteObject对象，用于和客户端进行通信。 | **示例：** @@ -158,9 +158,9 @@ Extension的生命周期，断开服务连接时回调。 **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want |[Want](js-apis-app-ability-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want |[Want](js-apis-app-ability-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | **示例：** @@ -184,9 +184,9 @@ onReconnect(want: Want): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want |[Want](js-apis-app-ability-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want |[Want](js-apis-app-ability-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | **示例：** @@ -210,9 +210,9 @@ onConfigurationUpdate(newConfig: Configuration): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | newConfig | [Configuration](js-apis-app-ability-configuration.md) | 是 | 表示需要更新的配置信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| newConfig | [Configuration](js-apis-app-ability-configuration.md) | 是 | 表示需要更新的配置信息。 | **示例：** @@ -236,9 +236,9 @@ onDump(params: Array\): Array\; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | params | Array\ | 是 | 表示命令形式的参数。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| params | Array\ | 是 | 表示命令形式的参数。| **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md index c27facb973d1b854c26e8921bc0f4ec549529d43..5ada363bc19af33cac1243e2fd127916703e75f0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md @@ -1,6 +1,6 @@ # @ohos.app.ability.StartOptions (StartOptions) -StartOptions模块对系统的基本通信组件进行查询和设置的能力。 +StartOptions可以作为[startAbility](js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability-1)的入参，用于指定目标Ability的窗口模式。 > **说明：** > diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md index c64f9cab59628e60741da089dd4a737a335e6c86..bc9c8806d8b71b5fc04b42978c563d28c53f7678 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md @@ -1,11 +1,9 @@ # @ohos.app.ability.UIAbility (UIAbility) -Ability模块提供对Ability生命周期、上下文环境等调用管理的能力，包括Ability创建、销毁、转储客户端信息等。 +UIAbility是包含UI界面的应用组件，提供组件创建、销毁、前后台切换等生命周期回调，同时也具备组件协同的能力，组件协同主要提供如下常用功能： -该模块提供以下Ability相关的常用功能： - -- [Caller](#caller)：通用组件Caller通信客户端调用接口, 用来向通用组件服务端发送约定数据。 -- [Callee](#callee)：通用组件服务端注册和解除客户端caller通知送信的callback接口。 +- [Caller](#caller)：由[startAbilityByCall](js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartabilitybycall)接口返回，CallerAbility(调用者)可使用Caller与CalleeAbility(被调用者)进行通信。 +- [Callee](#callee)：UIAbility的内部对象，CalleeAbility(被调用者)可以通过Callee与Caller进行通信。 > **说明：** > @@ -20,34 +18,34 @@ import UIAbility from '@ohos.app.ability.UIAbility'; ## 属性 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：以下各项对应的系统能力均为SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore -| 名称 | 类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| context | [UIAbilityContext](js-apis-inner-application-uiAbilityContext.md) | 是 | 否 | 上下文。 | -| launchWant | [Want](js-apis-app-ability-want.md) | 是 | 否 | Ability启动时的参数。 | -| lastRequestWant | [Want](js-apis-app-ability-want.md) | 是 | 否 | Ability最后请求时的参数。| -| callee | [Callee](#callee) | 是 | 否 | 调用Stub（桩）服务对象。| +| context | [UIAbilityContext](js-apis-inner-application-uiAbilityContext.md) | 是 | 否 | 上下文。 | +| launchWant | [Want](js-apis-app-ability-want.md) | 是 | 否 | UIAbility启动时的参数。 | +| lastRequestWant | [Want](js-apis-app-ability-want.md) | 是 | 否 | UIAbility最后请求时的参数。| +| callee | [Callee](#callee) | 是 | 否 | 调用Stub（桩）服务对象。| -## Ability.onCreate +## UIAbility.onCreate -onCreate(want: Want, param: AbilityConstant.LaunchParam): void; +onCreate(want: Want, param: UIAbilityConstant.LaunchParam): void; -Ability创建时回调，执行初始化业务逻辑操作。 +UIAbility创建时回调，执行初始化业务逻辑操作。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-app-ability-want.md) | 是 | 当前Ability的Want类型信息，包括ability名称、bundle名称等。 | - | param | AbilityConstant.LaunchParam | 是 | 创建 ability、上次异常退出的原因信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-app-ability-want.md) | 是 | 当前UIAbility的Want类型信息，包括ability名称、bundle名称等。 | +| param | UIAbilityConstant.LaunchParam | 是 | 创建 ability、上次异常退出的原因信息。 | **示例：** ```ts - class MyAbility extends UIAbility { + class MyUIAbility extends UIAbility { onCreate(want, param) { console.log('onCreate, want:' + want.abilityName); } @@ -55,24 +53,24 @@ Ability创建时回调，执行初始化业务逻辑操作。 ``` -## Ability.onWindowStageCreate +## UIAbility.onWindowStageCreate onWindowStageCreate(windowStage: window.WindowStage): void 当WindowStage创建后调用。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | windowStage | window.WindowStage | 是 | WindowStage相关信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| windowStage | window.WindowStage | 是 | WindowStage相关信息。 | **示例：** ```ts - class MyAbility extends UIAbility { + class MyUIAbility extends UIAbility { onWindowStageCreate(windowStage) { console.log('onWindowStageCreate'); } @@ -80,18 +78,18 @@ onWindowStageCreate(windowStage: window.WindowStage): void ``` -## Ability.onWindowStageDestroy +## UIAbility.onWindowStageDestroy onWindowStageDestroy(): void 当WindowStage销毁后调用。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **示例：** ```ts - class MyAbility extends UIAbility { + class MyUIAbility extends UIAbility { onWindowStageDestroy() { console.log('onWindowStageDestroy'); } @@ -99,24 +97,24 @@ onWindowStageDestroy(): void ``` -## Ability.onWindowStageRestore +## UIAbility.onWindowStageRestore onWindowStageRestore(windowStage: window.WindowStage): void 当迁移多实例ability时，恢复WindowStage后调用。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | windowStage | window.WindowStage | 是 | WindowStage相关信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| windowStage | window.WindowStage | 是 | WindowStage相关信息。 | **示例：** ```ts - class MyAbility extends UIAbility { + class MyUIAbility extends UIAbility { onWindowStageRestore(windowStage) { console.log('onWindowStageRestore'); } @@ -124,18 +122,18 @@ onWindowStageRestore(windowStage: window.WindowStage): void ``` -## Ability.onDestroy +## UIAbility.onDestroy onDestroy(): void; -Ability生命周期回调，在销毁时回调，执行资源清理等操作。 +UIAbility生命周期回调，在销毁时回调，执行资源清理等操作。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **示例：** ```ts - class MyAbility extends UIAbility { + class MyUIAbility extends UIAbility { onDestroy() { console.log('onDestroy'); } @@ -143,18 +141,18 @@ Ability生命周期回调，在销毁时回调，执行资源清理等操作。 ``` -## Ability.onForeground +## UIAbility.onForeground onForeground(): void; -Ability生命周期回调，当应用从后台转到前台时触发。 +UIAbility生命周期回调，当应用从后台转到前台时触发。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **示例：** ```ts - class MyAbility extends UIAbility { + class MyUIAbility extends UIAbility { onForeground() { console.log('onForeground'); } @@ -162,18 +160,18 @@ Ability生命周期回调，当应用从后台转到前台时触发。 ``` -## Ability.onBackground +## UIAbility.onBackground onBackground(): void; -Ability生命周期回调，当应用从前台转到后台时触发。 +UIAbility生命周期回调，当应用从前台转到后台时触发。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **示例：** ```ts - class MyAbility extends UIAbility { + class MyUIAbility extends UIAbility { onBackground() { console.log('onBackground'); } @@ -181,83 +179,83 @@ Ability生命周期回调，当应用从前台转到后台时触发。 ``` -## Ability.onContinue +## UIAbility.onContinue -onContinue(wantParam : {[key: string]: any}): AbilityConstant.OnContinueResult; +onContinue(wantParam : {[key: string]: any}): UIAbilityConstant.OnContinueResult; 当ability迁移准备迁移时触发，保存数据。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | wantParam | {[key: string]: any} | 是 | want相关参数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| wantParam | {[key: string]: any} | 是 | want相关参数。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | AbilityConstant.OnContinueResult | 继续的结果。 | +| 类型 | 说明 | +| -------- | -------- | +| UIAbilityConstant.OnContinueResult | 继续的结果。 | **示例：** ```ts - import AbilityConstant from "@ohos.app.ability.AbilityConstant" - class MyAbility extends UIAbility { + import UIAbilityConstant from "@ohos.app.ability.UIAbilityConstant" + class MyUIAbility extends UIAbility { onContinue(wantParams) { console.log('onContinue'); wantParams["myData"] = "my1234567"; - return AbilityConstant.OnContinueResult.AGREE; + return UIAbilityConstant.OnContinueResult.AGREE; } } ``` -## Ability.onNewWant +## UIAbility.onNewWant -onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void; +onNewWant(want: Want, launchParams: UIAbilityConstant.LaunchParam): void; 当ability的启动模式设置为单例时回调会被调用。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-app-ability-want.md) | 是 | Want类型参数，如ability名称，包名等。 | - | launchParams | AbilityConstant.LaunchParam | 是 | Ability启动的原因、上次异常退出的原因信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-app-ability-want.md) | 是 | Want类型参数，如ability名称，包名等。 | +| launchParams | UIAbilityConstant.LaunchParam | 是 | UIAbility启动的原因、上次异常退出的原因信息。 | **示例：** ```ts - class MyAbility extends UIAbility { + class MyUIAbility extends UIAbility { onNewWant(want) { console.log('onNewWant, want:' + want.abilityName); } } ``` -## Ability.onDump +## UIAbility.onDump onDump(params: Array\): Array\; 转储客户端信息时调用。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | params | Array\ | 是 | 表示命令形式的参数。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| params | Array\ | 是 | 表示命令形式的参数。| **示例：** ```ts - class MyAbility extends UIAbility { + class MyUIAbility extends UIAbility { onDump(params) { console.log('dump, params:' + JSON.stringify(params)); return ["params"] @@ -266,37 +264,37 @@ onDump(params: Array\): Array\; ``` -## Ability.onSaveState +## UIAbility.onSaveState -onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: any}): AbilityConstant.OnSaveResult; +onSaveState(reason: UIAbilityConstant.StateType, wantParam : {[key: string]: any}): UIAbilityConstant.OnSaveResult; -该API配合[appRecovery](js-apis-app-ability-appRecovery.md)使用。在应用故障时，如果使能了自动保存状态，框架将回调onSaveState保存Ability状态。 +该API配合[appRecovery](js-apis-app-ability-appRecovery.md)使用。在应用故障时，如果使能了自动保存状态，框架将回调onSaveState保存UIAbility状态。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | reason | [AbilityConstant.StateType](js-apis-app-ability-abilityConstant.md#abilityconstantstatetype) | 是 | 回调保存状态的原因。 | - | wantParam | {[key: string]: any} | 是 | want相关参数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| reason | [UIAbilityConstant.StateType](js-apis-app-ability-abilityConstant.md#abilityconstantstatetype) | 是 | 回调保存状态的原因。 | +| wantParam | {[key: string]: any} | 是 | want相关参数。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | AbilityConstant.OnSaveResult | 是否同意保存当前Ability的状态。 | +| 类型 | 说明 | +| -------- | -------- | +| UIAbilityConstant.OnSaveResult | 是否同意保存当前UIAbility的状态。 | **示例：** ```ts -import AbilityConstant from '@ohos.app.ability.AbilityConstant' +import UIAbilityConstant from '@ohos.app.ability.UIAbilityConstant' -class MyAbility extends UIAbility { +class MyUIAbility extends UIAbility { onSaveState(reason, wantParam) { console.log('onSaveState'); wantParam["myData"] = "my1234567"; - return AbilityConstant.OnSaveResult.RECOVERY_AGREE; + return UIAbilityConstant.OnSaveResult.RECOVERY_AGREE; } } ``` @@ -313,20 +311,20 @@ call(method: string, data: rpc.Sequenceable): Promise<void>; 向通用组件服务端发送约定序列化数据。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | method | string | 是 | 约定的服务端注册事件字符串。 | - | data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| method | string | 是 | 约定的服务端注册事件字符串。 | +| data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | Promise形式返回应答。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | Promise形式返回应答。 | **错误码：** @@ -361,11 +359,11 @@ call(method: string, data: rpc.Sequenceable): Promise<void>; }; var method = 'call_Function'; // 约定的通知消息字符串 var caller; - export default class MainAbility extends UIAbility { + export default class MainUIAbility extends UIAbility { onWindowStageCreate(windowStage) { - this.context.startAbilityByCall({ + this.context.startUIAbilityByCall({ bundleName: "com.example.myservice", - abilityName: "MainAbility", + abilityName: "MainUIAbility", deviceId: "" }).then((obj) => { caller = obj; @@ -393,20 +391,20 @@ callWithResult(method: string, data: rpc.Sequenceable): Promise<rpc.MessagePa 向通用组件服务端发送约定序列化数据, 并将服务端返回的约定序列化数据带回。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | method | string | 是 | 约定的服务端注册事件字符串。 | - | data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| method | string | 是 | 约定的服务端注册事件字符串。 | +| data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<rpc.MessageParcel> | Promise形式返回通用组件服务端应答数据。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<rpc.MessageParcel> | Promise形式返回通用组件服务端应答数据。 | **错误码：** @@ -441,11 +439,11 @@ callWithResult(method: string, data: rpc.Sequenceable): Promise<rpc.MessagePa }; var method = 'call_Function'; var caller; - export default class MainAbility extends UIAbility { + export default class MainUIAbility extends UIAbility { onWindowStageCreate(windowStage) { - this.context.startAbilityByCall({ + this.context.startUIAbilityByCall({ bundleName: "com.example.myservice", - abilityName: "MainAbility", + abilityName: "MainUIAbility", deviceId: "" }).then((obj) => { caller = obj; @@ -475,7 +473,7 @@ release(): void; 主动释放通用组件服务端的通信接口。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **错误码：** @@ -490,11 +488,11 @@ release(): void; ```ts var caller; - export default class MainAbility extends UIAbility { + export default class MainUIAbility extends UIAbility { onWindowStageCreate(windowStage) { - this.context.startAbilityByCall({ + this.context.startUIAbilityByCall({ bundleName: "com.example.myservice", - abilityName: "MainAbility", + abilityName: "MainUIAbility", deviceId: "" }).then((obj) => { caller = obj; @@ -518,23 +516,23 @@ release(): void; 注册通用组件服务端Stub（桩）断开监听通知。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | OnReleaseCallBack | 是 | 返回onRelease回调结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | OnReleaseCallBack | 是 | 返回onRelease回调结果。 | **示例：** ```ts var caller; - export default class MainAbility extends UIAbility { + export default class MainUIAbility extends UIAbility { onWindowStageCreate(windowStage) { - this.context.startAbilityByCall({ + this.context.startUIAbilityByCall({ bundleName: "com.example.myservice", - abilityName: "MainAbility", + abilityName: "MainUIAbility", deviceId: "" }).then((obj) => { caller = obj; @@ -560,14 +558,14 @@ release(): void; 注册通用组件服务端Stub（桩）断开监听通知。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 监听releaseCall事件，固定为'release'。 | - | callback | OnReleaseCallback | 是 | 返回onRelease回调结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| type | string | 是 | 监听releaseCall事件，固定为'release'。 | +| callback | OnReleaseCallback | 是 | 返回onRelease回调结果。 | **错误码：** @@ -580,11 +578,11 @@ release(): void; ```ts var caller; - export default class MainAbility extends UIAbility { + export default class MainUIAbility extends UIAbility { onWindowStageCreate(windowStage) { - this.context.startAbilityByCall({ + this.context.startUIAbilityByCall({ bundleName: "com.example.myservice", - abilityName: "MainAbility", + abilityName: "MainUIAbility", deviceId: "" }).then((obj) => { caller = obj; @@ -615,14 +613,14 @@ on(method: string, callback: CalleeCallback): void; 通用组件服务端注册消息通知callback。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | method | string | 是 | 与客户端约定的通知消息字符串。 | - | callback | CalleeCallback | 是 | 一个rpc.MessageParcel类型入参的js通知同步回调函数, 回调函数至少要返回一个空的rpc.Sequenceable数据对象, 其他视为函数执行错误。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| method | string | 是 | 与客户端约定的通知消息字符串。 | +| callback | CalleeCallback | 是 | 一个rpc.MessageParcel类型入参的js通知同步回调函数, 回调函数至少要返回一个空的rpc.Sequenceable数据对象, 其他视为函数执行错误。 | **错误码：** @@ -662,7 +660,7 @@ on(method: string, callback: CalleeCallback): void; pdata.readSequenceable(msg); return new MyMessageAble("test1", "Callee test"); } - export default class MainAbility extends UIAbility { + export default class MainUIAbility extends UIAbility { onCreate(want, launchParam) { console.log('Callee onCreate is called'); try { @@ -681,13 +679,13 @@ off(method: string): void; 解除通用组件服务端注册消息通知callback。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | method | string | 是 | 已注册的通知事件字符串。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| method | string | 是 | 已注册的通知事件字符串。 | **错误码：** @@ -701,7 +699,7 @@ off(method: string): void; ```ts var method = 'call_Function'; - export default class MainAbility extends UIAbility { + export default class MainUIAbility extends UIAbility { onCreate(want, launchParam) { console.log('Callee onCreate is called'); try { @@ -718,18 +716,18 @@ off(method: string): void; (msg: string): void; -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore -| 名称 | 可读 | 可写 | 类型 | 说明 | +| 名称 | 可读 | 可写 | 类型 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| (msg: string) | 是 | 否 | function | 调用者注册的侦听器函数接口的原型。 | +| (msg: string) | 是 | 否 | function | 调用者注册的侦听器函数接口的原型。 | ## CalleeCallback (indata: rpc.MessageParcel): rpc.Sequenceable; -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore -| 名称 | 可读 | 可写 | 类型 | 说明 | +| 名称 | 可读 | 可写 | 类型 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| (indata: rpc.MessageParcel) | 是 | 否 | rpc.Sequenceable | 被调用方注册的消息侦听器函数接口的原型。 | +| (indata: rpc.MessageParcel) | 是 | 否 | rpc.Sequenceable | 被调用方注册的消息侦听器函数接口的原型。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md index 6520391748d7593bba343086ca2438fc253dbf71..6acbe99c6ea59a3ffe9e23622721af1230d5ff06 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md @@ -1,6 +1,6 @@ # @ohos.app.form.FormExtensionAbility (FormExtensionAbility) -FormExtensionAbility模块提供了卡片扩展相关接口。 +FormExtensionAbility为卡片扩展模块，提供卡片创建、销毁、刷新等生命周期回调。 > **说明：** > @@ -17,9 +17,9 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; **系统能力**：SystemCapability.Ability.Form -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------- | ------------------------------------------------------- | ---- | ---- | --------------------------------------------------- | -| context | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | 是 | 否 | FormExtensionAbility的上下文环境，继承自ExtensionContext。 | +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------- | ------------------------------------------------------------ | ---- | ---- | ------------------------------------------------------------ | +| context | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | 是 | 否 | FormExtensionAbility的上下文环境，继承自[ExtensionContext](js-apis-inner-application-extensionContext.md)。 | ## onAddForm diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md index a3f91ff855b697a06b6dbe60fc6b19069fe23918..0c60a8d9511f4eafb61352bdbd574498ef73510f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md @@ -1,8 +1,6 @@ # @ohos.application.AbilityConstant (AbilityConstant) -AbilityConstant是启动参数的接口。 - -AbilityConstant提供启动参数的接口的能力，包括设置初次开始原因的类型、上次退出原因的类型、继续结果的类型。 +AbilityConstant提供Ability相关的枚举，包括设置初次启动原因、上次退出原因、迁移结果、窗口类型等。 > **说明：** > @@ -19,14 +17,14 @@ import AbilityConstant from '@ohos.application.AbilityConstant'; **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| launchReason | LaunchReason| 是 | 是 | 指示启动原因。 | -| lastExitReason | LastExitReason | 是 | 是 | 表示最后退出原因。 | +| launchReason | LaunchReason| 是 | 是 | 指示启动原因。 | +| lastExitReason | LastExitReason | 是 | 是 | 表示最后退出原因。 | ## AbilityConstant.LaunchReason -初次开始原因的类型。 +初次启动原因。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -41,7 +39,7 @@ import AbilityConstant from '@ohos.application.AbilityConstant'; ## AbilityConstant.LastExitReason -上次退出原因的类型。 +上次退出原因。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -54,7 +52,7 @@ import AbilityConstant from '@ohos.application.AbilityConstant'; ## AbilityConstant.OnContinueResult -继续结果的类型。 +迁移结果。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -92,7 +90,7 @@ import AbilityConstant from '@ohos.application.AbilityConstant'; ## AbilityConstant.OnSaveResult -保存应用数据的结果类型。 +保存应用数据的结果。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -107,7 +105,7 @@ import AbilityConstant from '@ohos.application.AbilityConstant'; ## AbilityConstant.StateType -保存应用数据场景原因类型。 +保存应用数据场景原因。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md index 754a819aff1bae7cc4642cdd2703cb309999f964..bc65594148e918b9719d49ebb8cca0736b3212af 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md @@ -1,6 +1,6 @@ # @ohos.application.AbilityLifecycleCallback (AbilityLifecycleCallback) -AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命周期监听方法的回调类的能力，包括onAbilityCreate、onWindowStageCreate、onWindowStageDestroy等方法。 +AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命周期监听方法的回调类的能力，包括onAbilityCreate、onWindowStageCreate、onWindowStageDestroy等方法，可以作为[registerAbilityLifecycleCallback](js-apis-inner-application-applicationContext.md#applicationcontextregisterabilitylifecyclecallback)的入参。 > **说明：** > @@ -25,9 +25,9 @@ onAbilityCreate(ability: Ability): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | ## AbilityLifecycleCallback.onWindowStageCreate @@ -40,10 +40,10 @@ onWindowStageCreate(ability: Ability, windowStage: window.WindowStage): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | - | windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | +| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 | ## AbilityLifecycleCallback.onWindowStageActive @@ -56,10 +56,10 @@ onWindowStageActive(ability: Ability, windowStage: window.WindowStage): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | - | windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | +| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 | ## AbilityLifecycleCallback.onWindowStageInactive @@ -72,10 +72,10 @@ onWindowStageInactive(ability: Ability, windowStage: window.WindowStage): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | - | windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | +| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 | ## AbilityLifecycleCallback.onWindowStageDestroy @@ -88,10 +88,10 @@ onWindowStageDestroy(ability: Ability, windowStage: window.WindowStage): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | - | windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | +| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 | ## AbilityLifecycleCallback.onAbilityDestroy @@ -104,9 +104,9 @@ onAbilityDestroy(ability: Ability): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | ## AbilityLifecycleCallback.onAbilityForeground @@ -119,9 +119,9 @@ onAbilityForeground(ability: Ability): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | ## AbilityLifecycleCallback.onAbilityBackground @@ -134,9 +134,9 @@ onAbilityBackground(ability: Ability): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | ## AbilityLifecycleCallback.onAbilityContinue @@ -149,64 +149,64 @@ onAbilityContinue(ability: Ability): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | **示例：** - ```ts import AbilityStage from "@ohos.application.AbilityStage"; -var lifecycleid; +var lifecycleId; export default class MyAbilityStage extends AbilityStage { onCreate() { console.log("MyAbilityStage onCreate") - let AbilityLifecycleCallback = { - onAbilityCreate(ability){ - console.log("AbilityLifecycleCallback onAbilityCreate ability:" + JSON.stringify(ability)); + let AbilityLifecycleCallback = { + onAbilityCreate(ability) { + console.log("onAbilityCreate ability:" + JSON.stringify(ability)); }, - onWindowStageCreate(ability, windowStage){ - console.log("AbilityLifecycleCallback onWindowStageCreate ability:" + JSON.stringify(ability)); - console.log("AbilityLifecycleCallback onWindowStageCreate windowStage:" + JSON.stringify(windowStage)); + onWindowStageCreate(ability, windowStage) { + console.log("onWindowStageCreate ability:" + JSON.stringify(ability)); + console.log("onWindowStageCreate windowStage:" + JSON.stringify(windowStage)); }, - onWindowStageActive(ability, windowStage){ - console.log("AbilityLifecycleCallback onWindowStageActive ability:" + JSON.stringify(ability)); - console.log("AbilityLifecycleCallback onWindowStageActive windowStage:" + JSON.stringify(windowStage)); + onWindowStageActive(ability, windowStage) { + console.log("onWindowStageActive ability:" + JSON.stringify(ability)); + console.log("onWindowStageActive windowStage:" + JSON.stringify(windowStage)); }, - onWindowStageInactive(ability, windowStage){ - console.log("AbilityLifecycleCallback onWindowStageInactive ability:" + JSON.stringify(ability)); - console.log("AbilityLifecycleCallback onWindowStageInactive windowStage:" + JSON.stringify(windowStage)); + onWindowStageInactive(ability, windowStage) { + console.log("onWindowStageInactive ability:" + JSON.stringify(ability)); + console.log("onWindowStageInactive windowStage:" + JSON.stringify(windowStage)); }, - onWindowStageDestroy(ability, windowStage){ - console.log("AbilityLifecycleCallback onWindowStageDestroy ability:" + JSON.stringify(ability)); - console.log("AbilityLifecycleCallback onWindowStageDestroy windowStage:" + JSON.stringify(windowStage)); + onWindowStageDestroy(ability, windowStage) { + console.log("onWindowStageDestroy ability:" + JSON.stringify(ability)); + console.log("onWindowStageDestroy windowStage:" + JSON.stringify(windowStage)); }, - onAbilityDestroy(ability){ - console.log("AbilityLifecycleCallback onAbilityDestroy ability:" + JSON.stringify(ability)); + onAbilityDestroy(ability) { + console.log("onAbilityDestroy ability:" + JSON.stringify(ability)); }, - onAbilityForeground(ability){ - console.log("AbilityLifecycleCallback onAbilityForeground ability:" + JSON.stringify(ability)); + onAbilityForeground(ability) { + console.log("onAbilityForeground ability:" + JSON.stringify(ability)); }, - onAbilityBackground(ability){ - console.log("AbilityLifecycleCallback onAbilityBackground ability:" + JSON.stringify(ability)); + onAbilityBackground(ability) { + console.log("onAbilityBackground ability:" + JSON.stringify(ability)); }, - onAbilityContinue(ability){ - console.log("AbilityLifecycleCallback onAbilityContinue ability:" + JSON.stringify(ability)); + onAbilityContinue(ability) { + console.log("onAbilityContinue ability:" + JSON.stringify(ability)); } } // 1.通过context属性获取applicationContext let applicationContext = this.context.getApplicationContext(); // 2.通过applicationContext注册监听应用内生命周期 - lifecycleid = applicationContext.registerAbilityLifecycleCallback(AbilityLifecycleCallback); - console.log("registerAbilityLifecycleCallback number: " + JSON.stringify(lifecycleid)); + lifecycleId = applicationContext.registerAbilityLifecycleCallback(AbilityLifecycleCallback); + console.log("registerAbilityLifecycleCallback number: " + JSON.stringify(lifecycleId)); } + onDestroy() { let applicationContext = this.context.getApplicationContext(); - applicationContext.unregisterAbilityLifecycleCallback(lifecycleid, (error, data) => { - console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error)); + applicationContext.unregisterAbilityLifecycleCallback(lifecycleId, (error, data) => { + console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error)); }); } } diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityStage.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityStage.md index 432ffcc0d526a861e616846d94551a71f5a99d1f..1fe541aa5524c3c340276b00940a2dcf5cfc81ff 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityStage.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityStage.md @@ -44,15 +44,15 @@ onAcceptWant(want: Want): string; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | string | 用户返回一个ability标识，如果之前启动过标识的ability，不创建新的实例并拉回栈顶，否则创建新的实例并启动。 | +| 类型 | 说明 | +| -------- | -------- | +| string | 用户返回一个ability标识，如果之前启动过标识的ability，不创建新的实例并拉回栈顶，否则创建新的实例并启动。 | **示例：** @@ -76,9 +76,9 @@ onConfigurationUpdated(config: Configuration): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | config | [Configuration](js-apis-application-configuration.md) | 是 | 发生全局配置变更时触发回调，当前全局配置包括系统语言、深浅色模式。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| config | [Configuration](js-apis-application-configuration.md) | 是 | 发生全局配置变更时触发回调，当前全局配置包括系统语言、深浅色模式。 | **示例：** @@ -100,9 +100,9 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | level | [AbilityConstant.MemoryLevel](js-apis-application-abilityConstant.md#abilityconstantmemorylevel) | 是 | 回调返回内存微调级别，显示当前内存使用状态。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| level | [AbilityConstant.MemoryLevel](js-apis-application-abilityConstant.md#abilityconstantmemorylevel) | 是 | 回调返回内存微调级别，显示当前内存使用状态。| **示例：** @@ -118,10 +118,10 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void; context: AbilityStageContext; -指示有关上下文的配置信息。 +AbilityStage的上下文对象。 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core -| 属性名 | 类型 | 说明 | -| ----------- | --------------------------- | ------------------------------------------------------------ | -| context | [AbilityStageContext](js-apis-inner-application-abilityStageContext.md) | 在启动能力阶段进行初始化时回调。 | +| 属性名 | 类型 | 说明 | +| ------- | ------------------------------------------------------------ | -------------------------- | +| context | [AbilityStageContext](js-apis-inner-application-abilityStageContext.md) | AbilityStage的上下文对象。 |