From 36769ad9ad1f86bc57597cf5c4e6423b830013ec Mon Sep 17 00:00:00 2001 From: HelloCrease Date: Sat, 30 Jul 2022 18:13:13 +0800 Subject: [PATCH] update docs Signed-off-by: HelloCrease --- .../ability/context-userguide.md | 22 +- .../reference/apis/js-apis-Context.md | 306 +++++++++--------- .../ui/ts-event-configuration.md | 2 +- 3 files changed, 165 insertions(+), 165 deletions(-) diff --git a/zh-cn/application-dev/ability/context-userguide.md b/zh-cn/application-dev/ability/context-userguide.md index 5750ac1315..85dc098719 100644 --- a/zh-cn/application-dev/ability/context-userguide.md +++ b/zh-cn/application-dev/ability/context-userguide.md @@ -7,10 +7,10 @@ ​ OpenHarmony的应用框架分为FA模型和Stage两种模型。对应存在两套Context机制适配两种应用框架模型，其中application/BaseContext属于通用的Context基类，里面包含一个属性stageMode，用来区分开发模型是FA还是Stage。 - FA模型 -只有app/Context中的方法属于FA模型对应的Context。该模式下，应用级别的Context和Ability级别的Context都是该类型的实例，如果在应用级别的Context里面调用了Ability级别的方法，会产生错误。所以开发者需要注意Context实例所代表的实际含义。 + 只有app/Context中的方法属于FA模型对应的Context。该模式下，应用级别的Context和Ability级别的Context都是该类型的实例，如果在应用级别的Context里面调用了Ability级别的方法，会产生错误。所以开发者需要注意Context实例所代表的实际含义。 - Stage模型 -除了app/Context之外的Context都属于Stage模型，分别有application/Context、application/ApplicationContext、application/AbilityStageContext、application/ExtensionContext、application/AbilityContext、application/FormExtensionContext等Context。这些Context的介绍及使用方式将会在[Stage模型和Context详细介绍](#stage模型和context详细介绍)种进行说明。 + 除了app/Context之外的Context都属于Stage模型，分别有application/Context、application/ApplicationContext、application/AbilityStageContext、application/ExtensionContext、application/AbilityContext、application/FormExtensionContext等Context。这些Context的介绍及使用方式将会在[Stage模型和Context详细介绍](#stage模型和context详细介绍)种进行说明。 ![contextIntroduction](figures/contextIntroduction.png) @@ -225,20 +225,21 @@ export default class MainAbility extends Ability { ​ [FormExtensionContext](/zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md) -### 在ets页面中访问Context +### 在eTS页面中访问Context -​ Stage模型下，在Ability的`onWindowStageCreate`生命周期中，可以通过WindowStage的`SetUIContent`方法加载一个ets页面。在一些场景中，需要在页面内获取Context调用相关API。 +Stage模型下，在Ability的`onWindowStageCreate`生命周期中，可以通过WindowStage的`SetUIContent`方法加载一个eTS页面。在一些场景中，需要在页面内获取Context调用相关API。 **获取方法** -​ 在ets页面中通过以下全局方法获取当前页面关联的Context。 -|接口名|描述| -|:------|:------| -|getContext(component: Object): Object|获取页面中component所关联的Context对象。| +在eTS页面中通过以下全局方法获取当前页面关联的Context。 + +| 接口名 | 描述 | +| :------------------------------------ | :--------------------------- | +| getContext(component: Object): Object | 获取页面中component所关联的Context对象。 | **示例** -```typescript +```ts // MainAbility.ts import Ability from '@ohos.application.Ability' @@ -264,7 +265,7 @@ export default class MainAbility extends Ability { }; ``` -```typescript +```ts // pages/index.ets import context from '@ohos.application.context' @@ -290,7 +291,6 @@ struct Index { .height('100%') } } - ``` ## 常见错误使用方式 diff --git a/zh-cn/application-dev/reference/apis/js-apis-Context.md b/zh-cn/application-dev/reference/apis/js-apis-Context.md index 3219356538..eacb8e6f9d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-Context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-Context.md @@ -3,7 +3,7 @@ Context模块提供了ability或application的上下文的能力，包括允许访问特定于应用程序的资源、请求和验证权限等。 > **说明：** -> +> > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在FA模型下使用。 @@ -29,9 +29,9 @@ getOrCreateLocalDir(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | -------------------------- | -| callback | AsyncCallback\ | 是 | 返回应用程序的本地根目录。 | +| 名称 | 类型 | 必填 | 描述 | +| -------- | ---------------------- | ---- | ------------- | +| callback | AsyncCallback\ | 是 | 返回应用程序的本地根目录。 | **示例：** @@ -57,8 +57,8 @@ getOrCreateLocalDir(): Promise\ **返回值：** -| 类型 | 说明 | -| ---------------- | ---------------------- | +| 类型 | 说明 | +| ---------------- | ----------- | | Promise\ | 应用程序的本地根目录。 | **示例：** @@ -83,11 +83,11 @@ verifyPermission(permission: string, options: PermissionOptions, callback: Async **参数：** -| 名称 | 类型 | 必填 | 描述 | -| ---------- | --------------------------------------- | ---- | ------------------------------------- | -| permission | string | 是 | 指定权限的名称。 | -| options | [PermissionOptions](#permissionoptions) | 是 | 权限选项。 | -| callback | AsyncCallback\ | 是 | 返回权限验证结果，0有权限，-1无权限。 | +| 名称 | 类型 | 必填 | 描述 | +| ---------- | --------------------------------------- | ---- | -------------------- | +| permission | string | 是 | 指定权限的名称。 | +| options | [PermissionOptions](#permissionoptions) | 是 | 权限选项。 | +| callback | AsyncCallback\ | 是 | 返回权限验证结果，0有权限，-1无权限。 | **示例：** @@ -112,10 +112,10 @@ verifyPermission(permission: string, callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | -| ---------- | ---------------------- | ---- | ------------------------------------- | -| permission | string | 是 | 指定权限的名称。 | -| callback | AsyncCallback\ | 是 | 返回权限验证结果，0有权限，-1无权限。 | +| 名称 | 类型 | 必填 | 描述 | +| ---------- | ---------------------- | ---- | -------------------- | +| permission | string | 是 | 指定权限的名称。 | +| callback | AsyncCallback\ | 是 | 返回权限验证结果，0有权限，-1无权限。 | **示例：** @@ -135,15 +135,15 @@ verifyPermission(permission: string, options?: PermissionOptions): Promise\ | 如果pid和uid具有权限，则使用0进行异步回调；否则使用-1回调。 | **示例：** @@ -170,11 +170,11 @@ requestPermissionsFromUser(permissions: Array\, requestCode: number, res **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- | -| permissions | Array\ | 是 | 指示要请求的权限列表。此参数不能为null。 | -| requestCode | number | 是 | 指示要传递给PermissionRequestResult的请求代码。 | -| resultCallback | AsyncCallback<[PermissionRequestResult](#permissionrequestresult)> | 是 | 返回授权结果信息。 | +| 名称 | 类型 | 必填 | 描述 | +| -------------- | ---------------------------------------- | ---- | ----------------------------------- | +| permissions | Array\ | 是 | 指示要请求的权限列表。此参数不能为null。 | +| requestCode | number | 是 | 指示要传递给PermissionRequestResult的请求代码。 | +| resultCallback | AsyncCallback<[PermissionRequestResult](#permissionrequestresult)> | 是 | 返回授权结果信息。 | **示例：** @@ -206,9 +206,9 @@ getApplicationInfo(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | ------------------------------- | ---- | ------------------------ | -| callback | AsyncCallback\ | 是 | 返回当前应用程序的信息。 | +| 名称 | 类型 | 必填 | 描述 | +| -------- | ------------------------------- | ---- | ------------ | +| callback | AsyncCallback\ | 是 | 返回当前应用程序的信息。 | **示例：** @@ -230,8 +230,8 @@ getApplicationInfo(): Promise\ **返回值：** -| 类型 | 说明 | -| ------------------------- | ------------------ | +| 类型 | 说明 | +| ------------------------- | --------- | | Promise\ | 当前应用程序的信息 | **示例：** @@ -257,9 +257,9 @@ getBundleName(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | ----------------------------- | -| callback | AsyncCallback\ | 是 | 返回当前ability的捆绑包名称。 | +| 名称 | 类型 | 必填 | 描述 | +| -------- | ---------------------- | ---- | ------------------ | +| callback | AsyncCallback\ | 是 | 返回当前ability的捆绑包名称。 | **示例：** @@ -281,8 +281,8 @@ getBundleName(): Promise\ **返回值：** -| 类型 | 说明 | -| ---------------- | ------------------------- | +| 类型 | 说明 | +| ---------------- | ---------------- | | Promise\ | 当前ability的捆绑包名称。 | **示例：** @@ -306,9 +306,9 @@ getDisplayOrientation(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | ----------------------------- | -| callback | AsyncCallback\<[bundle.DisplayOrientation](js-apis-bundle.md#displayorientation)> | 是 | 表示屏幕显示方向。 | +| 名称 | 类型 | 必填 | 描述 | +| -------- | ---------------------------------------- | ---- | --------- | +| callback | AsyncCallback\<[bundle.DisplayOrientation](js-apis-bundle.md#displayorientation)> | 是 | 表示屏幕显示方向。 | **示例：** @@ -328,8 +328,8 @@ getDisplayOrientation(): Promise\; **返回值：** -| 类型 | 说明 | -| ---------------- | ------------------------- | +| 类型 | 说明 | +| ---------------------------------------- | --------- | | Promise\<[bundle.DisplayOrientation](js-apis-bundle.md#displayorientation)> | 表示屏幕显示方向。 | **示例：** @@ -353,10 +353,10 @@ setDisplayOrientation(orientation: bundle.DisplayOrientation, callback: AsyncCal **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | ----------------------------- | -| orientation | [bundle.DisplayOrientation](js-apis-bundle.md#displayorientation) | 是 | 指示当前能力的新方向。。 | -| callback | AsyncCallback\<[bundle.DisplayOrientation](js-apis-bundle.md#displayorientation)> | 是 | 表示屏幕显示方向。 | +| 名称 | 类型 | 必填 | 描述 | +| ----------- | ---------------------------------------- | ---- | ------------ | +| orientation | [bundle.DisplayOrientation](js-apis-bundle.md#displayorientation) | 是 | 指示当前能力的新方向。。 | +| callback | AsyncCallback\<[bundle.DisplayOrientation](js-apis-bundle.md#displayorientation)> | 是 | 表示屏幕显示方向。 | **示例：** @@ -380,10 +380,10 @@ setDisplayOrientation(orientation: bundle.DisplayOrientation): Promise\; **返回值：** -| 类型 | 说明 | -| ---------------- | ------------------------- | -| orientation | [bundle.DisplayOrientation](js-apis-bundle.md#displayorientation) | 是 | 指示当前能力的新方向。。 | -| Promise\<[bundle.DisplayOrientation](js-apis-bundle.md#displayorientation)> | 表示屏幕显示方向。 | +| 类型 | 说明 | +| ---------------------------------------- | ---------------------------------------- | +| orientation | [bundle.DisplayOrientation](js-apis-bundle.md#displayorientation) | +| Promise\<[bundle.DisplayOrientation](js-apis-bundle.md#displayorientation)> | 表示屏幕显示方向。 | **示例：** @@ -408,10 +408,10 @@ setShowOnLockScreen(show: boolean, callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | ----------------------------- | -| show | boolean | 是 | 指定是否在锁屏顶部显示此功能。值true表示在锁屏上显示，值false表示不显示。 | -| callback | AsyncCallback\ | 是 | 返回回调结果。 | +| 名称 | 类型 | 必填 | 描述 | +| -------- | -------------------- | ---- | ---------------------------------------- | +| show | boolean | 是 | 指定是否在锁屏顶部显示此功能。值true表示在锁屏上显示，值false表示不显示。 | +| callback | AsyncCallback\ | 是 | 返回回调结果。 | **示例：** @@ -434,15 +434,15 @@ setShowOnLockScreen(show: boolean): Promise\; **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | ----------------------------- | -| show | boolean | 是 | 指定是否在锁屏顶部显示此功能。值true表示在锁屏上显示，值false表示不显示。 | +| 名称 | 类型 | 必填 | 描述 | +| ---- | ------- | ---- | ---------------------------------------- | +| show | boolean | 是 | 指定是否在锁屏顶部显示此功能。值true表示在锁屏上显示，值false表示不显示。 | **返回值：** -| 类型 | 说明 | -| ---------------- | ------------------------- | -| Promise\| 使用Promise形式返回结果 | +| 类型 | 说明 | +| -------------- | --------------- | +| Promise\ | 使用Promise形式返回结果 | **示例：** @@ -466,10 +466,10 @@ setWakeUpScreen(wakeUp: boolean, callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | ----------------------------- | -| wakeUp | boolean | 是 | 指定是否唤醒屏幕。值true表示唤醒它，值false表示不唤醒它。 | -| callback | AsyncCallback\ | 是 | 返回回调结果。 | +| 名称 | 类型 | 必填 | 描述 | +| -------- | -------------------- | ---- | --------------------------------- | +| wakeUp | boolean | 是 | 指定是否唤醒屏幕。值true表示唤醒它，值false表示不唤醒它。 | +| callback | AsyncCallback\ | 是 | 返回回调结果。 | **示例：** @@ -492,15 +492,15 @@ setWakeUpScreen(wakeUp: boolean): Promise\; **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | ----------------------------- | -| wakeUp | boolean | 是 | 指定是否唤醒屏幕。值true表示唤醒它，值false表示不唤醒它。 | +| 名称 | 类型 | 必填 | 描述 | +| ------ | ------- | ---- | --------------------------------- | +| wakeUp | boolean | 是 | 指定是否唤醒屏幕。值true表示唤醒它，值false表示不唤醒它。 | **返回值：** -| 类型 | 说明 | -| ---------------- | ------------------------- | -| Promise\| 使用Promise形式返回结果 | +| 类型 | 说明 | +| -------------- | --------------- | +| Promise\ | 使用Promise形式返回结果 | **示例：** @@ -527,9 +527,9 @@ getProcessInfo(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | --------------------------- | ---- | -------------------- | -| callback | AsyncCallback\ | 是 | 返回当前进程的信息。 | +| 名称 | 类型 | 必填 | 描述 | +| -------- | --------------------------- | ---- | ---------- | +| callback | AsyncCallback\ | 是 | 返回当前进程的信息。 | **示例：** @@ -551,8 +551,8 @@ getProcessInfo(): Promise\ **返回值：** -| 类型 | 说明 | -| --------------------- | -------------- | +| 类型 | 说明 | +| --------------------- | ------- | | Promise\ | 当前进程的信息 | **示例：** @@ -580,9 +580,9 @@ getElementName(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | --------------------------- | ---- | ---------------------------------------------- | -| callback | AsyncCallback\ | 是 | 返回当前ability的ohos.bundle.ElementName对象。 | +| 名称 | 类型 | 必填 | 描述 | +| -------- | --------------------------- | ---- | -------------------------------------- | +| callback | AsyncCallback\ | 是 | 返回当前ability的ohos.bundle.ElementName对象。 | **示例：** @@ -606,8 +606,8 @@ getElementName(): Promise\ **返回值：** -| 类型 | 说明 | -| --------------------- | ------------------------------------------ | +| 类型 | 说明 | +| --------------------- | ------------------------------------ | | Promise\ | 当前ability的ohos.bundle.ElementName对象。 | **示例：** @@ -631,9 +631,9 @@ getProcessName(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | -------------------- | -| callback | AsyncCallback\ | 是 | 返回当前进程的名称。 | +| 名称 | 类型 | 必填 | 描述 | +| -------- | ---------------------- | ---- | ---------- | +| callback | AsyncCallback\ | 是 | 返回当前进程的名称。 | **示例：** @@ -655,8 +655,8 @@ getProcessName(): Promise\ **返回值：** -| 类型 | 说明 | -| ---------------- | -------------------- | +| 类型 | 说明 | +| ---------------- | ---------- | | Promise\ | 返回当前进程的名称。 | **示例：** @@ -682,9 +682,9 @@ getCallingBundle(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | ------------------------- | -| callback | AsyncCallback\ | 是 | 返回调用ability的包名称。 | +| 名称 | 类型 | 必填 | 描述 | +| -------- | ---------------------- | ---- | ---------------- | +| callback | AsyncCallback\ | 是 | 返回调用ability的包名称。 | **示例：** @@ -706,8 +706,8 @@ getCallingBundle(): Promise\ **返回值：** -| 类型 | 说明 | -| --------------- | ------------------------- | +| 类型 | 说明 | +| ---------------- | -------------- | | Promise\ | 调用ability的包名称。 | **示例：** @@ -731,9 +731,9 @@ getCacheDir(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | ------------------------- | -| callback | AsyncCallback\ | 是 | 返回该应用程序的内部存储目录。| +| 名称 | 类型 | 必填 | 描述 | +| -------- | ---------------------- | ---- | --------------- | +| callback | AsyncCallback\ | 是 | 返回该应用程序的内部存储目录。 | **示例：** @@ -759,8 +759,8 @@ getCacheDir(): Promise\ **返回值：** -| 类型 | 说明 | -| --------------- | ------------------------- | +| 类型 | 说明 | +| ---------------- | --------------- | | Promise\ | 获取该应用程序的内部存储目录。 | **示例：** @@ -784,9 +784,9 @@ getFilesDir(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | ------------------------- | -| callback | AsyncCallback\ | 是 | 返回内部存储器上此应用程序的文件目录。| +| 名称 | 类型 | 必填 | 描述 | +| -------- | ---------------------- | ---- | ------------------- | +| callback | AsyncCallback\ | 是 | 返回内部存储器上此应用程序的文件目录。 | **示例：** @@ -812,8 +812,8 @@ getFilesDir(): Promise\ **返回值：** -| 类型 | 说明 | -| --------------- | ------------------------- | +| 类型 | 说明 | +| ---------------- | ------------------- | | Promise\ | 返回内部存储器上此应用程序的文件目录。 | **示例：** @@ -839,9 +839,9 @@ getOrCreateDistributedDir(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | ------------------------- | -| callback | AsyncCallback\ | 是 | 回调函数，可以在回调函数中处理接口返回值，返回Ability或应用的分布式文件路径。如果分布式文件路径不存在，系统将创建一个路径并返回创建的路径。| +| 名称 | 类型 | 必填 | 描述 | +| -------- | ---------------------- | ---- | ---------------------------------------- | +| callback | AsyncCallback\ | 是 | 回调函数，可以在回调函数中处理接口返回值，返回Ability或应用的分布式文件路径。如果分布式文件路径不存在，系统将创建一个路径并返回创建的路径。 | **示例：** @@ -869,8 +869,8 @@ getOrCreateDistributedDir(): Promise\ **返回值：** -| 类型 | 说明 | -| --------------- | ------------------------- | +| 类型 | 说明 | +| ---------------- | ----------------------------------- | | Promise\ | Ability或应用的分布式文件路径。如果是第一次调用，则将创建目录。 | **示例：** @@ -893,9 +893,9 @@ getAppType(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | ------------------------- | -| callback | AsyncCallback\ | 是 | 回调函数，可以在回调函数中处理接口返回值，返回此应用程序的类型。| +| 名称 | 类型 | 必填 | 描述 | +| -------- | ---------------------- | ---- | -------------------------------- | +| callback | AsyncCallback\ | 是 | 回调函数，可以在回调函数中处理接口返回值，返回此应用程序的类型。 | **示例：** @@ -921,8 +921,8 @@ getAppType(): Promise\ **返回值：** -| 类型 | 说明 | -| --------------- | ------------------------- | +| 类型 | 说明 | +| ---------------- | ------------------ | | Promise\ | Promise形式返回此应用的类型。 | **示例：** @@ -945,9 +945,9 @@ getHapModuleInfo(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | ------------------------- | -| callback | AsyncCallback\<[HapModuleInfo](js-apis-bundle-HapModuleInfo.md)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回应用的ModuleInfo对象。| +| 名称 | 类型 | 必填 | 描述 | +| -------- | ---------------------------------------- | ---- | --------------------------------------- | +| callback | AsyncCallback\<[HapModuleInfo](js-apis-bundle-HapModuleInfo.md)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回应用的ModuleInfo对象。 | **示例：** @@ -973,8 +973,8 @@ getHapModuleInfo(): Promise\ **返回值：** -| 类型 | 说明 | -| --------------- | ------------------------- | +| 类型 | 说明 | +| ---------------------------------------- | ------------------ | | Promise\<[HapModuleInfo](js-apis-bundle-HapModuleInfo.md)> | 返回应用的ModuleInfo对象。 | **示例：** @@ -997,9 +997,9 @@ getAppVersionInfo(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | ------------------------- | -| callback | AsyncCallback\<[AppVersionInfo](#appversioninfo)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回应用版本信息。| +| 名称 | 类型 | 必填 | 描述 | +| -------- | ---------------------------------------- | ---- | ------------------------------ | +| callback | AsyncCallback\<[AppVersionInfo](#appversioninfo)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回应用版本信息。 | **示例：** @@ -1025,8 +1025,8 @@ getAppVersionInfo(): Promise\ **返回值：** -| 类型 | 说明 | -| --------------- | ------------------------- | +| 类型 | 说明 | +| ---------------------------------------- | --------- | | Promise\<[AppVersionInfo](#appversioninfo)> | 返回应用版本信息。 | **示例：** @@ -1049,9 +1049,9 @@ getAbilityInfo(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | ------------------------- | -| callback | AsyncCallback\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回当前归属Ability详细信息。| +| 名称 | 类型 | 必填 | 描述 | +| -------- | ---------------------------------------- | ---- | --------------------------------------- | +| callback | AsyncCallback\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回当前归属Ability详细信息。 | **示例：** @@ -1077,8 +1077,8 @@ getAbilityInfo(): Promise\ **返回值：** -| 类型 | 说明 | -| --------------- | ------------------------- | +| 类型 | 说明 | +| ---------------------------------------- | ------------------ | | Promise\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 返回当前归属Ability详细信息。 | **示例：** @@ -1101,9 +1101,9 @@ getApplicationContext(): Context **返回值：** -| 类型 | 说明 | -| --------- |------ | -| Context | 返回应用上下文信息。 | +| 类型 | 说明 | +| ------- | ---------- | +| Context | 返回应用上下文信息。 | **示例：** @@ -1122,9 +1122,9 @@ isUpdatingConfigurations(callback: AsyncCallback\): void; **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | ------------------------- | -| callback | AsyncCallback\ | 是 | 如果该能力的配置正在更改，则为true，否则为false。| +| 名称 | 类型 | 必填 | 描述 | +| -------- | ----------------------- | ---- | ----------------------------- | +| callback | AsyncCallback\ | 是 | 如果该能力的配置正在更改，则为true，否则为false。 | **示例：** @@ -1150,9 +1150,9 @@ isUpdatingConfigurations(): Promise\; **返回值：** -| 类型 | 说明 | -| --------------- | ------------------------- | -|Promise\ | 如果该能力的配置正在更改，则为true，否则为false。 | +| 类型 | 说明 | +| ----------------- | ----------------------------- | +| Promise\ | 如果该能力的配置正在更改，则为true，否则为false。 | **示例：** @@ -1174,9 +1174,9 @@ printDrawnCompleted(callback: AsyncCallback\): void; **参数：** -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | ------------------------- | -| callback | AsyncCallback\ | 是 | 表示被指定的回调方法。| +| 名称 | 类型 | 必填 | 描述 | +| -------- | -------------------- | ---- | ----------- | +| callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | **示例：** @@ -1202,9 +1202,9 @@ printDrawnCompleted(): Promise\; **返回值：** -| 类型 | 说明 | -| --------------- | ------------------------- | -|Promise\ | 以Promise形式返回结果。 | +| 类型 | 说明 | +| -------------- | --------------- | +| Promise\ | 以Promise形式返回结果。 | **示例：** @@ -1221,27 +1221,27 @@ context.printDrawnCompleted().then((data) => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 读写属性 | 类型 | 必填 | 描述 | -| ---- | -------- | ------ | ---- | ------ | -| pid | 只读 | number | 否 | 进程id。 | -| uid | 只读 | number | 否 | 用户id。 | +| 名称 | 读写属性 | 类型 | 必填 | 描述 | +| ---- | ---- | ------ | ---- | ----- | +| pid | 只读 | number | 否 | 进程id。 | +| uid | 只读 | number | 否 | 用户id。 | ## PermissionRequestResult7+ **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 读写属性 | 类型 | 必填 | 描述 | -| ----------- | -------- | -------------- | ---- | ------------------ | -| requestCode | 只读 | number | 是 | 用户传入的请求代码。 | -| permissions | 只读 | Array\ | 是 | 用户传入的权限。 | -| authResults | 只读 | Array\ | 是 | 请求权限的结果。 | +| 名称 | 读写属性 | 类型 | 必填 | 描述 | +| ----------- | ---- | -------------- | ---- | ---------- | +| requestCode | 只读 | number | 是 | 用户传入的请求代码。 | +| permissions | 只读 | Array\ | 是 | 用户传入的权限。 | +| authResults | 只读 | Array\ | 是 | 请求权限的结果。 | ## AppVersionInfo7+ **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------ | ------ | ------| ------ | ------ | -| appName | string | 是 | 否 | 模块名称。 | -| versionCode | number | 是 | 否 | 模块描述信息。 | -| versionName | string | 是 | 否 | 描述信息ID。 | +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ----------- | ------ | ---- | ---- | ------- | +| appName | string | 是 | 否 | 模块名称。 | +| versionCode | number | 是 | 否 | 模块描述信息。 | +| versionName | string | 是 | 否 | 描述信息ID。 | diff --git a/zh-cn/application-dev/ui/ts-event-configuration.md b/zh-cn/application-dev/ui/ts-event-configuration.md index aa5637d2a0..d9c2274dca 100644 --- a/zh-cn/application-dev/ui/ts-event-configuration.md +++ b/zh-cn/application-dev/ui/ts-event-configuration.md @@ -1,6 +1,6 @@ # 事件配置 -通过事件方法可以配置组件支持的事件。 +通过事件方法可以配置组件支持的事件。从API Version 9开始，可以在回调函数中获取当前component关联的Context，具体用法请参考[在eTS页面中访问Context](../ability/context-userguide.md)。 - 使用lambda表达式配置组件的事件方法： -- GitLab