diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index f5e276efdf152da9f7f532e1353a2c1e1480a1f8..153e151a20477e738152606b1e5d5541b6d22556 100755 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -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) diff --git a/zh-cn/application-dev/reference/apis/js-apis-Context.md b/zh-cn/application-dev/reference/apis/js-apis-Context.md index 53cdd94445bb68abd77c43020fb7bdd0fa2a2151..9eb4bd06d2e25dfb16646ab33a135fe510e6b004 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-Context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-Context.md @@ -31,7 +31,7 @@ getOrCreateLocalDir(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------- | ---------------------- | ---- | ------------- | | callback | AsyncCallback\ | 是 | 返回应用程序的本地根目录。 | @@ -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\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | ---------- | ---------------------- | ---- | -------------------- | | permission | string | 是 | 指定权限的名称。 | | callback | AsyncCallback\ | 是 | 返回权限验证结果，0有权限，-1无权限。 | @@ -141,7 +141,7 @@ verifyPermission(permission: string, options?: PermissionOptions): Promise\, requestCode: number, res **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------------- | ---------------------------------------- | ---- | ----------------------------------- | | permissions | Array\ | 是 | 指示要请求的权限列表。此参数不能为null。 | | requestCode | number | 是 | 指示要传递给PermissionRequestResult的请求代码。 | @@ -210,7 +210,7 @@ requestPermissionsFromUser(permissions: Array\, requestCode: number): Pr **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------------- | ------------------- | ----- | -------------------------------------------- | | permissions | Array\ | 是 | 指示要请求的权限列表。此参数不能为null。 | | requestCode | number | 是 | 指示要传递给PermissionRequestResult的请求代码。 | @@ -250,7 +250,7 @@ getApplicationInfo(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------- | ------------------------------- | ---- | ------------ | | callback | AsyncCallback\ | 是 | 返回当前应用程序的信息。 | @@ -302,7 +302,7 @@ getBundleName(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------- | ---------------------- | ---- | ------------------ | | callback | AsyncCallback\ | 是 | 返回当前ability的捆绑包名称。 | @@ -352,7 +352,7 @@ getDisplayOrientation(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------- | ------------------------------------------------------------ | ---- | ------------------ | | callback | AsyncCallback\<[bundle.DisplayOrientation](js-apis-Bundle.md#displayorientation)> | 是 | 表示屏幕显示方向。 | @@ -400,7 +400,7 @@ getExternalCacheDir(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------- | ---------------------- | ---- | ------------------ | | callback | AsyncCallback\ | 是 | 返回应用程序的缓存目录的绝对路径。 | @@ -448,7 +448,7 @@ setDisplayOrientation(orientation: bundle.DisplayOrientation, callback: AsyncCal **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | ----------- | ---------------------------------------- | ---- | ------------ | | orientation | [bundle.DisplayOrientation](js-apis-Bundle.md#displayorientation) | 是 | 指示当前能力的新方向。。 | | callback | AsyncCallback\ | 是 | 表示屏幕显示方向。 | @@ -502,7 +502,7 @@ setShowOnLockScreen(show: boolean, callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------- | -------------------- | ---- | ---------------------------------------- | | show | boolean | 是 | 指定是否在锁屏顶部显示此功能。值true表示在锁屏上显示，值false表示不显示。 | | callback | AsyncCallback\ | 是 | 返回回调结果。 | @@ -528,7 +528,7 @@ setShowOnLockScreen(show: boolean): Promise\; **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | ---- | ------- | ---- | ---------------------------------------- | | show | boolean | 是 | 指定是否在锁屏顶部显示此功能。值true表示在锁屏上显示，值false表示不显示。 | @@ -559,7 +559,7 @@ setWakeUpScreen(wakeUp: boolean, callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------- | -------------------- | ---- | --------------------------------- | | wakeUp | boolean | 是 | 指定是否唤醒屏幕。值true表示唤醒它，值false表示不唤醒它。 | | callback | AsyncCallback\ | 是 | 返回回调结果。 | @@ -585,7 +585,7 @@ setWakeUpScreen(wakeUp: boolean): Promise\; **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | ------ | ------- | ---- | --------------------------------- | | wakeUp | boolean | 是 | 指定是否唤醒屏幕。值true表示唤醒它，值false表示不唤醒它。 | @@ -619,7 +619,7 @@ getProcessInfo(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------- | --------------------------- | ---- | ---------- | | callback | AsyncCallback\ | 是 | 返回当前进程的信息。 | @@ -673,7 +673,7 @@ getElementName(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------- | --------------------------- | ---- | -------------------------------------- | | callback | AsyncCallback\ | 是 | 返回当前ability的ohos.bundle.ElementName对象。 | @@ -725,7 +725,7 @@ getProcessName(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------- | ---------------------- | ---- | ---------- | | callback | AsyncCallback\ | 是 | 返回当前进程的名称。 | @@ -777,7 +777,7 @@ getCallingBundle(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------- | ---------------------- | ---- | ---------------- | | callback | AsyncCallback\ | 是 | 返回调用ability的包名称。 | @@ -827,7 +827,7 @@ getCacheDir(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------- | ---------------------- | ---- | --------------- | | callback | AsyncCallback\ | 是 | 返回该应用程序的内部存储目录。 | @@ -875,7 +875,7 @@ getFilesDir(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------- | ---------------------- | ---- | ------------------- | | callback | AsyncCallback\ | 是 | 返回内部存储器上此应用程序的文件目录。 | @@ -925,7 +925,7 @@ getOrCreateDistributedDir(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------- | ---------------------- | ---- | ---------------------------------------- | | callback | AsyncCallback\ | 是 | 回调函数，可以在回调函数中处理接口返回值，返回Ability或应用的分布式文件路径。如果分布式文件路径不存在，系统将创建一个路径并返回创建的路径。 | @@ -975,7 +975,7 @@ getAppType(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------- | ---------------------- | ---- | -------------------------------- | | callback | AsyncCallback\ | 是 | 回调函数，可以在回调函数中处理接口返回值，返回此应用程序的类型。 | @@ -1023,7 +1023,7 @@ getHapModuleInfo(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------- | ---------------------------------------- | ---- | --------------------------------------- | | callback | AsyncCallback\<[HapModuleInfo](js-apis-bundle-HapModuleInfo.md)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回应用的ModuleInfo对象。 | @@ -1071,7 +1071,7 @@ getAppVersionInfo(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------- | ---------------------------------------- | ---- | ------------------------------ | | callback | AsyncCallback\<[AppVersionInfo](#appversioninfo)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回应用版本信息。 | @@ -1119,7 +1119,7 @@ getAbilityInfo(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------- | ---------------------------------------- | ---- | --------------------------------------- | | callback | AsyncCallback\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回当前归属Ability详细信息。 | @@ -1188,7 +1188,7 @@ isUpdatingConfigurations(callback: AsyncCallback\): void; **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------- | ----------------------- | ---- | ----------------------------- | | callback | AsyncCallback\ | 是 | 如果该能力的配置正在更改，则为true，否则为false。 | @@ -1236,7 +1236,7 @@ printDrawnCompleted(callback: AsyncCallback\): void; **参数：** -| 名称 | 类型 | 必填 | 描述 | +| 参数名 | 类型 | 必填 | 描述 | | -------- | -------------------- | ---- | ----------- | | callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | @@ -1279,20 +1279,20 @@ context.printDrawnCompleted().then((data) => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 读写属性 | 类型 | 必填 | 描述 | -| ---- | ---- | ------ | ---- | ----- | -| pid | 只读 | number | 否 | 进程id。 | -| uid | 只读 | number | 否 | 用户id。 | +| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | +| ---- | ---- |-------- | ------ | ---- | ----- | +| pid | 是 | 否 | number | 否 | 进程id。 | +| uid | 是 | 否 | number | 否 | 用户id。 | ## PermissionRequestResult7+ **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 读写属性 | 类型 | 必填 | 描述 | -| ----------- | ---- | -------------- | ---- | ---------- | -| requestCode | 只读 | number | 是 | 用户传入的请求代码。 | -| permissions | 只读 | Array\ | 是 | 用户传入的权限。 | -| authResults | 只读 | Array\ | 是 | 请求权限的结果。 | +| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | +| ----------- | ---- |-------- | -------------- | ---- | ---------- | +| requestCode | 是 | 否 | number | 是 | 用户传入的请求代码。 | +| permissions | 是 | 否 | Array\ | 是 | 用户传入的权限。 | +| authResults | 是 | 否 | Array\ | 是 | 请求权限的结果。 | ## AppVersionInfo7+ diff --git a/zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md b/zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md index 97cf4b213839a3217c7050504e3cd145080bfc1f..0332b8e41ed1e3e567e70403dad7627f9fb6ce9c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md +++ b/zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md @@ -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 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-Want.md b/zh-cn/application-dev/reference/apis/js-apis-ability-Want.md index 31977ac9d0b78e7f7c77b0d6cb2c0a3c890d3980..81fe4d7c103b60d3627a6ee03aaef1ab4411b9f6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-Want.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-Want.md @@ -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值：
ohos.aafwk.callerPid 表示拉起方的pid。
ohos.aafwk.param.callerToken 表示拉起方的token。
ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。 | -| entities | 只读 | Array\ | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 | -| moduleName9+ | 只读 | 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值：
ohos.aafwk.callerPid 表示拉起方的pid。
ohos.aafwk.param.callerToken 表示拉起方的token。
ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。 | +| entities | 是 | 否 | Array\ | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 | +| moduleName9+ | 是 | 否 | string | 否 | 表示待启动的Ability所属的模块（module）。 | 具体字段描述参考ability/want.d.ts文件 diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-ability.md b/zh-cn/application-dev/reference/apis/js-apis-ability-ability.md index 5ff48efe1904e054c0fbefc92707039ba14a350a..473f7205a65f12057ca108f9e0903e71f975ad03 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-ability.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-ability.md @@ -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二级模块。 | **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-abilityResult.md b/zh-cn/application-dev/reference/apis/js-apis-ability-abilityResult.md index 2305ac5a20596fb301c4857eccccaaa840dc9311..ccd5569638750040a8df200103c1b31b07895948 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-abilityResult.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-abilityResult.md @@ -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 diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md b/zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md index 3ac842d69c02d585203b5cdf21a87579db63527f..c07de214397189e8a7e398658bd5170b1d01d71c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md @@ -20,7 +20,7 @@ import errorCode from '@ohos.ability.errorCode' **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 变量 | 值 | 说明 | +| 名称 | 值 | 说明 | | ------------------------------ | ---- | ---------------------------------------- | | NO_ERROR | 0 | 没有错误。 | | INVALID_PARAMETER | -1 | 无效的参数。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md b/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md index 038e29952871a2d96f2a51ef4966c0b3b6768bd6..f59251079e3feb37f06349cfe2646bb8cde16168 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md @@ -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执行写入操作的授权。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md b/zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md index 3e84088d2b8826e175eb14c9d8e8dd6eea431f50..f419bebbae38d348233b618902b28d18f9e0b779 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md @@ -23,7 +23,7 @@ abilitymanager.getAbilityRunningInfos((err,data) => { **系统API**：该接口为系统接口，三方应用不支持调用。 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | ability | ElementName | 是 | 否 | Ability匹配信息 | | pid | number | 是 | 否 | 进程ID。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md b/zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md index 58c966eb524c7afc9ad190c0c66d00d10b18e979..39a672967e687ab26bc176030d4dbafb9c5dbbe8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md @@ -26,7 +26,7 @@ class MyAbilityStage extends AbilityStage { **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | currentHapModuleInfo | HapModuleInfo | 是 | 否 | AbilityStage对应的ModuleInfo对象。 | | config | [Configuration](js-apis-configuration.md) | 是 | 否 | 环境变化对象。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-accessibility-config.md b/zh-cn/application-dev/reference/apis/js-apis-accessibility-config.md index 816a2e717534f23609ddeaf04983bd375c87f61e..7917f7e2c06f37876d0a1fbb2fe79c336585fa00 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-accessibility-config.md +++ b/zh-cn/application-dev/reference/apis/js-apis-accessibility-config.md @@ -440,7 +440,7 @@ config.highContrastText.off((data) => { **系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core -| 名称 | 描述 | +| 名称 | 说明 | | -------- | -------- | | Normal | 表示正常类型。 | | Protanomaly | 表示红色弱视类型。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-StartOptions.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-StartOptions.md index 56efe281fb200dcd0ac5205e0d14ece980d7a3bc..d1ddac75debac599e2ae21a9ba368c0bea8faf40 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-StartOptions.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-StartOptions.md @@ -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。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-Want.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-Want.md index d686c99bcf8d859cb789f60914fea4d59ece2e6c..1abcd1c631adf66ec00cee8af6409b7935cd03ba 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-Want.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-Want.md @@ -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值：
ohos.aafwk.callerPid 表示拉起方的pid。
ohos.aafwk.param.callerToken 表示拉起方的token。
ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。 | -| entities | 只读 | Array\ | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 | -| moduleName9+ | 只读 | 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值：
ohos.aafwk.callerPid 表示拉起方的pid。
ohos.aafwk.param.callerToken 表示拉起方的token。
ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。 | +| entities | 是 | 否 | Array\ | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 | +| moduleName9+ | 是 | 否 | string | 否 | 表示待启动的Ability所属的模块（module）。 | 具体字段描述参考ability/want.d.ts文件 diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md index c774c1ab3acabb5e0705cd5349e49323eee35448..176430808dbc106d85134a96b18fd719fd21d606 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md @@ -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 | 应用恢复保存状态。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityLifecycleCallback.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityLifecycleCallback.md index c7c83bb4a0566a1ce580afd6364946ccf9c4436f..e2cc4c4bbc6d582b4dd42d905f5e71d98209f799 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityLifecycleCallback.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityLifecycleCallback.md @@ -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 diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md index 46dcaf7e964a9efdbbbb22915c785198026d1fc0..f88bb99df81b2d6c7fb0420b51557010dd5c6c49 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md @@ -41,7 +41,7 @@ updateConfiguration(config: Configuration, callback: AsyncCallback\): void **参数**： -| 名称 | 类型 | 必填 | 描述 | +| 名称 | 类型 | 必填 | 说明 | | --------- | ---------------------------------------- | ---- | -------------- | | config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 新的配置项。 | | callback | AsyncCallback\ | 是 | 被指定的回调方法。 | @@ -77,7 +77,7 @@ updateConfiguration(config: Configuration): Promise\ **参数**： -| 名称 | 类型 | 必填 | 描述 | +| 名称 | 类型 | 必填 | 说明 | | --------- | ---------------------------------------- | ---- | -------------- | | config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 新的配置项。 | @@ -120,7 +120,7 @@ getAbilityRunningInfos(callback: AsyncCallback\>): vo **参数**： -| 名称 | 类型 | 必填 | 描述 | +| 名称 | 类型 | 必填 | 说明 | | --------- | ---------------------------------------- | ---- | -------------- | | callback | AsyncCallback\> | 是 | 被指定的回调方法。 | @@ -184,7 +184,7 @@ getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\> | 是 | 被指定的回调方法。 | @@ -218,7 +218,7 @@ getExtensionRunningInfos(upperLimit: number): Promise\): void; **参数**： -| 名称 | 类型 | 必填 | 描述 | +| 名称 | 类型 | 必填 | 说明 | | --------- | ---------------------------------------- | ---- | -------------- | | callback | AsyncCallback\ | 是 | 被指定的回调方法。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md index ae6136c862c3d60dcd90261e3c9d48f01c13e7ef..e29f2190aa95098b63ad6699b916776802bbf9bc 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md @@ -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 | 状态先保存在内存中，应用故障退出时写入到本地文件缓存。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-appmanager.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-appmanager.md index b77df2cb8eddd225b7c22c193030bea75342ce82..0d7f113e580df601682bf836a141ce668d24a844 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-appmanager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-appmanager.md @@ -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\ | 否 | 进程中运行的bundleName数组。 | +| pid | 是 | 否 | number | 否 | 进程ID。 | +| uid | 是 | 否 | number | 否 | 用户ID。 | +| processName | 是 | 否 | string | 否 | 进程的名称。 | +| bundleNames | 是 | 否 | Array\ | 否 | 进程中运行的bundleName数组。 | ## ApplicationStateObserver @@ -974,12 +974,12 @@ onProcessDied(processData: ProcessData): void; **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 读写属性 | 类型 | 必填 | 描述 | +| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | -| pid | 只读 | number | 否 | 进程ID。 | -| uid | 只读 | number | 否 | 用户ID。 | -| processName | 只读 | string | 否 | 进程的名称。 | -| bundleNames | 只读 | Array\ | 否 | 进程中运行的bundleName数组。 | +| pid | 是 | 否 | number | 否 | 进程ID。 | +| uid | 是 | 否 | number | 否 | 用户ID。 | +| processName | 是 | 否 | string | 否 | 进程的名称。 | +| bundleNames | 是 | 否 | Array\ | 否 | 进程中运行的bundleName数组。 | ## ApplicationState diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md index 87e9c9d66357e73ca574fc959389a6c88f1c25a6..b74857f2a1501e1cb25fb2ec68f5cbcd5b9a0414 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md @@ -8,7 +8,7 @@ **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase - | 名称 | 参数类型 | 可读 | 可写 | 说明 | + | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | language | string | 是 | 是 | 表示应用程序的当前语言。 | | colorMode | [ColorMode](js-apis-app-ability-configurationconstant.md#configurationconstantcolormode) | 是 | 是 | 表示深浅色模式，取值范围：浅色模式（COLOR_MODE_LIGHT），深色模式（COLOR_MODE_DARK）。默认为浅色。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-formInfo.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-formInfo.md deleted file mode 100644 index 54a98bb3f4559d2c8cb3b9116ab3c8c0b1659b85..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-formInfo.md +++ /dev/null @@ -1,144 +0,0 @@ -# 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<number> | 表示卡片支持的规格。 | -| 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" | 卡片标识。
**系统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" | 设备标识。
此接口为系统接口。 | -| 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与提供值相符的卡片信息。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-formbindingdata.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-formbindingdata.md deleted file mode 100644 index bd20a5fc9a5834ab885d3a99151283706e99118b..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-formbindingdata.md +++ /dev/null @@ -1,69 +0,0 @@ -# 卡片数据绑定类 - -卡片数据绑定模块提供卡片数据绑定的能力。包括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 格式的字符串。| - diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-formextension.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-formextension.md deleted file mode 100644 index 2122a3fb55253d3cdf29f667dc8a35ff35f32e59..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-formextension.md +++ /dev/null @@ -1,289 +0,0 @@ -# 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 diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-formhost.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-formhost.md deleted file mode 100644 index 9f7be9294d55ae7b3e03a69a428d703b79c19401..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-formhost.md +++ /dev/null @@ -1,1181 +0,0 @@ -# FormHost - -FormHost模块提供了卡片使用方相关接口的能力，包括删除、释放、请求更新卡片，发送通知到指定卡片，获取卡片信息、状态等。 - -> **说明：** -> -> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> 本模块接口均为系统接口，三方应用不支持调用。 - -## 导入模块 - -``` -import formHost from '@ohos.application.formHost'; -``` - -## 权限 - -ohos.permission.REQUIRE_FORM - -ohos.permission.GET_BUNDLE_INFO_PRIVILEGED - -## deleteForm - -deleteForm(formId: string, callback: AsyncCallback<void>): void; - -删除指定的卡片。调用此方法后，应用程序将无法使用该卡片，卡片管理器服务不再保留有关该卡片的信息。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formId | string | 是 | 卡片标识 | -| callback | AsyncCallback<void> | 是 | callback形式返回结果 | - -**示例：** - - ```js - var formId = "12400633174999288"; - formHost.deleteForm(formId, (error, data) => { - if (error.code) { - console.log('formHost deleteForm, error:' + JSON.stringify(error)); - } - }); - ``` - -## deleteForm - -deleteForm(formId: string): Promise<void>; - -删除指定的卡片。调用此方法后，应用程序将无法使用该卡片，卡片管理器服务不再保留有关该卡片的信息。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ------- | - | formId | string | 是 | 卡片标识 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果 | - -**参数：** - - ```js - var formId = "12400633174999288"; - formHost.deleteForm(formId).then(() => { - console.log('formHost deleteForm success'); - }).catch((error) => { - console.log('formHost deleteForm, error:' + JSON.stringify(error)); - }); - ``` - -## releaseForm - -releaseForm(formId: string, callback: AsyncCallback<void>): void; - -释放指定的卡片。调用此方法后，应用程序将无法使用该卡片，但卡片管理器服务仍然保留有关该卡片的缓存信息和存储信息。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formId | string | 是 | 卡片标识 | -| callback | AsyncCallback<void> | 是 | callback形式返回结果 | - -**示例：** - - ```js - var formId = "12400633174999288"; - formHost.releaseForm(formId, (error, data) => { - if (error.code) { - console.log('formHost releaseForm, error:' + JSON.stringify(error)); - } - }); - ``` - -## releaseForm - -releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback<void>): void; - -释放指定的卡片。调用此方法后，应用程序将无法使用该卡片，卡片管理器服务保留有关该卡片的存储信息，可以选择是否保留缓存信息。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------------- | ------ | ---- | ----------- | -| formId | string | 是 | 卡片标识 | -| isReleaseCache | boolean | 是 | 是否释放缓存 | -| callback | AsyncCallback<void> | 是 | callback形式返回结果 | - -**示例：** - - ```js - var formId = "12400633174999288"; - formHost.releaseForm(formId, true, (error, data) => { - if (error.code) { - console.log('formHost releaseForm, error:' + JSON.stringify(error)); - } - }); - ``` - -## releaseForm - -releaseForm(formId: string, isReleaseCache?: boolean): Promise<void>; - -释放指定的卡片。调用此方法后，应用程序将无法使用该卡片，卡片管理器服务保留有关该卡片的存储信息，可以选择是否保留缓存信息。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------------- | ------ | ---- | ----------- | - | formId | string | 是 | 卡片标识 | - | isReleaseCache | boolean | 否 | 是否释放缓存 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果 | - -**示例：** - - ```js - var formId = "12400633174999288"; - formHost.releaseForm(formId, true).then(() => { - console.log('formHost releaseForm success'); - }).catch((error) => { - console.log('formHost releaseForm, error:' + JSON.stringify(error)); - }); - ``` - -## requestForm - -requestForm(formId: string, callback: AsyncCallback<void>): void; - -请求卡片更新。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formId | string | 是 | 卡片标识 | -| callback | AsyncCallback<void> | 是 | callback形式返回结果 | - -**示例：** - - ```js - var formId = "12400633174999288"; - formHost.requestForm(formId, (error, data) => { - if (error.code) { - console.log('formHost requestForm, error:' + JSON.stringify(error)); - } - }); - ``` - -## requestForm - -requestForm(formId: string): Promise<void>; - -请求卡片更新。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ------- | - | formId | string | 是 | 卡片标识 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果 | - -**示例：** - - ```js - var formId = "12400633174999288"; - formHost.requestForm(formId).then(() => { - console.log('formHost requestForm success'); - }).catch((error) => { - console.log('formHost requestForm, error:' + JSON.stringify(error)); - }); - ``` - -## castTempForm - -castTempForm(formId: string, callback: AsyncCallback<void>): void; - -将指定的临时卡片转换为普通卡片。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formId | string | 是 | 卡片标识 | -| callback | AsyncCallback<void> | 是 | callback形式返回结果 | - -**示例：** - - ```js - var formId = "12400633174999288"; - formHost.castTempForm(formId, (error, data) => { - if (error.code) { - console.log('formHost castTempForm, error:' + JSON.stringify(error)); - } - }); - ``` - -## castTempForm - -castTempForm(formId: string): Promise<void>; - -将指定的临时卡片转换为普通卡片。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ------- | - | formId | string | 是 | 卡片标识 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果 | - -**示例：** - - ```js - var formId = "12400633174999288"; - formHost.castTempForm(formId).then(() => { - console.log('formHost castTempForm success'); - }).catch((error) => { - console.log('formHost castTempForm, error:' + JSON.stringify(error)); - }); - ``` - -## notifyVisibleForms - -notifyVisibleForms(formIds: Array<string>, callback: AsyncCallback<void>): void; - -向卡片框架发送通知以使指定的卡片可见。该方法调用成功后，会调用onVisibilityChange通知卡片提供方。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formIds | Array<string> | 是 | 卡片标识列表 | -| callback | AsyncCallback<void> | 是 | callback形式返回结果 | - -**示例：** - - ```js - var formId = ["12400633174999288"]; - formHost.notifyVisibleForms(formId, (error, data) => { - if (error.code) { - console.log('formHost notifyVisibleForms, error:' + JSON.stringify(error)); - } - }); - ``` - -## notifyVisibleForms - -notifyVisibleForms(formIds: Array<string>): Promise<void>; - -向卡片框架发送通知以使指定的卡片可见。该方法调用成功后，会调用onVisibilityChange通知卡片提供方。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formIds | Array<string> | 是 | 卡片标识列表 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果 | - -**示例：** - - ```js - var formId = ["12400633174999288"]; - formHost.notifyVisibleForms(formId).then(() => { - console.log('formHost notifyVisibleForms success'); - }).catch((error) => { - console.log('formHost notifyVisibleForms, error:' + JSON.stringify(error)); - }); - ``` - -## notifyInvisibleForms - -notifyInvisibleForms(formIds: Array<string>, callback: AsyncCallback<void>): void; - -向卡片框架发送通知以使指定的卡片不可见。该方法调用成功后，会调用onVisibilityChange通知卡片提供方。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formIds | Array<string> | 是 | 卡片标识列表 | -| callback | AsyncCallback<void> | 是 | callback形式返回结果 | - -**示例：** - - ```js - var formId = ["12400633174999288"]; - formHost.notifyInvisibleForms(formId, (error, data) => { - if (error.code) { - console.log('formHost notifyInvisibleForms, error:' + JSON.stringify(error)); - } - }); - ``` - -## notifyInvisibleForms - -notifyInvisibleForms(formIds: Array<string>): Promise<void>; - -向卡片框架发送通知以使指定的卡片不可见。该方法调用成功后，会调用onVisibilityChange通知卡片提供方。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formIds | Array<string> | 是 | 卡片标识列表 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果 | - -**示例：** - - ```js - var formId = ["12400633174999288"]; - formHost.notifyInvisibleForms(formId).then(() => { - console.log('formHost notifyInvisibleForms success'); - }).catch((error) => { - console.log('formHost notifyInvisibleForms, error:' + JSON.stringify(error)); - }); - ``` - -## enableFormsUpdate - -enableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void>): void; - -向卡片框架发送通知以使指定的卡片可以更新。该方法调用成功后，卡片刷新状态设置为使能，卡片可以接收来自卡片提供方的更新。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formIds | Array<string> | 是 | 卡片标识列表 | -| callback | AsyncCallback<void> | 是 | callback形式返回结果 | - -**示例：** - - ```js - var formId = ["12400633174999288"]; - formHost.enableFormsUpdate(formId, (error, data) => { - if (error.code) { - console.log('formHost enableFormsUpdate, error:' + JSON.stringify(error)); - } - }); - ``` - -## enableFormsUpdate - -enableFormsUpdate(formIds: Array<string>): Promise<void>; - -向卡片框架发送通知以使指定的卡片可以更新。该方法调用成功后，卡片刷新状态设置为使能，卡片可以接收来自卡片提供方的更新。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formIds | Array<string> | 是 | 卡片标识列表 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果 | - -**示例：** - - ```js - var formId = ["12400633174999288"]; - formHost.enableFormsUpdate(formId).then(() => { - console.log('formHost enableFormsUpdate success'); - }).catch((error) => { - console.log('formHost enableFormsUpdate, error:' + JSON.stringify(error)); - }); - ``` - -## disableFormsUpdate - -disableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void>): void; - -向卡片框架发送通知以使指定的卡片不可以更新。该方法调用成功后，卡片刷新状态设置为去使能，卡片不可以接收来自卡片提供方的更新。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formIds | Array<string> | 是 | 卡片标识列表 | -| callback | AsyncCallback<void> | 是 | callback形式返回结果 | - -**示例：** - - ```js - var formId = ["12400633174999288"]; - formHost.disableFormsUpdate(formId, (error, data) => { - if (error.code) { - console.log('formHost disableFormsUpdate, error:' + JSON.stringify(error)); - } - }); - ``` - -## disableFormsUpdate - -disableFormsUpdate(formIds: Array<string>): Promise<void>; - -向卡片框架发送通知以使指定的卡片不可以更新。该方法调用成功后，卡片刷新状态设置为去使能，卡片不可以接收来自卡片提供方的更新。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formIds | Array<string> | 是 | 卡片标识列表 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果 | - -**示例：** - - ```js - var formId = ["12400633174999288"]; - formHost.disableFormsUpdate(formId).then(() => { - console.log('formHost disableFormsUpdate success'); - }).catch((error) => { - console.log('formHost disableFormsUpdate, error:' + JSON.stringify(error)); - }); - ``` - -## isSystemReady - -isSystemReady(callback: AsyncCallback<void>): void; - -检查系统是否准备好。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| callback | AsyncCallback<void> | 是 | callback形式返回结果 | - -**示例：** - - ```js - var formId = "12400633174999288"; - formHost.isSystemReady((error, data) => { - if (error.code) { - console.log('formHost isSystemReady, error:' + JSON.stringify(error)); - } - }); - ``` - -## isSystemReady - -isSystemReady(): Promise<void>; - -检查系统是否准备好。 - -**系统能力**：SystemCapability.Ability.Form - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果 | - -**示例：** - - ```js - var formId = "12400633174999288"; - formHost.isSystemReady().then(() => { - console.log('formHost isSystemReady success'); - }).catch((error) => { - console.log('formHost isSystemReady, error:' + JSON.stringify(error)); - }); - ``` - -## getAllFormsInfo - -getAllFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): void; - -获取设备上所有应用提供的卡片信息。 - -**需要权限**：ohos.permission.GET_BUNDLE_INFO_PRIVILEGED - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ------- | - | callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | callback形式返回查询到的卡片信息 | - -**示例：** - - ```js - formHost.getAllFormsInfo((error, data) => { - if (error.code) { - console.log('formHost getAllFormsInfo, error:' + JSON.stringify(error)); - } else { - console.log('formHost getAllFormsInfo, data:' + JSON.stringify(data)); - } - }); - ``` - -## getAllFormsInfo - -getAllFormsInfo(): Promise<Array<formInfo.FormInfo>>; - - -获取设备上所有应用提供的卡片信息。 - -**需要权限**：ohos.permission.GET_BUNDLE_INFO_PRIVILEGED - -**系统能力**：SystemCapability.Ability.Form - -**返回值：** - -| 类型 | 说明 | -| :------------ | :---------------------------------- | -| Promise<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | Promise实例，用于获取异步返回查询到的卡片信息 | - -**示例：** - - ```js - formHost.getAllFormsInfo().then((data) => { - console.log('formHost getAllFormsInfo data:' + JSON.stringify(data)); - }).catch((error) => { - console.log('formHost getAllFormsInfo, error:' + JSON.stringify(error)); - }); - ``` - -## getFormsInfo - -getFormsInfo(bundleName: string, callback: AsyncCallback<Array<formInfo.FormInfo>>): void; - - -获取设备上指定应用程序提供的卡片信息。 - -**需要权限**：ohos.permission.GET_BUNDLE_INFO_PRIVILEGED - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ------- | - | bundleName | string | 是 | 要查询的应用程序包名称 | - | callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | callback形式返回查询到的卡片信息 | - -**示例：** - - ```js - formHost.getFormsInfo("com.example.ohos.formjsdemo", (error, data) => { - if (error.code) { - console.log('formHost getFormsInfo, error:' + JSON.stringify(error)); - } else { - console.log('formHost getFormsInfo, data:' + JSON.stringify(data)); - } - }); - ``` - -## getFormsInfo - -getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback<Array<formInfo.FormInfo>>): void; - - -获取设备上指定应用程序提供的卡片信息。 - -**需要权限**：ohos.permission.GET_BUNDLE_INFO_PRIVILEGED - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ------- | - | bundleName | string | 是 | 要查询的应用程序包名称 | - | moduleName | string | 是 | 要查询的模块名称 | - | callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | callback形式返回查询到的卡片信息 | - -**示例：** - - ```js - formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry", (error, data) => { - if (error.code) { - console.log('formHost getFormsInfo, error:' + JSON.stringify(error)); - } else { - console.log('formHost getFormsInfo, data:' + JSON.stringify(data)); - } - }); - ``` - -## getFormsInfo - -getFormsInfo(bundleName: string, moduleName?: string): Promise<Array<formInfo.FormInfo>>; - - -获取设备上指定应用程序提供的卡片信息。 - -**需要权限**：ohos.permission.GET_BUNDLE_INFO_PRIVILEGED - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ------- | - | bundleName | string | 是 | 要查询的应用程序包名称 | - | moduleName | string | 否 | 要查询的模块名称 | - -**返回值：** - -| 类型 | 说明 | -| :------------ | :---------------------------------- | -| Promise<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | Promise实例，用于获取异步返回查询到的卡片信息 | - -**示例：** - - ```js - formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry").then((data) => { - console.log('formHost getFormsInfo, data:' + JSON.stringify(data)); - }).catch((error) => { - console.log('formHost getFormsInfo, error:' + JSON.stringify(error)); - }); - ``` - -## deleteInvalidForms - -deleteInvalidForms(formIds: Array<string>, callback: AsyncCallback<number>): void; - -根据列表删除应用程序的无效卡片。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formIds | Array<string> | 是 | 有效卡片标识列表 | -| callback | AsyncCallback<number> | 是 | callback形式返回删除的卡片个数 | - -**示例：** - - ```js - var formIds = new Array("12400633174999288", "12400633174999289"); - formHost.deleteInvalidForms(formIds, (error, data) => { - if (error.code) { - console.log('formHost deleteInvalidForms, error:' + JSON.stringify(error)); - } else { - console.log('formHost deleteInvalidForms, data:' + JSON.stringify(data)); - } - }); - ``` - -## deleteInvalidForms - -deleteInvalidForms(formIds: Array<string>): Promise<number>; - -根据列表删除应用程序的无效卡片。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formIds | Array<string> | 是 | 有效卡片标识列表 | - -**返回值：** - -| 类型 | 说明 | -| :------------ | :---------------------------------- | -| Promise<number> | Promise实例，用于获取异步返回删除的卡片个数 | - -**示例：** - - ```js - var formIds = new Array("12400633174999288", "12400633174999289"); - formHost.deleteInvalidForms(formIds).then((data) => { - console.log('formHost deleteInvalidForms, data:' + JSON.stringify(data)); - }).catch((error) => { - console.log('formHost deleteInvalidForms, error:' + JSON.stringify(error)); - }); - ``` - -## acquireFormState - -acquireFormState(want: Want, callback: AsyncCallback<formInfo.FormStateInfo>): void; - -获取卡片状态 - -**需要权限**：ohos.permission.REQUIRE_FORM 和 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| want | [Want](js-apis-application-Want.md) | 是 | 查询卡片状态时携带的want信息 | -| callback | AsyncCallback<[FormStateInfo](js-apis-formInfo.md#formstateinfo)> | 是 | callback形式返回卡片状态 | - -**示例：** - - ```js - var want = { - "deviceId": "", - "bundleName": "ohos.samples.FormApplication", - "abilityName": "FormAbility", - "parameters": { - "ohos.extra.param.key.module_name": "entry", - "ohos.extra.param.key.form_name": "widget", - "ohos.extra.param.key.form_dimension": 2 - } - }; - formHost.acquireFormState(want, (error, data) => { - if (error.code) { - console.log('formHost acquireFormState, error:' + JSON.stringify(error)); - } else { - console.log('formHost acquireFormState, data:' + JSON.stringify(data)); - } - }); - ``` - -## acquireFormState - -acquireFormState(want: Want): Promise<formInfo.FormStateInfo>; - -获取卡片状态。 - -**需要权限**：ohos.permission.REQUIRE_FORM 和 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| want | [Want](js-apis-application-Want.md) | 是 | 查询卡片状态时携带的want信息 | - -**返回值：** - -| 类型 | 说明 | -| :------------ | :---------------------------------- | -| Promise<[FormStateInfo](js-apis-formInfo.md#formstateinfo)> | Promise实例，用于返回卡片状态 | - -**示例：** - - ```js - var want = { - "deviceId": "", - "bundleName": "ohos.samples.FormApplication", - "abilityName": "FormAbility", - "parameters": { - "ohos.extra.param.key.module_name": "entry", - "ohos.extra.param.key.form_name": "widget", - "ohos.extra.param.key.form_dimension": 2 - } - }; - formHost.acquireFormState(want).then((data) => { - console.log('formHost acquireFormState, data:' + JSON.stringify(data)); - }).catch((error) => { - console.log('formHost acquireFormState, error:' + JSON.stringify(error)); - }); - ``` - -## on("formUninstall") - -on(type: "formUninstall", callback: Callback<string>): void; - -订阅卡片卸载事件。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| type | string | 是 | 填写"formUninstall"，表示卡片卸载事件 | -| callback | Callback<string> | 是 | 需要注册的事件回调方法 | - -**示例：** - - ```js - let callback = function(formId) { - console.log('formHost on formUninstall, formId:' + formId); - } - formHost.on("formUninstall", callback); - ``` - -## off("formUninstall") - -off(type: "formUninstall", callback?: Callback<string>): void; - -取消订阅卡片卸载事件。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| type | string | 是 | 填写"formUninstall"，表示卡片卸载事件 | -| callback | Callback<string> | 否 | 需要注销的事件回调方法。缺省时，表示注销所有已注册事件回调 | - -**示例：** - - ```js - let callback = function(formId) { - console.log('formHost on formUninstall, formId:' + formId); - } - formHost.off("formUninstall", callback); - ``` - -## notifyFormsVisible - -notifyFormsVisible(formIds: Array<string>, isVisible: boolean, callback: AsyncCallback<void>): void; - -通知卡片是否可见。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formIds | Array<string> | 是 | 卡片标识列表 | -| isVisible | boolean | 是 | 是否可见 | -| callback | AsyncCallback<void> | 是 | callback形式返回结果 | - -**示例：** - - ```js - var formIds = new Array("12400633174999288", "12400633174999289"); - formHost.notifyFormsVisible(formIds, true, (error, data) => { - if (error.code) { - console.log('formHost notifyFormsVisible, error:' + JSON.stringify(error)); - } - }); - ``` - -## notifyFormsVisible - -notifyFormsVisible(formIds: Array<string>, isVisible: boolean): Promise<void>; - -通知卡片是否可见。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ------- | - | formIds | Array<string> | 是 | 卡片标识列表 | - | isVisible | boolean | 是 | 是否可见 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果 | - -**示例：** - - ```js - var formIds = new Array("12400633174999288", "12400633174999289"); - formHost.notifyFormsVisible(formIds, true).then(() => { - console.log('formHost notifyFormsVisible success'); - }).catch((error) => { - console.log('formHost notifyFormsVisible, error:' + JSON.stringify(error)); - }); - ``` - -## notifyFormsEnableUpdate - -notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean, callback: AsyncCallback<void>): void; - -通知卡片是否启用更新状态。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formIds | Array<string> | 是 | 卡片标识列表 | -| isEnableUpdate | boolean | 是 | 是否使能更新 | -| callback | AsyncCallback<void> | 是 | callback形式返回结果 | - -**示例：** - - ```js - var formIds = new Array("12400633174999288", "12400633174999289"); - formHost.notifyFormsEnableUpdate(formIds, true, (error, data) => { - if (error.code) { - console.log('formHost notifyFormsEnableUpdate, error:' + JSON.stringify(error)); - } - }); - ``` - -## notifyFormsEnableUpdate - -notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean): Promise<void>; - -通知卡片是否启用更新状态。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ------- | - | formIds | Array<string> | 是 | 卡片标识列表 | - | isEnableUpdate | boolean | 是 | 是否使能更新 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果 | - -**示例：** - - ```js - var formIds = new Array("12400633174999288", "12400633174999289"); - formHost.notifyFormsEnableUpdate(formIds, true).then(() => { - console.log('formHost notifyFormsEnableUpdate success'); - }).catch((error) => { - console.log('formHost notifyFormsEnableUpdate, error:' + JSON.stringify(error)); - }); - ``` -## shareForm9+ - -shareForm(formId: string, deviceId: string, callback: AsyncCallback<void>): void; - -指定formId和远程设备Id进行卡片分享。 - -此接口为系统接口。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formId | string | 是 | 卡片标识 | -| deviceId | string | 是 | 远程设备标识 | -| callback | AsyncCallback<void> | 是 | callback形式返回结果 | - -**示例：** - - ```js - var formId = "12400633174999288"; - var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2"; - formHost.shareForm(formId, deviceId, (error, data) => { - if (error.code) { - console.log('formHost shareForm, error:' + JSON.stringify(error)); - } - }); - ``` - -## shareForm9+ - -shareForm(formId: string, deviceId: string): Promise<void>; - -指定formId和远程设备Id进行卡片分享。 - -此接口为系统接口。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ------- | - | formId | string | 是 | 卡片标识 | - | deviceId | string | 是 | 远程设备标识 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果 | - -**参数：** - - ```js - var formId = "12400633174999288"; - var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2"; - formHost.shareForm(formId, deviceId).then(() => { - console.log('formHost shareForm success'); - }).catch((error) => { - console.log('formHost shareForm, error:' + JSON.stringify(error)); - }); - ``` - -## notifyFormsPrivacyProtected - -notifyFormsPrivacyProtected(formIds: Array<string>, isProtected: boolean, callback: AsyncCallback<void>): void; - -通知卡片隐私是否需要保护。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ------- | - | formIds | Array<string> | 是 | 卡片标识列表 | - | isProtected | boolean | 是 | 是否需要保护 | - | callback | AsyncCallback<void> | 是 | callback形式返回结果 | - -**示例：** - - ```js - var formIds = new Array("12400633174999288", "12400633174999289"); - formHost.notifyFormsPrivacyProtected(formIds, true, (error, data) => { - if (error.code) { - console.log('formHost notifyFormsPrivacyProtected, error:' + JSON.stringify(error)); - } - }); - ``` - -## notifyFormsPrivacyProtected - -notifyFormsPrivacyProtected(formIds: Array<string>, isProtected: boolean): Promise<void>; - -通知卡片隐私是否需要保护。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ------- | - | formIds | Array<string> | 是 | 卡片标识列表 | - | isProtected | boolean | 是 | 是否需要保护 | - -**示例：** - - ```js - var formIds = new Array("12400633174999288", "12400633174999289"); - formHost.notifyFormsPrivacyProtected(formIds, true).then(() => { - console.log('formHost notifyFormsPrivacyProtected success'); - }).catch((error) => { - console.log('formHost notifyFormsPrivacyProtected, error:' + JSON.stringify(error)); - }); - ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-formprovider.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-formprovider.md deleted file mode 100644 index 709fede3fcf2db3a17baf89e81634afd8d43559b..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-formprovider.md +++ /dev/null @@ -1,475 +0,0 @@ -# FormProvider - -FormProvider模块提供了卡片提供方相关接口的能力，包括更新卡片，设置卡片更新时间，获取卡片信息，请求发布卡片等。 - -> **说明：** -> -> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - -## 导入模块 - -``` -import formProvider from '@ohos.app.ability.formProvider'; -``` - -## 权限 - -无 - -## setFormNextRefreshTime - -setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback<void>): void; - -设置指定卡片的下一次更新时间。 - -**系统能力：** - -SystemCapability.Ability.Form - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ------------------------------------- | - | formId | string | 是 | 卡片标识 | - | minute | number | 是 | 指定多久之后更新，单位分钟，大于等于5 | - | callback | AsyncCallback<void> | 是 | 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<void>; - -设置指定卡片的下一次更新时间，以promise方式返回。 - -**系统能力：** - -SystemCapability.Ability.Form - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ------------------------------------- | - | formId | string | 是 | 卡片标识 | - | minute | number | 是 | 指定多久之后更新，单位分钟，大于等于5 | - -**返回值：** - - | 类型 | 说明 | - | ------------- | ---------------------------------- | - | Promise\ |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<void>): void; - -更新指定的卡片。 - -**系统能力：** - -SystemCapability.Ability.Form - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ---------------------------------------------------------------------- | ---- | ---------------- | - | formId | string | 是 | 请求更新的卡片标识 | - | formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据 | - | callback | AsyncCallback<void> | 是 | 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<void>; - -更新指定的卡片，以promise方式返回。 - -**系统能力：** - -SystemCapability.Ability.Form - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ---------------------------------------------------------------------- | ---- | ---------------- | - | formId | string | 是 | 请求更新的卡片标识 | - | formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据 | - -**返回值：** - -| 类型 | 说明 | -| -------------- | ----------------------------------- | -| Promise\ | 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<Array<formInfo.FormInfo>>): void; - -获取设备上当前应用程序的卡片信息。 - -**系统能力：** SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | 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<Array<formInfo.FormInfo>>): void; - -获取设备上当前应用程序的卡片信息。 - -**系统能力：** SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| filter | [formInfo.FormInfoFilter](./js-apis-formInfo.md#forminfofilter) | 是 | 过滤卡片信息 | -| callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | 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<Array<formInfo.FormInfo>>; - -获取设备上当前应用程序的卡片信息。 - -**系统能力：** SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| filter | [formInfo.FormInfoFilter](./js-apis-app-ability-formInfo.md) | 否 | 过滤卡片信息 | - -**返回值：** - -| 类型 | 说明 | -| :------------ | :---------------------------------- | -| Promise<Array<[FormInfo](./js-apis-app-ability-formInfo.md#forminfo-1)>> | 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\): void; - -请求发布一张卡片到使用方。 - -**系统能力：** SystemCapability.Ability.Form - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---------------------------------------------------------------------- | ---- | ---------------- | -| want | [Want](js-apis-app-ability-Want.md) | 是 | abilityName: 目标卡片ability
parameters:
"ohos.extra.param.key.form_dimension"
"ohos.extra.param.key.form_name"
"ohos.extra.param.key.module_name" | -| formBindingData | [FormBindingData](js-apis-app-ability-formbindingdata.md#formbindingdata) | 是 | 用于创建卡片的数据 | -| callback | AsyncCallback<string> | 是 | 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<string>): void; - -请求发布一张卡片到使用方。 - -**系统能力：** SystemCapability.Ability.Form - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ | -| want | [Want](js-apis-app-ability-Want.md) | 是 | abilityName: 目标卡片ability
parameters:
"ohos.extra.param.key.form_dimension"
"ohos.extra.param.key.form_name"
"ohos.extra.param.key.module_name" | -| callback | AsyncCallback<string> | 是 | 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<string>; - -请求发布一张卡片到使用方。 - -**系统能力：** SystemCapability.Ability.Form - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| --------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| want | [Want](js-apis-app-ability-Want.md) | 是 | abilityName: 目标卡片ability
parameters:
"ohos.extra.param.key.form_dimension"
"ohos.extra.param.key.form_name"
"ohos.extra.param.key.module_name" | -| formBindingData | [FormBindingData](js-apis-app-ability-formbindingdata.md#formbindingdata) | 否 | 用于创建卡片的数据 | - -**返回值：** - -| 类型 | 说明 | -| :------------ | :---------------------------------- | -| Promise<string> | 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<boolean>): void; - -查询是否支持发布一张卡片到使用方。 - -**系统能力：** SystemCapability.Ability.Form - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| callback | AsyncCallback<boolean> | 是 | 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<boolean>; - -查询是否支持发布一张卡片到使用方。 - -**系统能力：** SystemCapability.Ability.Form - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -**返回值：** - -| 类型 | 说明 | -| :------------ | :---------------------------------- | -| Promise<boolean> | 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 diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-missionManager.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-missionManager.md index bd26610955fac4b8cd993bf765c7becfb1d8044c..5d52a9484587e64c924ba436c83296bf3bdac1c2 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-missionManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-missionManager.md @@ -947,7 +947,7 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise<void&g **系统API**: 此接口为系统接口，三方应用不支持调用。 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | missionId | number | 是 | 是 | 表示任务ID。| | runningState | number | 是 | 是 | 表示运行状态。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-quickFixManager.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-quickFixManager.md index e551e4c42a2ce1ac5c0baaa43675e84e29557495..39d2dc130a026f94d2b6ecc1131d28082dd0304e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-quickFixManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-quickFixManager.md @@ -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 diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantConstant.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantConstant.md index ad7ce1d0b60f192920ed4242204859c082cdc7d1..c95ea8a3194a68c4da94813170e1f6681832605b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantConstant.md @@ -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执行写入操作的授权。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-form-forminfo.md b/zh-cn/application-dev/reference/apis/js-apis-app-form-forminfo.md index 3eeda5931dc0d081bf6d1ef2d2f4bb6d77040fbe..863a94ca6996aede70322deb5e21ad25398fd8a8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-form-forminfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-form-forminfo.md @@ -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<number> | 卡片支持的规格。具体可选规格参考[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<number> | 卡片支持的规格。具体可选规格参考[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 diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-MissionSnapshot.md b/zh-cn/application-dev/reference/apis/js-apis-application-MissionSnapshot.md index e9447a2709bbd3d4933746be58d28380daab80b9..ab2a696d17bd5566c15064eeb29de692f460ae59 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-application-MissionSnapshot.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-MissionSnapshot.md @@ -34,7 +34,7 @@ missionManager.getMissionInfos("", 10, (error, missions) => { **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | ability | ElementName | 是 | 是 | 表示Ability任务元素名称。 | | snapshot | [image.PixelMap](js-apis-image.md) | 是 | 是 | 表示任务快照。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-StartOptions.md b/zh-cn/application-dev/reference/apis/js-apis-application-StartOptions.md index b8049599ecbe69753f881b3e07ef3dd005944b43..92a37783f0a280a8ee108cdb0f76faa36dca491e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-StartOptions.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-StartOptions.md @@ -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。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-Want.md b/zh-cn/application-dev/reference/apis/js-apis-application-Want.md index bcd3d7213b44ff085acd546ddb78aaf97f870c5c..af1ed6f55a76ad7fd80b74f976f420b5b1879965 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-Want.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-Want.md @@ -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值：
ohos.aafwk.callerPid 表示拉起方的pid。
ohos.aafwk.param.callerToken 表示拉起方的token。
ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。 | -| entities | 只读 | Array\ | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 | -| moduleName9+ | 只读 | 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值：
ohos.aafwk.callerPid 表示拉起方的pid。
ohos.aafwk.param.callerToken 表示拉起方的token。
ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。 | +| entities | 是 | 否 | Array\ | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 | +| moduleName9+ | 是 | 否 | string | 否 | 表示待启动的Ability所属的模块（module）。 | **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-ability.md b/zh-cn/application-dev/reference/apis/js-apis-application-ability.md index 013c1c109ca88d3b006c59e38720e9c7aaa37ef5..e704a1b8c31e0bae481cc5446e2dfd2c49d83129 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-ability.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-ability.md @@ -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 | 是 | 否 | 被调用方注册的消息侦听器函数接口的原型。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md index 2ee65f6b1411b948cb11cb9fe511521ba445d6a8..ea4b5d4a263390d6e3895548956d987b1b5e02b6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md @@ -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 | 应用恢复保存状态。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md index 84c5d19a02faa4a35d77a974da158570873d4e9d..08bad2d65f1b7e08ba19b551d01e04d2ccca2918 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md @@ -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 diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityManager.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityManager.md index 3863f3d412b85712b2c395a0396bce45bb02711f..34595bc0138a11d854c8646fb8bdb058eb077908 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityManager.md @@ -41,7 +41,7 @@ updateConfiguration(config: Configuration, callback: AsyncCallback\): void **参数**： -| 名称 | 类型 | 必填 | 描述 | +| 名称 | 类型 | 必填 | 说明 | | --------- | ---------------------------------------- | ---- | -------------- | | config | [Configuration](js-apis-configuration.md) | 是 | 新的配置项。 | | callback | AsyncCallback\ | 是 | 被指定的回调方法。 | @@ -72,7 +72,7 @@ updateConfiguration(config: Configuration): Promise\ **参数**： -| 名称 | 类型 | 必填 | 描述 | +| 名称 | 类型 | 必填 | 说明 | | --------- | ---------------------------------------- | ---- | -------------- | | config | [Configuration](js-apis-configuration.md) | 是 | 新的配置项。 | @@ -110,7 +110,7 @@ getAbilityRunningInfos(callback: AsyncCallback\>): vo **参数**： -| 名称 | 类型 | 必填 | 描述 | +| 名称 | 类型 | 必填 | 说明 | | --------- | ---------------------------------------- | ---- | -------------- | | callback | AsyncCallback\> | 是 | 被指定的回调方法。 | @@ -164,7 +164,7 @@ getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\> | 是 | 被指定的回调方法。 | @@ -193,7 +193,7 @@ getExtensionRunningInfos(upperLimit: number): Promise\): void; **参数**： -| 名称 | 类型 | 必填 | 描述 | +| 名称 | 类型 | 必填 | 说明 | | --------- | ---------------------------------------- | ---- | -------------- | | callback | AsyncCallback\ | 是 | 被指定的回调方法。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-configuration.md b/zh-cn/application-dev/reference/apis/js-apis-application-configuration.md index 98353ab12584d1046724997f9384b7c7989cb0fc..4979ec21dc9695a413383fb3a4d9ece86257a244 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-configuration.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-configuration.md @@ -7,7 +7,7 @@ **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase - | 名称 | 参数类型 | 可读 | 可写 | 说明 | + | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | language8+ | string | 是 | 是 | 表示应用程序的当前语言。 | | colorMode8+ | [ColorMode](js-apis-configurationconstant.md#configurationconstantcolormode) | 是 | 是 | 表示深浅色模式，取值范围：浅色模式（COLOR_MODE_LIGHT），深色模式（COLOR_MODE_DARK）。默认为浅色。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-context.md b/zh-cn/application-dev/reference/apis/js-apis-application-context.md index 61a6e2b1d3ad14e3d7f48d4d6058324a75104538..864816ecd85aca561c32180cd9884cf057f90b10 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-context.md @@ -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。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-configuration.md b/zh-cn/application-dev/reference/apis/js-apis-configuration.md index d8a1dc478279b66b1ab73f2b12b3d7269fd04aac..8b32a2daf4719f8a527c587405367a12db432e0f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-configuration.md +++ b/zh-cn/application-dev/reference/apis/js-apis-configuration.md @@ -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）。默认为浅色。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-extension-context.md b/zh-cn/application-dev/reference/apis/js-apis-extension-context.md index d9f13dc31caf15b1c9232cdaad177a7265a46986..2181cda4b1155534c6bbef35a4edab595af4855e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-extension-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-extension-context.md @@ -13,7 +13,7 @@ ExtensionContext模块提供访问特定Extension的资源的能力，对于拓 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | currentHapModuleInfo | HapModuleInfo | 是 | 否 | 所属Hap包的信息。
(详见SDK目录下的 `api\bundle\hapModuleInfo.d.ts`) | | config | Configuration | 是 | 否 | 所属Module的配置信息。
(详见SDK目录下的 `api\@ohos.application.Configuration.d.ts`) | diff --git a/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md b/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md index 547f702b94742233ebea8ad3c191f8de75f797e5..1fc56d1fdfe746182190d8ff0037938496b3f5df 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md @@ -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<String> | 是 | 否 | 表示当期进程下的所有包名。 | -| 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 diff --git a/zh-cn/application-dev/reference/apis/js-apis-formInfo.md b/zh-cn/application-dev/reference/apis/js-apis-formInfo.md index 5d1945b5a1a0603431d489675029bef5ece18a72..6500955ee9d3521a84fbccb9275c3b2843e917f9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-formInfo.md @@ -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<number> | 卡片支持的规格。具体可选规格参考[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<number> | 表示卡片支持的规格。 | +| 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 diff --git a/zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md b/zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md index 9332e15c6219278b5675e64539e99f6569f7324a..000ff5527b70742972ddd9c16243823027f7259c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md +++ b/zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md @@ -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 格式的字符串。| + diff --git a/zh-cn/application-dev/reference/apis/js-apis-formextension.md b/zh-cn/application-dev/reference/apis/js-apis-formextension.md index e6771dfe88b4305c6771b39b325202643f9deaea..1a6a8b74f30b0f9d0ea3e72a6458754111b1accc 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formextension.md +++ b/zh-cn/application-dev/reference/apis/js-apis-formextension.md @@ -18,7 +18,7 @@ import FormExtension from '@ohos.application.FormExtension'; **系统能力**：SystemCapability.Ability.Form -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | ------- | ------------------------------------------------------- | ---- | ---- | --------------------------------------------------- | | context | [FormExtensionContext](js-apis-formextensioncontext.md) | 是 | 否 | FormExtension的上下文环境，继承自ExtensionContext。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-missionManager.md b/zh-cn/application-dev/reference/apis/js-apis-missionManager.md index d87db56eb8935c276aa1daf670f0803c26ab461b..8988c958cd0022c7f6586eea139ccbeb846e63a7 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-missionManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-missionManager.md @@ -869,7 +869,7 @@ moveMissionToFront(missionId: number, options?: StartOptions): Promise<void&g **系统API**: 此接口为系统接口，三方应用不支持调用。 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | missionId | number | 是 | 是 | 表示任务ID。| | runningState | number | 是 | 是 | 表示运行状态。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md b/zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md index 6a457a5df80e460b264b3bfd3e9019b661282bf2..c0fec4fa95b8809c1e44b813adea9ef218798481 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md +++ b/zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md @@ -34,7 +34,7 @@ export default class MainAbility extends Ability { **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - | 名称 | 参数类型 | 可读 | 可写 | 说明 | + | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | permissions | Array<string> | 是 | 否 | 用户传入的权限。| | authResults | Array<number> | 是 | 否 | 相应请求权限的结果。0表示授权成功，非0表示失败。 |