Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 aca19f3d 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!7484 文档修改 

Merge pull request !7484 from LiAn/cherry-pick-1659176237
上级 b6fd41b3 3725fa71
隐藏空白更改
内联 并排
Showing with 182 addition and 180 deletion
zh-cn/application-dev/ability/context-userguide.md
浏览文件 @ aca19f3d
...@@ -7,10 +7,10 @@ ...@@ -7,10 +7,10 @@
​ OpenHarmony的应用框架分为FA模型和Stage两种模型。对应存在两套Context机制适配两种应用框架模型，其中application/BaseContext属于通用的Context基类，里面包含一个属性stageMode，用来区分开发模型是FA还是Stage。 ​ OpenHarmony的应用框架分为FA模型和Stage两种模型。对应存在两套Context机制适配两种应用框架模型，其中application/BaseContext属于通用的Context基类，里面包含一个属性stageMode，用来区分开发模型是FA还是Stage。
- FA模型 - FA模型
只有app/Context中的方法属于FA模型对应的Context。该模式下，应用级别的Context和Ability级别的Context都是该类型的实例，如果在应用级别的Context里面调用了Ability级别的方法，会产生错误。所以开发者需要注意Context实例所代表的实际含义。 只有app/Context中的方法属于FA模型对应的Context。该模式下，应用级别的Context和Ability级别的Context都是该类型的实例，如果在应用级别的Context里面调用了Ability级别的方法，会产生错误。所以开发者需要注意Context实例所代表的实际含义。
- Stage模型 - 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) ![contextIntroduction](figures/contextIntroduction.png)
...@@ -225,20 +225,21 @@ export default class MainAbility extends Ability { ...@@ -225,20 +225,21 @@ export default class MainAbility extends Ability {
​ [FormExtensionContext](/zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md) ​ [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。 在eTS页面中通过以下全局方法获取当前页面关联的Context。
|接口名|描述|
|:------|:------| | 接口名 | 描述 |
|getContext(component: Object): Object|获取页面中component所关联的Context对象。| | :------------------------------------ | :--------------------------- |
| getContext(component: Object): Object | 获取页面中component所关联的Context对象。 |
**示例** **示例**
```typescript ```ts
// MainAbility.ts // MainAbility.ts
import Ability from '@ohos.application.Ability' import Ability from '@ohos.application.Ability'
...@@ -264,7 +265,7 @@ export default class MainAbility extends Ability { ...@@ -264,7 +265,7 @@ export default class MainAbility extends Ability {
}; };
``` ```
```typescript ```ts
// pages/index.ets // pages/index.ets
import context from '@ohos.application.context' import context from '@ohos.application.context'
...@@ -290,7 +291,6 @@ struct Index { ...@@ -290,7 +291,6 @@ struct Index {
.height('100%') .height('100%')
} }
} }
``` ```
## 常见错误使用方式 ## 常见错误使用方式
......
zh-cn/application-dev/reference/apis/js-apis-Context.md
浏览文件 @ aca19f3d
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
Context模块提供了ability或application的上下文的能力，包括允许访问特定于应用程序的资源、请求和验证权限等。 Context模块提供了ability或application的上下文的能力，包括允许访问特定于应用程序的资源、请求和验证权限等。
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在FA模型下使用。 > 本模块接口仅可在FA模型下使用。
...@@ -29,9 +29,9 @@ getOrCreateLocalDir(callback: AsyncCallback\<string>): void ...@@ -29,9 +29,9 @@ getOrCreateLocalDir(callback: AsyncCallback\<string>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | -------------------------- | | -------- | ---------------------- | ---- | ------------- |
| callback | AsyncCallback\<string> | 是 | 返回应用程序的本地根目录。 | | callback | AsyncCallback\<string> | 是 | 返回应用程序的本地根目录。 |
**示例：** **示例：**
...@@ -57,8 +57,8 @@ getOrCreateLocalDir(): Promise\<string> ...@@ -57,8 +57,8 @@ getOrCreateLocalDir(): Promise\<string>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ---------------------- | | ---------------- | ----------- |
| Promise\<string> | 应用程序的本地根目录。 | | Promise\<string> | 应用程序的本地根目录。 |
**示例：** **示例：**
...@@ -83,11 +83,11 @@ verifyPermission(permission: string, options: PermissionOptions, callback: Async ...@@ -83,11 +83,11 @@ verifyPermission(permission: string, options: PermissionOptions, callback: Async
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | --------------------------------------- | ---- | ------------------------------------- | | ---------- | --------------------------------------- | ---- | -------------------- |
| permission | string | 是 | 指定权限的名称。 | | permission | string | 是 | 指定权限的名称。 |
| options | [PermissionOptions](#permissionoptions) | 是 | 权限选项。 | | options | [PermissionOptions](#permissionoptions) | 是 | 权限选项。 |
| callback | AsyncCallback\<number> | 是 | 返回权限验证结果，0有权限，-1无权限。 | | callback | AsyncCallback\<number> | 是 | 返回权限验证结果，0有权限，-1无权限。 |
**示例：** **示例：**
...@@ -112,10 +112,10 @@ verifyPermission(permission: string, callback: AsyncCallback\<number>): void ...@@ -112,10 +112,10 @@ verifyPermission(permission: string, callback: AsyncCallback\<number>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | ---------------------- | ---- | ------------------------------------- | | ---------- | ---------------------- | ---- | -------------------- |
| permission | string | 是 | 指定权限的名称。 | | permission | string | 是 | 指定权限的名称。 |
| callback | AsyncCallback\<number> | 是 | 返回权限验证结果，0有权限，-1无权限。 | | callback | AsyncCallback\<number> | 是 | 返回权限验证结果，0有权限，-1无权限。 |
**示例：** **示例：**
...@@ -135,15 +135,15 @@ verifyPermission(permission: string, options?: PermissionOptions): Promise\<numb ...@@ -135,15 +135,15 @@ verifyPermission(permission: string, options?: PermissionOptions): Promise\<numb
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | --------------------------------------- | ---- | ---------------- | | ---------- | --------------------------------------- | ---- | -------- |
| permission | string | 是 | 指定权限的名称。 | | permission | string | 是 | 指定权限的名称。 |
| options | [PermissionOptions](#permissionoptions) | 否 | 权限选项。 | | options | [PermissionOptions](#permissionoptions) | 否 | 权限选项。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ----------------------------------------------------------- | | ---------------- | ---------------------------------- |
| Promise\<number> | 如果pid和uid具有权限，则使用0进行异步回调；否则使用-1回调。 | | Promise\<number> | 如果pid和uid具有权限，则使用0进行异步回调；否则使用-1回调。 |
**示例：** **示例：**
...@@ -170,11 +170,11 @@ requestPermissionsFromUser(permissions: Array\<string>, requestCode: number, res ...@@ -170,11 +170,11 @@ requestPermissionsFromUser(permissions: Array\<string>, requestCode: number, res
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- | | -------------- | ---------------------------------------- | ---- | ----------------------------------- |
| permissions | Array\<string> | 是 | 指示要请求的权限列表。此参数不能为null。 | | permissions | Array\<string> | 是 | 指示要请求的权限列表。此参数不能为null。 |
| requestCode | number | 是 | 指示要传递给PermissionRequestResult的请求代码。 | | requestCode | number | 是 | 指示要传递给PermissionRequestResult的请求代码。 |
| resultCallback | AsyncCallback<[PermissionRequestResult](#permissionrequestresult)> | 是 | 返回授权结果信息。 | | resultCallback | AsyncCallback<[PermissionRequestResult](#permissionrequestresult)> | 是 | 返回授权结果信息。 |
**示例：** **示例：**
...@@ -206,9 +206,9 @@ getApplicationInfo(callback: AsyncCallback\<ApplicationInfo>): void ...@@ -206,9 +206,9 @@ getApplicationInfo(callback: AsyncCallback\<ApplicationInfo>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ------------------------------- | ---- | ------------------------ | | -------- | ------------------------------- | ---- | ------------ |
| callback | AsyncCallback\<ApplicationInfo> | 是 | 返回当前应用程序的信息。 | | callback | AsyncCallback\<ApplicationInfo> | 是 | 返回当前应用程序的信息。 |
**示例：** **示例：**
...@@ -230,8 +230,8 @@ getApplicationInfo(): Promise\<ApplicationInfo> ...@@ -230,8 +230,8 @@ getApplicationInfo(): Promise\<ApplicationInfo>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------- | ------------------ | | ------------------------- | --------- |
| Promise\<ApplicationInfo> | 当前应用程序的信息 | | Promise\<ApplicationInfo> | 当前应用程序的信息 |
**示例：** **示例：**
...@@ -257,9 +257,9 @@ getBundleName(callback: AsyncCallback\<string>): void ...@@ -257,9 +257,9 @@ getBundleName(callback: AsyncCallback\<string>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ----------------------------- | | -------- | ---------------------- | ---- | ------------------ |
| callback | AsyncCallback\<string> | 是 | 返回当前ability的捆绑包名称。 | | callback | AsyncCallback\<string> | 是 | 返回当前ability的捆绑包名称。 |
**示例：** **示例：**
...@@ -281,8 +281,8 @@ getBundleName(): Promise\<string> ...@@ -281,8 +281,8 @@ getBundleName(): Promise\<string>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ------------------------- | | ---------------- | ---------------- |
| Promise\<string> | 当前ability的捆绑包名称。 | | Promise\<string> | 当前ability的捆绑包名称。 |
**示例：** **示例：**
...@@ -306,9 +306,9 @@ getDisplayOrientation(callback: AsyncCallback\<bundle.DisplayOrientation>): void ...@@ -306,9 +306,9 @@ getDisplayOrientation(callback: AsyncCallback\<bundle.DisplayOrientation>): 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\<bundle.DisplayOrientation>; ...@@ -328,8 +328,8 @@ getDisplayOrientation(): Promise\<bundle.DisplayOrientation>;
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ------------------------- | | ---------------------------------------- | --------- |
| Promise\<[bundle.DisplayOrientation](js-apis-bundle.md#displayorientation)> | 表示屏幕显示方向。 | | Promise\<[bundle.DisplayOrientation](js-apis-bundle.md#displayorientation)> | 表示屏幕显示方向。 |
**示例：** **示例：**
...@@ -353,10 +353,10 @@ setDisplayOrientation(orientation: bundle.DisplayOrientation, callback: AsyncCal ...@@ -353,10 +353,10 @@ setDisplayOrientation(orientation: bundle.DisplayOrientation, callback: AsyncCal
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ----------------------------- | | ----------- | ---------------------------------------- | ---- | ------------ |
| orientation | [bundle.DisplayOrientation](js-apis-bundle.md#displayorientation) | 是 | 指示当前能力的新方向。。 | | orientation | [bundle.DisplayOrientation](js-apis-bundle.md#displayorientation) | 是 | 指示当前能力的新方向。。 |
| callback | AsyncCallback\<[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\<void>; ...@@ -380,10 +380,10 @@ setDisplayOrientation(orientation: bundle.DisplayOrientation): Promise\<void>;
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ------------------------- | | ---------------------------------------- | ---------------------------------------- |
| orientation | [bundle.DisplayOrientation](js-apis-bundle.md#displayorientation) | 是 | 指示当前能力的新方向。。 | | orientation | [bundle.DisplayOrientation](js-apis-bundle.md#displayorientation) |
| Promise\<[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>): void ...@@ -408,10 +408,10 @@ setShowOnLockScreen(show: boolean, callback: AsyncCallback\<void>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ----------------------------- | | -------- | -------------------- | ---- | ---------------------------------------- |
| show | boolean | 是 | 指定是否在锁屏顶部显示此功能。值true表示在锁屏上显示，值false表示不显示。 | | show | boolean | 是 | 指定是否在锁屏顶部显示此功能。值true表示在锁屏上显示，值false表示不显示。 |
| callback | AsyncCallback\<void> | 是 | 返回回调结果。 | | callback | AsyncCallback\<void> | 是 | 返回回调结果。 |
**示例：** **示例：**
...@@ -434,15 +434,15 @@ setShowOnLockScreen(show: boolean): Promise\<void>; ...@@ -434,15 +434,15 @@ setShowOnLockScreen(show: boolean): Promise\<void>;
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ----------------------------- | | ---- | ------- | ---- | ---------------------------------------- |
| show | boolean | 是 | 指定是否在锁屏顶部显示此功能。值true表示在锁屏上显示，值false表示不显示。 | | show | boolean | 是 | 指定是否在锁屏顶部显示此功能。值true表示在锁屏上显示，值false表示不显示。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ------------------------- | | -------------- | --------------- |
| Promise\<void>| 使用Promise形式返回结果 | | Promise\<void> | 使用Promise形式返回结果 |
**示例：** **示例：**
...@@ -466,10 +466,10 @@ setWakeUpScreen(wakeUp: boolean, callback: AsyncCallback\<void>): void ...@@ -466,10 +466,10 @@ setWakeUpScreen(wakeUp: boolean, callback: AsyncCallback\<void>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ----------------------------- | | -------- | -------------------- | ---- | --------------------------------- |
| wakeUp | boolean | 是 | 指定是否唤醒屏幕。值true表示唤醒它，值false表示不唤醒它。 | | wakeUp | boolean | 是 | 指定是否唤醒屏幕。值true表示唤醒它，值false表示不唤醒它。 |
| callback | AsyncCallback\<void> | 是 | 返回回调结果。 | | callback | AsyncCallback\<void> | 是 | 返回回调结果。 |
**示例：** **示例：**
...@@ -492,15 +492,15 @@ setWakeUpScreen(wakeUp: boolean): Promise\<void>; ...@@ -492,15 +492,15 @@ setWakeUpScreen(wakeUp: boolean): Promise\<void>;
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ----------------------------- | | ------ | ------- | ---- | --------------------------------- |
| wakeUp | boolean | 是 | 指定是否唤醒屏幕。值true表示唤醒它，值false表示不唤醒它。 | | wakeUp | boolean | 是 | 指定是否唤醒屏幕。值true表示唤醒它，值false表示不唤醒它。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ------------------------- | | -------------- | --------------- |
| Promise\<void>| 使用Promise形式返回结果 | | Promise\<void> | 使用Promise形式返回结果 |
**示例：** **示例：**
...@@ -527,9 +527,9 @@ getProcessInfo(callback: AsyncCallback\<ProcessInfo>): void ...@@ -527,9 +527,9 @@ getProcessInfo(callback: AsyncCallback\<ProcessInfo>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | --------------------------- | ---- | -------------------- | | -------- | --------------------------- | ---- | ---------- |
| callback | AsyncCallback\<ProcessInfo> | 是 | 返回当前进程的信息。 | | callback | AsyncCallback\<ProcessInfo> | 是 | 返回当前进程的信息。 |
**示例：** **示例：**
...@@ -551,8 +551,8 @@ getProcessInfo(): Promise\<ProcessInfo> ...@@ -551,8 +551,8 @@ getProcessInfo(): Promise\<ProcessInfo>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | -------------- | | --------------------- | ------- |
| Promise\<ProcessInfo> | 当前进程的信息 | | Promise\<ProcessInfo> | 当前进程的信息 |
**示例：** **示例：**
...@@ -580,9 +580,9 @@ getElementName(callback: AsyncCallback\<ElementName>): void ...@@ -580,9 +580,9 @@ getElementName(callback: AsyncCallback\<ElementName>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | --------------------------- | ---- | ---------------------------------------------- | | -------- | --------------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback\<ElementName> | 是 | 返回当前ability的ohos.bundle.ElementName对象。 | | callback | AsyncCallback\<ElementName> | 是 | 返回当前ability的ohos.bundle.ElementName对象。 |
**示例：** **示例：**
...@@ -606,8 +606,8 @@ getElementName(): Promise\<ElementName> ...@@ -606,8 +606,8 @@ getElementName(): Promise\<ElementName>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ------------------------------------------ | | --------------------- | ------------------------------------ |
| Promise\<ElementName> | 当前ability的ohos.bundle.ElementName对象。 | | Promise\<ElementName> | 当前ability的ohos.bundle.ElementName对象。 |
**示例：** **示例：**
...@@ -631,9 +631,9 @@ getProcessName(callback: AsyncCallback\<string>): void ...@@ -631,9 +631,9 @@ getProcessName(callback: AsyncCallback\<string>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | -------------------- | | -------- | ---------------------- | ---- | ---------- |
| callback | AsyncCallback\<string> | 是 | 返回当前进程的名称。 | | callback | AsyncCallback\<string> | 是 | 返回当前进程的名称。 |
**示例：** **示例：**
...@@ -655,8 +655,8 @@ getProcessName(): Promise\<string> ...@@ -655,8 +655,8 @@ getProcessName(): Promise\<string>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | -------------------- | | ---------------- | ---------- |
| Promise\<string> | 返回当前进程的名称。 | | Promise\<string> | 返回当前进程的名称。 |
**示例：** **示例：**
...@@ -682,9 +682,9 @@ getCallingBundle(callback: AsyncCallback\<string>): void ...@@ -682,9 +682,9 @@ getCallingBundle(callback: AsyncCallback\<string>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------------- | | -------- | ---------------------- | ---- | ---------------- |
| callback | AsyncCallback\<string> | 是 | 返回调用ability的包名称。 | | callback | AsyncCallback\<string> | 是 | 返回调用ability的包名称。 |
**示例：** **示例：**
...@@ -706,8 +706,8 @@ getCallingBundle(): Promise\<string> ...@@ -706,8 +706,8 @@ getCallingBundle(): Promise\<string>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------- | ------------------------- | | ---------------- | -------------- |
| Promise\<string> | 调用ability的包名称。 | | Promise\<string> | 调用ability的包名称。 |
**示例：** **示例：**
...@@ -731,9 +731,9 @@ getCacheDir(callback: AsyncCallback\<string>): void ...@@ -731,9 +731,9 @@ getCacheDir(callback: AsyncCallback\<string>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------------- | | -------- | ---------------------- | ---- | --------------- |
| callback | AsyncCallback\<string> | 是 | 返回该应用程序的内部存储目录。| | callback | AsyncCallback\<string> | 是 | 返回该应用程序的内部存储目录。 |
**示例：** **示例：**
...@@ -759,8 +759,8 @@ getCacheDir(): Promise\<string> ...@@ -759,8 +759,8 @@ getCacheDir(): Promise\<string>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------- | ------------------------- | | ---------------- | --------------- |
| Promise\<string> | 获取该应用程序的内部存储目录。 | | Promise\<string> | 获取该应用程序的内部存储目录。 |
**示例：** **示例：**
...@@ -784,9 +784,9 @@ getFilesDir(callback: AsyncCallback\<string>): void ...@@ -784,9 +784,9 @@ getFilesDir(callback: AsyncCallback\<string>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------------- | | -------- | ---------------------- | ---- | ------------------- |
| callback | AsyncCallback\<string> | 是 | 返回内部存储器上此应用程序的文件目录。| | callback | AsyncCallback\<string> | 是 | 返回内部存储器上此应用程序的文件目录。 |
**示例：** **示例：**
...@@ -812,8 +812,8 @@ getFilesDir(): Promise\<string> ...@@ -812,8 +812,8 @@ getFilesDir(): Promise\<string>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------- | ------------------------- | | ---------------- | ------------------- |
| Promise\<string> | 返回内部存储器上此应用程序的文件目录。 | | Promise\<string> | 返回内部存储器上此应用程序的文件目录。 |
**示例：** **示例：**
...@@ -839,9 +839,9 @@ getOrCreateDistributedDir(callback: AsyncCallback\<string>): void ...@@ -839,9 +839,9 @@ getOrCreateDistributedDir(callback: AsyncCallback\<string>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------------- | | -------- | ---------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback\<string> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回Ability或应用的分布式文件路径。如果分布式文件路径不存在，系统将创建一个路径并返回创建的路径。| | callback | AsyncCallback\<string> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回Ability或应用的分布式文件路径。如果分布式文件路径不存在，系统将创建一个路径并返回创建的路径。 |
**示例：** **示例：**
...@@ -869,8 +869,8 @@ getOrCreateDistributedDir(): Promise\<string> ...@@ -869,8 +869,8 @@ getOrCreateDistributedDir(): Promise\<string>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------- | ------------------------- | | ---------------- | ----------------------------------- |
| Promise\<string> | Ability或应用的分布式文件路径。如果是第一次调用，则将创建目录。 | | Promise\<string> | Ability或应用的分布式文件路径。如果是第一次调用，则将创建目录。 |
**示例：** **示例：**
...@@ -893,9 +893,9 @@ getAppType(callback: AsyncCallback\<string>): void ...@@ -893,9 +893,9 @@ getAppType(callback: AsyncCallback\<string>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------------- | | -------- | ---------------------- | ---- | -------------------------------- |
| callback | AsyncCallback\<string> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回此应用程序的类型。| | callback | AsyncCallback\<string> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回此应用程序的类型。 |
**示例：** **示例：**
...@@ -921,8 +921,8 @@ getAppType(): Promise\<string> ...@@ -921,8 +921,8 @@ getAppType(): Promise\<string>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------- | ------------------------- | | ---------------- | ------------------ |
| Promise\<string> | Promise形式返回此应用的类型。 | | Promise\<string> | Promise形式返回此应用的类型。 |
**示例：** **示例：**
...@@ -945,9 +945,9 @@ getHapModuleInfo(callback: AsyncCallback\<HapModuleInfo>): void ...@@ -945,9 +945,9 @@ getHapModuleInfo(callback: AsyncCallback\<HapModuleInfo>): 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\<HapModuleInfo> ...@@ -973,8 +973,8 @@ getHapModuleInfo(): Promise\<HapModuleInfo>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------- | ------------------------- | | ---------------------------------------- | ------------------ |
| Promise\<[HapModuleInfo](js-apis-bundle-HapModuleInfo.md)> | 返回应用的ModuleInfo对象。 | | Promise\<[HapModuleInfo](js-apis-bundle-HapModuleInfo.md)> | 返回应用的ModuleInfo对象。 |
**示例：** **示例：**
...@@ -997,9 +997,9 @@ getAppVersionInfo(callback: AsyncCallback\<AppVersionInfo>): void ...@@ -997,9 +997,9 @@ getAppVersionInfo(callback: AsyncCallback\<AppVersionInfo>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------------- | | -------- | ---------------------------------------- | ---- | ------------------------------ |
| callback | AsyncCallback\<[AppVersionInfo](#appversioninfo)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回应用版本信息。| | callback | AsyncCallback\<[AppVersionInfo](#appversioninfo)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回应用版本信息。 |
**示例：** **示例：**
...@@ -1025,8 +1025,8 @@ getAppVersionInfo(): Promise\<AppVersionInfo> ...@@ -1025,8 +1025,8 @@ getAppVersionInfo(): Promise\<AppVersionInfo>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------- | ------------------------- | | ---------------------------------------- | --------- |
| Promise\<[AppVersionInfo](#appversioninfo)> | 返回应用版本信息。 | | Promise\<[AppVersionInfo](#appversioninfo)> | 返回应用版本信息。 |
**示例：** **示例：**
...@@ -1049,9 +1049,9 @@ getAbilityInfo(callback: AsyncCallback\<AbilityInfo>): void ...@@ -1049,9 +1049,9 @@ getAbilityInfo(callback: AsyncCallback\<AbilityInfo>): 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\<AbilityInfo> ...@@ -1077,8 +1077,8 @@ getAbilityInfo(): Promise\<AbilityInfo>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------- | ------------------------- | | ---------------------------------------- | ------------------ |
| Promise\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 返回当前归属Ability详细信息。 | | Promise\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 返回当前归属Ability详细信息。 |
**示例：** **示例：**
...@@ -1101,9 +1101,9 @@ getApplicationContext(): Context ...@@ -1101,9 +1101,9 @@ getApplicationContext(): Context
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------- |------ | | ------- | ---------- |
| Context | 返回应用上下文信息。 | | Context | 返回应用上下文信息。 |
**示例：** **示例：**
...@@ -1122,9 +1122,9 @@ isUpdatingConfigurations(callback: AsyncCallback\<boolean>): void; ...@@ -1122,9 +1122,9 @@ isUpdatingConfigurations(callback: AsyncCallback\<boolean>): void;
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------------- | | -------- | ----------------------- | ---- | ----------------------------- |
| callback | AsyncCallback\<boolean> | 是 | 如果该能力的配置正在更改，则为true，否则为false。| | callback | AsyncCallback\<boolean> | 是 | 如果该能力的配置正在更改，则为true，否则为false。 |
**示例：** **示例：**
...@@ -1150,9 +1150,9 @@ isUpdatingConfigurations(): Promise\<boolean>; ...@@ -1150,9 +1150,9 @@ isUpdatingConfigurations(): Promise\<boolean>;
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------- | ------------------------- | | ----------------- | ----------------------------- |
|Promise\<boolean> | 如果该能力的配置正在更改，则为true，否则为false。 | | Promise\<boolean> | 如果该能力的配置正在更改，则为true，否则为false。 |
**示例：** **示例：**
...@@ -1174,9 +1174,9 @@ printDrawnCompleted(callback: AsyncCallback\<void>): void; ...@@ -1174,9 +1174,9 @@ printDrawnCompleted(callback: AsyncCallback\<void>): void;
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------------- | | -------- | -------------------- | ---- | ----------- |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。| | callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 |
**示例：** **示例：**
...@@ -1202,9 +1202,9 @@ printDrawnCompleted(): Promise\<void>; ...@@ -1202,9 +1202,9 @@ printDrawnCompleted(): Promise\<void>;
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------- | ------------------------- | | -------------- | --------------- |
|Promise\<void> | 以Promise形式返回结果。 | | Promise\<void> | 以Promise形式返回结果。 |
**示例：** **示例：**
...@@ -1221,27 +1221,27 @@ context.printDrawnCompleted().then((data) => { ...@@ -1221,27 +1221,27 @@ context.printDrawnCompleted().then((data) => {
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ------ | ---- | ------ | | ---- | ---- | ------ | ---- | ----- |
| pid | 只读 | number | 否 | 进程id。 | | pid | 只读 | number | 否 | 进程id。 |
| uid | 只读 | number | 否 | 用户id。 | | uid | 只读 | number | 否 | 用户id。 |
## PermissionRequestResult<sup>7+</sup> ## PermissionRequestResult<sup>7+</sup>
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------- | ---- | ------------------ | | ----------- | ---- | -------------- | ---- | ---------- |
| requestCode | 只读 | number | 是 | 用户传入的请求代码。 | | requestCode | 只读 | number | 是 | 用户传入的请求代码。 |
| permissions | 只读 | Array\<string> | 是 | 用户传入的权限。 | | permissions | 只读 | Array\<string> | 是 | 用户传入的权限。 |
| authResults | 只读 | Array\<number> | 是 | 请求权限的结果。 | | authResults | 只读 | Array\<number> | 是 | 请求权限的结果。 |
## AppVersionInfo<sup>7+</sup> ## AppVersionInfo<sup>7+</sup>
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------| ------ | ------ | | ----------- | ------ | ---- | ---- | ------- |
| appName | string | 是 | 否 | 模块名称。 | | appName | string | 是 | 否 | 模块名称。 |
| versionCode | number | 是 | 否 | 模块描述信息。 | | versionCode | number | 是 | 否 | 模块描述信息。 |
| versionName | string | 是 | 否 | 描述信息ID。 | | versionName | string | 是 | 否 | 描述信息ID。 |
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md
浏览文件 @ aca19f3d
# Web # Web
> **说明：** > **说明：**
> 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 >
> - 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
> - 示例效果请以真机运行为准，当前IDE预览器不支持。
提供具有网页显示能力的Web组件。 提供具有网页显示能力的Web组件。
...@@ -81,7 +83,7 @@ fileAccess(fileAccess: boolean) ...@@ -81,7 +83,7 @@ fileAccess(fileAccess: boolean)
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------- | ------- | ---- | ---- | ---------------------------------------- | | ---------- | ------- | ---- | ---- | ---------------------------------------- |
| fileAccess | boolean | 是 | - | 设置是否开启通过[$rawfile(filepath/filename)](../../ui/ts-resource-access.md)访问应用中rawfile路径的文件。 | | fileAccess | boolean | 是 | true | 设置是否开启通过[$rawfile(filepath/filename)](../../ui/ts-resource-access.md)访问应用中rawfile路径的文件，默认启用。 |
**示例：** **示例：**
```ts ```ts
...@@ -106,9 +108,9 @@ fileFromUrlAccess(fileFromUrlAccess: boolean) ...@@ -106,9 +108,9 @@ fileFromUrlAccess(fileFromUrlAccess: boolean)
设置是否允许通过网页中的JavaScript脚本访问[$rawfile(filepath/filename)](../../ui/ts-resource-access.md)的内容，默认未启用。 设置是否允许通过网页中的JavaScript脚本访问[$rawfile(filepath/filename)](../../ui/ts-resource-access.md)的内容，默认未启用。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----------------- | ------- | ---- | ---- | ---------------------------------------- | | ----------------- | ------- | ---- | ----- | ---------------------------------------- |
| fileFromUrlAccess | boolean | 是 | - | 设置是否允许通过网页中的JavaScript脚本访问[$rawfile(filepath/filename)](../../ui/ts-resource-access.md)的内容。 | | fileFromUrlAccess | boolean | 是 | false | 设置是否允许通过网页中的JavaScript脚本访问[$rawfile(filepath/filename)](../../ui/ts-resource-access.md)的内容，默认未启用。 |
**示例：** **示例：**
```ts ```ts
...@@ -2849,9 +2851,9 @@ static getOriginQuota(origin : string, callback : AsyncCallback\<number>) : void ...@@ -2849,9 +2851,9 @@ static getOriginQuota(origin : string, callback : AsyncCallback\<number>) : void
使用callback回调异步获取指定源的Web SQL数据库的存储配额，配额以字节为单位。 使用callback回调异步获取指定源的Web SQL数据库的存储配额，配额以字节为单位。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | --------- | | -------- | ---------------------- | ---- | --------- |
| origin | string | 是 | 指定源的字符串索引 | | origin | string | 是 | 指定源的字符串索引 |
| callback | AsyncCallback\<number> | 是 | 指定源的存储配额。 | | callback | AsyncCallback\<number> | 是 | 指定源的存储配额。 |
**示例：** **示例：**
...@@ -2893,8 +2895,8 @@ static getOriginQuota(origin : string) : Promise\<number> ...@@ -2893,8 +2895,8 @@ static getOriginQuota(origin : string) : Promise\<number>
| origin | string | 是 | 指定源的字符串索引。 | | origin | string | 是 | 指定源的字符串索引。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------- | ----------------------- | | ---------------- | ----------------------- |
| Promise\<number> | Promise实例，用于获取指定源的存储配额。 | | Promise\<number> | Promise实例，用于获取指定源的存储配额。 |
**示例：** **示例：**
...@@ -2931,9 +2933,9 @@ static getOriginUsage(origin : string, callback : AsyncCallback\<number>) : void ...@@ -2931,9 +2933,9 @@ static getOriginUsage(origin : string, callback : AsyncCallback\<number>) : void
以回调方式异步获取指定源的Web SQL数据库的存储量，存储量以字节为单位。 以回调方式异步获取指定源的Web SQL数据库的存储量，存储量以字节为单位。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ---------- | | -------- | ---------------------- | ---- | ---------- |
| origin | string | 是 | 指定源的字符串索引。 | | origin | string | 是 | 指定源的字符串索引。 |
| callback | AsyncCallback\<number> | 是 | 指定源的存储量。 | | callback | AsyncCallback\<number> | 是 | 指定源的存储量。 |
**示例：** **示例：**
...@@ -2975,8 +2977,8 @@ static getOriginUsage(origin : string) : Promise\<number> ...@@ -2975,8 +2977,8 @@ static getOriginUsage(origin : string) : Promise\<number>
| origin | string | 是 | 指定源的字符串索引。 | | origin | string | 是 | 指定源的字符串索引。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------- | ---------------------- | | ---------------- | ---------------------- |
| Promise\<number> | Promise实例，用于获取指定源的存储量。 | | Promise\<number> | Promise实例，用于获取指定源的存储量。 |
**示例：** **示例：**
......
zh-cn/application-dev/ui/ts-event-configuration.md
浏览文件 @ aca19f3d
# 事件配置 # 事件配置
通过事件方法可以配置组件支持的事件。 通过事件方法可以配置组件支持的事件。从API Version 9开始，可以在回调函数中获取当前component关联的Context，具体用法请参考[在eTS页面中访问Context](../ability/context-userguide.md)。
- 使用lambda表达式配置组件的事件方法： - 使用lambda表达式配置组件的事件方法：
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或