Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 3bd55d12 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!13412 卡片资料优化 

Merge pull request !13412 from chenyuyan/applicationForminfo
上级 aaf971a1 52831925
展开全部 隐藏空白更改
内联 并排
Showing with 489 addition and 285 deletion
zh-cn/application-dev/reference/apis/js-apis-app-form-formBindingData.md
浏览文件 @ 3bd55d12
......@@ -59,6 +59,6 @@ try {
};
formBindingData.createFormBindingData(obj);
} catch (error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`);
console.log(`catch error, code: ${error.code}, message: ${error.message}`);
}
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-application-formBindingData.md
浏览文件 @ 3bd55d12
......@@ -48,16 +48,17 @@ createFormBindingData(obj?: Object | string): FormBindingData
**示例：**
```ts
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);
import formBindingData from @ohos.application.formBindingData;
import fs from '@ohos.file.fs';
try {
let fd = fs.openSync('/path/to/form.png')
let obj = {
"temperature": "21°",
"formImages": {"image": fd}
"formImages": { "image": fd }
};
let formBindingDataObj = formBindingData.createFormBindingData(obj);
})
formBindingData.createFormBindingData(obj);
} catch (error.code) {
console.log('catch error, error:' + JSON.stringify(error));
}
```
zh-cn/application-dev/reference/apis/js-apis-application-formError.md
浏览文件 @ 3bd55d12
# @ohos.application.formError (FormError)
# @ohos.application.formError (formError)
FormError模块提供获取卡片错误码的能力。
formError模块提供获取卡片错误码的能力。
> **说明：**
>
......
zh-cn/application-dev/reference/apis/js-apis-application-formInfo.md
浏览文件 @ 3bd55d12
# @ohos.application.formInfo (FormInfo)
# @ohos.application.formInfo (formInfo)
FormInfo模块提供对卡片的相关卡片信息和状态进行设置和查询的能力。
formInfo模块提供了卡片信息和状态等相关类型和枚举。
> **说明：**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 从API version 9 开始不再维护，建议使用[FormInfo](js-apis-app-form-formInfo.md)替代。
> 从API version 9 开始不再维护，建议使用[formInfo](js-apis-app-form-formInfo.md)替代。
## 导入模块
......@@ -31,11 +31,11 @@ import formInfo from '@ohos.application.formInfo';
| colorMode | [ColorMode](#colormode) | 是 | 否 | 表示卡片颜色模式。 |
| isDefault | boolean | 是 | 否 | 表示是否是默认卡片。 |
| updateEnabled | boolean | 是 | 否 | 表示卡片是否使能更新。 |
| formVisibleNotify | string | 是 | 否 | 表示卡片是否使能可见通知。 |
| formVisibleNotify | boolean | 是 | 否 | 表示卡片是否使能可见通知。 |
| relatedBundleName | string | 是 | 否 | 表示卡片所属的相关联Bundle名称。 |
| scheduledUpdateTime | string | 是 | 否 | 表示卡片更新时间。 |
| formConfigAbility | string | 是 | 否 | 表示卡片配置ability。 |
| updateDuration | string | 是 | 否 | 表示卡片更新周期。 |
| updateDuration | number | 是 | 否 | 表示卡片更新周期。 |
| defaultDimension | number | 是 | 否 | 表示卡片规格 |
| supportDimensions | Array<number> | 是 | 否 | 表示卡片支持的规格。 |
| customizeData | {[key: string]: [value: string]} | 是 | 否 | 表示卡片用户数据。 |
......@@ -101,8 +101,8 @@ import formInfo from '@ohos.application.formInfo';
| 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<sup>9+</sup> | "ohos.extra.param.key.ability_name" | ability名称 |
| DEVICE_ID_KEY<sup>9+</sup> | "ohos.extra.param.key.device_id" | 设备标识。<br/>**系统接口**: 此接口为系统接口。 |
| ABILITY_NAME_KEY<sup>9+</sup> | "ohos.extra.param.key.ability_name" | ability名称。 |
| DEVICE_ID_KEY<sup>9+</sup> | "ohos.extra.param.key.device_id" | 设备标识。 |
| BUNDLE_NAME_KEY<sup>9+</sup> | "ohos.extra.param.key.bundle_name" | 指示指定要获取的捆绑包名称的键。|
## FormDimension<sup>9+</sup>
......@@ -117,18 +117,7 @@ import formInfo from '@ohos.application.formInfo';
| Dimension_2_2 <sup>9+</sup> | 2 | 2 x 2 form。 |
| Dimension_2_4 <sup>9+</sup> | 3 | 2 x 4 form。 |
| Dimension_4_4 <sup>9+</sup> | 4 | 4 x 4 form。 |
| Dimension_2_1 <sup>9+</sup> | 5 | 2 x 1 form。 |
## VisibilityType
卡片可见性。
**系统能力**：SystemCapability.Ability.Form
| 名称 | 值 | 说明 |
| ----------- | ---- | ------------ |
| FORM_VISIBLE<sup>9+<sup> | 1 | 卡片状态为可见。 |
| FORM_INVISIBLE<sup>9+<sup> | 2 | 卡片状态为不可见。 |
| Dimension_2_1 <sup>9+</sup> | 5 | 2 x 1 form。 |
## FormInfoFilter<sup>9+</sup>
......@@ -138,7 +127,7 @@ import formInfo from '@ohos.application.formInfo';
| 名称 | 说明 |
| ----------- | ------------ |
| moduleName<sup>9+</sup> | 仅保留moduleName与提供值相符的卡片信息。 |
| moduleName<sup>9+</sup> | 选填。仅保留moduleName与提供值相符的卡片信息。<br>未填写时则不通过moduleName进行过滤。 |
## VisibilityType<sup>9+</sup>
......
zh-cn/application-dev/reference/apis/js-apis-application-formProvider.md
浏览文件 @ 3bd55d12
# @ohos.application.formProvider (FormProvider)
# @ohos.application.formProvider (formProvider)
FormProvider模块提供了卡片提供方相关接口的能力，开发者在开发卡片时，可通过该模块提供接口实现更新卡片，设置卡片更新时间，获取卡片信息，请求发布卡片等。
> **说明：**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 从API version 9 开始不再维护，建议使用[FormProvider](js-apis-app-form-formProvider.md)替代。
> 从API version 9 开始不再维护，建议使用[formProvider](js-apis-app-form-formProvider.md)替代。
## 导入模块
......@@ -31,11 +31,13 @@ setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback&l
**示例：**
```ts
var formId = "12400633174999288";
import formProvider from '@ohos.app.form.formProvider';
let formId = "12400633174999288";
formProvider.setFormNextRefreshTime(formId, 5, (error, data) => {
if (error.code) {
console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error));
}
if (error.code) {
console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error));
}
});
```
......@@ -63,11 +65,13 @@ setFormNextRefreshTime(formId: string, minute: number): Promise&lt;void&gt;
**示例：**
```ts
var formId = "12400633174999288";
import formProvider from '@ohos.app.form.formProvider';
let formId = "12400633174999288";
formProvider.setFormNextRefreshTime(formId, 5).then(() => {
console.log('formProvider setFormNextRefreshTime success');
console.log('formProvider setFormNextRefreshTime success');
}).catch((error) => {
console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error));
console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error));
});
```
......@@ -84,19 +88,21 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData,call
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
| formId | string | 是 | 请求更新的卡片标识。 |
| formBindingData.FormBindingData | [FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是 | 用于更新的数据。 |
| formBindingData | [formBindingData.FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是 | 用于更新的数据。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：**
```ts
import formBindingData from '@ohos.application.formBindingData';
var formId = "12400633174999288";
import formProvider from '@ohos.app.form.formProvider';
let formId = "12400633174999288";
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
formProvider.updateForm(formId, obj, (error, data) => {
if (error.code) {
console.log('formProvider updateForm, error:' + JSON.stringify(error));
}
if (error.code) {
console.log('formProvider updateForm, error:' + JSON.stringify(error));
}
});
```
......@@ -113,7 +119,7 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
| formId | string | 是 | 请求更新的卡片标识。 |
| formBindingData.FormBindingData | [FormBindingData](js-apis-application-formBindingData.md#formbindingdat) | 是 | 用于更新的数据。 |
| formBindingData | [formBindingData.FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是 | 用于更新的数据。 |
**返回值：**
......@@ -125,12 +131,14 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr
```ts
import formBindingData from '@ohos.application.formBindingData';
var formId = "12400633174999288";
import formProvider from '@ohos.app.form.formProvider';
let formId = "12400633174999288";
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
formProvider.updateForm(formId, obj).then(() => {
console.log('formProvider updateForm success');
console.log('formProvider updateForm success');
}).catch((error) => {
console.log('formProvider updateForm, error:' + JSON.stringify(error));
console.log('formProvider updateForm, error:' + JSON.stringify(error));
});
```
......@@ -146,17 +154,19 @@ getFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): voi
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](./js-apis-application-formInfo.md#forminfo-1)&gt;&gt; | 是 | 回调函数。返回查询到的卡片信息。 |
| callback | AsyncCallback&lt;Array&lt;[formInfo.FormInfo](./js-apis-application-formInfo.md#forminfo-1)&gt;&gt; | 是 | 回调函数。返回查询到的卡片信息。 |
**示例：**
```ts
import formProvider from '@ohos.app.form.formProvider';
formProvider.getFormsInfo((error, data) => {
if (error.code) {
console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
} else {
console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
}
if (error.code) {
console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
} else {
console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
}
});
```
## getFormsInfo<sup>9+</sup>
......@@ -172,22 +182,24 @@ getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback&lt;Array&l
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| filter | [formInfo.FormInfoFilter](./js-apis-application-formInfo.md#forminfofilter) | 是 | 卡片信息过滤器。 |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](./js-apis-application-formInfo.md#forminfo-1)&gt;&gt; | 是 | 回调函数。返回查询到符合条件的卡片信息。 |
| callback | AsyncCallback&lt;Array&lt;[formInfo.FormInfo](./js-apis-application-formInfo.md#forminfo-1)&gt;&gt; | 是 | 回调函数。返回查询到符合条件的卡片信息。 |
**示例：**
```ts
import formInfo from '@ohos.application.formInfo';
import formProvider from '@ohos.app.form.formProvider';
const filter : formInfo.FormInfoFilter = {
// get info of forms belong to module entry.
moduleName : "entry"
// get info of forms belong to module entry.
moduleName : "entry"
};
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));
}
if (error.code) {
console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
} else {
console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
}
});
```
......@@ -209,20 +221,22 @@ getFormsInfo(filter?: formInfo.FormInfoFilter): Promise&lt;Array&lt;formInfo.For
| 类型 | 说明 |
| :------------ | :---------------------------------- |
| Promise&lt;Array&lt;[FormInfo](./js-apis-application-formInfo.md#forminfo-1)&gt;&gt; | Promise对象。返回查询到符合条件的卡片信息。 |
| Promise&lt;Array&lt;[formInfo.FormInfo](./js-apis-application-formInfo.md#forminfo-1)&gt;&gt; | Promise对象。返回查询到符合条件的卡片信息。 |
**示例：**
```ts
import formInfo from '@ohos.application.formInfo';
import formProvider from '@ohos.app.form.formProvider';
const filter : formInfo.FormInfoFilter = {
// get info of forms belong to module entry.
moduleName : "entry"
// get info of forms belong to module entry.
moduleName : "entry"
};
formProvider.getFormsInfo(filter).then((data) => {
console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
}).catch((error) => {
console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
});
```
......@@ -241,28 +255,29 @@ requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData,
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
| want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。<br>abilityName: 目标卡片ability<br>parameters:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" |
| formBindingData.FormBindingData | [FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是 | 创建卡片的数据。 |
| formBindingData | [formBindingData.FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是 | 创建卡片的数据。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。返回卡片标识。 |
**示例：**
```ts
import formBindingData from '@ohos.application.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"
}
import formProvider from '@ohos.app.form.formProvider';
let 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"
}
};
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));
}
if (error.code) {
console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error));
} else {
console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data));
}
});
```
......@@ -286,20 +301,22 @@ requestPublishForm(want: Want, callback: AsyncCallback&lt;string&gt;): void
**示例：**
```ts
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"
}
import formProvider from '@ohos.app.form.formProvider';
let 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));
}
if (error.code) {
console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error));
} else {
console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data));
}
});
```
......@@ -318,7 +335,7 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData
| 参数名 | 类型 | 必填 | 说明 |
| --------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。<br>abilityName: 目标卡片ability<br>parameters:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" |
| formBindingData.FormBindingData | [FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 否 | 创建卡片的数据。 |
| formBindingData | [formBindingData.FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是 | 创建卡片的数据。 |
**返回值：**
......@@ -329,18 +346,20 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData
**示例：**
```ts
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"
}
import formProvider from '@ohos.app.form.formProvider';
let 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));
console.log('formProvider requestPublishForm success, form ID is :' + JSON.stringify(data));
}).catch((error) => {
console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error));
console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error));
});
```
......@@ -368,13 +387,13 @@ formProvider.isRequestPublishFormSupported((error, isSupported) => {
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"
}
let 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) {
......@@ -409,13 +428,13 @@ isRequestPublishFormSupported(): Promise&lt;boolean&gt;
```ts
formProvider.isRequestPublishFormSupported().then((isSupported) => {
if (isSupported) {
var want = {
abilityName: "FormAbility",
parameters: {
let 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));
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或