未验证 提交 7d07bb0f 编写于 作者: O openharmony_ci 提交者: Gitee

!12925 卡片API参考文档优化

Merge pull request !12925 from yangzk/master
...@@ -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
...@@ -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
# @ohos.app.form.formHost (FormHost) # @ohos.app.form.formHost (formHost)
FormHost模块提供了卡片使用方相关接口的能力,包括对使用方同一用户下安装的卡片进行删除、释放、请求更新、获取卡片信息、状态等操作。 formHost模块提供了卡片使用方相关接口的能力,包括对使用方同一用户下安装的卡片进行删除、释放、请求更新、获取卡片信息、状态等操作。
> **说明:** > **说明:**
> >
...@@ -34,25 +34,24 @@ deleteForm(formId: string, callback: AsyncCallback<void>): void ...@@ -34,25 +34,24 @@ deleteForm(formId: string, callback: AsyncCallback<void>): void
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
```ts ```ts
try { try {
var formId = "12400633174999288"; let formId = "12400633174999288";
formHost.deleteForm(formId, (error, data) => { formHost.deleteForm(formId, (error) => {
if (error) { if (error) {
console.log('formHost deleteForm, error:' + JSON.stringify(error)); console.log(`error, code: ${error.code}, message: ${error.message})`);
} else { } else {
console.log('formHost deleteForm success'); console.log('formHost deleteForm success');
} }
}); });
} catch (error) { } catch (error) {
console.log(`catch err->${JSON.stringify(error)}`); console.log(`catch error, code: ${error.code}, message: ${error.message})`);
} }
``` ```
## deleteForm ## deleteForm
...@@ -82,21 +81,21 @@ deleteForm(formId: string): Promise<void> ...@@ -82,21 +81,21 @@ deleteForm(formId: string): Promise<void>
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**参数:** **参数:**
```ts ```ts
try { try {
var formId = "12400633174999288"; let formId = "12400633174999288";
formHost.deleteForm(formId).then(() => { formHost.deleteForm(formId).then(() => {
console.log('formHost deleteForm success'); console.log('formHost deleteForm success');
}).catch((error) => { }).catch((error) => {
console.log('formHost deleteForm, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -121,21 +120,21 @@ releaseForm(formId: string, callback: AsyncCallback<void>): void ...@@ -121,21 +120,21 @@ releaseForm(formId: string, callback: AsyncCallback<void>): void
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
```ts ```ts
try { try {
var formId = "12400633174999288"; let formId = "12400633174999288";
formHost.releaseForm(formId, (error, data) => { formHost.releaseForm(formId, (error) => {
if (error) { if (error) {
console.log('formHost releaseForm, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -161,21 +160,21 @@ releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback< ...@@ -161,21 +160,21 @@ releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback<
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
```ts ```ts
try { try {
var formId = "12400633174999288"; let formId = "12400633174999288";
formHost.releaseForm(formId, true, (error, data) => { formHost.releaseForm(formId, true, (error) => {
if (error) { if (error) {
console.log('formHost releaseForm, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -206,21 +205,21 @@ releaseForm(formId: string, isReleaseCache?: boolean): Promise<void> ...@@ -206,21 +205,21 @@ releaseForm(formId: string, isReleaseCache?: boolean): Promise<void>
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
```ts ```ts
try { try {
var formId = "12400633174999288"; let formId = "12400633174999288";
formHost.releaseForm(formId, true).then(() => { formHost.releaseForm(formId, true).then(() => {
console.log('formHost releaseForm success'); console.log('formHost releaseForm success');
}).catch((error) => { }).catch((error) => {
console.log('formHost releaseForm, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -245,21 +244,21 @@ requestForm(formId: string, callback: AsyncCallback<void>): void ...@@ -245,21 +244,21 @@ requestForm(formId: string, callback: AsyncCallback<void>): void
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
```ts ```ts
try { try {
var formId = "12400633174999288"; let formId = "12400633174999288";
formHost.requestForm(formId, (error, data) => { formHost.requestForm(formId, (error) => {
if (error) { if (error) {
console.log('formHost requestForm, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -289,21 +288,21 @@ requestForm(formId: string): Promise<void> ...@@ -289,21 +288,21 @@ requestForm(formId: string): Promise<void>
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
```ts ```ts
try { try {
var formId = "12400633174999288"; let formId = "12400633174999288";
formHost.requestForm(formId).then(() => { formHost.requestForm(formId).then(() => {
console.log('formHost requestForm success'); console.log('formHost requestForm success');
}).catch((error) => { }).catch((error) => {
console.log('formHost requestForm, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -323,27 +322,27 @@ castToNormalForm(formId: string, callback: AsyncCallback<void>): void ...@@ -323,27 +322,27 @@ castToNormalForm(formId: string, callback: AsyncCallback<void>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formId | string | 是 | 卡片标识。 | | formId | string | 是 | 卡片标识。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当将指定的临时卡片转换为普通卡片成功,err为undefined,否则为错误对象。 | | callback | AsyncCallback<void> | 是 | 回调函数。当将指定的临时卡片转换为普通卡片成功,error为undefined,否则为错误对象。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
```ts ```ts
try { try {
var formId = "12400633174999288"; let formId = "12400633174999288";
formHost.castToNormalForm(formId, (error, data) => { formHost.castToNormalForm(formId, (error) => {
if (error) { if (error) {
console.log('formHost castTempForm, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -373,21 +372,21 @@ castToNormalForm(formId: string): Promise<void> ...@@ -373,21 +372,21 @@ castToNormalForm(formId: string): Promise<void>
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
```ts ```ts
try { try {
var formId = "12400633174999288"; let formId = "12400633174999288";
formHost.castToNormalForm(formId).then(() => { formHost.castToNormalForm(formId).then(() => {
console.log('formHost castTempForm success'); console.log('formHost castTempForm success');
}).catch((error) => { }).catch((error) => {
console.log('formHost castTempForm, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -406,27 +405,27 @@ notifyVisibleForms(formIds: Array<string>, callback: AsyncCallback<void ...@@ -406,27 +405,27 @@ notifyVisibleForms(formIds: Array<string>, callback: AsyncCallback<void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formIds | Array<string> | 是 | 卡片标识列表。 | | formIds | Array<string> | 是 | 卡片标识列表。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当向卡片框架发送通知以使指定的卡片可见成功,err为undefined,否则为错误对象。 | | callback | AsyncCallback<void> | 是 | 回调函数。当向卡片框架发送通知以使指定的卡片可见成功,error为undefined,否则为错误对象。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
```ts ```ts
try { try {
var formId = ["12400633174999288"]; let formId = ["12400633174999288"];
formHost.notifyVisibleForms(formId, (error, data) => { formHost.notifyVisibleForms(formId, (error) => {
if (error) { if (error) {
console.log('formHost notifyVisibleForms, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -456,21 +455,21 @@ notifyVisibleForms(formIds: Array<string>): Promise<void> ...@@ -456,21 +455,21 @@ notifyVisibleForms(formIds: Array<string>): Promise<void>
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
```ts ```ts
try { try {
var formId = ["12400633174999288"]; let formId = ["12400633174999288"];
formHost.notifyVisibleForms(formId).then(() => { formHost.notifyVisibleForms(formId).then(() => {
console.log('formHost notifyVisibleForms success'); console.log('formHost notifyVisibleForms success');
}).catch((error) => { }).catch((error) => {
console.log('formHost notifyVisibleForms, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -489,27 +488,27 @@ notifyInvisibleForms(formIds: Array<string>, callback: AsyncCallback<vo ...@@ -489,27 +488,27 @@ notifyInvisibleForms(formIds: Array<string>, callback: AsyncCallback<vo
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formIds | Array<string> | 是 | 卡片标识列表。| | formIds | Array<string> | 是 | 卡片标识列表。|
| callback | AsyncCallback<void> | 是 | 回调函数。当向卡片框架发送通知以使指定的卡片不可见成功,err为undefined,否则为错误对象。 | | callback | AsyncCallback<void> | 是 | 回调函数。当向卡片框架发送通知以使指定的卡片不可见成功,error为undefined,否则为错误对象。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
```ts ```ts
try { try {
var formId = ["12400633174999288"]; let formId = ["12400633174999288"];
formHost.notifyInvisibleForms(formId, (error, data) => { formHost.notifyInvisibleForms(formId, (error) => {
if (error) { if (error) {
console.log('formHost notifyInvisibleForms, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -539,21 +538,21 @@ notifyInvisibleForms(formIds: Array<string>): Promise<void> ...@@ -539,21 +538,21 @@ notifyInvisibleForms(formIds: Array<string>): Promise<void>
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
```ts ```ts
try { try {
var formId = ["12400633174999288"]; let formId = ["12400633174999288"];
formHost.notifyInvisibleForms(formId).then(() => { formHost.notifyInvisibleForms(formId).then(() => {
console.log('formHost notifyInvisibleForms success'); console.log('formHost notifyInvisibleForms success');
}).catch((error) => { }).catch((error) => {
console.log('formHost notifyInvisibleForms, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -572,27 +571,27 @@ enableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void& ...@@ -572,27 +571,27 @@ enableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void&
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formIds | Array<string> | 是 | 卡片标识列表。 | | formIds | Array<string> | 是 | 卡片标识列表。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当向卡片框架发送通知以使指定的卡片可以更新成功,err为undefined,否则为错误对象。 | | callback | AsyncCallback<void> | 是 | 回调函数。当向卡片框架发送通知以使指定的卡片可以更新成功,error为undefined,否则为错误对象。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
```ts ```ts
try { try {
var formId = ["12400633174999288"]; let formId = ["12400633174999288"];
formHost.enableFormsUpdate(formId, (error, data) => { formHost.enableFormsUpdate(formId, (error) => {
if (error) { if (error) {
console.log('formHost enableFormsUpdate, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -622,21 +621,21 @@ enableFormsUpdate(formIds: Array<string>): Promise<void> ...@@ -622,21 +621,21 @@ enableFormsUpdate(formIds: Array<string>): Promise<void>
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
```ts ```ts
try { try {
var formId = ["12400633174999288"]; let formId = ["12400633174999288"];
formHost.enableFormsUpdate(formId).then(() => { formHost.enableFormsUpdate(formId).then(() => {
console.log('formHost enableFormsUpdate success'); console.log('formHost enableFormsUpdate success');
}).catch((error) => { }).catch((error) => {
console.log('formHost enableFormsUpdate, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -655,27 +654,27 @@ disableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void ...@@ -655,27 +654,27 @@ disableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formIds | Array<string> | 是 | 卡片标识列表。 | | formIds | Array<string> | 是 | 卡片标识列表。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当向卡片框架发送通知以使指定的卡片不可以更新成功,err为undefined,否则为错误对象。 | | callback | AsyncCallback<void> | 是 | 回调函数。当向卡片框架发送通知以使指定的卡片不可以更新成功,error为undefined,否则为错误对象。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
```ts ```ts
try { try {
var formId = ["12400633174999288"]; let formId = ["12400633174999288"];
formHost.disableFormsUpdate(formId, (error, data) => { formHost.disableFormsUpdate(formId, (error) => {
if (error) { if (error) {
console.log('formHost disableFormsUpdate, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -705,21 +704,21 @@ disableFormsUpdate(formIds: Array<string>): Promise<void> ...@@ -705,21 +704,21 @@ disableFormsUpdate(formIds: Array<string>): Promise<void>
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
```ts ```ts
try { try {
var formId = ["12400633174999288"]; let formId = ["12400633174999288"];
formHost.disableFormsUpdate(formId).then(() => { formHost.disableFormsUpdate(formId).then(() => {
console.log('formHost disableFormsUpdate success'); console.log('formHost disableFormsUpdate success');
}).catch((error) => { }).catch((error) => {
console.log('formHost disableFormsUpdate, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -735,20 +734,19 @@ isSystemReady(callback: AsyncCallback<void>): void ...@@ -735,20 +734,19 @@ isSystemReady(callback: AsyncCallback<void>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| callback | AsyncCallback<void> | 是 | 回调函数。当检查系统是否准备好成功,err为undefined,否则为错误对象。 | | callback | AsyncCallback<void> | 是 | 回调函数。当检查系统是否准备好成功,error为undefined,否则为错误对象。 |
**示例:** **示例:**
```ts ```ts
try { try {
var formId = "12400633174999288";
formHost.isSystemReady((error, data) => { formHost.isSystemReady((error, data) => {
if (error) { if (error) {
console.log('formHost isSystemReady, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -770,14 +768,13 @@ isSystemReady(): Promise<void> ...@@ -770,14 +768,13 @@ isSystemReady(): Promise<void>
```ts ```ts
try { try {
var formId = "12400633174999288";
formHost.isSystemReady().then(() => { formHost.isSystemReady().then(() => {
console.log('formHost isSystemReady success'); console.log('formHost isSystemReady success');
}).catch((error) => { }).catch((error) => {
console.log('formHost isSystemReady, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -795,7 +792,7 @@ getAllFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): ...@@ -795,7 +792,7 @@ getAllFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>):
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| callback | AsyncCallback<Array<[FormInfo](js-apis-app-form-formInfo.md)>> | 是 | 回调函数。当获取设备上所有应用提供的卡片信息成功,err为undefined,data为查询到的卡片信息;否则为错误对象。 | | callback | AsyncCallback<Array<[formInfo.FormInfo](js-apis-app-form-formInfo.md)>> | 是 | 回调函数。当获取设备上所有应用提供的卡片信息成功,error为undefined,data为查询到的卡片信息;否则为错误对象。 |
**示例:** **示例:**
...@@ -803,13 +800,13 @@ getAllFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): ...@@ -803,13 +800,13 @@ getAllFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>):
try { try {
formHost.getAllFormsInfo((error, data) => { formHost.getAllFormsInfo((error, data) => {
if (error) { if (error) {
console.log('formHost getAllFormsInfo, error:' + JSON.stringify(error)); console.log(`error, code: ${error.code}, message: ${error.message})`);
} else { } else {
console.log('formHost getAllFormsInfo, data:' + JSON.stringify(data)); console.log('formHost getAllFormsInfo, 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})`);
} }
``` ```
...@@ -826,8 +823,8 @@ getAllFormsInfo(): Promise<Array<formInfo.FormInfo>> ...@@ -826,8 +823,8 @@ getAllFormsInfo(): Promise<Array<formInfo.FormInfo>>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :------------ | :---------------------------------- | | :----------------------------------------------------------- | :---------------------------------- |
| Promise<Array<[FormInfo](js-apis-app-form-formInfo.md)>> | Promise对象,返回查询到的卡片信息。 | | Promise<Array<[formInfo.FormInfo](js-apis-app-form-formInfo.md)>> | Promise对象,返回查询到的卡片信息。 |
**示例:** **示例:**
...@@ -836,10 +833,10 @@ try { ...@@ -836,10 +833,10 @@ try {
formHost.getAllFormsInfo().then((data) => { formHost.getAllFormsInfo().then((data) => {
console.log('formHost getAllFormsInfo data:' + JSON.stringify(data)); console.log('formHost getAllFormsInfo data:' + JSON.stringify(data));
}).catch((error) => { }).catch((error) => {
console.log('formHost getAllFormsInfo, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -858,14 +855,14 @@ getFormsInfo(bundleName: string, callback: AsyncCallback<Array<formInfo.Fo ...@@ -858,14 +855,14 @@ getFormsInfo(bundleName: string, callback: AsyncCallback<Array<formInfo.Fo
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| bundleName | string | 是 | 要查询的应用Bundle名称。 | | bundleName | string | 是 | 要查询的应用Bundle名称。 |
| callback | AsyncCallback<Array<[FormInfo](js-apis-app-form-formInfo.md)>> | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功,err为undefined,data为查询到的卡片信息;否则为错误对象。 | | callback | AsyncCallback<Array<[formInfo.FormInfo](js-apis-app-form-formInfo.md)>> | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功,error为undefined,data为查询到的卡片信息;否则为错误对象。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
...@@ -873,13 +870,13 @@ getFormsInfo(bundleName: string, callback: AsyncCallback<Array<formInfo.Fo ...@@ -873,13 +870,13 @@ getFormsInfo(bundleName: string, callback: AsyncCallback<Array<formInfo.Fo
try { try {
formHost.getFormsInfo("com.example.ohos.formjsdemo", (error, data) => { formHost.getFormsInfo("com.example.ohos.formjsdemo", (error, data) => {
if (error) { if (error) {
console.log('formHost getFormsInfo, error:' + JSON.stringify(error)); console.log(`error, code: ${error.code}, message: ${error.message})`);
} else { } else {
console.log('formHost getFormsInfo, data:' + JSON.stringify(data)); console.log('formHost 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})`);
} }
``` ```
...@@ -899,14 +896,14 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback< ...@@ -899,14 +896,14 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback<
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| bundleName | string | 是 | 要查询的应用Bundle名称。 | | bundleName | string | 是 | 要查询的应用Bundle名称。 |
| moduleName | string | 是 | 要查询的模块名称。 | | moduleName | string | 是 | 要查询的模块名称。 |
| callback | AsyncCallback<Array<[FormInfo](js-apis-app-form-formInfo.md)>> | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功,err为undefined,data为查询到的卡片信息;否则为错误对象。 | | callback | AsyncCallback<Array<[formInfo.FormInfo](js-apis-app-form-formInfo.md)>> | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功,error为undefined,data为查询到的卡片信息;否则为错误对象。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
...@@ -914,13 +911,13 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback< ...@@ -914,13 +911,13 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback<
try { try {
formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry", (error, data) => { formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry", (error, data) => {
if (error) { if (error) {
console.log('formHost getFormsInfo, error:' + JSON.stringify(error)); console.log(`error, code: ${error.code}, message: ${error.message})`);
} else { } else {
console.log('formHost getFormsInfo, data:' + JSON.stringify(data)); console.log('formHost 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})`);
} }
``` ```
...@@ -944,15 +941,15 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise<Array<formI ...@@ -944,15 +941,15 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise<Array<formI
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :------------ | :---------------------------------- | | :----------------------------------------------------------- | :---------------------------------- |
| Promise<Array<[FormInfo](js-apis-app-form-formInfo.md)>> | Promise对象,返回查询到的卡片信息。 | | Promise<Array<[formInfo.FormInfo](js-apis-app-form-formInfo.md)>> | Promise对象,返回查询到的卡片信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
...@@ -961,10 +958,10 @@ try { ...@@ -961,10 +958,10 @@ try {
formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry").then((data) => { formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry").then((data) => {
console.log('formHost getFormsInfo, data:' + JSON.stringify(data)); console.log('formHost getFormsInfo, data:' + JSON.stringify(data));
}).catch((error) => { }).catch((error) => {
console.log('formHost getFormsInfo, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -983,22 +980,22 @@ deleteInvalidForms(formIds: Array<string>, callback: AsyncCallback<numb ...@@ -983,22 +980,22 @@ deleteInvalidForms(formIds: Array<string>, callback: AsyncCallback<numb
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formIds | Array<string> | 是 | 有效卡片标识列表。 | | formIds | Array<string> | 是 | 有效卡片标识列表。 |
| callback | AsyncCallback<number> | 是 | 回调函数。当根据列表删除应用程序的无效卡片成功,err为undefined,data为删除的卡片个数;否则为错误对象。 | | callback | AsyncCallback<number> | 是 | 回调函数。当根据列表删除应用程序的无效卡片成功,error为undefined,data为删除的卡片个数;否则为错误对象。 |
**示例:** **示例:**
```ts ```ts
try { try {
var formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array("12400633174999288", "12400633174999289");
formHost.deleteInvalidForms(formIds, (error, data) => { formHost.deleteInvalidForms(formIds, (error, data) => {
if (error) { if (error) {
console.log('formHost deleteInvalidForms, error:' + JSON.stringify(error)); console.log(`error, code: ${error.code}, message: ${error.message})`);
} else { } else {
console.log('formHost deleteInvalidForms, data:' + JSON.stringify(data)); console.log('formHost deleteInvalidForms, 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})`);
} }
``` ```
...@@ -1028,14 +1025,14 @@ deleteInvalidForms(formIds: Array<string>): Promise<number> ...@@ -1028,14 +1025,14 @@ deleteInvalidForms(formIds: Array<string>): Promise<number>
```ts ```ts
try { try {
var formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array("12400633174999288", "12400633174999289");
formHost.deleteInvalidForms(formIds).then((data) => { formHost.deleteInvalidForms(formIds).then((data) => {
console.log('formHost deleteInvalidForms, data:' + JSON.stringify(data)); console.log('formHost deleteInvalidForms, data:' + JSON.stringify(data));
}).catch((error) => { }).catch((error) => {
console.log('formHost deleteInvalidForms, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -1053,15 +1050,15 @@ acquireFormState(want: Want, callback: AsyncCallback<formInfo.FormStateInfo&g ...@@ -1053,15 +1050,15 @@ acquireFormState(want: Want, callback: AsyncCallback<formInfo.FormStateInfo&g
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| want | [Want](js-apis-application-want.md) | 是 | 查询卡片状态时携带的want信息。 | | want | [Want](js-apis-application-want.md) | 是 | 查询卡片状态时携带的want信息。需要包含bundle名、ability名、module名、卡片名、卡片规格等。 |
| callback | AsyncCallback<[FormStateInfo](js-apis-app-form-formInfo.md#formstateinfo)> | 是 | 回调函数。当获取卡片状态成功,err为undefined,data为获取到的卡片状态;否则为错误对象。 | | callback | AsyncCallback<[formInfo.FormStateInfo](js-apis-app-form-formInfo.md#formstateinfo)> | 是 | 回调函数。当获取卡片状态成功,error为undefined,data为获取到的卡片状态;否则为错误对象。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
...@@ -1079,13 +1076,13 @@ var want = { ...@@ -1079,13 +1076,13 @@ var want = {
try { try {
formHost.acquireFormState(want, (error, data) => { formHost.acquireFormState(want, (error, data) => {
if (error) { if (error) {
console.log('formHost acquireFormState, error:' + JSON.stringify(error)); console.log(`error, code: ${error.code}, message: ${error.message})`);
} else { } else {
console.log('formHost acquireFormState, data:' + JSON.stringify(data)); console.log('formHost acquireFormState, 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})`);
} }
``` ```
...@@ -1103,20 +1100,20 @@ acquireFormState(want: Want): Promise<formInfo.FormStateInfo> ...@@ -1103,20 +1100,20 @@ acquireFormState(want: Want): Promise<formInfo.FormStateInfo>
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| want | [Want](js-apis-application-want.md) | 是 | 查询卡片状态时携带的want信息。 | | want | [Want](js-apis-application-want.md) | 是 | 查询卡片状态时携带的want信息。需要包含bundle名、ability名、module名、卡片名、卡片规格等。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise<[FormStateInfo](js-apis-app-form-formInfo.md#formstateinfo)> | Promise对象,返回卡片状态。 | | Promise<[formInfo.FormStateInfo](js-apis-app-form-formInfo.md#formstateinfo)> | Promise对象,返回卡片状态。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
...@@ -1135,10 +1132,10 @@ try { ...@@ -1135,10 +1132,10 @@ try {
formHost.acquireFormState(want).then((data) => { formHost.acquireFormState(want).then((data) => {
console.log('formHost acquireFormState, data:' + JSON.stringify(data)); console.log('formHost acquireFormState, data:' + JSON.stringify(data));
}).catch((error) => { }).catch((error) => {
console.log('formHost acquireFormState, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -1206,27 +1203,27 @@ notifyFormsVisible(formIds: Array<string>, isVisible: boolean, callback: A ...@@ -1206,27 +1203,27 @@ notifyFormsVisible(formIds: Array<string>, isVisible: boolean, callback: A
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formIds | Array<string> | 是 | 卡片标识列表。 | | formIds | Array<string> | 是 | 卡片标识列表。 |
| isVisible | boolean | 是 | 是否可见。 | | isVisible | boolean | 是 | 是否可见。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当通知卡片是否可见成功,err为undefined,否则为错误对象。 | | callback | AsyncCallback<void> | 是 | 回调函数。当通知卡片是否可见成功,error为undefined,否则为错误对象。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
```ts ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array("12400633174999288", "12400633174999289");
try { try {
formHost.notifyFormsVisible(formIds, true, (error, data) => { formHost.notifyFormsVisible(formIds, true, (error) => {
if (error) { if (error) {
console.log('formHost notifyFormsVisible, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -1257,21 +1254,21 @@ notifyFormsVisible(formIds: Array<string>, isVisible: boolean): Promise&lt ...@@ -1257,21 +1254,21 @@ notifyFormsVisible(formIds: Array<string>, isVisible: boolean): Promise&lt
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
```ts ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array("12400633174999288", "12400633174999289");
try { try {
formHost.notifyFormsVisible(formIds, true).then(() => { formHost.notifyFormsVisible(formIds, true).then(() => {
console.log('formHost notifyFormsVisible success'); console.log('formHost notifyFormsVisible success');
}).catch((error) => { }).catch((error) => {
console.log('formHost notifyFormsVisible, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -1291,27 +1288,27 @@ notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean, c ...@@ -1291,27 +1288,27 @@ notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean, c
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formIds | Array<string> | 是 | 卡片标识列表。 | | formIds | Array<string> | 是 | 卡片标识列表。 |
| isEnableUpdate | boolean | 是 | 是否使能更新。 | | isEnableUpdate | boolean | 是 | 是否使能更新。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当通知卡片是否启用更新状态成功,err为undefined,否则为错误对象。 | | callback | AsyncCallback<void> | 是 | 回调函数。当通知卡片是否启用更新状态成功,error为undefined,否则为错误对象。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
```ts ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array("12400633174999288", "12400633174999289");
try { try {
formHost.notifyFormsEnableUpdate(formIds, true, (error, data) => { formHost.notifyFormsEnableUpdate(formIds, true, (error) => {
if (error) { if (error) {
console.log('formHost notifyFormsEnableUpdate, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -1342,21 +1339,21 @@ notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean): ...@@ -1342,21 +1339,21 @@ notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean):
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | -------- | | -------- | -------- |
| 401 | If the input parameter is not valid parameter. | | 401 | 调用接口入参错误。 |
以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md) |以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。||
**示例:** **示例:**
```ts ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array("12400633174999288", "12400633174999289");
try { try {
formHost.notifyFormsEnableUpdate(formIds, true).then(() => { formHost.notifyFormsEnableUpdate(formIds, true).then(() => {
console.log('formHost notifyFormsEnableUpdate success'); console.log('formHost notifyFormsEnableUpdate success');
}).catch((error) => { }).catch((error) => {
console.log('formHost notifyFormsEnableUpdate, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
## shareForm ## shareForm
...@@ -1375,29 +1372,28 @@ shareForm(formId: string, deviceId: string, callback: AsyncCallback<void>) ...@@ -1375,29 +1372,28 @@ shareForm(formId: string, deviceId: string, callback: AsyncCallback<void>)
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formId | string | 是 | 卡片标识。 | | formId | string | 是 | 卡片标识。 |
| deviceId | string | 是 | 远程设备标识。 | | deviceId | string | 是 | 远程设备标识。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当指定formId和远程设备Id进行卡片分享成功,err为undefined,否则为错误对象。 | | callback | AsyncCallback<void> | 是 | 回调函数。当指定formId和远程设备Id进行卡片分享成功,error为undefined,否则为错误对象。 |
**错误码:** **错误码:**
| 错误码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"; let formId = "12400633174999288";
var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2"; var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2";
try { try {
formHost.shareForm(formId, deviceId, (error, data) => { formHost.shareForm(formId, deviceId, (error) => {
if (error) { if (error) {
console.log('formHost shareForm, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -1428,22 +1424,22 @@ shareForm(formId: string, deviceId: string): Promise<void> ...@@ -1428,22 +1424,22 @@ shareForm(formId: string, deviceId: string): Promise<void>
| 错误码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"; let formId = "12400633174999288";
var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2"; var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2";
try { try {
formHost.shareForm(formId, deviceId).then(() => { formHost.shareForm(formId, deviceId).then(() => {
console.log('formHost shareForm success'); console.log('formHost shareForm success');
}).catch((error) => { }).catch((error) => {
console.log('formHost shareForm, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
...@@ -1451,6 +1447,8 @@ try { ...@@ -1451,6 +1447,8 @@ try {
notifyFormsPrivacyProtected(formIds: Array\<string>, isProtected: boolean, callback: AsyncCallback\<void>): void notifyFormsPrivacyProtected(formIds: Array\<string>, isProtected: boolean, callback: AsyncCallback\<void>): void
通知指定卡片隐私保护状态改变。使用callback异步回调。
**需要权限**:ohos.permission.REQUIRE_FORM **需要权限**:ohos.permission.REQUIRE_FORM
**系统能力**:SystemCapability.Ability.Form **系统能力**:SystemCapability.Ability.Form
...@@ -1459,18 +1457,72 @@ notifyFormsPrivacyProtected(formIds: Array\<string>, isProtected: boolean, callb ...@@ -1459,18 +1457,72 @@ notifyFormsPrivacyProtected(formIds: Array\<string>, isProtected: boolean, callb
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formId | string | 是 | 卡片标识。 | | formIds | Array\<string\> | 是 | 需要修改隐私保护的卡片标识列表。 |
| deviceId | string | 是 | 远程设备标识。 | | isProtected | boolean | 是 | 是否进行隐私保护。 |
| callback | AsyncCallback\<void> | 是 | 回调函数。当指定卡片设置隐私保护属性成功,error为undefined,否则为错误对象。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------------------------------------------------------------ | ------------------ |
| 401 | 调用接口入参错误。 |
| 以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 | |
**示例:**
```ts ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array("12400633174999288", "12400633174999289");
try {
formHost.notifyFormsPrivacyProtected(formIds, true, (error) => {
if (error) {
console.log(`error, code: ${error.code}, message: ${error.message})`);
}
});
} catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`);
}
```
## notifyFormsPrivacyProtected
function notifyFormsPrivacyProtected(formIds: Array\<string\>, isProtected: boolean): Promise\<void\>;
通知指定卡片隐私保护状态改变。使用Promise异步回调。
**需要权限**:ohos.permission.REQUIRE_FORM
**系统能力**:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------- | ---- | -------------------------------- |
| formIds | Array\<string\> | 是 | 需要修改隐私保护的卡片标识列表。 |
| isProtected | boolean | 是 | 是否进行隐私保护。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------------------------------------------------------------ | ------------------ |
| 401 | 调用接口入参错误。 |
| 以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 | |
```ts
let formIds = new Array("12400633174999288", "12400633174999289");
try { try {
formHost.notifyFormsPrivacyProtected(formIds, true).then(() => { formHost.notifyFormsPrivacyProtected(formIds, true).then(() => {
console.log('formHost shareForm success'); console.log('formHost notifyFormsPrivacyProtected success');
}).catch((error) => { }).catch((error) => {
console.log('formHost shareForm, error:' + JSON.stringify(error)); console.log(`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})`);
} }
``` ```
# @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&lt;number&gt; | 是 | 否 | 卡片支持的规格。具体可选规格参考[FormDimension](#formdimension) | | supportDimensions | Array&lt;number&gt; | 是 | 否 | 卡片支持的规格。具体可选规格参考[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
......
# @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
# 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.
先完成此消息的编辑!
想要评论请 注册