提交 52831925 编写于 作者: C chenyuyan

卡片资料优化

Signed-off-by: Nchenyuyan <chenyuyan3@huawei.com>
Change-Id: I10172a61ffb1cf1b83bd4b92cb8869fa8cdc0a06
上级 bfd8e841
...@@ -59,6 +59,6 @@ try { ...@@ -59,6 +59,6 @@ try {
}; };
formBindingData.createFormBindingData(obj); formBindingData.createFormBindingData(obj);
} catch (error) { } catch (error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
\ No newline at end of file
...@@ -40,17 +40,19 @@ deleteForm(formId: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -40,17 +40,19 @@ deleteForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
let formId = "12400633174999288"; let formId = "12400633174999288";
formHost.deleteForm(formId, (error) => { formHost.deleteForm(formId, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message})`); 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 error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -87,15 +89,17 @@ deleteForm(formId: string): Promise&lt;void&gt; ...@@ -87,15 +89,17 @@ deleteForm(formId: string): Promise&lt;void&gt;
**参数:** **参数:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
let 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(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -126,15 +130,17 @@ releaseForm(formId: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -126,15 +130,17 @@ releaseForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
let formId = "12400633174999288"; let formId = "12400633174999288";
formHost.releaseForm(formId, (error) => { formHost.releaseForm(formId, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
} }
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -166,15 +172,17 @@ releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback&lt; ...@@ -166,15 +172,17 @@ releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback&lt;
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
let formId = "12400633174999288"; let formId = "12400633174999288";
formHost.releaseForm(formId, true, (error) => { formHost.releaseForm(formId, true, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
} }
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -211,15 +219,17 @@ releaseForm(formId: string, isReleaseCache?: boolean): Promise&lt;void&gt; ...@@ -211,15 +219,17 @@ releaseForm(formId: string, isReleaseCache?: boolean): Promise&lt;void&gt;
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
let 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(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -250,15 +260,17 @@ requestForm(formId: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -250,15 +260,17 @@ requestForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
let formId = "12400633174999288"; let formId = "12400633174999288";
formHost.requestForm(formId, (error) => { formHost.requestForm(formId, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
} }
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -294,15 +306,17 @@ requestForm(formId: string): Promise&lt;void&gt; ...@@ -294,15 +306,17 @@ requestForm(formId: string): Promise&lt;void&gt;
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
let 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(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -334,15 +348,17 @@ castToNormalForm(formId: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -334,15 +348,17 @@ castToNormalForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
let formId = "12400633174999288"; let formId = "12400633174999288";
formHost.castToNormalForm(formId, (error) => { formHost.castToNormalForm(formId, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
} }
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -378,15 +394,17 @@ castToNormalForm(formId: string): Promise&lt;void&gt; ...@@ -378,15 +394,17 @@ castToNormalForm(formId: string): Promise&lt;void&gt;
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
let 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(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -417,15 +435,17 @@ notifyVisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void ...@@ -417,15 +435,17 @@ notifyVisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
let formId = ["12400633174999288"]; let formId = ["12400633174999288"];
formHost.notifyVisibleForms(formId, (error) => { formHost.notifyVisibleForms(formId, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
} }
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -461,15 +481,17 @@ notifyVisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt; ...@@ -461,15 +481,17 @@ notifyVisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
let 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(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -500,15 +522,17 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;vo ...@@ -500,15 +522,17 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;vo
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
let formId = ["12400633174999288"]; let formId = ["12400633174999288"];
formHost.notifyInvisibleForms(formId, (error) => { formHost.notifyInvisibleForms(formId, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
} }
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -544,15 +568,17 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt; ...@@ -544,15 +568,17 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
let 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(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -583,15 +609,17 @@ enableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void& ...@@ -583,15 +609,17 @@ enableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void&
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
let formId = ["12400633174999288"]; let formId = ["12400633174999288"];
formHost.enableFormsUpdate(formId, (error) => { formHost.enableFormsUpdate(formId, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
} }
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -627,15 +655,17 @@ enableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt; ...@@ -627,15 +655,17 @@ enableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
let 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(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -666,15 +696,17 @@ disableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void ...@@ -666,15 +696,17 @@ disableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
let formId = ["12400633174999288"]; let formId = ["12400633174999288"];
formHost.disableFormsUpdate(formId, (error) => { formHost.disableFormsUpdate(formId, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
} }
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -710,15 +742,17 @@ disableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt; ...@@ -710,15 +742,17 @@ disableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
let 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(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -739,14 +773,16 @@ isSystemReady(callback: AsyncCallback&lt;void&gt;): void ...@@ -739,14 +773,16 @@ isSystemReady(callback: AsyncCallback&lt;void&gt;): void
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
formHost.isSystemReady((error, data) => { formHost.isSystemReady((error, data) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
} }
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -767,14 +803,16 @@ isSystemReady(): Promise&lt;void&gt; ...@@ -767,14 +803,16 @@ isSystemReady(): Promise&lt;void&gt;
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
formHost.isSystemReady().then(() => { formHost.isSystemReady().then(() => {
console.log('formHost isSystemReady success'); console.log('formHost isSystemReady success');
}).catch((error) => { }).catch((error) => {
console.log(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -797,16 +835,18 @@ getAllFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): ...@@ -797,16 +835,18 @@ getAllFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;):
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
formHost.getAllFormsInfo((error, data) => { formHost.getAllFormsInfo((error, data) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message})`); 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 error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -829,14 +869,16 @@ getAllFormsInfo(): Promise&lt;Array&lt;formInfo.FormInfo&gt;&gt; ...@@ -829,14 +869,16 @@ getAllFormsInfo(): Promise&lt;Array&lt;formInfo.FormInfo&gt;&gt;
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { 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(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -867,16 +909,18 @@ getFormsInfo(bundleName: string, callback: AsyncCallback&lt;Array&lt;formInfo.Fo ...@@ -867,16 +909,18 @@ getFormsInfo(bundleName: string, callback: AsyncCallback&lt;Array&lt;formInfo.Fo
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
formHost.getFormsInfo("com.example.ohos.formjsdemo", (error, data) => { formHost.getFormsInfo("com.example.ohos.formjsdemo", (error, data) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message})`); 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 error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -908,16 +952,18 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback&lt; ...@@ -908,16 +952,18 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback&lt;
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
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(`error, code: ${error.code}, message: ${error.message})`); 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 error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -954,14 +1000,16 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise&lt;Array&lt;formI ...@@ -954,14 +1000,16 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise&lt;Array&lt;formI
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { 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(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -985,17 +1033,19 @@ deleteInvalidForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;numb ...@@ -985,17 +1033,19 @@ deleteInvalidForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;numb
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
let 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(`error, code: ${error.code}, message: ${error.message})`); 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 error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -1024,15 +1074,17 @@ deleteInvalidForms(formIds: Array&lt;string&gt;): Promise&lt;number&gt; ...@@ -1024,15 +1074,17 @@ deleteInvalidForms(formIds: Array&lt;string&gt;): Promise&lt;number&gt;
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
try { try {
let 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(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -1063,7 +1115,9 @@ acquireFormState(want: Want, callback: AsyncCallback&lt;formInfo.FormStateInfo&g ...@@ -1063,7 +1115,9 @@ acquireFormState(want: Want, callback: AsyncCallback&lt;formInfo.FormStateInfo&g
**示例:** **示例:**
```ts ```ts
var want = { import formHost from '@ohos.app.form.formHost';
let want = {
"deviceId": "", "deviceId": "",
"bundleName": "ohos.samples.FormApplication", "bundleName": "ohos.samples.FormApplication",
"abilityName": "FormAbility", "abilityName": "FormAbility",
...@@ -1076,13 +1130,13 @@ var want = { ...@@ -1076,13 +1130,13 @@ var want = {
try { try {
formHost.acquireFormState(want, (error, data) => { formHost.acquireFormState(want, (error, data) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message})`); 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 error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -1118,7 +1172,9 @@ acquireFormState(want: Want): Promise&lt;formInfo.FormStateInfo&gt; ...@@ -1118,7 +1172,9 @@ acquireFormState(want: Want): Promise&lt;formInfo.FormStateInfo&gt;
**示例:** **示例:**
```ts ```ts
var want = { import formHost from '@ohos.app.form.formHost';
let want = {
"deviceId": "", "deviceId": "",
"bundleName": "ohos.samples.FormApplication", "bundleName": "ohos.samples.FormApplication",
"abilityName": "FormAbility", "abilityName": "FormAbility",
...@@ -1132,10 +1188,10 @@ try { ...@@ -1132,10 +1188,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(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -1157,6 +1213,8 @@ on(type: "formUninstall", callback: Callback&lt;string&gt;): void ...@@ -1157,6 +1213,8 @@ on(type: "formUninstall", callback: Callback&lt;string&gt;): void
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
let callback = function(formId) { let callback = function(formId) {
console.log('formHost on formUninstall, formId:' + formId); console.log('formHost on formUninstall, formId:' + formId);
} }
...@@ -1181,6 +1239,8 @@ off(type: "formUninstall", callback?: Callback&lt;string&gt;): void ...@@ -1181,6 +1239,8 @@ off(type: "formUninstall", callback?: Callback&lt;string&gt;): void
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
let callback = function(formId) { let callback = function(formId) {
console.log('formHost on formUninstall, formId:' + formId); console.log('formHost on formUninstall, formId:' + formId);
} }
...@@ -1215,15 +1275,17 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean, callback: A ...@@ -1215,15 +1275,17 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean, callback: A
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
let formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array("12400633174999288", "12400633174999289");
try { try {
formHost.notifyFormsVisible(formIds, true, (error) => { formHost.notifyFormsVisible(formIds, true, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
} }
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -1260,15 +1322,17 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean): Promise&lt ...@@ -1260,15 +1322,17 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean): Promise&lt
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
let 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(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -1300,15 +1364,17 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean, c ...@@ -1300,15 +1364,17 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean, c
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
let formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array("12400633174999288", "12400633174999289");
try { try {
formHost.notifyFormsEnableUpdate(formIds, true, (error) => { formHost.notifyFormsEnableUpdate(formIds, true, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
} }
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -1345,15 +1411,17 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean): ...@@ -1345,15 +1411,17 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean):
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
let 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(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
## shareForm ## shareForm
...@@ -1384,16 +1452,18 @@ shareForm(formId: string, deviceId: string, callback: AsyncCallback&lt;void&gt;) ...@@ -1384,16 +1452,18 @@ shareForm(formId: string, deviceId: string, callback: AsyncCallback&lt;void&gt;)
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
let formId = "12400633174999288"; let formId = "12400633174999288";
var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2"; let deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2";
try { try {
formHost.shareForm(formId, deviceId, (error) => { formHost.shareForm(formId, deviceId, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
} }
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -1430,16 +1500,18 @@ shareForm(formId: string, deviceId: string): Promise&lt;void&gt; ...@@ -1430,16 +1500,18 @@ shareForm(formId: string, deviceId: string): Promise&lt;void&gt;
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
let formId = "12400633174999288"; let formId = "12400633174999288";
var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2"; let 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(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -1471,15 +1543,17 @@ notifyFormsPrivacyProtected(formIds: Array\<string>, isProtected: boolean, callb ...@@ -1471,15 +1543,17 @@ notifyFormsPrivacyProtected(formIds: Array\<string>, isProtected: boolean, callb
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.app.form.formHost';
let formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array("12400633174999288", "12400633174999289");
try { try {
formHost.notifyFormsPrivacyProtected(formIds, true, (error) => { formHost.notifyFormsPrivacyProtected(formIds, true, (error) => {
if (error) { if (error) {
console.log(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
} }
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -1514,15 +1588,17 @@ function notifyFormsPrivacyProtected(formIds: Array\<string\>, isProtected: bool ...@@ -1514,15 +1588,17 @@ function notifyFormsPrivacyProtected(formIds: Array\<string\>, isProtected: bool
| 以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 | | | 以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 | |
```ts ```ts
import formHost from '@ohos.app.form.formHost';
let formIds = new Array("12400633174999288", "12400633174999289"); let formIds = new Array("12400633174999288", "12400633174999289");
try { try {
formHost.notifyFormsPrivacyProtected(formIds, true).then(() => { formHost.notifyFormsPrivacyProtected(formIds, true).then(() => {
console.log('formHost notifyFormsPrivacyProtected success'); console.log('formHost notifyFormsPrivacyProtected success');
}).catch((error) => { }).catch((error) => {
console.log(`error, code: ${error.code}, message: ${error.message})`); console.log(`error, code: ${error.code}, message: ${error.message}`);
}); });
} catch(error) { } catch(error) {
console.log(`catch error, code: ${error.code}, message: ${error.message})`); console.log(`catch error, code: ${error.code}, message: ${error.message}`);
} }
``` ```
...@@ -48,16 +48,17 @@ createFormBindingData(obj?: Object | string): FormBindingData ...@@ -48,16 +48,17 @@ createFormBindingData(obj?: Object | string): FormBindingData
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import formBindingData from @ohos.application.formBindingData;
import fileio from '@ohos.fileio'; import fs from '@ohos.file.fs';
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 }
}; };
let formBindingDataObj = formBindingData.createFormBindingData(obj); formBindingData.createFormBindingData(obj);
}) } catch (error.code) {
console.log('catch error, error:' + JSON.stringify(error));
}
``` ```
# @ohos.application.formError (FormError) # @ohos.application.formError (formError)
FormError模块提供获取卡片错误码的能力。 formError模块提供获取卡片错误码的能力。
> **说明:** > **说明:**
> >
......
# @ohos.application.formHost (FormHost) # @ohos.application.formHost (formHost)
FormHost模块提供了卡片使用方相关接口的能力,包括对使用方同一用户下安装的卡片进行删除、释放、请求更新,获取信息、状态等操作。 formHost模块提供了卡片使用方相关接口的能力,包括对使用方同一用户下安装的卡片进行删除、释放、请求更新,获取信息、状态等操作。
> **说明:** > **说明:**
> >
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 从API version 9 开始不再维护,建议使用[FormHost](js-apis-app-form-formHost.md)替代。 > 从API version 9 开始不再维护,建议使用[formHost](js-apis-app-form-formHost.md)替代。
> 本模块接口均为系统接口。 > 本模块接口均为系统接口。
## 导入模块 ## 导入模块
...@@ -34,10 +34,12 @@ deleteForm(formId: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -34,10 +34,12 @@ deleteForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
**示例:** **示例:**
```ts ```ts
var formId = "12400633174999288"; import formHost from '@ohos.application.formHost';
let formId = "12400633174999288";
formHost.deleteForm(formId, (error, data) => { formHost.deleteForm(formId, (error, data) => {
if (error.code) { if (error.code) {
console.log('formHost deleteForm, error:' + JSON.stringify(error)); console.error('formHost deleteForm, error:' + JSON.stringify(error));
} }
}); });
``` ```
...@@ -67,11 +69,13 @@ deleteForm(formId: string): Promise&lt;void&gt; ...@@ -67,11 +69,13 @@ deleteForm(formId: string): Promise&lt;void&gt;
**参数:** **参数:**
```ts ```ts
var formId = "12400633174999288"; import formHost from '@ohos.application.formHost';
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.error('formHost deleteForm, error:' + JSON.stringify(error));
}); });
``` ```
...@@ -95,10 +99,14 @@ releaseForm(formId: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -95,10 +99,14 @@ releaseForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
**示例:** **示例:**
```ts ```ts
var formId = "12400633174999288"; import formHost from '@ohos.application.formHost';
let formId = "12400633174999288";
formHost.releaseForm(formId, (error, data) => { formHost.releaseForm(formId, (error, data) => {
if (error.code) { if (error.code) {
console.log('formHost releaseForm, error:' + JSON.stringify(error)); console.error('formHost releaseForm, error:' + JSON.stringify(error));
} else {
console.log('formHost releaseForm success');
} }
}); });
``` ```
...@@ -124,10 +132,14 @@ releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback&lt; ...@@ -124,10 +132,14 @@ releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback&lt;
**示例:** **示例:**
```ts ```ts
var formId = "12400633174999288"; import formHost from '@ohos.application.formHost';
let formId = "12400633174999288";
formHost.releaseForm(formId, true, (error, data) => { formHost.releaseForm(formId, true, (error, data) => {
if (error.code) { if (error.code) {
console.log('formHost releaseForm, error:' + JSON.stringify(error)); console.error('formHost releaseForm, error:' + JSON.stringify(error));
} else {
console.log('formHost releaseForm success');
} }
}); });
``` ```
...@@ -158,11 +170,13 @@ releaseForm(formId: string, isReleaseCache?: boolean): Promise&lt;void&gt; ...@@ -158,11 +170,13 @@ releaseForm(formId: string, isReleaseCache?: boolean): Promise&lt;void&gt;
**示例:** **示例:**
```ts ```ts
var formId = "12400633174999288"; import formHost from '@ohos.application.formHost';
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.error('formHost releaseForm, error:' + JSON.stringify(error));
}); });
``` ```
...@@ -186,10 +200,12 @@ requestForm(formId: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -186,10 +200,12 @@ requestForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
**示例:** **示例:**
```ts ```ts
var formId = "12400633174999288"; import formHost from '@ohos.application.formHost';
let formId = "12400633174999288";
formHost.requestForm(formId, (error, data) => { formHost.requestForm(formId, (error, data) => {
if (error.code) { if (error.code) {
console.log('formHost requestForm, error:' + JSON.stringify(error)); console.error('formHost requestForm, error:' + JSON.stringify(error));
} }
}); });
``` ```
...@@ -219,11 +235,13 @@ requestForm(formId: string): Promise&lt;void&gt; ...@@ -219,11 +235,13 @@ requestForm(formId: string): Promise&lt;void&gt;
**示例:** **示例:**
```ts ```ts
var formId = "12400633174999288"; import formHost from '@ohos.application.formHost';
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.error('formHost requestForm, error:' + JSON.stringify(error));
}); });
``` ```
...@@ -242,15 +260,17 @@ castTempForm(formId: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -242,15 +260,17 @@ castTempForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formId | string | 是 | 卡片标识。 | | formId | string | 是 | 卡片标识。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当将指定的临时卡片转换为普通卡片成功,err为undefined,否则为错误对象。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当将指定的临时卡片转换为普通卡片成功,error为undefined,否则为错误对象。 |
**示例:** **示例:**
```ts ```ts
var formId = "12400633174999288"; import formHost from '@ohos.application.formHost';
let formId = "12400633174999288";
formHost.castTempForm(formId, (error, data) => { formHost.castTempForm(formId, (error, data) => {
if (error.code) { if (error.code) {
console.log('formHost castTempForm, error:' + JSON.stringify(error)); console.error('formHost castTempForm, error:' + JSON.stringify(error));
} }
}); });
``` ```
...@@ -280,11 +300,13 @@ castTempForm(formId: string): Promise&lt;void&gt; ...@@ -280,11 +300,13 @@ castTempForm(formId: string): Promise&lt;void&gt;
**示例:** **示例:**
```ts ```ts
var formId = "12400633174999288"; import formHost from '@ohos.application.formHost';
let formId = "12400633174999288";
formHost.castTempForm(formId).then(() => { formHost.castTempForm(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.error('formHost castTempForm, error:' + JSON.stringify(error));
}); });
``` ```
...@@ -303,15 +325,17 @@ notifyVisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void ...@@ -303,15 +325,17 @@ notifyVisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formIds | Array&lt;string&gt; | 是 | 卡片标识列表。 | | formIds | Array&lt;string&gt; | 是 | 卡片标识列表。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当向卡片框架发送通知以使指定的卡片可见成功,err为undefined,否则为错误对象。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当向卡片框架发送通知以使指定的卡片可见成功,error为undefined,否则为错误对象。 |
**示例:** **示例:**
```ts ```ts
var formId = ["12400633174999288"]; import formHost from '@ohos.application.formHost';
let formId = ["12400633174999288"];
formHost.notifyVisibleForms(formId, (error, data) => { formHost.notifyVisibleForms(formId, (error, data) => {
if (error.code) { if (error.code) {
console.log('formHost notifyVisibleForms, error:' + JSON.stringify(error)); console.error('formHost notifyVisibleForms, error:' + JSON.stringify(error));
} }
}); });
``` ```
...@@ -341,11 +365,13 @@ notifyVisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt; ...@@ -341,11 +365,13 @@ notifyVisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
**示例:** **示例:**
```ts ```ts
var formId = ["12400633174999288"]; import formHost from '@ohos.application.formHost';
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.error('formHost notifyVisibleForms, error:' + JSON.stringify(error));
}); });
``` ```
...@@ -364,15 +390,17 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;vo ...@@ -364,15 +390,17 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;vo
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formIds | Array&lt;string&gt; | 是 | 卡片标识列表。| | formIds | Array&lt;string&gt; | 是 | 卡片标识列表。|
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当向卡片框架发送通知以使指定的卡片不可见成功,err为undefined,否则为错误对象。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当向卡片框架发送通知以使指定的卡片不可见成功,error为undefined,否则为错误对象。 |
**示例:** **示例:**
```ts ```ts
var formId = ["12400633174999288"]; import formHost from '@ohos.application.formHost';
let formId = ["12400633174999288"];
formHost.notifyInvisibleForms(formId, (error, data) => { formHost.notifyInvisibleForms(formId, (error, data) => {
if (error.code) { if (error.code) {
console.log('formHost notifyInvisibleForms, error:' + JSON.stringify(error)); console.error('formHost notifyInvisibleForms, error:' + JSON.stringify(error));
} }
}); });
``` ```
...@@ -402,11 +430,13 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt; ...@@ -402,11 +430,13 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
**示例:** **示例:**
```ts ```ts
var formId = ["12400633174999288"]; import formHost from '@ohos.application.formHost';
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.error('formHost notifyInvisibleForms, error:' + JSON.stringify(error));
}); });
``` ```
...@@ -425,15 +455,17 @@ enableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void& ...@@ -425,15 +455,17 @@ enableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void&
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formIds | Array&lt;string&gt; | 是 | 卡片标识列表。 | | formIds | Array&lt;string&gt; | 是 | 卡片标识列表。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当向卡片框架发送通知以使指定的卡片可以更新成功,err为undefined,否则为错误对象。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当向卡片框架发送通知以使指定的卡片可以更新成功,error为undefined,否则为错误对象。 |
**示例:** **示例:**
```ts ```ts
var formId = ["12400633174999288"]; import formHost from '@ohos.application.formHost';
let formId = ["12400633174999288"];
formHost.enableFormsUpdate(formId, (error, data) => { formHost.enableFormsUpdate(formId, (error, data) => {
if (error.code) { if (error.code) {
console.log('formHost enableFormsUpdate, error:' + JSON.stringify(error)); console.error('formHost enableFormsUpdate, error:' + JSON.stringify(error));
} }
}); });
``` ```
...@@ -463,11 +495,13 @@ enableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt; ...@@ -463,11 +495,13 @@ enableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
**示例:** **示例:**
```ts ```ts
var formId = ["12400633174999288"]; import formHost from '@ohos.application.formHost';
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.error('formHost enableFormsUpdate, error:' + JSON.stringify(error));
}); });
``` ```
...@@ -486,15 +520,17 @@ disableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void ...@@ -486,15 +520,17 @@ disableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formIds | Array&lt;string&gt; | 是 | 卡片标识列表。 | | formIds | Array&lt;string&gt; | 是 | 卡片标识列表。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当向卡片框架发送通知以使指定的卡片不可以更新成功,err为undefined,否则为错误对象。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当向卡片框架发送通知以使指定的卡片不可以更新成功,error为undefined,否则为错误对象。 |
**示例:** **示例:**
```ts ```ts
var formId = ["12400633174999288"]; import formHost from '@ohos.application.formHost';
let formId = ["12400633174999288"];
formHost.disableFormsUpdate(formId, (error, data) => { formHost.disableFormsUpdate(formId, (error, data) => {
if (error.code) { if (error.code) {
console.log('formHost disableFormsUpdate, error:' + JSON.stringify(error)); console.error('formHost disableFormsUpdate, error:' + JSON.stringify(error));
} }
}); });
``` ```
...@@ -524,11 +560,13 @@ disableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt; ...@@ -524,11 +560,13 @@ disableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
**示例:** **示例:**
```ts ```ts
var formId = ["12400633174999288"]; import formHost from '@ohos.application.formHost';
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.error('formHost disableFormsUpdate, error:' + JSON.stringify(error));
}); });
``` ```
...@@ -544,15 +582,17 @@ isSystemReady(callback: AsyncCallback&lt;void&gt;): void ...@@ -544,15 +582,17 @@ isSystemReady(callback: AsyncCallback&lt;void&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当检查系统是否准备好成功,err为undefined,否则为错误对象。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当检查系统是否准备好成功,error为undefined,否则为错误对象。 |
**示例:** **示例:**
```ts ```ts
var formId = "12400633174999288"; import formHost from '@ohos.application.formHost';
let formId = "12400633174999288";
formHost.isSystemReady((error, data) => { formHost.isSystemReady((error, data) => {
if (error.code) { if (error.code) {
console.log('formHost isSystemReady, error:' + JSON.stringify(error)); console.error('formHost isSystemReady, error:' + JSON.stringify(error));
} }
}); });
``` ```
...@@ -574,11 +614,13 @@ isSystemReady(): Promise&lt;void&gt; ...@@ -574,11 +614,13 @@ isSystemReady(): Promise&lt;void&gt;
**示例:** **示例:**
```ts ```ts
var formId = "12400633174999288"; import formHost from '@ohos.application.formHost';
let 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.error('formHost isSystemReady, error:' + JSON.stringify(error));
}); });
``` ```
...@@ -596,14 +638,16 @@ getAllFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): ...@@ -596,14 +638,16 @@ getAllFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;):
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](js-apis-application-formInfo.md)&gt;&gt; | 是 | 回调函数。当获取设备上所有应用提供的卡片信息成功,err为undefined,data为查询到的卡片信息;否则为错误对象。 | | callback | AsyncCallback&lt;Array&lt;[formInfo.FormInfo](js-apis-application-formInfo.md)&gt;&gt; | 是 | 回调函数。当获取设备上所有应用提供的卡片信息成功,error为undefined,data为查询到的卡片信息;否则为错误对象。 |
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.application.formHost';
formHost.getAllFormsInfo((error, data) => { formHost.getAllFormsInfo((error, data) => {
if (error.code) { if (error.code) {
console.log('formHost getAllFormsInfo, error:' + JSON.stringify(error)); console.error('formHost getAllFormsInfo, error:' + JSON.stringify(error));
} else { } else {
console.log('formHost getAllFormsInfo, data:' + JSON.stringify(data)); console.log('formHost getAllFormsInfo, data:' + JSON.stringify(data));
} }
...@@ -624,15 +668,17 @@ getAllFormsInfo(): Promise&lt;Array&lt;formInfo.FormInfo&gt;&gt; ...@@ -624,15 +668,17 @@ getAllFormsInfo(): Promise&lt;Array&lt;formInfo.FormInfo&gt;&gt;
| 类型 | 说明 | | 类型 | 说明 |
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise&lt;Array&lt;[FormInfo](js-apis-application-formInfo.md)&gt;&gt; | Promise对象,返回查询到的卡片信息。 | | Promise&lt;Array&lt;[formInfo.FormInfo](js-apis-application-formInfo.md)&gt;&gt; | Promise对象,返回查询到的卡片信息。 |
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.application.formHost';
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.error('formHost getAllFormsInfo, error:' + JSON.stringify(error));
}); });
``` ```
...@@ -651,14 +697,16 @@ getFormsInfo(bundleName: string, callback: AsyncCallback&lt;Array&lt;formInfo.Fo ...@@ -651,14 +697,16 @@ getFormsInfo(bundleName: string, callback: AsyncCallback&lt;Array&lt;formInfo.Fo
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| bundleName | string | 是 | 要查询的应用Bundle名称。 | | bundleName | string | 是 | 要查询的应用Bundle名称。 |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](js-apis-application-formInfo.md)&gt;&gt; | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功,err为undefined,data为查询到的卡片信息;否则为错误对象。 | | callback | AsyncCallback&lt;Array&lt;[formInfo.FormInfo](js-apis-application-formInfo.md)&gt;&gt; | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功,error为undefined,data为查询到的卡片信息;否则为错误对象。 |
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.application.formHost';
formHost.getFormsInfo("com.example.ohos.formjsdemo", (error, data) => { formHost.getFormsInfo("com.example.ohos.formjsdemo", (error, data) => {
if (error.code) { if (error.code) {
console.log('formHost getFormsInfo, error:' + JSON.stringify(error)); console.error('formHost getFormsInfo, error:' + JSON.stringify(error));
} else { } else {
console.log('formHost getFormsInfo, data:' + JSON.stringify(data)); console.log('formHost getFormsInfo, data:' + JSON.stringify(data));
} }
...@@ -681,14 +729,16 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback&lt; ...@@ -681,14 +729,16 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback&lt;
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| bundleName | string | 是 | 要查询的应用程序Bundle名称。 | | bundleName | string | 是 | 要查询的应用程序Bundle名称。 |
| moduleName | string | 是 | 要查询的模块名称。 | | moduleName | string | 是 | 要查询的模块名称。 |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](js-apis-application-formInfo.md)&gt;&gt; | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功,err为undefined,data为查询到的卡片信息;否则为错误对象。 | | callback | AsyncCallback&lt;Array&lt;[formInfo.FormInfo](js-apis-application-formInfo.md)&gt;&gt; | 是 | 回调函数。当获取设备上指定应用程序提供的卡片信息成功,error为undefined,data为查询到的卡片信息;否则为错误对象。 |
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.application.formHost';
formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry", (error, data) => { formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry", (error, data) => {
if (error.code) { if (error.code) {
console.log('formHost getFormsInfo, error:' + JSON.stringify(error)); console.error('formHost getFormsInfo, error:' + JSON.stringify(error));
} else { } else {
console.log('formHost getFormsInfo, data:' + JSON.stringify(data)); console.log('formHost getFormsInfo, data:' + JSON.stringify(data));
} }
...@@ -716,15 +766,17 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise&lt;Array&lt;formI ...@@ -716,15 +766,17 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise&lt;Array&lt;formI
| 类型 | 说明 | | 类型 | 说明 |
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise&lt;Array&lt;[FormInfo](js-apis-application-formInfo.md)&gt;&gt; | Promise对象,返回查询到的卡片信息。 | | Promise&lt;Array&lt;[formInfo.FormInfo](js-apis-application-formInfo.md)&gt;&gt; | Promise对象,返回查询到的卡片信息。 |
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.application.formHost';
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.error('formHost getFormsInfo, error:' + JSON.stringify(error));
}); });
``` ```
...@@ -743,15 +795,17 @@ deleteInvalidForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;numb ...@@ -743,15 +795,17 @@ deleteInvalidForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;numb
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formIds | Array&lt;string&gt; | 是 | 有效卡片标识列表。 | | formIds | Array&lt;string&gt; | 是 | 有效卡片标识列表。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。当根据列表删除应用程序的无效卡片成功,err为undefined,data为删除的卡片个数;否则为错误对象。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。当根据列表删除应用程序的无效卡片成功,error为undefined,data为删除的卡片个数;否则为错误对象。 |
**示例:** **示例:**
```ts ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); import formHost from '@ohos.application.formHost';
let formIds = new Array("12400633174999288", "12400633174999289");
formHost.deleteInvalidForms(formIds, (error, data) => { formHost.deleteInvalidForms(formIds, (error, data) => {
if (error.code) { if (error.code) {
console.log('formHost deleteInvalidForms, error:' + JSON.stringify(error)); console.error('formHost deleteInvalidForms, error:' + JSON.stringify(error));
} else { } else {
console.log('formHost deleteInvalidForms, data:' + JSON.stringify(data)); console.log('formHost deleteInvalidForms, data:' + JSON.stringify(data));
} }
...@@ -783,11 +837,13 @@ deleteInvalidForms(formIds: Array&lt;string&gt;): Promise&lt;number&gt; ...@@ -783,11 +837,13 @@ deleteInvalidForms(formIds: Array&lt;string&gt;): Promise&lt;number&gt;
**示例:** **示例:**
```ts ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); import formHost from '@ohos.application.formHost';
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.error('formHost deleteInvalidForms, error:' + JSON.stringify(error));
}); });
``` ```
...@@ -805,13 +861,15 @@ acquireFormState(want: Want, callback: AsyncCallback&lt;formInfo.FormStateInfo&g ...@@ -805,13 +861,15 @@ acquireFormState(want: Want, callback: AsyncCallback&lt;formInfo.FormStateInfo&g
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| want | [Want](js-apis-application-want.md) | 是 | 查询卡片状态时携带的want信息。 | | want | [Want](js-apis-application-want.md) | 是 | 查询卡片状态时携带的want信息。需要包含bundle名、ability名、module名、卡片名、卡片规格等。 |
| callback | AsyncCallback&lt;[FormStateInfo](js-apis-application-formInfo.md#formstateinfo)&gt; | 是 | 回调函数。当获取卡片状态成功,err为undefined,data为获取到的卡片状态;否则为错误对象。 | | callback | AsyncCallback&lt;[formInfo.FormStateInfo](js-apis-application-formInfo.md#formstateinfo)&gt; | 是 | 回调函数。当获取卡片状态成功,error为undefined,data为获取到的卡片状态;否则为错误对象。 |
**示例:** **示例:**
```ts ```ts
var want = { import formHost from '@ohos.application.formHost';
let want = {
"deviceId": "", "deviceId": "",
"bundleName": "ohos.samples.FormApplication", "bundleName": "ohos.samples.FormApplication",
"abilityName": "FormAbility", "abilityName": "FormAbility",
...@@ -823,7 +881,7 @@ var want = { ...@@ -823,7 +881,7 @@ var want = {
}; };
formHost.acquireFormState(want, (error, data) => { formHost.acquireFormState(want, (error, data) => {
if (error.code) { if (error.code) {
console.log('formHost acquireFormState, error:' + JSON.stringify(error)); console.error('formHost acquireFormState, error:' + JSON.stringify(error));
} else { } else {
console.log('formHost acquireFormState, data:' + JSON.stringify(data)); console.log('formHost acquireFormState, data:' + JSON.stringify(data));
} }
...@@ -855,7 +913,9 @@ acquireFormState(want: Want): Promise&lt;formInfo.FormStateInfo&gt; ...@@ -855,7 +913,9 @@ acquireFormState(want: Want): Promise&lt;formInfo.FormStateInfo&gt;
**示例:** **示例:**
```ts ```ts
var want = { import formHost from '@ohos.application.formHost';
let want = {
"deviceId": "", "deviceId": "",
"bundleName": "ohos.samples.FormApplication", "bundleName": "ohos.samples.FormApplication",
"abilityName": "FormAbility", "abilityName": "FormAbility",
...@@ -868,7 +928,7 @@ var want = { ...@@ -868,7 +928,7 @@ var want = {
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.error('formHost acquireFormState, error:' + JSON.stringify(error));
}); });
``` ```
...@@ -890,6 +950,8 @@ on(type: "formUninstall", callback: Callback&lt;string&gt;): void ...@@ -890,6 +950,8 @@ on(type: "formUninstall", callback: Callback&lt;string&gt;): void
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.application.formHost';
let callback = function(formId) { let callback = function(formId) {
console.log('formHost on formUninstall, formId:' + formId); console.log('formHost on formUninstall, formId:' + formId);
} }
...@@ -909,11 +971,13 @@ off(type: "formUninstall", callback?: Callback&lt;string&gt;): void ...@@ -909,11 +971,13 @@ off(type: "formUninstall", callback?: Callback&lt;string&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| type | string | 是 | 填写"formUninstall",表示卡片卸载事件。 | | type | string | 是 | 填写"formUninstall",表示卡片卸载事件。 |
| callback | Callback&lt;string&gt; | 否 | 回调函数。返回卡片标识。缺省时,表示注销所有已注册事件回调。 | | callback | Callback&lt;string&gt; | 否 | 回调函数。返回卡片标识。缺省时,表示注销所有已注册事件回调。<br> 需与对应on("formUninstall")的callback一致。|
**示例:** **示例:**
```ts ```ts
import formHost from '@ohos.application.formHost';
let callback = function(formId) { let callback = function(formId) {
console.log('formHost on formUninstall, formId:' + formId); console.log('formHost on formUninstall, formId:' + formId);
} }
...@@ -936,15 +1000,17 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean, callback: A ...@@ -936,15 +1000,17 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean, callback: A
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formIds | Array&lt;string&gt; | 是 | 卡片标识列表。 | | formIds | Array&lt;string&gt; | 是 | 卡片标识列表。 |
| isVisible | boolean | 是 | 是否可见。 | | isVisible | boolean | 是 | 是否可见。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当通知卡片是否可见成功,err为undefined,否则为错误对象。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当通知卡片是否可见成功,error为undefined,否则为错误对象。 |
**示例:** **示例:**
```ts ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); import formHost from '@ohos.application.formHost';
let formIds = new Array("12400633174999288", "12400633174999289");
formHost.notifyFormsVisible(formIds, true, (error, data) => { formHost.notifyFormsVisible(formIds, true, (error, data) => {
if (error.code) { if (error.code) {
console.log('formHost notifyFormsVisible, error:' + JSON.stringify(error)); console.error('formHost notifyFormsVisible, error:' + JSON.stringify(error));
} }
}); });
``` ```
...@@ -975,11 +1041,13 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean): Promise&lt ...@@ -975,11 +1041,13 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean): Promise&lt
**示例:** **示例:**
```ts ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); import formHost from '@ohos.application.formHost';
let formIds = new Array("12400633174999288", "12400633174999289");
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.error('formHost notifyFormsVisible, error:' + JSON.stringify(error));
}); });
``` ```
...@@ -999,15 +1067,17 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean, c ...@@ -999,15 +1067,17 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean, c
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formIds | Array&lt;string&gt; | 是 | 卡片标识列表。 | | formIds | Array&lt;string&gt; | 是 | 卡片标识列表。 |
| isEnableUpdate | boolean | 是 | 是否使能更新。 | | isEnableUpdate | boolean | 是 | 是否使能更新。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当通知卡片是否启用更新状态成功,err为undefined,否则为错误对象。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当通知卡片是否启用更新状态成功,error为undefined,否则为错误对象。 |
**示例:** **示例:**
```ts ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); import formHost from '@ohos.application.formHost';
let formIds = new Array("12400633174999288", "12400633174999289");
formHost.notifyFormsEnableUpdate(formIds, true, (error, data) => { formHost.notifyFormsEnableUpdate(formIds, true, (error, data) => {
if (error.code) { if (error.code) {
console.log('formHost notifyFormsEnableUpdate, error:' + JSON.stringify(error)); console.error('formHost notifyFormsEnableUpdate, error:' + JSON.stringify(error));
} }
}); });
``` ```
...@@ -1038,11 +1108,13 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean): ...@@ -1038,11 +1108,13 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean):
**示例:** **示例:**
```ts ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); import formHost from '@ohos.application.formHost';
let formIds = new Array("12400633174999288", "12400633174999289");
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.error('formHost notifyFormsEnableUpdate, error:' + JSON.stringify(error));
}); });
``` ```
## shareForm<sup>9+</sup> ## shareForm<sup>9+</sup>
...@@ -1051,7 +1123,7 @@ shareForm(formId: string, deviceId: string, callback: AsyncCallback&lt;void&gt;) ...@@ -1051,7 +1123,7 @@ shareForm(formId: string, deviceId: string, callback: AsyncCallback&lt;void&gt;)
指定formId和远程设备Id进行卡片分享。使用callback异步回调。 指定formId和远程设备Id进行卡片分享。使用callback异步回调。
**需要权限**:ohos.permission.REQUIRE_FORM **需要权限**:ohos.permission.REQUIRE_FORM 和 ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**:SystemCapability.Ability.Form **系统能力**:SystemCapability.Ability.Form
...@@ -1061,16 +1133,18 @@ shareForm(formId: string, deviceId: string, callback: AsyncCallback&lt;void&gt;) ...@@ -1061,16 +1133,18 @@ shareForm(formId: string, deviceId: string, callback: AsyncCallback&lt;void&gt;)
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| formId | string | 是 | 卡片标识。 | | formId | string | 是 | 卡片标识。 |
| deviceId | string | 是 | 远程设备标识。 | | deviceId | string | 是 | 远程设备标识。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当指定formId和远程设备Id进行卡片分享成功,err为undefined,否则为错误对象。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当指定formId和远程设备Id进行卡片分享成功,error为undefined,否则为错误对象。 |
**示例:** **示例:**
```ts ```ts
var formId = "12400633174999288"; import formHost from '@ohos.application.formHost';
var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2";
let formId = "12400633174999288";
let deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2";
formHost.shareForm(formId, deviceId, (error, data) => { formHost.shareForm(formId, deviceId, (error, data) => {
if (error.code) { if (error.code) {
console.log('formHost shareForm, error:' + JSON.stringify(error)); console.error('formHost shareForm, error:' + JSON.stringify(error));
} }
}); });
``` ```
...@@ -1101,18 +1175,22 @@ shareForm(formId: string, deviceId: string): Promise&lt;void&gt; ...@@ -1101,18 +1175,22 @@ shareForm(formId: string, deviceId: string): Promise&lt;void&gt;
**参数:** **参数:**
```ts ```ts
var formId = "12400633174999288"; import formHost from '@ohos.application.formHost';
var deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2";
let formId = "12400633174999288";
let deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2";
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.error('formHost shareForm, error:' + JSON.stringify(error));
}); });
``` ```
## notifyFormsPrivacyProtected<sup>9+</sup> ## notifyFormsPrivacyProtected<sup>9+</sup>
notifyFormsPrivacyProtected(formIds: Array\<string>, isProtected: boolean, callback: AsyncCallback\<void>): void notifyFormsPrivacyProtected(formIds: Array&lt;string&gt;, isProtected: boolean, callback: AsyncCallback&lt;void&gt;): void
通知指定卡片隐私保护状态改变。使用callback异步回调。
**需要权限**:ohos.permission.REQUIRE_FORM **需要权限**:ohos.permission.REQUIRE_FORM
...@@ -1126,10 +1204,51 @@ notifyFormsPrivacyProtected(formIds: Array\<string>, isProtected: boolean, callb ...@@ -1126,10 +1204,51 @@ notifyFormsPrivacyProtected(formIds: Array\<string>, isProtected: boolean, callb
| deviceId | string | 是 | 远程设备标识。 | | deviceId | string | 是 | 远程设备标识。 |
```ts ```ts
var formIds = new Array("12400633174999288", "12400633174999289"); import formHost from '@ohos.application.formHost';
let formIds = new Array("12400633174999288", "12400633174999289");
formHost.notifyFormsPrivacyProtected(formIds, true).then(() => { formHost.notifyFormsPrivacyProtected(formIds, true).then(() => {
console.log('formHost shareForm success'); console.log('formHost shareForm success');
}).catch((error) => { }).catch((error) => {
console.log('formHost shareForm, error:' + JSON.stringify(error)); console.error('formHost shareForm, error:' + JSON.stringify(error));
}); });
``` ```
## notifyFormsPrivacyProtected
function notifyFormsPrivacyProtected(formIds: Array&lt;string&gt;, isProtected: boolean): Promise&lt;void&gt;;
通知指定卡片隐私保护状态改变。使用Promise异步回调。
**需要权限**:ohos.permission.REQUIRE_FORM
**系统能力**:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------- | ---- | -------------------------------- |
| formIds | Array&lt;string&gt; | 是 | 需要修改隐私保护的卡片标识列表。 |
| isProtected | boolean | 是 | 是否进行隐私保护。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
```ts
import formHost from '@ohos.application.formHost';
let formIds = new Array("12400633174999288", "12400633174999289");
try {
formHost.notifyFormsPrivacyProtected(formIds, true).then(() => {
console.log('formHost notifyFormsPrivacyProtected success');
}).catch((error) => {
console.log('formHost notifyFormsPrivacyProtected, error:' + JSON.stringify(error));
});
} catch(error) {
console.log('formHost notifyFormsPrivacyProtected, error:' + JSON.stringify(error));
}
```
# @ohos.application.formInfo (FormInfo) # @ohos.application.formInfo (formInfo)
FormInfo模块提供对卡片的相关卡片信息和状态进行设置和查询的能力 formInfo模块提供了卡片信息和状态等相关类型和枚举
> **说明:** > **说明:**
> >
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 从API version 9 开始不再维护,建议使用[FormInfo](js-apis-app-form-formInfo.md)替代。 > 从API version 9 开始不再维护,建议使用[formInfo](js-apis-app-form-formInfo.md)替代。
## 导入模块 ## 导入模块
...@@ -31,11 +31,11 @@ import formInfo from '@ohos.application.formInfo'; ...@@ -31,11 +31,11 @@ import formInfo from '@ohos.application.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。 | | formConfigAbility | string | 是 | 否 | 表示卡片配置ability。 |
| updateDuration | string | 是 | 否 | 表示卡片更新周期。 | | updateDuration | number | 是 | 否 | 表示卡片更新周期。 |
| defaultDimension | number | 是 | 否 | 表示卡片规格 | | defaultDimension | number | 是 | 否 | 表示卡片规格 |
| supportDimensions | Array&lt;number&gt; | 是 | 否 | 表示卡片支持的规格。 | | supportDimensions | Array&lt;number&gt; | 是 | 否 | 表示卡片支持的规格。 |
| customizeData | {[key: string]: [value: string]} | 是 | 否 | 表示卡片用户数据。 | | customizeData | {[key: string]: [value: string]} | 是 | 否 | 表示卡片用户数据。 |
...@@ -101,8 +101,8 @@ import formInfo from '@ohos.application.formInfo'; ...@@ -101,8 +101,8 @@ import formInfo from '@ohos.application.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<sup>9+</sup> | "ohos.extra.param.key.ability_name" | ability名称 | | ABILITY_NAME_KEY<sup>9+</sup> | "ohos.extra.param.key.ability_name" | ability名称 |
| DEVICE_ID_KEY<sup>9+</sup> | "ohos.extra.param.key.device_id" | 设备标识。<br/>**系统接口**: 此接口为系统接口。 | | DEVICE_ID_KEY<sup>9+</sup> | "ohos.extra.param.key.device_id" | 设备标识。 |
| BUNDLE_NAME_KEY<sup>9+</sup> | "ohos.extra.param.key.bundle_name" | 指示指定要获取的捆绑包名称的键。| | BUNDLE_NAME_KEY<sup>9+</sup> | "ohos.extra.param.key.bundle_name" | 指示指定要获取的捆绑包名称的键。|
## FormDimension<sup>9+</sup> ## FormDimension<sup>9+</sup>
...@@ -119,17 +119,6 @@ import formInfo from '@ohos.application.formInfo'; ...@@ -119,17 +119,6 @@ import formInfo from '@ohos.application.formInfo';
| Dimension_4_4 <sup>9+</sup> | 4 | 4 x 4 form。 | | Dimension_4_4 <sup>9+</sup> | 4 | 4 x 4 form。 |
| Dimension_2_1 <sup>9+</sup> | 5 | 2 x 1 form。 | | Dimension_2_1 <sup>9+</sup> | 5 | 2 x 1 form。 |
## VisibilityType
卡片可见性。
**系统能力**:SystemCapability.Ability.Form
| 名称 | 值 | 说明 |
| ----------- | ---- | ------------ |
| FORM_VISIBLE<sup>9+<sup> | 1 | 卡片状态为可见。 |
| FORM_INVISIBLE<sup>9+<sup> | 2 | 卡片状态为不可见。 |
## FormInfoFilter<sup>9+</sup> ## FormInfoFilter<sup>9+</sup>
卡片信息过滤器,仅将符合过滤器内要求的卡片信息返回。 卡片信息过滤器,仅将符合过滤器内要求的卡片信息返回。
...@@ -138,7 +127,7 @@ import formInfo from '@ohos.application.formInfo'; ...@@ -138,7 +127,7 @@ import formInfo from '@ohos.application.formInfo';
| 名称 | 说明 | | 名称 | 说明 |
| ----------- | ------------ | | ----------- | ------------ |
| moduleName<sup>9+</sup> | 仅保留moduleName与提供值相符的卡片信息。 | | moduleName<sup>9+</sup> | 选填。仅保留moduleName与提供值相符的卡片信息。<br>未填写时则不通过moduleName进行过滤。 |
## VisibilityType<sup>9+</sup> ## VisibilityType<sup>9+</sup>
......
# @ohos.application.formProvider (FormProvider) # @ohos.application.formProvider (formProvider)
FormProvider模块提供了卡片提供方相关接口的能力,开发者在开发卡片时,可通过该模块提供接口实现更新卡片,设置卡片更新时间,获取卡片信息,请求发布卡片等。 FormProvider模块提供了卡片提供方相关接口的能力,开发者在开发卡片时,可通过该模块提供接口实现更新卡片,设置卡片更新时间,获取卡片信息,请求发布卡片等。
> **说明:** > **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 从API version 9 开始不再维护,建议使用[FormProvider](js-apis-app-form-formProvider.md)替代。 > 从API version 9 开始不再维护,建议使用[formProvider](js-apis-app-form-formProvider.md)替代。
## 导入模块 ## 导入模块
...@@ -31,7 +31,9 @@ setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback&l ...@@ -31,7 +31,9 @@ setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback&l
**示例:** **示例:**
```ts ```ts
var formId = "12400633174999288"; import formProvider from '@ohos.app.form.formProvider';
let formId = "12400633174999288";
formProvider.setFormNextRefreshTime(formId, 5, (error, data) => { formProvider.setFormNextRefreshTime(formId, 5, (error, data) => {
if (error.code) { if (error.code) {
console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error)); console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error));
...@@ -63,7 +65,9 @@ setFormNextRefreshTime(formId: string, minute: number): Promise&lt;void&gt; ...@@ -63,7 +65,9 @@ setFormNextRefreshTime(formId: string, minute: number): Promise&lt;void&gt;
**示例:** **示例:**
```ts ```ts
var formId = "12400633174999288"; import formProvider from '@ohos.app.form.formProvider';
let formId = "12400633174999288";
formProvider.setFormNextRefreshTime(formId, 5).then(() => { formProvider.setFormNextRefreshTime(formId, 5).then(() => {
console.log('formProvider setFormNextRefreshTime success'); console.log('formProvider setFormNextRefreshTime success');
}).catch((error) => { }).catch((error) => {
...@@ -84,14 +88,16 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData,call ...@@ -84,14 +88,16 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData,call
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------------------------------------------------------------------- | ---- | ---------------- | | ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
| formId | string | 是 | 请求更新的卡片标识。 | | formId | string | 是 | 请求更新的卡片标识。 |
| formBindingData.FormBindingData | [FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是 | 用于更新的数据。 | | formBindingData | [formBindingData.FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是 | 用于更新的数据。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例:** **示例:**
```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";
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.code) { if (error.code) {
...@@ -113,7 +119,7 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr ...@@ -113,7 +119,7 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------------------------------------------------------------------- | ---- | ---------------- | | ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
| formId | string | 是 | 请求更新的卡片标识。 | | formId | string | 是 | 请求更新的卡片标识。 |
| formBindingData.FormBindingData | [FormBindingData](js-apis-application-formBindingData.md#formbindingdat) | 是 | 用于更新的数据。 | | formBindingData | [formBindingData.FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是 | 用于更新的数据。 |
**返回值:** **返回值:**
...@@ -125,7 +131,9 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr ...@@ -125,7 +131,9 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr
```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";
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
formProvider.updateForm(formId, obj).then(() => { formProvider.updateForm(formId, obj).then(() => {
console.log('formProvider updateForm success'); console.log('formProvider updateForm success');
...@@ -146,11 +154,13 @@ getFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): voi ...@@ -146,11 +154,13 @@ getFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): voi
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](./js-apis-application-formInfo.md#forminfo-1)&gt;&gt; | 是 | 回调函数。返回查询到的卡片信息。 | | callback | AsyncCallback&lt;Array&lt;[formInfo.FormInfo](./js-apis-application-formInfo.md#forminfo-1)&gt;&gt; | 是 | 回调函数。返回查询到的卡片信息。 |
**示例:** **示例:**
```ts ```ts
import formProvider from '@ohos.app.form.formProvider';
formProvider.getFormsInfo((error, data) => { formProvider.getFormsInfo((error, data) => {
if (error.code) { if (error.code) {
console.log('formProvider getFormsInfo, error:' + JSON.stringify(error)); console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
...@@ -172,12 +182,14 @@ getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback&lt;Array&l ...@@ -172,12 +182,14 @@ getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback&lt;Array&l
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| filter | [formInfo.FormInfoFilter](./js-apis-application-formInfo.md#forminfofilter) | 是 | 卡片信息过滤器。 | | filter | [formInfo.FormInfoFilter](./js-apis-application-formInfo.md#forminfofilter) | 是 | 卡片信息过滤器。 |
| callback | AsyncCallback&lt;Array&lt;[FormInfo](./js-apis-application-formInfo.md#forminfo-1)&gt;&gt; | 是 | 回调函数。返回查询到符合条件的卡片信息。 | | callback | AsyncCallback&lt;Array&lt;[formInfo.FormInfo](./js-apis-application-formInfo.md#forminfo-1)&gt;&gt; | 是 | 回调函数。返回查询到符合条件的卡片信息。 |
**示例:** **示例:**
```ts ```ts
import formInfo from '@ohos.application.formInfo'; import formInfo from '@ohos.application.formInfo';
import formProvider from '@ohos.app.form.formProvider';
const filter : formInfo.FormInfoFilter = { const filter : formInfo.FormInfoFilter = {
// get info of forms belong to module entry. // get info of forms belong to module entry.
moduleName : "entry" moduleName : "entry"
...@@ -209,12 +221,14 @@ getFormsInfo(filter?: formInfo.FormInfoFilter): Promise&lt;Array&lt;formInfo.For ...@@ -209,12 +221,14 @@ getFormsInfo(filter?: formInfo.FormInfoFilter): Promise&lt;Array&lt;formInfo.For
| 类型 | 说明 | | 类型 | 说明 |
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise&lt;Array&lt;[FormInfo](./js-apis-application-formInfo.md#forminfo-1)&gt;&gt; | Promise对象。返回查询到符合条件的卡片信息。 | | Promise&lt;Array&lt;[formInfo.FormInfo](./js-apis-application-formInfo.md#forminfo-1)&gt;&gt; | Promise对象。返回查询到符合条件的卡片信息。 |
**示例:** **示例:**
```ts ```ts
import formInfo from '@ohos.application.formInfo'; import formInfo from '@ohos.application.formInfo';
import formProvider from '@ohos.app.form.formProvider';
const filter : formInfo.FormInfoFilter = { const filter : formInfo.FormInfoFilter = {
// get info of forms belong to module entry. // get info of forms belong to module entry.
moduleName : "entry" moduleName : "entry"
...@@ -241,14 +255,15 @@ requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData, ...@@ -241,14 +255,15 @@ 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-application-formBindingData.md#formbindingdata) | 是 | 创建卡片的数据。 | | formBindingData | [formBindingData.FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是 | 创建卡片的数据。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。返回卡片标识。 | | callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。返回卡片标识。 |
**示例:** **示例:**
```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,
...@@ -286,7 +301,9 @@ requestPublishForm(want: Want, callback: AsyncCallback&lt;string&gt;): void ...@@ -286,7 +301,9 @@ requestPublishForm(want: Want, callback: AsyncCallback&lt;string&gt;): void
**示例:** **示例:**
```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,
...@@ -318,7 +335,7 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData ...@@ -318,7 +335,7 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | --------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。<br>abilityName: 目标卡片ability<br>parameters:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" | | want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。<br>abilityName: 目标卡片ability<br>parameters:<br>"ohos.extra.param.key.form_dimension"<br>"ohos.extra.param.key.form_name"<br>"ohos.extra.param.key.module_name" |
| formBindingData.FormBindingData | [FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 否 | 创建卡片的数据。 | | formBindingData | [formBindingData.FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是 | 创建卡片的数据。 |
**返回值:** **返回值:**
...@@ -329,7 +346,9 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData ...@@ -329,7 +346,9 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData
**示例:** **示例:**
```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,
...@@ -368,7 +387,7 @@ formProvider.isRequestPublishFormSupported((error, isSupported) => { ...@@ -368,7 +387,7 @@ formProvider.isRequestPublishFormSupported((error, isSupported) => {
console.log('formProvider isRequestPublishFormSupported, error:' + JSON.stringify(error)); console.log('formProvider isRequestPublishFormSupported, error:' + JSON.stringify(error));
} else { } else {
if (isSupported) { if (isSupported) {
var want = { let want = {
abilityName: "FormAbility", abilityName: "FormAbility",
parameters: { parameters: {
"ohos.extra.param.key.form_dimension": 2, "ohos.extra.param.key.form_dimension": 2,
...@@ -409,7 +428,7 @@ isRequestPublishFormSupported(): Promise&lt;boolean&gt; ...@@ -409,7 +428,7 @@ isRequestPublishFormSupported(): Promise&lt;boolean&gt;
```ts ```ts
formProvider.isRequestPublishFormSupported().then((isSupported) => { formProvider.isRequestPublishFormSupported().then((isSupported) => {
if (isSupported) { if (isSupported) {
var want = { let want = {
abilityName: "FormAbility", abilityName: "FormAbility",
parameters: { parameters: {
"ohos.extra.param.key.form_dimension": 2, "ohos.extra.param.key.form_dimension": 2,
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册