Skip to content

D
Docs

Tonvia / Docs
与 Fork 源项目一致

Fork自 OpenHarmony / Docs

通知 1
Star 0
Fork 0
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

未验证 提交 ac4719d5 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!12147 【仅API一致性规范整改】【元能力】文档描述修改 

Merge pull request !12147 from donglin/specification
上级 7f2ce875 c0fbeea5
展开全部 隐藏空白更改
内联 并排
Showing with 261 addition and 2411 deletion
zh-cn/application-dev/reference/apis/Readme-CN.md
浏览文件 @ ac4719d5
......@@ -22,7 +22,6 @@
- [@ohos.application.DataShareExtensionAbility (数据共享扩展能力)](js-apis-application-DataShareExtensionAbility.md)
- [@ohos.app.ability.EnvironmentCallback (EnvironmentCallback)](js-apis-app-ability-EnvironmentCallback.md)
- [@ohos.application.EnvironmentCallback (EnvironmentCallback)](js-apis-application-EnvironmentCallback.md)
- [@ohos.app.ability.FormExtension (FormExtension)](js-apis-app-ability-formextension.md)
- [@ohos.application.FormExtension (FormExtension)](js-apis-formextension.md)
- [@ohos.app.ability.ServiceExtensionAbility (ServiceExtensionAbility)](js-apis-app-ability-service-extension-ability.md)
- [@ohos.app.form.FormExtensionAbility.d.ts](FormExtensionAbility)(js-apis-app-form-formextensionability.md)
......@@ -60,14 +59,10 @@
- [@ohos.application.ConfigurationConstant (ConfigurationConstant)](js-apis-application-configurationConstant.md)
- [@ohos.app.ability.errorManager (ErrorManager)](js-apis-app-ability-errorManager.md)
- [@ohos.application.errorManager (ErrorManager)](js-apis-errorManager.md)
- [@ohos.app.abiltiy.formBindingData (卡片数据绑定类)](js-apis-app-ability-formbindingdata.md)
- [@ohos.application.formBindingData (卡片数据绑定类)](js-apis-formbindingdata.md)
- [@ohos.application.formError (FormError)](js-apis-formerror.md)
- [@ohos.app.ability.formHost (FormHost)](js-apis-app-ability-formhost.md)
- [@ohos.application.formHost (FormHost)](js-apis-formhost.md)
- [@ohos.app.ability.formInfo (FormInfo)](js-apis-app-ability-formInfo.md)
- [@ohos.application.formInfo (FormInfo)](js-apis-formInfo.md)
- [@ohos.app.ability.formProvider (FormProvider)](js-apis-app-ability-formprovider.md)
- [@ohos.application.formProvider (FormProvider)](js-apis-formprovider.md)
- [@ohos.app.ability.missionManager (missionManager)](js-apis-app-ability-missionManager.md)
- [@oho.app.form.formBindingData (卡片数据绑定类)](js-apis-app-form-formbindingdata.md)
......
zh-cn/application-dev/reference/apis/js-apis-Context.md
浏览文件 @ ac4719d5
......@@ -31,7 +31,7 @@ getOrCreateLocalDir(callback: AsyncCallback\<string>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------- |
| callback | AsyncCallback\<string> | 是 | 返回应用程序的本地根目录。 |
......@@ -85,7 +85,7 @@ verifyPermission(permission: string, options: PermissionOptions, callback: Async
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| ---------- | --------------------------------------- | ---- | -------------------- |
| permission | string | 是 | 指定权限的名称。 |
| options | [PermissionOptions](#permissionoptions7) | 是 | 权限选项。 |
......@@ -116,7 +116,7 @@ verifyPermission(permission: string, callback: AsyncCallback\<number>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| ---------- | ---------------------- | ---- | -------------------- |
| permission | string | 是 | 指定权限的名称。 |
| callback | AsyncCallback\<number> | 是 | 返回权限验证结果，0有权限，-1无权限。 |
......@@ -141,7 +141,7 @@ verifyPermission(permission: string, options?: PermissionOptions): Promise\<numb
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| ---------- | --------------------------------------- | ---- | -------- |
| permission | string | 是 | 指定权限的名称。 |
| options | [PermissionOptions](#permissionoptions) | 否 | 权限选项。 |
......@@ -175,7 +175,7 @@ requestPermissionsFromUser(permissions: Array\<string>, requestCode: number, res
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------------- | ---------------------------------------- | ---- | ----------------------------------- |
| permissions | Array\<string> | 是 | 指示要请求的权限列表。此参数不能为null。 |
| requestCode | number | 是 | 指示要传递给PermissionRequestResult的请求代码。 |
......@@ -210,7 +210,7 @@ requestPermissionsFromUser(permissions: Array\<string>, requestCode: number): Pr
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------------- | ------------------- | ----- | -------------------------------------------- |
| permissions | Array\<string> | 是 | 指示要请求的权限列表。此参数不能为null。 |
| requestCode | number | 是 | 指示要传递给PermissionRequestResult的请求代码。 |
......@@ -250,7 +250,7 @@ getApplicationInfo(callback: AsyncCallback\<ApplicationInfo>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ------------------------------- | ---- | ------------ |
| callback | AsyncCallback\<ApplicationInfo> | 是 | 返回当前应用程序的信息。 |
......@@ -302,7 +302,7 @@ getBundleName(callback: AsyncCallback\<string>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------ |
| callback | AsyncCallback\<string> | 是 | 返回当前ability的捆绑包名称。 |
......@@ -352,7 +352,7 @@ getDisplayOrientation(callback: AsyncCallback\<bundle.DisplayOrientation>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ------------------------------------------------------------ | ---- | ------------------ |
| callback | AsyncCallback\<[bundle.DisplayOrientation](js-apis-Bundle.md#displayorientation)> | 是 | 表示屏幕显示方向。 |
......@@ -400,7 +400,7 @@ getExternalCacheDir(callback: AsyncCallback\<string>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------ |
| callback | AsyncCallback\<string> | 是 | 返回应用程序的缓存目录的绝对路径。 |
......@@ -448,7 +448,7 @@ setDisplayOrientation(orientation: bundle.DisplayOrientation, callback: AsyncCal
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| ----------- | ---------------------------------------- | ---- | ------------ |
| orientation | [bundle.DisplayOrientation](js-apis-Bundle.md#displayorientation) | 是 | 指示当前能力的新方向。。 |
| callback | AsyncCallback\<void> | 是 | 表示屏幕显示方向。 |
......@@ -502,7 +502,7 @@ setShowOnLockScreen(show: boolean, callback: AsyncCallback\<void>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | ---------------------------------------- |
| show | boolean | 是 | 指定是否在锁屏顶部显示此功能。值true表示在锁屏上显示，值false表示不显示。 |
| callback | AsyncCallback\<void> | 是 | 返回回调结果。 |
......@@ -528,7 +528,7 @@ setShowOnLockScreen(show: boolean): Promise\<void>;
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| ---- | ------- | ---- | ---------------------------------------- |
| show | boolean | 是 | 指定是否在锁屏顶部显示此功能。值true表示在锁屏上显示，值false表示不显示。 |
......@@ -559,7 +559,7 @@ setWakeUpScreen(wakeUp: boolean, callback: AsyncCallback\<void>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | --------------------------------- |
| wakeUp | boolean | 是 | 指定是否唤醒屏幕。值true表示唤醒它，值false表示不唤醒它。 |
| callback | AsyncCallback\<void> | 是 | 返回回调结果。 |
......@@ -585,7 +585,7 @@ setWakeUpScreen(wakeUp: boolean): Promise\<void>;
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| ------ | ------- | ---- | --------------------------------- |
| wakeUp | boolean | 是 | 指定是否唤醒屏幕。值true表示唤醒它，值false表示不唤醒它。 |
......@@ -619,7 +619,7 @@ getProcessInfo(callback: AsyncCallback\<ProcessInfo>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | --------------------------- | ---- | ---------- |
| callback | AsyncCallback\<ProcessInfo> | 是 | 返回当前进程的信息。 |
......@@ -673,7 +673,7 @@ getElementName(callback: AsyncCallback\<ElementName>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | --------------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback\<ElementName> | 是 | 返回当前ability的ohos.bundle.ElementName对象。 |
......@@ -725,7 +725,7 @@ getProcessName(callback: AsyncCallback\<string>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ---------- |
| callback | AsyncCallback\<string> | 是 | 返回当前进程的名称。 |
......@@ -777,7 +777,7 @@ getCallingBundle(callback: AsyncCallback\<string>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ---------------- |
| callback | AsyncCallback\<string> | 是 | 返回调用ability的包名称。 |
......@@ -827,7 +827,7 @@ getCacheDir(callback: AsyncCallback\<string>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | --------------- |
| callback | AsyncCallback\<string> | 是 | 返回该应用程序的内部存储目录。 |
......@@ -875,7 +875,7 @@ getFilesDir(callback: AsyncCallback\<string>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------- |
| callback | AsyncCallback\<string> | 是 | 返回内部存储器上此应用程序的文件目录。 |
......@@ -925,7 +925,7 @@ getOrCreateDistributedDir(callback: AsyncCallback\<string>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback\<string> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回Ability或应用的分布式文件路径。如果分布式文件路径不存在，系统将创建一个路径并返回创建的路径。 |
......@@ -975,7 +975,7 @@ getAppType(callback: AsyncCallback\<string>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | -------------------------------- |
| callback | AsyncCallback\<string> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回此应用程序的类型。 |
......@@ -1023,7 +1023,7 @@ getHapModuleInfo(callback: AsyncCallback\<HapModuleInfo>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ---------------------------------------- | ---- | --------------------------------------- |
| callback | AsyncCallback\<[HapModuleInfo](js-apis-bundle-HapModuleInfo.md)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回应用的ModuleInfo对象。 |
......@@ -1071,7 +1071,7 @@ getAppVersionInfo(callback: AsyncCallback\<AppVersionInfo>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ---------------------------------------- | ---- | ------------------------------ |
| callback | AsyncCallback\<[AppVersionInfo](#appversioninfo)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回应用版本信息。 |
......@@ -1119,7 +1119,7 @@ getAbilityInfo(callback: AsyncCallback\<AbilityInfo>): void
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ---------------------------------------- | ---- | --------------------------------------- |
| callback | AsyncCallback\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回当前归属Ability详细信息。 |
......@@ -1188,7 +1188,7 @@ isUpdatingConfigurations(callback: AsyncCallback\<boolean>): void;
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | ----------------------------- |
| callback | AsyncCallback\<boolean> | 是 | 如果该能力的配置正在更改，则为true，否则为false。 |
......@@ -1236,7 +1236,7 @@ printDrawnCompleted(callback: AsyncCallback\<void>): void;
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | ----------- |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 |
......@@ -1279,20 +1279,20 @@ context.printDrawnCompleted().then((data) => {
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | ---- | ------ | ---- | ----- |
| pid | 只读 | number | 否 | 进程id。 |
| uid | 只读 | number | 否 | 用户id。 |
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| ---- | ---- |-------- | ------ | ---- | ----- |
| pid | 是 | 否 | number | 否 | 进程id。 |
| uid | 是 | 否 | number | 否 | 用户id。 |
## PermissionRequestResult<sup>7+</sup>
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | ---- | -------------- | ---- | ---------- |
| requestCode | 只读 | number | 是 | 用户传入的请求代码。 |
| permissions | 只读 | Array\<string> | 是 | 用户传入的权限。 |
| authResults | 只读 | Array\<number> | 是 | 请求权限的结果。 |
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| ----------- | ---- |-------- | -------------- | ---- | ---------- |
| requestCode | 是 | 否 | number | 是 | 用户传入的请求代码。 |
| permissions | 是 | 否 | Array\<string> | 是 | 用户传入的权限。 |
| authResults | 是 | 否 | Array\<number> | 是 | 请求权限的结果。 |
## AppVersionInfo<sup>7+</sup>
......
zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md
浏览文件 @ ac4719d5
......@@ -22,7 +22,7 @@ getId(uri: string): number
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中获取ID的uri对象。 |
......@@ -50,7 +50,7 @@ attachId(uri: string, id: number): string
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中获取ID的uri对象。 |
| id | number | 是 | 指示要附加的ID。 |
......@@ -83,7 +83,7 @@ deleteId(uri: string): string
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中删除ID的uri对象。 |
......@@ -111,7 +111,7 @@ updateId(uri: string, id: number): string
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------------- |
| uri | string | 是 | 指示要更新的uri对象 |
| id | number | 是 | 指示新ID |
......
zh-cn/application-dev/reference/apis/js-apis-ability-Want.md
浏览文件 @ ac4719d5
......@@ -8,18 +8,18 @@ Want是对象间信息传递的载体, 可以用于应用组件间的信息传
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 |
| bundleName | 只读 | string | 否 | 表示包名。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 |
| uri | 只读 | string | 否 | 表示Uri。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 |
| type | 只读 | string | 否 | 表示MIME type类型，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 |
| flags | 只读 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-featureAbility.md#flags说明)。 |
| action | 只读 | string | 否 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。 |
| parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams，由开发者自行决定传入的键值对。默认会携带以下key值：<br>ohos.aafwk.callerPid 表示拉起方的pid。<br>ohos.aafwk.param.callerToken 表示拉起方的token。<br>ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。 |
| entities | 只读 | Array\<string> | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 |
| moduleName<sup>9+</sup> | 只读 | string | 否 | 表示待启动的Ability所属的模块（module）。 |
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ |
| deviceId | 是 | 否 | string | 否 | 表示运行指定Ability的设备ID。 |
| bundleName | 是 | 否 | string | 否 | 表示包名。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| abilityName | 是 | 否 | string | 否 | 表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 |
| uri | 是 | 否 | string | 否 | 表示Uri。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 |
| type | 是 | 否 | string | 否 | 表示MIME type类型，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 |
| flags | 是 | 否 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-featureAbility.md#flags说明)。 |
| action | 是 | 否 | string | 否 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。 |
| parameters | 是 | 否 | {[key: string]: any} | 否 | 表示WantParams，由开发者自行决定传入的键值对。默认会携带以下key值：<br>ohos.aafwk.callerPid 表示拉起方的pid。<br>ohos.aafwk.param.callerToken 表示拉起方的token。<br>ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。 |
| entities | 是 | 否 | Array\<string> | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 |
| moduleName<sup>9+</sup> | 是 | 否 | string | 否 | 表示待启动的Ability所属的模块（module）。 |
具体字段描述参考ability/want.d.ts文件
......
zh-cn/application-dev/reference/apis/js-apis-ability-ability.md
浏览文件 @ ac4719d5
......@@ -15,15 +15,15 @@ import ability from '@ohos.ability.ability'
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| DataAbilityHelper | 只读 | number | 否 | DataAbilityHelper二级模块。 |
| PacMap | 只读 | Want | 否 | PacMap二级模块。 |
| DataAbilityOperation | 只读 | Want | 否 | DataAbilityOperation二级模块。 |
| DataAbilityResult | 只读 | Want | 否 | DataAbilityResult二级模块。 |
| AbilityResult | 只读 | Want | 否 | AbilityResult二级模块。 |
| ConnectOptions | 只读 | Want | 否 | ConnectOptions二级模块。 |
| StartAbilityParameter | 只读 | Want | 否 | StartAbilityParameter二级模块。 |
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ |
| DataAbilityHelper | 是 | 否 | number | 否 | DataAbilityHelper二级模块。 |
| PacMap | 是 | 否 | Want | 否 | PacMap二级模块。 |
| DataAbilityOperation | 是 | 否 | Want | 否 | DataAbilityOperation二级模块。 |
| DataAbilityResult | 是 | 否 | Want | 否 | DataAbilityResult二级模块。 |
| AbilityResult | 是 | 否 | Want | 否 | AbilityResult二级模块。 |
| ConnectOptions | 是 | 否 | Want | 否 | ConnectOptions二级模块。 |
| StartAbilityParameter | 是 | 否 | Want | 否 | StartAbilityParameter二级模块。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-ability-abilityResult.md
浏览文件 @ ac4719d5
......@@ -4,10 +4,10 @@
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| resultCode | 只读 | number | 否 | 表示ability拉起、销毁之后返回的结果码。 |
| want | 只读 | [Want](js-apis-ability-Want.md) | 否 | 表示ability销毁之后返回的数据。 |
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ |
| resultCode | 是 | 否 | number | 否 | 表示ability拉起、销毁之后返回的结果码。 |
| want | 是 | 否 | [Want](js-apis-ability-Want.md) | 否 | 表示ability销毁之后返回的数据。 |
**示例：**
```ts
......
zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md
浏览文件 @ ac4719d5
......@@ -20,7 +20,7 @@ import errorCode from '@ohos.ability.errorCode'
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ------------------------------ | ---- | ---------------------------------------- |
| NO_ERROR | 0 | 没有错误。 |
| INVALID_PARAMETER | -1 | 无效的参数。 |
......
zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md
浏览文件 @ ac4719d5
......@@ -18,7 +18,7 @@ want操作的常数。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 值 | 描述 |
| 名称 | 值 | 说明 |
| ------------ | ------------------ | ---------------------- |
| ACTION_HOME | ohos.want.action.home | 指示返回原点的操作。 |
| ACTION_DIAL | ohos.want.action.dial | 指示启动显示小键盘的页面功能的操作 |
......@@ -61,7 +61,7 @@ want实体的常数。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 值 | 描述 |
| 名称 | 值 | 说明 |
| ------------ | ------------------ | ---------------------- |
| ENTITY_DEFAULT | entity.system.default | 指示默认实体，如果未指定该实体，则使用该实体。 |
| ENTITY_HOME | entity.system.home | 指示主屏幕实体。 |
......@@ -76,7 +76,7 @@ Flags说明。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 值 | 描述 |
| 名称 | 值 | 说明 |
| ------------------------------------ | ---------- | ------------------------------------------------------------ |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权。 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权。 |
......
zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md
浏览文件 @ ac4719d5
......@@ -23,7 +23,7 @@ abilitymanager.getAbilityRunningInfos((err,data) => {
**系统API**：该接口为系统接口，三方应用不支持调用。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ability | ElementName | 是 | 否 | Ability匹配信息 |
| pid | number | 是 | 否 | 进程ID。 |
......
zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md
浏览文件 @ ac4719d5
......@@ -26,7 +26,7 @@ class MyAbilityStage extends AbilityStage {
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | AbilityStage对应的ModuleInfo对象。 |
| config | [Configuration](js-apis-configuration.md) | 是 | 否 | 环境变化对象。 |
zh-cn/application-dev/reference/apis/js-apis-accessibility-config.md
浏览文件 @ ac4719d5
......@@ -440,7 +440,7 @@ config.highContrastText.off((data) => {
**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称 | 描述 |
| 名称 | 说明 |
| -------- | -------- |
| Normal | 表示正常类型。 |
| Protanomaly | 表示红色弱视类型。 |
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-StartOptions.md
浏览文件 @ ac4719d5
......@@ -17,7 +17,7 @@ import StartOptions from '@ohos.app.ability.StartOptions';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 可读 | 可写 | 参数类型 | 必填 | 说明 |
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | -------- | -------- |
| [windowMode](js-apis-app-ability-abilityConstant.md#abilityconstantwindowmode) | 是 | 否 | number | 否 | 窗口模式。 |
| displayId | 是 | 否 | number | 否 | 显示ID。 |
zh-cn/application-dev/reference/apis/js-apis-app-ability-Want.md
浏览文件 @ ac4719d5
......@@ -8,18 +8,18 @@ Want是对象间信息传递的载体, 可以用于应用组件间的信息传
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 |
| bundleName | 只读 | string | 否 | 表示包名。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 |
| uri | 只读 | string | 否 | 表示Uri。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 |
| type | 只读 | string | 否 | 表示MIME type类型，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 |
| flags | 只读 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-featureAbility.md#flags说明)。 |
| action | 只读 | string | 否 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。 |
| parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams，由开发者自行决定传入的键值对。默认会携带以下key值：<br>ohos.aafwk.callerPid 表示拉起方的pid。<br>ohos.aafwk.param.callerToken 表示拉起方的token。<br>ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。 |
| entities | 只读 | Array\<string> | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 |
| moduleName<sup>9+</sup> | 只读 | string | 否 | 表示待启动的Ability所属的模块（module）。 |
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ |
| deviceId | 是 | 否 | string | 否 | 表示运行指定Ability的设备ID。 |
| bundleName | 是 | 否 | string | 否 | 表示包名。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| abilityName | 是 | 否 | string | 否 | 表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 |
| uri | 是 | 否 | string | 否 | 表示Uri。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 |
| type | 是 | 否 | string | 否 | 表示MIME type类型，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 |
| flags | 是 | 否 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-featureAbility.md#flags说明)。 |
| action | 是 | 否 | string | 否 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。 |
| parameters | 是 | 否 | {[key: string]: any} | 否 | 表示WantParams，由开发者自行决定传入的键值对。默认会携带以下key值：<br>ohos.aafwk.callerPid 表示拉起方的pid。<br>ohos.aafwk.param.callerToken 表示拉起方的token。<br>ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。 |
| entities | 是 | 否 | Array\<string> | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 |
| moduleName<sup>9+</sup> | 是 | 否 | string | 否 | 表示待启动的Ability所属的模块（module）。 |
具体字段描述参考ability/want.d.ts文件
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md
浏览文件 @ ac4719d5
......@@ -19,7 +19,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| launchReason | LaunchReason| 是 | 是 | 指示启动原因。 |
| lastExitReason | LastExitReason | 是 | 是 | 表示最后退出原因。 |
......@@ -30,7 +30,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| UNKNOWN | 0 | 未知的状态。 |
| START_ABILITY | 1 | 启动能力。 |
......@@ -45,7 +45,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| UNKNOWN | 0 | 未知的状态。 |
| ABILITY_NOT_RESPONDING | 1 | 能力没有反应 |
......@@ -58,7 +58,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| AGREE | 0 | 同意。 |
| REJECT | 1 | 拒绝。 |
......@@ -70,7 +70,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 取值 | 说明 |
| 名称 | 取值 | 说明 |
| --- | --- | --- |
| WINDOW_MODE_UNDEFINED | 0 | 未定义窗口模式。 |
| WINDOW_MODE_FULLSCREEN | 1 | 全屏模式。 |
......@@ -84,7 +84,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 取值 | 说明 |
| 名称 | 取值 | 说明 |
| --- | --- | --- |
| MEMORY_LEVEL_MODERATE | 0 | 内存占用适中。 |
| MEMORY_LEVEL_LOW | 1 | 内存占用低。 |
......@@ -96,7 +96,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| ALL_AGREE | 0 | 同意保存状态。 |
| CONTINUATION_REJECT | 1 | 拒绝迁移保存状态。 |
......@@ -111,7 +111,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| CONTINUATION | 0 | 迁移保存状态。 |
| APP_RECOVERY | 1 | 应用恢复保存状态。 |
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityLifecycleCallback.md
浏览文件 @ ac4719d5
......@@ -43,7 +43,7 @@ onWindowStageCreate(ability: Ability, windowStage: window.WindowStage): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 |
| windowStage | [WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 |
| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 |
## AbilityLifecycleCallback.onWindowStageActive
......@@ -59,7 +59,7 @@ onWindowStageActive(ability: Ability, windowStage: window.WindowStage): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 |
| windowStage | [WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 |
| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 |
## AbilityLifecycleCallback.onWindowStageInactive
......@@ -75,7 +75,7 @@ onWindowStageInactive(ability: Ability, windowStage: window.WindowStage): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 |
| windowStage | [WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 |
| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 |
## AbilityLifecycleCallback.onWindowStageDestroy
......@@ -91,7 +91,7 @@ onWindowStageDestroy(ability: Ability, windowStage: window.WindowStage): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 |
| windowStage | [WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 |
| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 |
## AbilityLifecycleCallback.onAbilityDestroy
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md
浏览文件 @ ac4719d5
......@@ -41,7 +41,7 @@ updateConfiguration(config: Configuration, callback: AsyncCallback\<void>): void
**参数**：
| 名称 | 类型 | 必填 | 描述 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 新的配置项。 |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法。 |
......@@ -77,7 +77,7 @@ updateConfiguration(config: Configuration): Promise\<void>
**参数**：
| 名称 | 类型 | 必填 | 描述 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 新的配置项。 |
......@@ -120,7 +120,7 @@ getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): vo
**参数**：
| 名称 | 类型 | 必填 | 描述 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<Array\<AbilityRunningInfo>> | 是 | 被指定的回调方法。 |
......@@ -184,7 +184,7 @@ getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<Ext
**参数**：
| 名称 | 类型 | 必填 | 描述 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| upperLimit | number | 是 | 获取消息数量的最大限制。 |
| callback | AsyncCallback\<Array\<AbilityRunningInfo>> | 是 | 被指定的回调方法。 |
......@@ -218,7 +218,7 @@ getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningIn
**参数**：
| 名称 | 类型 | 必填 | 描述 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| upperLimit | number | 是 | 获取消息数量的最大限制。 |
......@@ -257,7 +257,7 @@ getTopAbility(callback: AsyncCallback\<ElementName>): void;
**参数**：
| 名称 | 类型 | 必填 | 描述 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<ElementName> | 是 | 被指定的回调方法。 |
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md
浏览文件 @ ac4719d5
......@@ -18,7 +18,7 @@ import appRecovery from '@ohos.app.ability.appRecovery'
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| ALWAYS_RESTART | 0 | 总是重启应用。 |
| CPP_CRASH_NO_RESTART | 1 | 发生CPP_CRASH时不重启应用。 |
......@@ -32,7 +32,7 @@ import appRecovery from '@ohos.app.ability.appRecovery'
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| SAVE_WHEN_ERROR | 1 | 当发生应用故障时保存。 |
| SAVE_WHEN_BACKGROUND | 2 | 当应用切入后台时保存。 |
......@@ -43,7 +43,7 @@ import appRecovery from '@ohos.app.ability.appRecovery'
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| SAVE_WITH_FILE | 1 | 每次状态保存都会写入到本地文件缓存。 |
| SAVE_WITH_SHARED_MEMORY | 2 | 状态先保存在内存中，应用故障退出时写入到本地文件缓存。 |
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-appmanager.md
浏览文件 @ ac4719d5
......@@ -908,11 +908,11 @@ onProcessDied(processData: ProcessData): void;
**系统API**：该接口为系统接口，三方应用不支持调用。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| bundleName | 只读 | string | 否 | 包名。 |
| uid | 只读 | number | 否 | 用户ID。 |
| state | 只读 | number | 否 | 应用状态。 |
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ |
| bundleName | 是 | 否 | string | 否 | 包名。 |
| uid | 是 | 否 | number | 否 | 用户ID。 |
| state | 是 | 否 | number | 否 | 应用状态。 |
## AbilityStateData
......@@ -948,12 +948,12 @@ onProcessDied(processData: ProcessData): void;
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| pid | 只读 | number | 否 | 进程ID。 |
| uid | 只读 | number | 否 | 用户ID。 |
| processName | 只读 | string | 否 | 进程的名称。 |
| bundleNames | 只读 | Array\<string> | 否 | 进程中运行的bundleName数组。 |
| pid | 是 | 否 | number | 否 | 进程ID。 |
| uid | 是 | 否 | number | 否 | 用户ID。 |
| processName | 是 | 否 | string | 否 | 进程的名称。 |
| bundleNames | 是 | 否 | Array\<string> | 否 | 进程中运行的bundleName数组。 |
## ApplicationStateObserver
......@@ -974,12 +974,12 @@ onProcessDied(processData: ProcessData): void;
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| pid | 只读 | number | 否 | 进程ID。 |
| uid | 只读 | number | 否 | 用户ID。 |
| processName | 只读 | string | 否 | 进程的名称。 |
| bundleNames | 只读 | Array\<string> | 否 | 进程中运行的bundleName数组。 |
| pid | 是 | 否 | number | 否 | 进程ID。 |
| uid | 是 | 否 | number | 否 | 用户ID。 |
| processName | 是 | 否 | string | 否 | 进程的名称。 |
| bundleNames | 是 | 否 | Array\<string> | 否 | 进程中运行的bundleName数组。 |
## ApplicationState
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md
浏览文件 @ ac4719d5
......@@ -8,7 +8,7 @@
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| language | string | 是 | 是 | 表示应用程序的当前语言。 |
| colorMode | [ColorMode](js-apis-app-ability-configurationconstant.md#configurationconstantcolormode) | 是 | 是 | 表示深浅色模式，取值范围：浅色模式（COLOR_MODE_LIGHT），深色模式（COLOR_MODE_DARK）。默认为浅色。 |
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-formInfo.md 已删除 100644 → 0
浏览文件 @ 7f2ce875
# FormInfo
FormInfo模块提供对卡片的相关卡片信息和状态进行设置和查询的能力。
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```
import formInfo from '@ohos.app.ability.formInfo';
```
## 权限
无
## FormInfo
卡片信息
**系统能力**：SystemCapability.Ability.Form
| 名称 | 读写属性 | 类型 | 描述 |
| ----------- | -------- | -------------------- | ------------------------------------------------------------ |
| bundleName | 只读 | string | 表示卡片所属包的包名。 |
| moduleName | 只读 | string | 表示卡片所属模块的模块名。 |
| abilityName | 只读 | string | 表示卡片所属的Ability名称。 |
| name | 只读 | string | 表示卡片名称。 |
| description | 只读 | string | 表示卡片描述。 |
| type | 只读 | [FormType](#formtype) | 表示卡片类型，当前支持JS卡片。 |
| jsComponentName | 只读 | string | 表示js卡片的组件名。 |
| colorMode | 只读 | [ColorMode](#colormode) | 表示卡片颜色模式。 |
| isDefault | 只读 | boolean | 表示是否是默认卡片。 |
| updateEnabled | 只读 | boolean | 表示卡片是否使能更新。 |
| formVisibleNotify | 只读 | string | 表示卡片是否使能可见通知。 |
| relatedBundleName | 只读 | string | 表示卡片所属的相关联包名。 |
| scheduledUpdateTime | 只读 | string | 表示卡片更新时间。 |
| formConfigAbility | 只读 | string | 表示卡片配置ability。 |
| updateDuration | 只读 | string | 表示卡片更新周期。 |
| defaultDimension | 只读 | number | 表示卡片规格 |
| supportDimensions | 只读 | Array&lt;number&gt; | 表示卡片支持的规格。 |
| customizeData | 只读 | {[key: string]: [value: string]} | 表示卡片用户数据。 |
## FormType
枚举，支持的卡片类型。
**系统能力**：SystemCapability.Ability.Form
| 名称 | 值 | 说明 |
| ----------- | ---- | ------------ |
| JS | 1 | 卡片类型为JS。 |
| eTS | 2 | 卡片类型为eTS。 |
## ColorMode
枚举，卡片支持的颜色模式。
**系统能力**：SystemCapability.Ability.Form
| 名称 | 值 | 说明 |
| ----------- | ---- | ------------ |
| MODE_AUTO | -1 | 自动模式。 |
| MODE_DARK | 0 | 暗色。 |
| MODE_LIGHT | 1 | 亮色。 |
## FormStateInfo
卡片状态信息。
**系统能力**：SystemCapability.Ability.Form
| 名称 | 读写属性 | 类型 | 描述 |
| ----------- | -------- | -------------------- | ------------------------------------------------------------ |
| formState | 只读 | [FormState](#formstate) | 表示卡片状态。 |
| want | 只读 | Want | Want文本内容。 |
## FormState
枚举，卡片状态。
**系统能力**：SystemCapability.Ability.Form
| 名称 | 值 | 说明 |
| ----------- | ---- | ------------ |
| UNKNOWN | -1 | 未知状态。 |
| DEFAULT | 0 | 默认状态。 |
| READY | 1 | 就绪状态。 |
## FormParam
枚举，卡片参数。
**系统能力**：SystemCapability.Ability.Form
| 名称 | 值 | 说明 |
| ----------- | ---- | ------------ |
| IDENTITY_KEY | "ohos.extra.param.key.form_identity" | 卡片标识。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| DIMENSION_KEY | "ohos.extra.param.key.form_dimension" | 卡片规格样式。 |
| NAME_KEY | "ohos.extra.param.key.form_name" | 卡片名称。 |
| MODULE_NAME_KEY | "ohos.extra.param.key.module_name" | 卡片所属模块名称。 |
| WIDTH_KEY | "ohos.extra.param.key.form_width" | 卡片宽度。 |
| HEIGHT_KEY | "ohos.extra.param.key.form_height" | 卡片高度。 |
| TEMPORARY_KEY | "ohos.extra.param.key.form_temporary" | 临时卡片。 |
| ABILITY_NAME_KEY | "ohos.extra.param.key.ability_name" | ability名称 |
| DEVICE_ID_KEY | "ohos.extra.param.key.device_id" | 设备标识。<br/>此接口为系统接口。 |
| BUNDLE_NAME_KEY | "ohos.extra.param.key.bundle_name" | 指示指定要获取的捆绑包名称的键。|
## FormDimension
定义卡片尺寸枚举。
**系统能力**：SystemCapability.Ability.Form
| 名称 | 值 | 说明 |
| ----------- | ---- | ------------ |
| Dimension_1_2 | 1 | 1 x 2 form。 |
| Dimension_2_2 | 2 | 2 x 2 form。 |
| Dimension_2_4 | 3 | 2 x 4 form。 |
| Dimension_4_4 | 4 | 4 x 4 form。 |
| Dimension_2_1 | 5 | 2 x 1 form。 |
## VisibilityType
卡片可见性。
**系统能力**：SystemCapability.Ability.Form
| 名称 | 值 | 说明 |
| ----------- | ---- | ------------ |
| FORM_VISIBLE | 1 | 卡片状态为可见。 |
| FORM_INVISIBLE | 2 | 卡片状态为不可见。 |
## FormInfoFilter
卡片信息过滤器，仅将符合过滤器内要求的卡片信息返回。
**系统能力**：SystemCapability.Ability.Form
| 名称 | 必选 | 说明 |
| ----------- | ---- | ------------ |
| moduleName | 否 | 可选字段，表示仅保留moduleName与提供值相符的卡片信息。 |
zh-cn/application-dev/reference/apis/js-apis-app-ability-formbindingdata.md 已删除 100644 → 0
浏览文件 @ 7f2ce875
# 卡片数据绑定类
卡片数据绑定模块提供卡片数据绑定的能力。包括FormBindingData对象的创建、相关信息的描述。
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```
import formBindingData from '@ohos.app.ability.formBindingData';
```
## 权限
无
## formBindingData.createFormBindingData
createFormBindingData(obj?: Object | string): FormBindingData
创建一个FormBindingData对象。
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------- | ---- | ------------------------------------------------------------ |
| obj | Object或string | 否 | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。其中图片数据以"formImages"作为标识，内容为图片标识与图片文件描述符的键值对{"formImages": {"key1": fd1, "key2": fd2}} |
**返回值：**
| 类型 | 说明 |
| ----------------------------------- | --------------------------------------- |
| [FormBindingData](#formbindingdata) | 根据传入数据创建的FormBindingData对象。 |
**示例：**
```js
import featureAbility from '@ohos.ability.featureAbility';
import fileio from '@ohos.fileio';
let context=featureAbility.getContext();
context.getOrCreateLocalDir((err,data)=>{
let path=data+"/xxx.jpg";
let fd = fileio.openSync(path);
let obj = {
"temperature": "21°",
"formImages": {"image": fd}
};
let formBindingDataObj = formBindingData.createFormBindingData(obj);
})
```
## 属性
FormBindingData相关描述。
**系统能力**：SystemCapability.Ability.Form
| 名称 | 可读 | 可写 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | -------- | -------- |
| data | 是 | 否 | Object | 是 | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。|
zh-cn/application-dev/reference/apis/js-apis-app-ability-formextension.md 已删除 100644 → 0
浏览文件 @ 7f2ce875
# FormExtension
FormExtension模块提供了FormExtension卡片扩展相关接口。
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
```
import FormExtension from '@ohos.app.ability.FormExtension';
```
## 权限
无
## 属性
**系统能力**：SystemCapability.Ability.Form
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------- | ------------------------------------------------------- | ---- | ---- | --------------------------------------------------- |
| context | [FormExtensionContext](js-apis-formextensioncontext.md) | 是 | 否 | FormExtension的上下文环境，继承自ExtensionContext。 |
## onCreate
onCreate(want: Want): formBindingData.FormBindingData
卡片提供方接收创建卡片的通知接口。
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------------------------------- | ---- | ------------------------------------------------------------ |
| want | [Want](js-apis-app-ability-Want.md) | 是 | 当前Extension相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理，以便后续更新和删除卡片。 |
**返回值：**
| 类型 | 说明 |
| ------------------------------------------------------------ | ----------------------------------------------------------- |
| [formBindingData.FormBindingData](js-apis-app-ability-formbindingdata.md#formbindingdata) | 一个formBindingData.FormBindingData对象，卡片要显示的数据。 |
**示例：**
```js
import formBindingData from '@ohos.app.ability.formBindingData'
export default class MyFormExtension extends FormExtension {
onCreate(want) {
console.log('FormExtension onCreate, want:' + want.abilityName);
let dataObj1 = {
temperature:"11c",
"time":"11:00"
};
let obj1 = formBindingData.createFormBindingData(dataObj1);
return obj1;
}
}
```
## FormExtension.onCastToNormal
onCastToNormal(formId: string): void
卡片提供方接收临时卡片转常态卡片的通知接口。
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------ |
| formId | string | 是 | 请求转换为常态的卡片ID。 |
**示例：**
```
export default class MyFormExtension extends FormExtension {
onCastToNormal(formId) {
console.log('FormExtension onCastToNormal, formId:' + formId);
}
}
```
## FormExtension.onUpdate
onUpdate(formId: string): void
卡片提供方接收更新卡片的通知接口。获取最新数据后调用[FormExtensionContext](js-apis-formextensioncontext.md)的updateForm接口刷新卡片数据。
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ |
| formId | string | 是 | 请求更新的卡片ID。 |
**示例：**
```js
import formBindingData from '@ohos.app.ability.formBindingData'
export default class MyFormExtension extends FormExtension {
onUpdate(formId) {
console.log('FormExtension onUpdate, formId:' + formId);
let obj2 = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
this.context.updateForm(formId, obj2)
.then((data)=>{
console.log('FormExtension context updateForm, data:' + data);
}).catch((error) => {
console.error('Operation updateForm failed. Cause: ' + error);});
}
}
```
## FormExtension.onVisibilityChange
onVisibilityChange(newStatus: { [key: string]: number }): void
卡片提供方接收修改可见性的通知接口。
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | ---------------------------- |
| newStatus | { [key: string]: number } | 是 | 请求修改的卡片ID和可见状态。 |
**示例：**
```js
import formBindingData from '@ohos.app.ability.formBindingData'
export default class MyFormExtension extends FormExtension {
onVisibilityChange(newStatus) {
console.log('FormExtension onVisibilityChange, newStatus:' + newStatus);
let obj2 = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
for (let key in newStatus) {
console.log('FormExtension onVisibilityChange, key:' + key + ", value=" + newStatus[key]);
this.context.updateForm(key, obj2)
.then((data)=>{
console.log('FormExtension context updateForm, data:' + data);
}).catch((error) => {
console.error('Operation updateForm failed. Cause: ' + error);});
}
}
}
```
## FormExtension.onEvent
onEvent(formId: string, message: string): void
卡片提供方接收处理卡片事件的通知接口。
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ---------------------- |
| formId | string | 是 | 请求触发事件的卡片ID。 |
| message | string | 是 | 事件消息。 |
**示例：**
```js
export default class MyFormExtension extends FormExtension {
onEvent(formId, message) {
console.log('FormExtension onEvent, formId:' + formId + ", message:" + message);
}
}
```
## FormExtension.onDestroy
onDestroy(formId: string): void
卡片提供方接收销毁卡片的通知接口。
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ |
| formId | string | 是 | 请求销毁的卡片ID。 |
**示例：**
```js
export default class MyFormExtension extends FormExtension {
onDestroy(formId) {
console.log('FormExtension onDestroy, formId:' + formId);
}
}
```
## FormExtension.onConfigurationUpdated
onConfigurationUpdated(config: Configuration): void;
当系统配置更新时调用。
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 表示需要更新的配置信息。 |
**示例：**
```js
class MyFormExtension extends FormExtension {
onConfigurationUpdated(config) {
console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
}
}
```
## FormExtension.onAcquireFormState
onAcquireFormState?(want: Want): formInfo.FormState;
卡片提供方接收查询卡片状态通知接口。默认返回卡片初始状态。
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-app-ability-Want.md) | 否 | want表示获取卡片状态的描述。描述包括包名称、能力名称、模块名称、卡片名和卡片维度。 |
**示例：**
```js
import formInfo from '@ohos.app.ability.formInfo'
class MyFormExtension extends FormExtension {
onAcquireFormState(want) {
console.log('FormExtension onAcquireFormState, want:' + want);
return formInfo.FormState.UNKNOWN;
}
}
```
## FormExtension.onShare
onShare?(formId: string): {[key: string]: any};
卡片提供方接收卡片分享的通知接口。
此接口为系统接口。
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| formId | string | 是 | 卡片标识 |
**返回值：**
| 类型 | 说明 |
| ------------------------------------------------------------ | ----------------------------------------------------------- |
| {[key: string]: any} | 卡片要分享的数据，由开发者自行决定传入的键值对。 |
**示例：**
```js
class MyFormExtension extends FormExtension {
onShare(formId) {
console.log('FormExtension onShare, formId:' + formId);
let wantParams = {
"temperature":"20",
"time":"2022-8-8 09:59",
};
return wantParams;
}
}
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-app-ability-formprovider.md 已删除 100644 → 0
浏览文件 @ 7f2ce875
# FormProvider
FormProvider模块提供了卡片提供方相关接口的能力，包括更新卡片，设置卡片更新时间，获取卡片信息，请求发布卡片等。
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```
import formProvider from '@ohos.app.ability.formProvider';
```
## 权限
无
## setFormNextRefreshTime
setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback&lt;void&gt;): void;
设置指定卡片的下一次更新时间。
**系统能力：**
SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------- |
| formId | string | 是 | 卡片标识 |
| minute | number | 是 | 指定多久之后更新，单位分钟，大于等于5 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动结果 |
**示例：**
```js
var formId = "12400633174999288";
try {
formProvider.setFormNextRefreshTime(formId, 5, (error, data) => {
if (error.code) {
console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error));
}
});
} catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message);
}
```
## setFormNextRefreshTime
setFormNextRefreshTime(formId: string, minute: number): Promise&lt;void&gt;;
设置指定卡片的下一次更新时间，以promise方式返回。
**系统能力：**
SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------- |
| formId | string | 是 | 卡片标识 |
| minute | number | 是 | 指定多久之后更新，单位分钟，大于等于5 |
**返回值：**
| 类型 | 说明 |
| ------------- | ---------------------------------- |
| Promise\<void> |Promise实例，用于获取异步返回结果。 |
**示例：**
```js
var formId = "12400633174999288";
try {
formProvider.setFormNextRefreshTime(formId, 5).then(() => {
console.log('formProvider setFormNextRefreshTime success');
}).catch((error) => {
console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error));
});
} catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message);
}
```
## updateForm
updateForm(formId: string, formBindingData: formBindingData.FormBindingData,callback: AsyncCallback&lt;void&gt;): void;
更新指定的卡片。
**系统能力：**
SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
| formId | string | 是 | 请求更新的卡片标识 |
| formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动结果 |
**示例：**
```js
import formBindingData from '@ohos.application.formBindingData';
var formId = "12400633174999288";
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
try {
formProvider.updateForm(formId, obj, (error, data) => {
if (error.code) {
console.log('formProvider updateForm, error:' + JSON.stringify(error));
}
});
} catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message);
}
```
## updateForm
updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Promise&lt;void&gt;;
更新指定的卡片，以promise方式返回。
**系统能力：**
SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
| formId | string | 是 | 请求更新的卡片标识 |
| formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据 |
**返回值：**
| 类型 | 说明 |
| -------------- | ----------------------------------- |
| Promise\<void> | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
import formBindingData from '@ohos.application.formBindingData';
var formId = "12400633174999288";
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
try {
formProvider.updateForm(formId, obj).then(() => {
console.log('formProvider updateForm success');
}).catch((error) => {
console.log('formProvider updateForm, error:' + JSON.stringify(error));
});
} catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message);
}
```
## getFormsInfo
getFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): void;
获取设备上当前应用程序的卡片信息。
**系统能力：** SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](./js-apis-formInfo.md#forminfo-1)&gt;&gt; | 是 | callback形式返回查询到的卡片信息。 |
**示例：**
```js
formProvider.getFormsInfo((error, data) => {
if (error.code) {
console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
} else {
console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
}
});
```
## getFormsInfo
getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): void;
获取设备上当前应用程序的卡片信息。
**系统能力：** SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| filter | [formInfo.FormInfoFilter](./js-apis-formInfo.md#forminfofilter) | 是 | 过滤卡片信息 |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](./js-apis-formInfo.md#forminfo-1)&gt;&gt; | 是 | callback形式返回查询到的卡片信息。 |
**示例：**
```js
import formInfo from '@ohos.application.formInfo';
const filter : formInfo.FormInfoFilter = {
moduleName : "entry"
};
try {
formProvider.getFormsInfo(filter, (error, data) => {
if (error.code) {
console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
} else {
console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
}
});
} catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message);
}
```
## getFormsInfo
getFormsInfo(filter?: formInfo.FormInfoFilter): Promise&lt;Array&lt;formInfo.FormInfo&gt;&gt;;
获取设备上当前应用程序的卡片信息。
**系统能力：** SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| filter | [formInfo.FormInfoFilter](./js-apis-app-ability-formInfo.md) | 否 | 过滤卡片信息 |
**返回值：**
| 类型 | 说明 |
| :------------ | :---------------------------------- |
| Promise&lt;Array&lt;[FormInfo](./js-apis-app-ability-formInfo.md#forminfo-1)&gt;&gt; | Promise实例，用于获取异步返回查询到的卡片信息。 |
**示例：**
```js
import formInfo from '@ohos.app.ability.formInfo';
const filter : formInfo.FormInfoFilter = {
moduleName : "entry"
};
try {
formProvider.getFormsInfo(filter).then((data) => {
console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
}).catch((error) => {
console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
});
} catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message);
}
```
## requestPublishForm
requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData, callback: AsyncCallback\<string>): void;
请求发布一张卡片到使用方。
**系统能力：** SystemCapability.Ability.Form
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
| want | [Want](js-apis-app-ability-Want.md) | 是 | abilityName: 目标卡片ability<br>parameters:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" |
| formBindingData | [FormBindingData](js-apis-app-ability-formbindingdata.md#formbindingdata) | 是 | 用于创建卡片的数据 |
| callback | AsyncCallback&lt;string&gt; | 是 | callback形式返回卡片标识 |
**示例：**
```js
import formBindingData from '@ohos.app.ability.formBindingData';
var want = {
abilityName: "FormAbility",
parameters: {
"ohos.extra.param.key.form_dimension": 2,
"ohos.extra.param.key.form_name": "widget",
"ohos.extra.param.key.module_name": "entry"
}
};
try {
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
formProvider.requestPublishForm(want, obj, (error, data) => {
if (error.code) {
console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error));
} else {
console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data));
}
});
} catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message);
}
```
## requestPublishForm
requestPublishForm(want: Want, callback: AsyncCallback&lt;string&gt;): void;
请求发布一张卡片到使用方。
**系统能力：** SystemCapability.Ability.Form
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ |
| want | [Want](js-apis-app-ability-Want.md) | 是 | abilityName: 目标卡片ability<br>parameters:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" |
| callback | AsyncCallback&lt;string&gt; | 是 | callback形式返回卡片标识 |
**示例：**
```js
var want = {
abilityName: "FormAbility",
parameters: {
"ohos.extra.param.key.form_dimension": 2,
"ohos.extra.param.key.form_name": "widget",
"ohos.extra.param.key.module_name": "entry"
}
};
try {
formProvider.requestPublishForm(want, (error, data) => {
if (error.code) {
console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error));
} else {
console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data));
}
});
} catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message);
}
```
## requestPublishForm
requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData): Promise&lt;string&gt;;
请求发布一张卡片到使用方。
**系统能力：** SystemCapability.Ability.Form
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| want | [Want](js-apis-app-ability-Want.md) | 是 | abilityName: 目标卡片ability<br/>parameters:<br/>"ohos.extra.param.key.form_dimension"<br/>"ohos.extra.param.key.form_name"<br/>"ohos.extra.param.key.module_name" |
| formBindingData | [FormBindingData](js-apis-app-ability-formbindingdata.md#formbindingdata) | 否 | 用于创建卡片的数据 |
**返回值：**
| 类型 | 说明 |
| :------------ | :---------------------------------- |
| Promise&lt;string&gt; | Promise实例，用于返回卡片标识。 |
**示例：**
```js
var want = {
abilityName: "FormAbility",
parameters: {
"ohos.extra.param.key.form_dimension": 2,
"ohos.extra.param.key.form_name": "widget",
"ohos.extra.param.key.module_name": "entry"
}
};
try {
formProvider.requestPublishForm(want).then((data) => {
console.log('formProvider requestPublishForm success, form ID is :' + JSON.stringify(data));
}).catch((error) => {
console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error));
});
} catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message);
}
```
## isRequestPublishFormSupported
isRequestPublishFormSupported(callback: AsyncCallback&lt;boolean&gt;): void;
查询是否支持发布一张卡片到使用方。
**系统能力：** SystemCapability.Ability.Form
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | callback形式返回是否支持发布一张卡片到使用方 |
**示例：**
```js
formProvider.isRequestPublishFormSupported((error, isSupported) => {
if (error.code) {
console.log('formProvider isRequestPublishFormSupported, error:' + JSON.stringify(error));
} else {
if (isSupported) {
var want = {
abilityName: "FormAbility",
parameters: {
"ohos.extra.param.key.form_dimension": 2,
"ohos.extra.param.key.form_name": "widget",
"ohos.extra.param.key.module_name": "entry"
}
};
formProvider.requestPublishForm(want, (error, data) => {
if (error.code) {
console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error));
} else {
console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data));
}
});
}
}
});
```
## isRequestPublishFormSupported
isRequestPublishFormSupported(): Promise&lt;boolean&gt;;
查询是否支持发布一张卡片到使用方。
**系统能力：** SystemCapability.Ability.Form
**系统API**: 此接口为系统接口，三方应用不支持调用。
**返回值：**
| 类型 | 说明 |
| :------------ | :---------------------------------- |
| Promise&lt;boolean&gt; | Promise实例，用于获取异步返回是否支持发布一张卡片到使用方 |
**示例：**
```js
formProvider.isRequestPublishFormSupported().then((isSupported) => {
if (isSupported) {
var want = {
abilityName: "FormAbility",
parameters: {
"ohos.extra.param.key.form_dimension": 2,
"ohos.extra.param.key.form_name": "widget",
"ohos.extra.param.key.module_name": "entry"
}
};
formProvider.requestPublishForm(want).then((data) => {
console.log('formProvider requestPublishForm success, form ID is :' + JSON.stringify(data));
}).catch((error) => {
console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error));
});
}
}).catch((error) => {
console.log('formProvider isRequestPublishFormSupported, error:' + JSON.stringify(error));
});
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-app-ability-missionManager.md
浏览文件 @ ac4719d5
......@@ -947,7 +947,7 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&g
**系统API**: 此接口为系统接口，三方应用不支持调用。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| missionId | number | 是 | 是 | 表示任务ID。|
| runningState | number | 是 | 是 | 表示运行状态。 |
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-quickFixManager.md
浏览文件 @ ac4719d5
......@@ -20,11 +20,11 @@ hap级别的快速修复信息。
**系统API**: 此接口为系统接口，三方应用不支持调用。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| moduleName | 只读 | string | 是 | hap包的名称。 |
| originHapHash | 只读 | string | 是 | 指示hap的哈希值。 |
| quickFixFilePath | 只读 | string | 是 | 指示快速修复文件的安装路径。 |
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ |
| moduleName | 是 | 否 | string | 是 | hap包的名称。 |
| originHapHash | 是 | 否 | string | 是 | 指示hap的哈希值。 |
| quickFixFilePath | 是 | 否 | string | 是 | 指示快速修复文件的安装路径。 |
## ApplicationQuickFixInfo
......@@ -34,14 +34,14 @@ hap级别的快速修复信息。
**系统API**: 此接口为系统接口，三方应用不支持调用。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| bundleName | 只读 | string | 是 | 应用的包名。 |
| bundleVersionCode | 只读 | number | 是 | 应用的版本号。 |
| bundleVersionName | 只读 | string | 是 | 应用版本号的文字描述。 |
| quickFixVersionCode | 只读 | number | 是 | 快速修复补丁包的版本号。 |
| quickFixVersionName | 只读 | string | 是 | 快速修复补丁包版本号的文字描述。 |
| hapModuleQuickFixInfo | 只读 | Array\<[HapModuleQuickFixInfo](#hapmodulequickfixinfo)> | 是 | hap级别的快速修复信息。 |
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ |
| bundleName | 是 | 否 | string | 是 | 应用的包名。 |
| bundleVersionCode | 是 | 否 | number | 是 | 应用的版本号。 |
| bundleVersionName | 是 | 否 | string | 是 | 应用版本号的文字描述。 |
| quickFixVersionCode | 是 | 否 | number | 是 | 快速修复补丁包的版本号。 |
| quickFixVersionName | 是 | 否 | string | 是 | 快速修复补丁包版本号的文字描述。 |
| hapModuleQuickFixInfo | 是 | 否 | Array\<[HapModuleQuickFixInfo](#hapmodulequickfixinfo)> | 是 | hap级别的快速修复信息。 |
## quickFixManager.applyQuickFix
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-wantConstant.md
浏览文件 @ ac4719d5
......@@ -4,7 +4,7 @@ wantConstant模块提供want中操作want常数和解释Flags说明的能力。
> **说明：**
>
> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
......@@ -18,7 +18,7 @@ want操作的常数。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 值 | 描述 |
| 名称 | 值 | 说明 |
| ------------ | ------------------ | ---------------------- |
| ACTION_HOME | ohos.want.action.home | 指示返回原点的操作。 |
| ACTION_DIAL | ohos.want.action.dial | 指示启动显示小键盘的页面功能的操作 |
......@@ -61,7 +61,7 @@ want实体的常数。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 值 | 描述 |
| 名称 | 值 | 说明 |
| ------------ | ------------------ | ---------------------- |
| ENTITY_DEFAULT | entity.system.default | 指示默认实体，如果未指定该实体，则使用该实体。 |
| ENTITY_HOME | entity.system.home | 指示主屏幕实体。 |
......@@ -76,7 +76,7 @@ Flags说明。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 值 | 描述 |
| 名称 | 值 | 说明 |
| ------------------------------------ | ---------- | ------------------------------------------------------------ |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权。 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权。 |
......
zh-cn/application-dev/reference/apis/js-apis-app-form-forminfo.md
浏览文件 @ ac4719d5
......@@ -18,26 +18,26 @@ import formInfo from '@ohos.app.form.formInfo';
**系统能力**：SystemCapability.Ability.Form
| 名称 | 读写属性 | 类型 | 描述 |
| ----------- | -------- | -------------------- | ------------------------------------------------------------ |
| bundleName | 只读 | string | 卡片所属包的包名。 |
| moduleName | 只读 | string | 卡片所属模块的模块名。 |
| abilityName | 只读 | string | 卡片所属的Ability名称。 |
| name | 只读 | string | 卡片名称。 |
| description | 只读 | string | 卡片描述。 |
| type | 只读 | [FormType](#formtype) | 卡片类型。当前支持JS卡片。 |
| jsComponentName | 只读 | string | js卡片的组件名。 |
| colorMode | 只读 | [ColorMode](#colormode) | 卡片颜色模式。 |
| isDefault | 只读 | boolean | 卡片是否是默认卡片。 |
| updateEnabled | 只读 | boolean | 卡片是否使能更新。 |
| formVisibleNotify | 只读 | string | 卡片是否使能可见通知。 |
| relatedBundleName | 只读 | string | 卡片所属的相关联包名。 |
| scheduledUpdateTime | 只读 | string | 卡片更新时间。 |
| formConfigAbility | 只读 | string | 卡片配置ability。指定长按卡片弹出的选择框内，编辑选项所对应的ability。 |
| updateDuration | 只读 | string | 卡片更新周期。 |
| defaultDimension | 只读 | number | 表示卡片规格 |
| supportDimensions | 只读 | Array&lt;number&gt; | 卡片支持的规格。具体可选规格参考[FormDimension](#formdimension) |
| customizeData | 只读 | {[key: string]: [value: string]} | 卡片用户数据。 |
| 名称 | 可读 | 可写 | 类型 | 说明 |
| ----------- | -------- | -------- | -------------------- | ------------------------------------------------------------ |
| bundleName | 是 | 否 | string | 卡片所属包的包名。 |
| moduleName | 是 | 否 | string | 卡片所属模块的模块名。 |
| abilityName | 是 | 否 | string | 卡片所属的Ability名称。 |
| name | 是 | 否 | string | 卡片名称。 |
| description | 是 | 否 | string | 卡片描述。 |
| type | 是 | 否 | [FormType](#formtype) | 卡片类型。当前支持JS卡片。 |
| jsComponentName | 是 | 否 | string | js卡片的组件名。 |
| colorMode | 是 | 否 | [ColorMode](#colormode) | 卡片颜色模式。 |
| isDefault | 是 | 否 | boolean | 卡片是否是默认卡片。 |
| updateEnabled | 是 | 否 | boolean | 卡片是否使能更新。 |
| formVisibleNotify | 是 | 否 | string | 卡片是否使能可见通知。 |
| relatedBundleName | 是 | 否 | string | 卡片所属的相关联包名。 |
| scheduledUpdateTime | 是 | 否 | string | 卡片更新时间。 |
| formConfigAbility | 是 | 否 | string | 卡片配置ability。指定长按卡片弹出的选择框内，编辑选项所对应的ability。 |
| updateDuration | 是 | 否 | string | 卡片更新周期。 |
| defaultDimension | 是 | 否 | number | 表示卡片规格 |
| supportDimensions | 是 | 否 | Array&lt;number&gt; | 卡片支持的规格。具体可选规格参考[FormDimension](#formdimension) |
| customizeData | 是 | 否 | {[key: string]: [value: string]} | 卡片用户数据。 |
## FormType
......@@ -68,10 +68,10 @@ import formInfo from '@ohos.app.form.formInfo';
**系统能力**：SystemCapability.Ability.Form
| 名称 | 读写属性 | 类型 | 描述 |
| ----------- | -------- | -------------------- | ------------------------------------------------------------ |
| formState | 只读 | [FormState](#formstate) | 卡片状态。 |
| want | 只读 | Want | Want文本内容。 |
| 名称 | 可读 | 可写 | 类型 | 说明 |
| ----------- | -------- | -------- | -------------------- | ------------------------------------------------------------ |
| formState | 是 | 否 | [FormState](#formstate) | 卡片状态。 |
| want | 是 | 否 | Want | Want文本内容。 |
## FormState
......
zh-cn/application-dev/reference/apis/js-apis-application-MissionSnapshot.md
浏览文件 @ ac4719d5
......@@ -34,7 +34,7 @@ missionManager.getMissionInfos("", 10, (error, missions) => {
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ability | ElementName | 是 | 是 | 表示Ability任务元素名称。 |
| snapshot | [image.PixelMap](js-apis-image.md) | 是 | 是 | 表示任务快照。 |
zh-cn/application-dev/reference/apis/js-apis-application-StartOptions.md
浏览文件 @ ac4719d5
......@@ -17,7 +17,7 @@ import StartOptions from '@ohos.application.StartOptions';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 可读 | 可写 | 参数类型 | 必填 | 说明 |
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | -------- | -------- |
| [windowMode](js-apis-application-abilityConstant.md#abilityconstantwindowmode) | 是 | 否 | number | 否 | 窗口模式。 |
| displayId | 是 | 否 | number | 否 | 显示ID。 |
zh-cn/application-dev/reference/apis/js-apis-application-Want.md
浏览文件 @ ac4719d5
......@@ -16,18 +16,18 @@ import Want from '@ohos.application.Want';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 |
| bundleName | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 |
| uri | 只读 | string | 否 | 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 |
| type | 只读 | string | 否 | 表示MIME type类型描述，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 |
| flags | 只读 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-featureAbility.md#flags说明)。 |
| action | 只读 | string | 否 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。 |
| parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams描述，由开发者自行决定传入的键值对。默认会携带以下key值：<br>ohos.aafwk.callerPid 表示拉起方的pid。<br>ohos.aafwk.param.callerToken 表示拉起方的token。<br>ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。 |
| entities | 只读 | Array\<string> | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 |
| moduleName<sup>9+</sup> | 只读 | string | 否 | 表示待启动的Ability所属的模块（module）。 |
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ----------- | -------- | ------- | -------------------- | ---- | ------------------------------------------------------------ |
| deviceId | 是 | 否 | string | 否 | 表示运行指定Ability的设备ID。 |
| bundleName | 是 | 否 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| abilityName | 是 | 否 | string | 否 | 表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 |
| uri | 是 | 否 | string | 否 | 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 |
| type | 是 | 否 | string | 否 | 表示MIME type类型描述，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 |
| flags | 是 | 否 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-featureAbility.md#flags说明)。 |
| action | 是 | 否 | string | 否 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。 |
| parameters | 是 | 否 | {[key: string]: any} | 否 | 表示WantParams描述，由开发者自行决定传入的键值对。默认会携带以下key值：<br>ohos.aafwk.callerPid 表示拉起方的pid。<br>ohos.aafwk.param.callerToken 表示拉起方的token。<br>ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。 |
| entities | 是 | 否 | Array\<string> | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 |
| moduleName<sup>9+</sup> | 是 | 否 | string | 否 | 表示待启动的Ability所属的模块（module）。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-application-ability.md
浏览文件 @ ac4719d5
......@@ -22,7 +22,7 @@ import Ability from '@ohos.application.Ability';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.AbilityCore
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| context | [AbilityContext](js-apis-ability-context.md) | 是 | 否 | 上下文。 |
| launchWant | [Want](js-apis-application-Want.md) | 是 | 否 | Ability启动时的参数。 |
......@@ -743,7 +743,7 @@ off(method: string): void;
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| (msg: string) | function | 是 | 否 | 调用者注册的侦听器函数接口的原型。 |
......@@ -753,6 +753,6 @@ off(method: string): void;
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| (indata: rpc.MessageParcel) | rpc.Sequenceable | 是 | 否 | 被调用方注册的消息侦听器函数接口的原型。 |
zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md
浏览文件 @ ac4719d5
......@@ -19,7 +19,7 @@ import AbilityConstant from '@ohos.application.AbilityConstant';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| launchReason | LaunchReason| 是 | 是 | 指示启动原因。 |
| lastExitReason | LastExitReason | 是 | 是 | 表示最后退出原因。 |
......@@ -30,7 +30,7 @@ import AbilityConstant from '@ohos.application.AbilityConstant';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| UNKNOWN | 0 | 未知的状态。 |
| START_ABILITY | 1 | 启动能力。 |
......@@ -45,7 +45,7 @@ import AbilityConstant from '@ohos.application.AbilityConstant';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| UNKNOWN | 0 | 未知的状态。 |
| ABILITY_NOT_RESPONDING | 1 | 能力没有反应 |
......@@ -58,7 +58,7 @@ import AbilityConstant from '@ohos.application.AbilityConstant';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| AGREE | 0 | 同意。 |
| REJECT | 1 | 拒绝。 |
......@@ -70,7 +70,7 @@ import AbilityConstant from '@ohos.application.AbilityConstant';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 取值 | 说明 |
| 名称 | 取值 | 说明 |
| --- | --- | --- |
| WINDOW_MODE_UNDEFINED | 0 | 未定义窗口模式。 |
| WINDOW_MODE_FULLSCREEN | 1 | 全屏模式。 |
......@@ -84,7 +84,7 @@ import AbilityConstant from '@ohos.application.AbilityConstant';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 取值 | 说明 |
| 名称 | 取值 | 说明 |
| --- | --- | --- |
| MEMORY_LEVEL_MODERATE | 0 | 内存占用适中。 |
| MEMORY_LEVEL_LOW | 1 | 内存占用低。 |
......@@ -96,7 +96,7 @@ import AbilityConstant from '@ohos.application.AbilityConstant';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| ALL_AGREE | 0 | 同意保存状态。 |
| CONTINUATION_REJECT | 1 | 拒绝迁移保存状态。 |
......@@ -111,7 +111,7 @@ import AbilityConstant from '@ohos.application.AbilityConstant';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| CONTINUATION | 0 | 迁移保存状态。 |
| APP_RECOVERY | 1 | 应用恢复保存状态。 |
zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md
浏览文件 @ ac4719d5
......@@ -43,7 +43,7 @@ onWindowStageCreate(ability: Ability, windowStage: window.WindowStage): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 |
| windowStage | [WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 |
| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 |
## AbilityLifecycleCallback.onWindowStageActive
......@@ -59,7 +59,7 @@ onWindowStageActive(ability: Ability, windowStage: window.WindowStage): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 |
| windowStage | [WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 |
| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 |
## AbilityLifecycleCallback.onWindowStageInactive
......@@ -75,7 +75,7 @@ onWindowStageInactive(ability: Ability, windowStage: window.WindowStage): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 |
| windowStage | [WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 |
| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 |
## AbilityLifecycleCallback.onWindowStageDestroy
......@@ -91,7 +91,7 @@ onWindowStageDestroy(ability: Ability, windowStage: window.WindowStage): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 |
| windowStage | [WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 |
| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 |
## AbilityLifecycleCallback.onAbilityDestroy
......
zh-cn/application-dev/reference/apis/js-apis-application-abilityManager.md
浏览文件 @ ac4719d5
......@@ -41,7 +41,7 @@ updateConfiguration(config: Configuration, callback: AsyncCallback\<void>): void
**参数**：
| 名称 | 类型 | 必填 | 描述 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| config | [Configuration](js-apis-configuration.md) | 是 | 新的配置项。 |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法。 |
......@@ -72,7 +72,7 @@ updateConfiguration(config: Configuration): Promise\<void>
**参数**：
| 名称 | 类型 | 必填 | 描述 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| config | [Configuration](js-apis-configuration.md) | 是 | 新的配置项。 |
......@@ -110,7 +110,7 @@ getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): vo
**参数**：
| 名称 | 类型 | 必填 | 描述 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<Array\<AbilityRunningInfo>> | 是 | 被指定的回调方法。 |
......@@ -164,7 +164,7 @@ getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<Ext
**参数**：
| 名称 | 类型 | 必填 | 描述 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| upperLimit | number | 是 | 获取消息数量的最大限制。 |
| callback | AsyncCallback\<Array\<AbilityRunningInfo>> | 是 | 被指定的回调方法。 |
......@@ -193,7 +193,7 @@ getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningIn
**参数**：
| 名称 | 类型 | 必填 | 描述 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| upperLimit | number | 是 | 获取消息数量的最大限制。 |
......@@ -227,7 +227,7 @@ getTopAbility(callback: AsyncCallback\<ElementName>): void;
**参数**：
| 名称 | 类型 | 必填 | 描述 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<ElementName> | 是 | 被指定的回调方法。 |
......
zh-cn/application-dev/reference/apis/js-apis-application-configuration.md
浏览文件 @ ac4719d5
......@@ -7,7 +7,7 @@
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| language<sup>8+</sup> | string | 是 | 是 | 表示应用程序的当前语言。 |
| colorMode<sup>8+</sup> | [ColorMode](js-apis-configurationconstant.md#configurationconstantcolormode) | 是 | 是 | 表示深浅色模式，取值范围：浅色模式（COLOR_MODE_LIGHT），深色模式（COLOR_MODE_DARK）。默认为浅色。 |
......
zh-cn/application-dev/reference/apis/js-apis-application-context.md
浏览文件 @ ac4719d5
......@@ -26,7 +26,7 @@ class MainAbility extends Ability {
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| resourceManager | resmgr.ResourceManager; | 是 | 否 | ResourceManager对象。 |
| applicationInfo | ApplicationInfo | 是 | 否 | 当前应用信息。 |
......@@ -179,7 +179,7 @@ class MainAbility extends Ability {
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 变量 | 值 | 描述 |
| 名称 | 值 | 说明 |
| --------------- | ---- | --------------- |
| EL1 | 0 | 设备级加密区。 |
| EL2 | 1 | 用户凭据加密区。默认为EL2。 |
zh-cn/application-dev/reference/apis/js-apis-configuration.md
浏览文件 @ ac4719d5
......@@ -16,7 +16,7 @@ import Configuration from '@ohos.application.Configuration';
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| language | string | 是 | 是 | 表示应用程序的当前语言。 |
| colorMode | [ColorMode](js-apis-configurationconstant.md) | 是 | 是 | 表示深浅色模式，取值范围：浅色模式（COLOR_MODE_LIGHT），深色模式（COLOR_MODE_DARK）。默认为浅色。 |
......
zh-cn/application-dev/reference/apis/js-apis-extension-context.md
浏览文件 @ ac4719d5
......@@ -13,7 +13,7 @@ ExtensionContext模块提供访问特定Extension的资源的能力，对于拓
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 所属Hap包的信息。<br>(详见SDK目录下的 `api\bundle\hapModuleInfo.d.ts`) |
| config | Configuration | 是 | 否 | 所属Module的配置信息。<br>(详见SDK目录下的 `api\@ohos.application.Configuration.d.ts`) |
......
zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md
浏览文件 @ ac4719d5
......@@ -23,7 +23,7 @@ abilityManager.getExtensionRunningInfos(upperLimit, (err,data) => {
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| extension | ElementName | 是 | 否 | Extension匹配信息。 |
| pid | number | 是 | 否 | 进程ID。 |
......@@ -31,4 +31,4 @@ abilityManager.getExtensionRunningInfos(upperLimit, (err,data) => {
| processName | string | 是 | 否 | 进程名称。 |
| startTime | number | 是 | 否 | Extension启动时间。 |
| clientPackage | Array&lt;String&gt; | 是 | 否 | 表示当期进程下的所有包名。 |
| type | [bundle.ExtensionAbilityType](js-apis-Bundle.md#extensionabilitytype9) | 是 | 否 | Extension类型。 |
\ No newline at end of file
| type | [bundle.ExtensionAbilityType](js-apis-bundleManager.md#extensionabilitytype) | 是 | 否 | Extension类型。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-formInfo.md
浏览文件 @ ac4719d5
......@@ -19,26 +19,26 @@ import formInfo from '@ohos.application.formInfo';
**系统能力**：SystemCapability.Ability.Form
| 名称 | 读写属性 | 类型 | 描述 |
| ----------- | -------- | -------------------- | ------------------------------------------------------------ |
| bundleName | 只读 | string | 卡片所属包的包名。 |
| moduleName | 只读 | string | 卡片所属模块的模块名。 |
| abilityName | 只读 | string | 卡片所属的Ability名称。 |
| name | 只读 | string | 卡片名称。 |
| description | 只读 | string | 卡片描述。 |
| type | 只读 | [FormType](#formtype) | 卡片类型。当前支持JS卡片。 |
| jsComponentName | 只读 | string | js卡片的组件名。 |
| colorMode | 只读 | [ColorMode](#colormode) | 卡片颜色模式。 |
| isDefault | 只读 | boolean | 卡片是否是默认卡片。 |
| updateEnabled | 只读 | boolean | 卡片是否使能更新。 |
| formVisibleNotify | 只读 | string | 卡片是否使能可见通知。 |
| relatedBundleName | 只读 | string | 卡片所属的相关联包名。 |
| scheduledUpdateTime | 只读 | string | 卡片更新时间。 |
| formConfigAbility | 只读 | string | 卡片配置ability。指定长按卡片弹出的选择框内，编辑选项所对应的ability。 |
| updateDuration | 只读 | string | 卡片更新周期。 |
| defaultDimension | 只读 | number | 表示卡片规格 |
| supportDimensions | 只读 | Array&lt;number&gt; | 卡片支持的规格。具体可选规格参考[FormDimension](#formdimension) |
| customizeData | 只读 | {[key: string]: [value: string]} | 卡片用户数据。 |
| 名称 | 可读 | 可写 | 类型 | 说明 |
| ----------- | -------- |-------- | -------------------- | ------------------------------------------------------------ |
| bundleName | 是 | 否 | string | 表示卡片所属包的包名。 |
| moduleName | 是 | 否 | string | 表示卡片所属模块的模块名。 |
| abilityName | 是 | 否 | string | 表示卡片所属的Ability名称。 |
| name | 是 | 否 | string | 表示卡片名称。 |
| description | 是 | 否 | string | 表示卡片描述。 |
| type | 是 | 否 | [FormType](#formtype) | 表示卡片类型，当前支持JS卡片。 |
| jsComponentName | 是 | 否 | string | 表示js卡片的组件名。 |
| colorMode | 是 | 否 | [ColorMode](#colormode) | 表示卡片颜色模式。 |
| isDefault | 是 | 否 | boolean | 表示是否是默认卡片。 |
| updateEnabled | 是 | 否 | boolean | 表示卡片是否使能更新。 |
| formVisibleNotify | 是 | 否 | string | 表示卡片是否使能可见通知。 |
| relatedBundleName | 是 | 否 | string | 表示卡片所属的相关联包名。 |
| scheduledUpdateTime | 是 | 否 | string | 表示卡片更新时间。 |
| formConfigAbility | 是 | 否 | string | 表示卡片配置ability。 |
| updateDuration | 是 | 否 | string | 表示卡片更新周期。 |
| defaultDimension | 是 | 否 | number | 表示卡片规格 |
| supportDimensions | 是 | 否 | Array&lt;number&gt; | 表示卡片支持的规格。 |
| customizeData | 是 | 否 | {[key: string]: [value: string]} | 表示卡片用户数据。 |
## FormType
......@@ -69,10 +69,10 @@ import formInfo from '@ohos.application.formInfo';
**系统能力**：SystemCapability.Ability.Form
| 名称 | 读写属性 | 类型 | 描述 |
| ----------- | -------- | -------------------- | ------------------------------------------------------------ |
| formState | 只读 | [FormState](#formstate) | 卡片状态。 |
| want | 只读 | Want | Want文本内容。 |
| 名称 | 可读 | 可写 | 类型 | 说明 |
| ----------- | -------- |-------- | -------------------- | ------------------------------------------------------------ |
| formState | 是 | 否 | [FormState](#formstate) | 表示卡片状态。 |
| want | 是 | 否 | Want | Want文本内容。 |
## FormState
......
zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md
浏览文件 @ ac4719d5
......@@ -47,17 +47,30 @@ createFormBindingData(obj?: Object | string): FormBindingData
**示例：**
```js
import featureAbility from '@ohos.ability.featureAbility';
import fileio from '@ohos.fileio';
let context=featureAbility.getContext();
context.getOrCreateLocalDir((err,data)=>{
let path=data+"/xxx.jpg";
let fd = fileio.openSync(path);
let obj = {
"temperature": "21°",
"formImages": {"image": fd}
};
let formBindingDataObj = formBindingData.createFormBindingData(obj);
})
```
\ No newline at end of file
```js
import featureAbility from '@ohos.ability.featureAbility';
import fileio from '@ohos.fileio';
let context=featureAbility.getContext();
context.getOrCreateLocalDir((err,data)=>{
let path=data+"/xxx.jpg";
let fd = fileio.openSync(path);
let obj = {
"temperature": "21°",
"formImages": {"image": fd}
};
let formBindingDataObj = formBindingData.createFormBindingData(obj);
})
```
## 属性
FormBindingData相关描述。
**系统能力**：SystemCapability.Ability.Form
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | -------- | -------- |
| data | 是 | 否 | Object | 是 | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。|
zh-cn/application-dev/reference/apis/js-apis-formextension.md
浏览文件 @ ac4719d5
......@@ -18,7 +18,7 @@ import FormExtension from '@ohos.application.FormExtension';
**系统能力**：SystemCapability.Ability.Form
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------- | ------------------------------------------------------- | ---- | ---- | --------------------------------------------------- |
| context | [FormExtensionContext](js-apis-formextensioncontext.md) | 是 | 否 | FormExtension的上下文环境，继承自ExtensionContext。 |
......
zh-cn/application-dev/reference/apis/js-apis-missionManager.md
浏览文件 @ ac4719d5
......@@ -869,7 +869,7 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&g
**系统API**: 此接口为系统接口，三方应用不支持调用。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| missionId | number | 是 | 是 | 表示任务ID。|
| runningState | number | 是 | 是 | 表示运行状态。 |
......
zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md
浏览文件 @ ac4719d5
......@@ -34,7 +34,7 @@ export default class MainAbility extends Ability {
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| permissions | Array&lt;string&gt; | 是 | 否 | 用户传入的权限。|
| authResults | Array&lt;number&gt; | 是 | 否 | 相应请求权限的结果。0表示授权成功，非0表示失败。 |
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或