diff --git a/zh-cn/application-dev/reference/apis/js-apis-formprovider.md b/zh-cn/application-dev/reference/apis/js-apis-formprovider.md index 27d8b77bcc1c56e75bb9b5d3977cabbaf01dbfc8..5e8ff5742eb6792e9934d72c263215a09c3e2824 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formprovider.md +++ b/zh-cn/application-dev/reference/apis/js-apis-formprovider.md @@ -1,10 +1,10 @@ # FormProvider -FormProvider模块提供了卡片提供方相关接口的能力，包括更新卡片，设置卡片更新时间，获取卡片信息，请求发布卡片等。 +FormProvider模块提供了卡片提供方相关接口的能力，开发者在开发卡片时，可通过该模块提供接口实现更新卡片，设置卡片更新时间，获取卡片信息，请求发布卡片等。 > **说明：** -> > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 从API version 9 开始不再维护，建议使用[FormProvider](js-apis-app-form-formprovider.md)替代。 ## 导入模块 @@ -12,27 +12,21 @@ FormProvider模块提供了卡片提供方相关接口的能力，包括更新 import formProvider from '@ohos.application.formProvider'; ``` -## 权限 - -无 - ## setFormNextRefreshTime -setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback<void>): void; +setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback<void>): void -设置指定卡片的下一次更新时间。 +设置指定卡片的下一次更新时间，使用callback异步回调。 -**系统能力：** - -SystemCapability.Ability.Form +**系统能力：** SystemCapability.Ability.Form **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------------------------------------- | - | formId | string | 是 | 卡片标识 | - | minute | number | 是 | 指定多久之后更新，单位分钟，大于等于5 | - | callback | AsyncCallback<void> | 是 | callback形式返回启动结果 | + | formId | string | 是 | 卡片标识。 | + | minute | number | 是 | 指定多久之后更新，单位分钟，大于等于5。 | + | callback | AsyncCallback<void> | 是 | 回调函数。 | **示例：** @@ -47,26 +41,24 @@ SystemCapability.Ability.Form ## setFormNextRefreshTime -setFormNextRefreshTime(formId: string, minute: number): Promise<void>; +setFormNextRefreshTime(formId: string, minute: number): Promise<void> -设置指定卡片的下一次更新时间，以promise方式返回。 +设置指定卡片的下一次更新时间，使用Promise异步回调。 -**系统能力：** - -SystemCapability.Ability.Form +**系统能力：** SystemCapability.Ability.Form **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------------------------------------- | - | formId | string | 是 | 卡片标识 | - | minute | number | 是 | 指定多久之后更新，单位分钟，大于等于5 | + | formId | string | 是 | 卡片标识。 | + | minute | number | 是 | 指定多久之后更新，单位分钟，大于等于5。 | **返回值：** | 类型 | 说明 | | ------------- | ---------------------------------- | - | Promise\ |Promise实例，用于获取异步返回结果。 | + | Promise\ | 无返回结果的Promise对象。 | **示例：** @@ -81,21 +73,19 @@ SystemCapability.Ability.Form ## updateForm -updateForm(formId: string, formBindingData: formBindingData.FormBindingData,callback: AsyncCallback<void>): void; - -更新指定的卡片。 +updateForm(formId: string, formBindingData: formBindingData.FormBindingData,callback: AsyncCallback<void>): void -**系统能力：** +更新指定的卡片，使用callback异步回调。 -SystemCapability.Ability.Form +**系统能力：** SystemCapability.Ability.Form **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ---------------------------------------------------------------------- | ---- | ---------------- | - | formId | string | 是 | 请求更新的卡片标识 | - | formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据 | - | callback | AsyncCallback<void> | 是 | callback形式返回启动结果 | + | formId | string | 是 | 请求更新的卡片标识。 | + | formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据。 | + | callback | AsyncCallback<void> | 是 | 回调函数。 | **示例：** @@ -112,26 +102,24 @@ SystemCapability.Ability.Form ## updateForm -updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Promise<void>; - -更新指定的卡片，以promise方式返回。 +updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Promise<void> -**系统能力：** +更新指定的卡片，使用Promise异步回调。 -SystemCapability.Ability.Form +**系统能力：** SystemCapability.Ability.Form **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ---------------------------------------------------------------------- | ---- | ---------------- | - | formId | string | 是 | 请求更新的卡片标识 | - | formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据 | + | formId | string | 是 | 请求更新的卡片标识。 | + | formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 用于更新的数据。 | **返回值：** | 类型 | 说明 | | -------------- | ----------------------------------- | -| Promise\ | Promise实例，用于获取异步返回结果。 | +| Promise\ | 无返回结果的Promise对象。 | **示例：** @@ -148,9 +136,9 @@ SystemCapability.Ability.Form ## getFormsInfo9+ -getFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): void; +getFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): void -获取设备上当前应用程序的卡片信息。 +获取设备上当前应用程序的卡片信息，使用callback异步回调。 **系统能力：** SystemCapability.Ability.Form @@ -158,7 +146,7 @@ getFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): voi | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | callback形式返回查询到的卡片信息。 | +| callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | 回调函数。返回查询到的卡片信息。 | **示例：** @@ -173,9 +161,9 @@ formProvider.getFormsInfo((error, data) => { ``` ## getFormsInfo9+ -getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback<Array<formInfo.FormInfo>>): void; +getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback<Array<formInfo.FormInfo>>): void -获取设备上当前应用程序的卡片信息。 +获取设备上当前应用程序的卡片信息，并筛选符合条件的信息，使用callback异步回调。 **系统能力：** SystemCapability.Ability.Form @@ -183,14 +171,15 @@ getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback<Array&l | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| filter | [formInfo.FormInfoFilter](./js-apis-formInfo.md#forminfofilter) | 是 | 过滤卡片信息 | -| callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | callback形式返回查询到的卡片信息。 | +| filter | [formInfo.FormInfoFilter](./js-apis-formInfo.md#forminfofilter) | 是 | 卡片信息过滤器。 | +| callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | 回调函数。返回查询到符合条件的卡片信息。 | **示例：** ```js import formInfo from '@ohos.application.formInfo'; const filter : formInfo.FormInfoFilter = { + // get info of forms belong to module entry. moduleName : "entry" }; formProvider.getFormsInfo(filter, (error, data) => { @@ -204,9 +193,9 @@ formProvider.getFormsInfo(filter, (error, data) => { ## getFormsInfo9+ -getFormsInfo(filter?: formInfo.FormInfoFilter): Promise<Array<formInfo.FormInfo>>; +getFormsInfo(filter?: formInfo.FormInfoFilter): Promise<Array<formInfo.FormInfo>> -获取设备上当前应用程序的卡片信息。 +获取设备上当前应用程序的卡片信息，使用Promise异步回调。 **系统能力：** SystemCapability.Ability.Form @@ -214,19 +203,20 @@ getFormsInfo(filter?: formInfo.FormInfoFilter): Promise<Array<formInfo.For | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| filter | [formInfo.FormInfoFilter](./js-apis-formInfo.md) | 否 | 过滤卡片信息 | +| filter | [formInfo.FormInfoFilter](./js-apis-formInfo.md) | 否 | 卡片信息过滤器。 | **返回值：** | 类型 | 说明 | | :------------ | :---------------------------------- | -| Promise<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | Promise实例，用于获取异步返回查询到的卡片信息。 | +| Promise<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | Promise对象。返回查询到符合条件的卡片信息。 | **示例：** ```js import formInfo from '@ohos.application.formInfo'; const filter : formInfo.FormInfoFilter = { + // get info of forms belong to module entry. moduleName : "entry" }; formProvider.getFormsInfo(filter).then((data) => { @@ -238,21 +228,21 @@ formProvider.getFormsInfo(filter).then((data) => { ## requestPublishForm9+ -requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData, callback: AsyncCallback\): void; +requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData, callback: AsyncCallback\): void -请求发布一张卡片到使用方。 +请求发布一张卡片到使用方。使用方通常为桌面。 **系统能力：** SystemCapability.Ability.Form -**系统API**: 此接口为系统接口，三方应用不支持调用。 +**系统接口**: 此接口为系统接口。 **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ---------------------------------------------------------------------- | ---- | ---------------- | -| want | [Want](js-apis-application-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-formbindingdata.md#formbindingdata) | 是 | 用于创建卡片的数据 | -| callback | AsyncCallback<string> | 是 | callback形式返回卡片标识 | +| want | [Want](js-apis-application-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-formbindingdata.md#formbindingdata) | 是 | 创建卡片的数据。 | +| callback | AsyncCallback<string> | 是 | 回调函数。返回卡片标识。 | **示例：** @@ -278,20 +268,20 @@ requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData, ## requestPublishForm9+ -requestPublishForm(want: Want, callback: AsyncCallback<string>): void; +requestPublishForm(want: Want, callback: AsyncCallback<string>): void -请求发布一张卡片到使用方。 +请求发布一张卡片到使用方。使用方通常为桌面。 **系统能力：** SystemCapability.Ability.Form -**系统API**: 此接口为系统接口，三方应用不支持调用。 +**系统接口**: 此接口为系统接口。 **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------- | ---- | ------------------------------------------------------------ | -| want | [Want](js-apis-application-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形式返回卡片标识 | +| want | [Want](js-apis-application-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> | 是 | 回调函数。返回卡片标识。 | **示例：** @@ -315,26 +305,26 @@ requestPublishForm(want: Want, callback: AsyncCallback<string>): void; ## requestPublishForm9+ -requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData): Promise<string>; +requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData): Promise<string> -请求发布一张卡片到使用方。 +请求发布一张卡片到使用方。使用方通常为桌面。 **系统能力：** SystemCapability.Ability.Form -**系统API**: 此接口为系统接口，三方应用不支持调用。 +**系统接口**: 此接口为系统接口。 **参数：** | 参数名 | 类型 | 必填 | 说明 | | --------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| want | [Want](js-apis-application-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-formbindingdata.md#formbindingdata) | 否 | 用于创建卡片的数据 | +| want | [Want](js-apis-application-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-formbindingdata.md#formbindingdata) | 否 | 创建卡片的数据。 | **返回值：** | 类型 | 说明 | | :------------ | :---------------------------------- | -| Promise<string> | Promise实例，用于返回卡片标识。 | +| Promise<string> | Promise对象。返回卡片标识。 | **示例：** @@ -356,19 +346,19 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData ## isRequestPublishFormSupported9+ -isRequestPublishFormSupported(callback: AsyncCallback<boolean>): void; +isRequestPublishFormSupported(callback: AsyncCallback<boolean>): void 查询是否支持发布一张卡片到使用方。 -**系统能力：** SystemCapability.Ability.Form +**系统接口**: 此接口为系统接口。 -**系统API**: 此接口为系统接口，三方应用不支持调用。 +**系统能力：** SystemCapability.Ability.Form **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| callback | AsyncCallback<boolean> | 是 | callback形式返回是否支持发布一张卡片到使用方 | +| callback | AsyncCallback<boolean> | 是 | 回调函数。返回是否支持发布一张卡片到使用方。| **示例：** @@ -400,19 +390,19 @@ formProvider.isRequestPublishFormSupported((error, isSupported) => { ## isRequestPublishFormSupported9+ -isRequestPublishFormSupported(): Promise<boolean>; +isRequestPublishFormSupported(): Promise<boolean> 查询是否支持发布一张卡片到使用方。 -**系统能力：** SystemCapability.Ability.Form +**系统接口**: 此接口为系统接口。 -**系统API**: 此接口为系统接口，三方应用不支持调用。 +**系统能力：** SystemCapability.Ability.Form **返回值：** | 类型 | 说明 | | :------------ | :---------------------------------- | -| Promise<boolean> | Promise实例，用于获取异步返回是否支持发布一张卡片到使用方 | +| Promise<boolean> | Promise对象。返回是否支持发布一张卡片到使用方。 | **示例：**