Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 7d07bb0f 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!12925 卡片API参考文档优化 

Merge pull request !12925 from yangzk/master
上级 be87c2e7 56ec85ec
展开全部 显示空白变更内容
内联 并排
Showing with 512 addition and 401 deletion
zh-cn/application-dev/reference/apis/js-apis-app-form-formBindingData.md
浏览文件 @ 7d07bb0f
...@@ -48,20 +48,17 @@ createFormBindingData(obj?: Object | string): FormBindingData ...@@ -48,20 +48,17 @@ createFormBindingData(obj?: Object | string): FormBindingData
**示例：** **示例：**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import fs from '@ohos.file.fs';
import fileio from '@ohos.fileio'; import formBindingData from '@ohos.app.form.formBindingData';
let context=featureAbility.getContext();
context.getOrCreateLocalDir((err,data)=>{ try {
let path=data+"/xxx.jpg"; let fd = fs.openSync('/path/to/form.png')
let fd = fileio.openSync(path);
let obj = { let obj = {
"temperature": "21°", "temperature": "21°",
"formImages": {"image": fd} "formImages": { "image": fd }
}; };
try {
formBindingData.createFormBindingData(obj); formBindingData.createFormBindingData(obj);
} catch (error) { } catch (error) {
console.log(`catch err->${JSON.stringify(err)}`); console.log(`catch error, code: ${error.code}, message: ${error.message})`);
} }
})
``` ```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md
浏览文件 @ 7d07bb0f
...@@ -33,7 +33,7 @@ onAddForm(want: Want): formBindingData.FormBindingData ...@@ -33,7 +33,7 @@ onAddForm(want: Want): formBindingData.FormBindingData
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------------------------------- | ---- | ------------------------------------------------------------ | | ------ | -------------------------------------- | ---- | ------------------------------------------------------------ |
| want | [Want](js-apis-application-want.md) | 是 | 当前ExtensionAbility相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理，以便后续更新和删除卡片。 | | want | [Want](js-apis-application-want.md) | 是 | 当前卡片相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理，以便后续更新和删除卡片。 |
**返回值：** **返回值：**
...@@ -45,17 +45,19 @@ onAddForm(want: Want): formBindingData.FormBindingData ...@@ -45,17 +45,19 @@ onAddForm(want: Want): formBindingData.FormBindingData
```ts ```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import formBindingData from '@ohos.app.form.formBindingData';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onAddForm(want) { onAddForm(want) {
console.log('FormExtensionAbility onAddForm, want:' + want.abilityName); console.log('FormExtensionAbility onAddForm, want:' + want.abilityName);
let dataObj1 = { let dataObj1 = {
temperature:"11c", temperature: "11c",
"time":"11:00" "time": "11:00"
}; };
let obj1 = formBindingData.createFormBindingData(dataObj1); let obj1 = formBindingData.createFormBindingData(dataObj1);
return obj1; return obj1;
} }
} };
``` ```
## onCastToNormalForm ## onCastToNormalForm
...@@ -75,11 +77,13 @@ onCastToNormalForm(formId: string): void ...@@ -75,11 +77,13 @@ onCastToNormalForm(formId: string): void
**示例：** **示例：**
```ts ```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onCastToNormalForm(formId) { onCastToNormalForm(formId) {
console.log('FormExtensionAbility onCastToNormalForm, formId:' + formId); console.log('FormExtensionAbility onCastToNormalForm, formId:' + formId);
} }
} };
``` ```
## onUpdateForm ## onUpdateForm
...@@ -99,17 +103,24 @@ onUpdateForm(formId: string): void ...@@ -99,17 +103,24 @@ onUpdateForm(formId: string): void
**示例：** **示例：**
```ts ```ts
import formBindingData from '@ohos.app.form.formBindingData' import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import formBindingData from '@ohos.app.form.formBindingData';
import formProvider from '@ohos.app.form.formProvider';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onUpdateForm(formId) { onUpdateForm(formId) {
console.log('FormExtensionAbility onUpdateForm, formId:' + formId); console.log('FormExtensionAbility onUpdateForm, formId:' + formId);
let obj2 = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); let obj2 = formBindingData.createFormBindingData({
this.context.updateForm(formId, obj2).then((data)=>{ temperature: "22c",
time: "22:00"
});
formProvider.updateForm(formId, obj2).then((data) => {
console.log('FormExtensionAbility context updateForm, data:' + data); console.log('FormExtensionAbility context updateForm, data:' + data);
}).catch((error) => { }).catch((error) => {
console.error('Operation updateForm failed. Cause: ' + error);}); console.error('Operation updateForm failed. Cause: ' + error);
});
} }
} };
``` ```
## onChangeFormVisibility ## onChangeFormVisibility
...@@ -129,21 +140,28 @@ onChangeFormVisibility(newStatus: { [key: string]: number }): void ...@@ -129,21 +140,28 @@ onChangeFormVisibility(newStatus: { [key: string]: number }): void
**示例：** **示例：**
```ts ```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import formBindingData from '@ohos.app.form.formBindingData' import formBindingData from '@ohos.app.form.formBindingData'
import formProvider from '@ohos.app.form.formProvider';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onChangeFormVisibility(newStatus) { onChangeFormVisibility(newStatus) {
console.log('FormExtensionAbility onChangeFormVisibility, newStatus:' + newStatus); console.log('FormExtensionAbility onChangeFormVisibility, newStatus:' + newStatus);
let obj2 = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); let obj2 = formBindingData.createFormBindingData({
temperature: "22c",
time: "22:00"
});
for (let key in newStatus) { for (let key in newStatus) {
console.log('FormExtensionAbility onChangeFormVisibility, key:' + key + ", value=" + newStatus[key]); console.log('FormExtensionAbility onChangeFormVisibility, key:' + key + ", value=" + newStatus[key]);
this.context.updateForm(key, obj2).then((data)=>{ formProvider.updateForm(key, obj2).then((data) => {
console.log('FormExtensionAbility context updateForm, data:' + data); console.log('FormExtensionAbility context updateForm, data:' + data);
}).catch((error) => { }).catch((error) => {
console.error('Operation updateForm failed. Cause: ' + error);}); console.error('Operation updateForm failed. Cause: ' + error);
});
} }
} }
} };
``` ```
## onFormEvent ## onFormEvent
...@@ -164,11 +182,13 @@ onFormEvent(formId: string, message: string): void ...@@ -164,11 +182,13 @@ onFormEvent(formId: string, message: string): void
**示例：** **示例：**
```ts ```ts
export default class MyFormExtension extends FormExtensionAbility { import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onFormEvent(formId, message) { onFormEvent(formId, message) {
console.log('FormExtensionAbility onFormEvent, formId:' + formId + ", message:" + message); console.log('FormExtensionAbility onFormEvent, formId:' + formId + ", message:" + message);
} }
} };
``` ```
## onRemoveForm ## onRemoveForm
...@@ -188,11 +208,13 @@ onRemoveForm(formId: string): void ...@@ -188,11 +208,13 @@ onRemoveForm(formId: string): void
**示例：** **示例：**
```ts ```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onRemoveForm(formId) { onRemoveForm(formId) {
console.log('FormExtensionAbility onRemoveForm, formId:' + formId); console.log('FormExtensionAbility onRemoveForm, formId:' + formId);
} }
} };
``` ```
## onConfigurationUpdate ## onConfigurationUpdate
...@@ -212,11 +234,13 @@ onConfigurationUpdate(newConfig: Configuration): void; ...@@ -212,11 +234,13 @@ onConfigurationUpdate(newConfig: Configuration): void;
**示例：** **示例：**
```ts ```ts
class MyFormExtensionAbility extends FormExtensionAbility { import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onConfigurationUpdate(config) { onConfigurationUpdate(config) {
console.log('onConfigurationUpdate, config:' + JSON.stringify(config)); console.log('onConfigurationUpdate, config:' + JSON.stringify(config));
} }
} };
``` ```
## onAcquireFormState ## onAcquireFormState
...@@ -236,13 +260,15 @@ onAcquireFormState?(want: Want): formInfo.FormState; ...@@ -236,13 +260,15 @@ onAcquireFormState?(want: Want): formInfo.FormState;
**示例：** **示例：**
```ts ```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import formInfo from '@ohos.app.form.formInfo'; import formInfo from '@ohos.app.form.formInfo';
class MyFormExtensionAbility extends FormExtensionAbility {
export default class MyFormExtensionAbility extends FormExtensionAbility {
onAcquireFormState(want) { onAcquireFormState(want) {
console.log('FormExtensionAbility onAcquireFormState, want:' + want); console.log('FormExtensionAbility onAcquireFormState, want:' + want);
return formInfo.FormState.UNKNOWN; return formInfo.FormState.UNKNOWN;
} }
} };
``` ```
## onShareForm ## onShareForm
...@@ -270,14 +296,16 @@ onShareForm?(formId: string): { [key: string]: any } ...@@ -270,14 +296,16 @@ onShareForm?(formId: string): { [key: string]: any }
**示例：** **示例：**
```ts ```ts
class MyFormExtensionAbility extends FormExtensionAbility { import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onShareForm(formId) { onShareForm(formId) {
console.log('FormExtensionAbility onShareForm, formId:' + formId); console.log('FormExtensionAbility onShareForm, formId:' + formId);
let wantParams = { let wantParams = {
"temperature":"20", "temperature": "20",
"time":"2022-8-8 09:59", "time": "2022-8-8 09:59",
}; };
return wantParams; return wantParams;
} }
} };
``` ```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-app-form-formInfo.md
浏览文件 @ 7d07bb0f
# @ohos.app.form.formInfo (FormInfo) # @ohos.app.form.formInfo (formInfo)
FormInfo模块提供对卡片的相关卡片信息和状态进行设置和查询的能力。 formInfo模块提供了卡片信息和状态等相关类型和枚举。
> **说明：** > **说明：**
> >
...@@ -30,11 +30,11 @@ import formInfo from '@ohos.app.form.formInfo'; ...@@ -30,11 +30,11 @@ import formInfo from '@ohos.app.form.formInfo';
| colorMode | [ColorMode](#colormode) | 是 | 否 | 卡片颜色模式。 | | colorMode | [ColorMode](#colormode) | 是 | 否 | 卡片颜色模式。 |
| isDefault | boolean | 是 | 否 | 卡片是否是默认卡片。 | | isDefault | boolean | 是 | 否 | 卡片是否是默认卡片。 |
| updateEnabled | boolean | 是 | 否 | 卡片是否使能更新。 | | updateEnabled | boolean | 是 | 否 | 卡片是否使能更新。 |
| formVisibleNotify | string | 是 | 否 | 卡片是否使能可见通知。 | | formVisibleNotify | boolean | 是 | 否 | 卡片是否使能可见通知。 |
| relatedBundleName | string | 是 | 否 | 卡片所属的相关联Bundle名称。 | | relatedBundleName | string | 是 | 否 | 卡片所属的相关联Bundle名称。 |
| scheduledUpdateTime | string | 是 | 否 | 卡片更新时间。 | | scheduledUpdateTime | string | 是 | 否 | 卡片更新时间。 |
| formConfigAbility | string | 是 | 否 | 卡片配置ability。指定长按卡片弹出的选择框内，编辑选项所对应的ability。 | | formConfigAbility | string | 是 | 否 | 卡片配置ability。指定长按卡片弹出的选择框内，编辑选项所对应的ability。 |
| updateDuration | string | 是 | 否 | 卡片更新周期。 | | updateDuration | number | 是 | 否 | 卡片更新周期。 |
| defaultDimension | number | 是 | 否 | 表示卡片规格 | | defaultDimension | number | 是 | 否 | 表示卡片规格 |
| supportDimensions | Array<number> | 是 | 否 | 卡片支持的规格。具体可选规格参考[FormDimension](#formdimension) | | supportDimensions | Array<number> | 是 | 否 | 卡片支持的规格。具体可选规格参考[FormDimension](#formdimension) |
| customizeData | {[key: string]: [value: string]} | 是 | 否 | 卡片用户数据。 | | customizeData | {[key: string]: [value: string]} | 是 | 否 | 卡片用户数据。 |
...@@ -100,8 +100,8 @@ import formInfo from '@ohos.app.form.formInfo'; ...@@ -100,8 +100,8 @@ import formInfo from '@ohos.app.form.formInfo';
| WIDTH_KEY | "ohos.extra.param.key.form_width" | 卡片宽度。 | | WIDTH_KEY | "ohos.extra.param.key.form_width" | 卡片宽度。 |
| HEIGHT_KEY | "ohos.extra.param.key.form_height" | 卡片高度。 | | HEIGHT_KEY | "ohos.extra.param.key.form_height" | 卡片高度。 |
| TEMPORARY_KEY | "ohos.extra.param.key.form_temporary" | 临时卡片。 | | TEMPORARY_KEY | "ohos.extra.param.key.form_temporary" | 临时卡片。 |
| ABILITY_NAME_KEY | "ohos.extra.param.key.ability_name" | ability名称 | | ABILITY_NAME_KEY | "ohos.extra.param.key.ability_name" | ability名称。 |
| DEVICE_ID_KEY | "ohos.extra.param.key.device_id" | 设备标识。<br/>**系统接口**: 此接口为系统接口。 | | DEVICE_ID_KEY | "ohos.extra.param.key.device_id" | 设备标识。 |
| BUNDLE_NAME_KEY | "ohos.extra.param.key.bundle_name" | 指示指定要获取的捆绑Bundle名称的键。 | | BUNDLE_NAME_KEY | "ohos.extra.param.key.bundle_name" | 指示指定要获取的捆绑Bundle名称的键。 |
## FormDimension ## FormDimension
...@@ -127,7 +127,7 @@ import formInfo from '@ohos.app.form.formInfo'; ...@@ -127,7 +127,7 @@ import formInfo from '@ohos.app.form.formInfo';
| 名称 | 说明 | | 名称 | 说明 |
| ----------- | ------------ | | ----------- | ------------ |
| moduleName | 仅保留moduleName与提供值相符的卡片信息。 | | moduleName | 选填。仅保留moduleName与提供值相符的卡片信息。未填写时则不通过moduleName进行过滤。 |
## VisibilityType ## VisibilityType
......
zh-cn/application-dev/reference/apis/js-apis-app-form-formProvider.md
浏览文件 @ 7d07bb0f
# @ohos.app.form.formProvider (FormProvider) # @ohos.app.form.formProvider (formProvider)
FormProvider模块提供了卡片提供方相关接口的能力，开发者在开发卡片时，可通过该模块提供接口实现更新卡片，设置卡片更新时间，获取卡片信息，请求发布卡片等。 FormProvider模块提供了卡片提供方相关接口的能力，开发者在开发卡片时，可通过该模块提供接口实现更新卡片、设置卡片更新时间、获取卡片信息、请求发布卡片等。
> **说明：** > **说明：**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
...@@ -31,23 +31,25 @@ setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback&l ...@@ -31,23 +31,25 @@ setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback&l
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例：** **示例：**
```ts ```ts
var formId = "12400633174999288"; import formProvider from '@ohos.app.form.formProvider';
let formId = "12400633174999288";
try { try {
formProvider.setFormNextRefreshTime(formId, 5, (error, data) => { formProvider.setFormNextRefreshTime(formId, 5, (error, data) => {
if (error) { if (error) {
console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error)); console.log(`callback error, code: ${error.code}, message: ${error.message})`);
} else { } else {
console.log(`formProvider setFormNextRefreshTime success`); console.log(`formProvider setFormNextRefreshTime success`);
} }
}); });
} catch (error) { } catch (error) {
console.log("error" + JSON.stringify(error)) console.log(`catch error, code: ${error.code}, message: ${error.message})`);
} }
``` ```
...@@ -76,21 +78,23 @@ setFormNextRefreshTime(formId: string, minute: number): Promise&lt;void&gt; ...@@ -76,21 +78,23 @@ setFormNextRefreshTime(formId: string, minute: number): Promise&lt;void&gt;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例：** **示例：**
```ts ```ts
var formId = "12400633174999288"; import formProvider from '@ohos.app.form.formProvider';
let formId = "12400633174999288";
try { try {
formProvider.setFormNextRefreshTime(formId, 5).then(() => { formProvider.setFormNextRefreshTime(formId, 5).then(() => {
console.log('formProvider setFormNextRefreshTime success'); console.log(`formProvider setFormNextRefreshTime success`);
}).catch((error) => { }).catch((error) => {
console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error)); console.log(`promise error, code: ${error.code}, message: ${error.message})`);
}); });
} catch (error) { } catch (error) {
console.log(`catch err->${JSON.stringify(error)}`); console.log(`catch error, code: ${error.code}, message: ${error.message})`);
} }
``` ```
...@@ -114,25 +118,27 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData,call ...@@ -114,25 +118,27 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData,call
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例：** **示例：**
```ts ```ts
import formBindingData from '@ohos.application.formBindingData'; import formBindingData from '@ohos.application.formBindingData';
var formId = "12400633174999288"; import formProvider from '@ohos.app.form.formProvider';
let formId = "12400633174999288";
try { try {
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
formProvider.updateForm(formId, obj, (error, data) => { formProvider.updateForm(formId, obj, (error, data) => {
if (error) { if (error) {
console.log('formProvider updateForm, error:' + JSON.stringify(error)); console.log(`callback error, code: ${error.code}, message: ${error.message})`);
} else { } else {
console.log(`formProvider updateForm success`); console.log(`formProvider updateForm success`);
} }
}); });
} catch (error) { } catch (error) {
console.log(`catch err->${JSON.stringify(error)}`); console.log(`catch error, code: ${error.code}, message: ${error.message})`);
} }
``` ```
...@@ -161,23 +167,25 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr ...@@ -161,23 +167,25 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例：** **示例：**
```ts ```ts
import formBindingData from '@ohos.application.formBindingData'; import formBindingData from '@ohos.application.formBindingData';
var formId = "12400633174999288"; import formProvider from '@ohos.app.form.formProvider';
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
let formId = "12400633174999288";
let obj = formBindingData.createFormBindingData({ temperature: "22c", time: "22:00" });
try { try {
formProvider.updateForm(formId, obj).then(() => { formProvider.updateForm(formId, obj).then(() => {
console.log('formProvider updateForm success'); console.log(`formProvider updateForm success`);
}).catch((error) => { }).catch((error) => {
console.log('formProvider updateForm, error:' + JSON.stringify(error)); console.log(`promise error, code: ${error.code}, message: ${error.message})`);
}); });
} catch (error) { } catch (error) {
console.log(`catch err->${JSON.stringify(error)}`); console.log(`catch error, code: ${error.code}, message: ${error.message})`);
} }
``` ```
...@@ -193,29 +201,31 @@ getFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): voi ...@@ -193,29 +201,31 @@ getFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): voi
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](js-apis-app-form-formInfo.md)&gt;&gt; | 是 | 回调函数。返回查询到的卡片信息。 | | callback | AsyncCallback&lt;Array&lt;[formInfo.FormInfo](js-apis-app-form-formInfo.md)&gt;&gt; | 是 | 回调函数。返回查询到的卡片信息。 |
**错误码：** **错误码：**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例：** **示例：**
```ts ```ts
import formProvider from '@ohos.app.form.formProvider';
try { try {
formProvider.getFormsInfo((error, data) => { formProvider.getFormsInfo((error, data) => {
if (error) { if (error) {
console.log('formProvider getFormsInfo, error:' + JSON.stringify(error)); console.log(`callback error, code: ${error.code}, message: ${error.message})`);
} else { } else {
console.log('formProvider getFormsInfo, data:' + JSON.stringify(data)); console.log('formProvider getFormsInfo, data: ' + JSON.stringify(data));
} }
}); });
} catch (error) { } catch (error) {
console.log(`catch err->${JSON.stringify(error)}`); console.log(`catch error, code: ${error.code}, message: ${error.message})`);
} }
``` ```
## getFormsInfo ## getFormsInfo
...@@ -231,33 +241,35 @@ getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback&lt;Array&l ...@@ -231,33 +241,35 @@ getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback&lt;Array&l
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| filter | [formInfo.FormInfoFilter](js-apis-app-form-formInfo.md#forminfofilter) | 是 | 卡片信息过滤器。 | | filter | [formInfo.FormInfoFilter](js-apis-app-form-formInfo.md#forminfofilter) | 是 | 卡片信息过滤器。 |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](js-apis-app-form-formInfo.md)&gt;&gt; | 是 | 回调函数。返回查询到符合条件的卡片信息。 | | callback | AsyncCallback&lt;Array&lt;[formInfo.FormInfo](js-apis-app-form-formInfo.md)&gt;&gt; | 是 | 回调函数。返回查询到符合条件的卡片信息。 |
**错误码：** **错误码：**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例：** **示例：**
```ts ```ts
import formInfo from '@ohos.application.formInfo'; import formInfo from '@ohos.app.form.formInfo';
const filter : formInfo.FormInfoFilter = { import formProvider from '@ohos.app.form.formProvider';
const filter: formInfo.FormInfoFilter = {
// get info of forms belong to module entry. // get info of forms belong to module entry.
moduleName : "entry" moduleName: "entry"
}; };
try { try {
formProvider.getFormsInfo(filter, (error, data) => { formProvider.getFormsInfo(filter, (error, data) => {
if (error) { if (error) {
console.log('formProvider getFormsInfo, error:' + JSON.stringify(error)); console.log(`callback error, code: ${error.code}, message: ${error.message})`);
} else { } else {
console.log('formProvider getFormsInfo, data:' + JSON.stringify(data)); console.log('formProvider getFormsInfo, data: ' + JSON.stringify(data));
} }
}); });
} catch(error) { } catch (error) {
console.log(`catch err->${JSON.stringify(error)}`); console.log(`catch error, code: ${error.code}, message: ${error.message})`);
} }
``` ```
...@@ -279,31 +291,33 @@ getFormsInfo(filter?: formInfo.FormInfoFilter): Promise&lt;Array&lt;formInfo.For ...@@ -279,31 +291,33 @@ getFormsInfo(filter?: formInfo.FormInfoFilter): Promise&lt;Array&lt;formInfo.For
| 类型 | 说明 | | 类型 | 说明 |
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise&lt;Array&lt;[FormInfo](js-apis-app-form-formInfo.md)&gt;&gt; | Promise对象。返回查询到符合条件的卡片信息。 | | Promise&lt;Array&lt;[formInfo.FormInfo](js-apis-app-form-formInfo.md)&gt;&gt; | Promise对象。返回查询到符合条件的卡片信息。 |
**错误码：** **错误码：**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例：** **示例：**
```ts ```ts
import formInfo from '@ohos.application.formInfo'; import formInfo from '@ohos.app.form.formInfo';
const filter : formInfo.FormInfoFilter = { import formProvider from '@ohos.app.form.formProvider';
const filter: formInfo.FormInfoFilter = {
// get info of forms belong to module entry. // get info of forms belong to module entry.
moduleName : "entry" moduleName: "entry"
}; };
try { try {
formProvider.getFormsInfo(filter).then((data) => { formProvider.getFormsInfo(filter).then((data) => {
console.log('formProvider getFormsInfo, data:' + JSON.stringify(data)); console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
}).catch((error) => { }).catch((error) => {
console.log('formProvider getFormsInfo, error:' + JSON.stringify(error)); console.log(`promise error, code: ${error.code}, message: ${error.message})`);
}); });
} catch (error) { } catch (error) {
console.log(`catch err->${JSON.stringify(error)}`); console.log(`catch error, code: ${error.code}, message: ${error.message})`);
} }
``` ```
...@@ -322,21 +336,23 @@ requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData, ...@@ -322,21 +336,23 @@ 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" | | 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-app-form-formBindingData.md#formbindingdata) | 是 | 创建卡片的数据。 | | formBindingData | [formBindingData.FormBindingData](js-apis-app-form-formBindingData.md#formbindingdata) | 是 | 创建卡片的数据。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。返回卡片标识。 | | callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。返回卡片标识。 |
**错误码：** **错误码：**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例：** **示例：**
```ts ```ts
import formBindingData from '@ohos.application.formBindingData'; import formBindingData from '@ohos.application.formBindingData';
var want = { import formProvider from '@ohos.app.form.formProvider';
let want = {
abilityName: "FormAbility", abilityName: "FormAbility",
parameters: { parameters: {
"ohos.extra.param.key.form_dimension": 2, "ohos.extra.param.key.form_dimension": 2,
...@@ -345,16 +361,16 @@ var want = { ...@@ -345,16 +361,16 @@ var want = {
} }
}; };
try { try {
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); let obj = formBindingData.createFormBindingData({ temperature: "22c", time: "22:00" });
formProvider.requestPublishForm(want, obj, (error, data) => { formProvider.requestPublishForm(want, obj, (error, data) => {
if (error) { if (error) {
console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error)); console.log(`callback error, code: ${error.code}, message: ${error.message})`);
} else { } else {
console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data)); console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data));
} }
}); });
} catch (error) { } catch (error) {
console.log(`catch err->${JSON.stringify(error)}`); console.log(`catch error, code: ${error.code}, message: ${error.message})`);
} }
``` ```
...@@ -379,13 +395,15 @@ requestPublishForm(want: Want, callback: AsyncCallback&lt;string&gt;): void ...@@ -379,13 +395,15 @@ requestPublishForm(want: Want, callback: AsyncCallback&lt;string&gt;): void
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例：** **示例：**
```ts ```ts
var want = { import formProvider from '@ohos.app.form.formProvider';
let want = {
abilityName: "FormAbility", abilityName: "FormAbility",
parameters: { parameters: {
"ohos.extra.param.key.form_dimension": 2, "ohos.extra.param.key.form_dimension": 2,
...@@ -396,15 +414,14 @@ var want = { ...@@ -396,15 +414,14 @@ var want = {
try { try {
formProvider.requestPublishForm(want, (error, data) => { formProvider.requestPublishForm(want, (error, data) => {
if (error) { if (error) {
console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error)); console.log(`callback error, code: ${error.code}, message: ${error.message})`);
} else { } else {
console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data)); console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data));
} }
}); });
} catch (error) { } catch (error) {
console.log(`catch err->${JSON.stringify(error)}`); console.log(`catch error, code: ${error.code}, message: ${error.message})`);
} }
``` ```
## requestPublishForm ## requestPublishForm
...@@ -422,7 +439,7 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData ...@@ -422,7 +439,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" | | 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-app-form-formBindingData.md#formbindingdata) | 否 | 创建卡片的数据。 | | formBindingData | [formBindingData.FormBindingData](js-apis-app-form-formBindingData.md#formbindingdata) | 否 | 创建卡片的数据。 |
**返回值：** **返回值：**
...@@ -434,13 +451,15 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData ...@@ -434,13 +451,15 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例：** **示例：**
```ts ```ts
var want = { import formProvider from '@ohos.app.form.formProvider';
let want = {
abilityName: "FormAbility", abilityName: "FormAbility",
parameters: { parameters: {
"ohos.extra.param.key.form_dimension": 2, "ohos.extra.param.key.form_dimension": 2,
...@@ -452,10 +471,10 @@ try { ...@@ -452,10 +471,10 @@ try {
formProvider.requestPublishForm(want).then((data) => { 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) => { }).catch((error) => {
console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error)); console.log(`promise error, code: ${error.code}, message: ${error.message})`);
}); });
} catch (error) { } catch (error) {
console.log(`catch err->${JSON.stringify(error)}`); console.log(`catch error, code: ${error.code}, message: ${error.message})`);
} }
``` ```
...@@ -478,10 +497,12 @@ isRequestPublishFormSupported(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -478,10 +497,12 @@ isRequestPublishFormSupported(callback: AsyncCallback&lt;boolean&gt;): void
**示例：** **示例：**
```ts ```ts
import formProvider from '@ohos.app.form.formProvider';
try { try {
formProvider.isRequestPublishFormSupported((error, isSupported) => { formProvider.isRequestPublishFormSupported((error, isSupported) => {
if (error) { if (error) {
console.log('formProvider isRequestPublishFormSupported, error:' + JSON.stringify(error)); console.log(`callback error, code: ${error.code}, message: ${error.message})`);
} else { } else {
if (isSupported) { if (isSupported) {
var want = { var want = {
...@@ -495,20 +516,19 @@ try { ...@@ -495,20 +516,19 @@ try {
try { try {
formProvider.requestPublishForm(want, (error, data) => { formProvider.requestPublishForm(want, (error, data) => {
if (error) { if (error) {
console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error)); console.log(`callback error, code: ${error.code}, message: ${error.message})`);
} else { } else {
console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data)); console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data));
} }
}); });
} catch (error) { } catch (error) {
console.log(`catch err->${JSON.stringify(error)}`); console.log(`catch error, code: ${error.code}, message: ${error.message})`);
} }
} }
} }
}); });
} catch (error) { } catch (error) {
console.log(`catch err->${JSON.stringify(error)}`); console.log(`catch error, code: ${error.code}, message: ${error.message})`);
} }
``` ```
...@@ -531,6 +551,8 @@ isRequestPublishFormSupported(): Promise&lt;boolean&gt; ...@@ -531,6 +551,8 @@ isRequestPublishFormSupported(): Promise&lt;boolean&gt;
**示例：** **示例：**
```ts ```ts
import formProvider from '@ohos.app.form.formProvider';
try { try {
formProvider.isRequestPublishFormSupported().then((isSupported) => { formProvider.isRequestPublishFormSupported().then((isSupported) => {
if (isSupported) { if (isSupported) {
...@@ -546,17 +568,16 @@ try { ...@@ -546,17 +568,16 @@ try {
formProvider.requestPublishForm(want).then((data) => { 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) => { }).catch((error) => {
console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error)); console.log(`promise error, code: ${error.code}, message: ${error.message})`);
}); });
} catch (error) { } catch (error) {
console.log(`catch err->${JSON.stringify(error)}`); console.log(`catch error, code: ${error.code}, message: ${error.message})`);
} }
} }
}).catch((error) => { }).catch((error) => {
console.log('formProvider isRequestPublishFormSupported, error:' + JSON.stringify(error)); console.log(`promise error, code: ${error.code}, message: ${error.message})`);
}); });
} catch (error) { } catch (error) {
console.log(`catch err->${JSON.stringify(error)}`); console.log(`catch error, code: ${error.code}, message: ${error.message})`);
} }
``` ```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-application-formExtensionContext.md
浏览文件 @ 7d07bb0f
# FormExtensionContext # FormExtensionContext
FormExtensionContext模块是FormExtension的上下文环境，继承自ExtensionContext。 FormExtensionContext模块是FormExtensionAbility的上下文环境，继承自ExtensionContext。
FormExtensionContext模块提供FormExtension具有的接口和能力。 FormExtensionContext模块提供FormExtensionAbility具有的接口和能力。
> **说明：** > **说明：**
> >
...@@ -11,23 +11,24 @@ FormExtensionContext模块提供FormExtension具有的接口和能力。 ...@@ -11,23 +11,24 @@ FormExtensionContext模块提供FormExtension具有的接口和能力。
## 使用说明 ## 使用说明
在使用FormExtensionContext的功能前，需要通过FormExtension获取。 在使用FormExtensionContext的功能前，需要通过FormExtensionAbility获取。
```ts ```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import formBindingData from '@ohos.app.form.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onAddForm() { onAddForm(want) {
let formContext = this.context; // 获取FormExtensionContext let formContext = this.context; // 获取FormExtensionContext
// ... // ...
let dataObj1 = { let dataObj1 = {
temperature:"11c", temperature: "11c",
"time":"11:00" "time": "11:00"
}; };
let obj1 = formBindingData.createFormBindingData(dataObj1); let obj1 = formBindingData.createFormBindingData(dataObj1);
return obj1; return obj1;
} }
} };
``` ```
## startAbility ## startAbility
...@@ -50,23 +51,29 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void ...@@ -50,23 +51,29 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void
**示例：** **示例：**
```ts ```ts
var want = { import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onFormEvent(formId, message) {
// 当触发卡片message事件时，执行startAbility
console.log('FormExtensionAbility onFormEvent, formId:' + formId + ", message:" + message);
let want = {
deviceId: "", deviceId: "",
bundleName: "com.example.formstartability", bundleName: "com.example.formstartability",
abilityName: "MainAbility", abilityName: "MainAbility",
action: "action1", parameters: {
entities: ["entity1"], "message": message
type: "MIMETYPE", }
uri: "key={true,true,false}", };
parameters: {} this.context.startAbility(want, (error, data) => {
}
this.context.startAbility(want, (error, data) => {
if (error) { if (error) {
console.log('FormExtensionContext startAbility, error:' + JSON.stringify(error)); console.log('FormExtensionContext startAbility, error:' + JSON.stringify(error));
} else { } else {
console.log(`FormExtensionContext startAbility success`); console.log('FormExtensionContext startAbility success');
}
});
} }
}) };
``` ```
## startAbility ## startAbility
...@@ -89,24 +96,30 @@ startAbility(want: Want): Promise&lt;void&gt; ...@@ -89,24 +96,30 @@ startAbility(want: Want): Promise&lt;void&gt;
| 类型 | 说明 | | 类型 | 说明 |
| ------------ | ---------------------------------- | | ------------ | ---------------------------------- |
| Promise&lt;void&lt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：** **示例：**
```ts ```ts
var want = { import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onFormEvent(formId, message) {
// 当触发卡片message事件时，执行startAbility
console.log('FormExtensionAbility onFormEvent, formId:' + formId + ", message:" + message);
let want = {
deviceId: "", deviceId: "",
bundleName: "com.example.formstartability", bundleName: "com.example.formstartability",
abilityName: "MainAbility", abilityName: "MainAbility",
action: "action1", parameters: {
entities: ["entity1"], "message": message
type: "MIMETYPE", }
uri: "key={true,true,false}", };
parameters: {} this.context.startAbility(want).then(() => {
}
this.context.startAbility(want).then(() => {
console.info("StartAbility Success"); console.info("StartAbility Success");
}).catch((error) => { }).catch((error) => {
console.info("StartAbility failed"); console.info("StartAbility failed");
}); });
}
};
``` ```
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或