From cf8488a1930c5d0456123a7443317d246966f819 Mon Sep 17 00:00:00 2001 From: yanwenhao Date: Tue, 8 Nov 2022 16:47:22 +0800 Subject: [PATCH] Add docs of app.formBindingData.d.ts Signed-off-by: yanwenhao Change-Id: I658355f94079f383a5e121d586d96a32c601f853 --- .../reference/apis/Readme-CN.md | 2 +- .../apis/js-apis-app-form-formbindingdata.md | 68 +++++++++++++++++++ 2 files changed, 69 insertions(+), 1 deletion(-) create mode 100644 zh-cn/application-dev/reference/apis/js-apis-app-form-formbindingdata.md diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index 944cf0fdc8..c75ebb53aa 100755 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -42,7 +42,7 @@ - [@ohos.application.Configuration (Configuration)](js-apis-application-configuration.md) - [@ohos.application.ConfigurationConstant (ConfigurationConstant)](js-apis-application-configurationConstant.md) - [@ohos.application.errorManager (ErrorManager)](js-apis-errorManager.md) - + - [@oho.app.form.formBindingData (卡片数据绑定类)](js-apis-app-form-formbindingdata.md) - [@ohos.application.formError (FormError)](js-apis-formerror.md) - [@ohos.application.formHost (FormHost)](js-apis-formhost.md) - [@ohos.app.form.formProvider (FormProvider)](js-apis-app-form-formprovider.md) diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-form-formbindingdata.md b/zh-cn/application-dev/reference/apis/js-apis-app-form-formbindingdata.md new file mode 100644 index 0000000000..2cf65c138f --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-app-form-formbindingdata.md @@ -0,0 +1,68 @@ +# 卡片数据绑定类 + +卡片数据绑定模块提供卡片数据绑定的能力。包括FormBindingData对象的创建、相关信息的描述。 + +> **说明:** +> +> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 + +## 导入模块 + +``` +import formBindingData from '@ohos.app.form.formBindingData'; +``` + +## FormBindingData + +FormBindingData相关描述。 + +**系统能力**:SystemCapability.Ability.Form + +| 名称 | 可读 | 可写 | 参数类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | -------- | -------- | +| data | 是 | 否 | Object | 是 | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。| + + +## 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} + }; + var formBindingDataObj; + try { + formBindingData.createFormBindingData(obj); + } catch (error) { + console.log(`catch err->${JSON.stringify(err)}`); + } +}) +``` \ No newline at end of file -- GitLab