From d15dd3cde2c9280d60cde1627b48dd710fd745f8 Mon Sep 17 00:00:00 2001 From: yangzk Date: Tue, 8 Feb 2022 10:38:17 +0800 Subject: [PATCH] IssueNo:#I4PCGJ:add docs for form extension Description:add docs for form extension Sig:SIG_ApplicationFramework Feature or Bugfix:Feature Binary Source:No Signed-off-by: yangzk Change-Id: Ifbf4866e484fa8398f999bbe259beaa328cc20d8 --- .../reference/apis/js-apis-formbindingdata.md | 12 ++++++------ .../reference/apis/js-apis-formextension.md | 10 ++++++++-- .../reference/apis/js-apis-formextensioncontext.md | 2 +- 3 files changed, 15 insertions(+), 9 deletions(-) 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 db6c4676f2..97263eedf6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md +++ b/zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md @@ -21,9 +21,9 @@ createFormBindingData(obj?: Object | string): FormBindingData - 参数： - | 参数名 | 类型 | 必填 | 说明 | - | ------ | -------------- | ---- | -------------------- | - | obj | Object或string | 否 | js卡片要展示的数据。 | + | 参数名 | 类型 | 必填 | 说明 | + | ------ | -------------- | ---- | ------------------------------------------------------------ | + | obj | Object或string | 否 | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。 | @@ -46,6 +46,6 @@ createFormBindingData(obj?: Object | string): FormBindingData FormBindingData相关描述。 -| 名称 | 类型 | 说明 | -| ---- | -------------- | -------------------- | -| obj | Object或string | js卡片要展示的数据。 | \ No newline at end of file +| 名称 | 类型 | 说明 | +| ---- | -------------- | ------------------------------------------------------------ | +| obj | Object或string | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。 | \ No newline at end of file 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 1c87d59e0e..83e27c049b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formextension.md +++ b/zh-cn/application-dev/reference/apis/js-apis-formextension.md @@ -31,7 +31,7 @@ onCreate(want: Want): formBindingData.FormBindingData | 参数名 | 类型 | 必填 | 说明 | | ------ | -------------------------------------- | ---- | ------------------------------------------------------------ | - | want | [Want](js-apis-featureAbility.md#want) | 是 | 当前Extension相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。 | + | want | [Want](js-apis-featureAbility.md#want) | 是 | 当前Extension相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理，以便后续更新和删除卡片。 | - 返回值： @@ -77,7 +77,7 @@ onCastToNormal(formId: string): void onUpdate(formId: string): void -卡片提供方接收更新卡片的通知接口。 +卡片提供方接收更新卡片的通知接口。获取最新数据后调用[FormExtensionContext](js-apis-formextensioncontext.md)的updateForm接口刷新卡片数据。 - 参数： @@ -90,6 +90,12 @@ onUpdate(formId: string): void ``` 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);}); } ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md b/zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md index 16c4de97a2..1a7cb0401c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md @@ -9,7 +9,7 @@ FormExtension的上下文环境，提供FormExtension具有的能力和接口， updateForm(formId: string, formBindingData: formBindingData.FormBindingData, callback: AsyncCallback\): void -更新卡片。 +主动更新卡片。 - 参数： -- GitLab