W3Cschool
恭喜您成為首批注冊(cè)用戶(hù)
獲得88經(jīng)驗(yàn)值獎(jiǎng)勵(lì)
FormProvider模塊提供了卡片提供方相關(guān)接口的能力,開(kāi)發(fā)者在開(kāi)發(fā)卡片時(shí),可通過(guò)該模塊提供接口實(shí)現(xiàn)更新卡片,設(shè)置卡片更新時(shí)間,獲取卡片信息,請(qǐng)求發(fā)布卡片等。
本模塊首批接口從API version 9開(kāi)始支持。后續(xù)版本的新增接口,采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。
setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback<void>): void
設(shè)置指定卡片的下一次更新時(shí)間,使用callback異步回調(diào)。
系統(tǒng)能力: SystemCapability.Ability.Form
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
formId | string | 是 | 卡片標(biāo)識(shí)。 |
minute | number | 是 | 指定多久之后更新,單位分鐘,大于等于5。 |
callback | AsyncCallback<void> | 是 | 回調(diào)函數(shù)。 |
錯(cuò)誤碼:
錯(cuò)誤碼ID | 錯(cuò)誤信息 |
---|---|
401 | If the input parameter is not valid parameter. |
以上錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)卡片錯(cuò)誤碼。 |
示例:
- var formId = '12400633174999288';
- try {
- formProvider.setFormNextRefreshTime(formId, 5, (error, data) => {
- if (error) {
- console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error));
- } else {
- console.log(`formProvider setFormNextRefreshTime success`);
- }
- });
- } catch (error) {
- console.log('error' + JSON.stringify(error))
- }
setFormNextRefreshTime(formId: string, minute: number): Promise<void>
設(shè)置指定卡片的下一次更新時(shí)間,使用Promise異步回調(diào)。
系統(tǒng)能力: SystemCapability.Ability.Form
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
formId | string | 是 | 卡片標(biāo)識(shí)。 |
minute | number | 是 | 指定多久之后更新,單位分鐘,大于等于5。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
Promise<void> | 無(wú)返回結(jié)果的Promise對(duì)象。 |
錯(cuò)誤碼:
錯(cuò)誤碼ID | 錯(cuò)誤信息 |
---|---|
401 | If the input parameter is not valid parameter. |
以上錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)卡片錯(cuò)誤碼。 |
示例:
- var formId = '12400633174999288';
- try {
- formProvider.setFormNextRefreshTime(formId, 5).then(() => {
- console.log('formProvider setFormNextRefreshTime success');
- }).catch((error) => {
- console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error));
- });
- } catch (error) {
- console.log(`catch err->${JSON.stringify(error)}`);
- }
updateForm(formId: string, formBindingData: formBindingData.FormBindingData,callback: AsyncCallback<void>): void
更新指定的卡片,使用callback異步回調(diào)。
系統(tǒng)能力: SystemCapability.Ability.Form
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
formId | string | 是 | 請(qǐng)求更新的卡片標(biāo)識(shí)。 |
formBindingData.FormBindingData | 是 | 用于更新的數(shù)據(jù)。 | |
callback | AsyncCallback<void> | 是 | 回調(diào)函數(shù)。 |
錯(cuò)誤碼:
錯(cuò)誤碼ID | 錯(cuò)誤信息 |
---|---|
401 | If the input parameter is not valid parameter. |
以上錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)卡片錯(cuò)誤碼。 |
示例:
- import formBindingData from '@ohos.application.formBindingData';
- var formId = '12400633174999288';
- try {
- let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'});
- formProvider.updateForm(formId, obj, (error, data) => {
- if (error) {
- console.log('formProvider updateForm, error:' + JSON.stringify(error));
- } else {
- console.log(`formProvider updateForm success`);
- }
- });
- } catch (error) {
- console.log(`catch err->${JSON.stringify(error)}`);
- }
updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Promise<void>
更新指定的卡片,使用Promise異步回調(diào)。
系統(tǒng)能力: SystemCapability.Ability.Form
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
formId | string | 是 | 請(qǐng)求更新的卡片標(biāo)識(shí)。 |
formBindingData.FormBindingData | 是 | 用于更新的數(shù)據(jù)。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
Promise<void> | 無(wú)返回結(jié)果的Promise對(duì)象。 |
錯(cuò)誤碼:
錯(cuò)誤碼ID | 錯(cuò)誤信息 |
---|---|
401 | If the input parameter is not valid parameter. |
以上錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)卡片錯(cuò)誤碼。 |
示例:
- import formBindingData from '@ohos.application.formBindingData';
- var formId = '12400633174999288';
- let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'});
- try {
- formProvider.updateForm(formId, obj).then(() => {
- console.log('formProvider updateForm success');
- }).catch((error) => {
- console.log('formProvider updateForm, error:' + JSON.stringify(error));
- });
- } catch (error) {
- console.log(`catch err->${JSON.stringify(error)}`);
- }
getFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): void
獲取設(shè)備上當(dāng)前應(yīng)用程序的卡片信息,使用callback異步回調(diào)。
系統(tǒng)能力: SystemCapability.Ability.Form
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
callback | AsyncCallback<Array<FormInfo>> | 是 | 回調(diào)函數(shù)。返回查詢(xún)到的卡片信息。 |
錯(cuò)誤碼:
錯(cuò)誤碼ID | 錯(cuò)誤信息 |
---|---|
401 | If the input parameter is not valid parameter. |
以上錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)卡片錯(cuò)誤碼。 |
示例:
- try {
- formProvider.getFormsInfo((error, data) => {
- if (error) {
- console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
- } else {
- console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
- }
- });
- } catch (error) {
- console.log(`catch err->${JSON.stringify(error)}`);
- }
getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback<Array<formInfo.FormInfo>>): void
獲取設(shè)備上當(dāng)前應(yīng)用程序的卡片信息,并篩選符合條件的信息,使用callback異步回調(diào)。
系統(tǒng)能力: SystemCapability.Ability.Form
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
filter | 是 | 卡片信息過(guò)濾器。 | |
callback | AsyncCallback<Array<FormInfo>> | 是 | 回調(diào)函數(shù)。返回查詢(xún)到符合條件的卡片信息。 |
錯(cuò)誤碼:
錯(cuò)誤碼ID | 錯(cuò)誤信息 |
---|---|
401 | If the input parameter is not valid parameter. |
以上錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)卡片錯(cuò)誤碼。 |
示例:
- import formInfo from '@ohos.app.form.formInfo';
- const filter : formInfo.FormInfoFilter = {
- // get info of forms belong to module entry.
- moduleName : 'entry'
- };
- try {
- formProvider.getFormsInfo(filter, (error, data) => {
- if (error) {
- console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
- } else {
- console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
- }
- });
- } catch(error) {
- console.log(`catch err->${JSON.stringify(error)}`);
- }
getFormsInfo(filter?: formInfo.FormInfoFilter): Promise<Array<formInfo.FormInfo>>
獲取設(shè)備上當(dāng)前應(yīng)用程序的卡片信息,使用Promise異步回調(diào)。
系統(tǒng)能力: SystemCapability.Ability.Form
參數(shù):
參數(shù)名 | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
filter | 否 | 卡片信息過(guò)濾器。 |
返回值:
類(lèi)型 | 說(shuō)明 |
---|---|
Promise<Array<FormInfo>> | Promise對(duì)象。返回查詢(xún)到符合條件的卡片信息。 |
錯(cuò)誤碼:
錯(cuò)誤碼ID | 錯(cuò)誤信息 |
---|---|
401 | If the input parameter is not valid parameter. |
以上錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)卡片錯(cuò)誤碼。 |
示例:
- import formInfo from '@ohos.app.form.formInfo';
- const filter : formInfo.FormInfoFilter = {
- // get info of forms belong to module entry.
- moduleName : 'entry'
- };
- try {
- formProvider.getFormsInfo(filter).then((data) => {
- console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
- }).catch((error) => {
- console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
- });
- } catch (error) {
- console.log(`catch err->${JSON.stringify(error)}`);
- }
Copyright©2021 w3cschool編程獅|閩ICP備15016281號(hào)-3|閩公網(wǎng)安備35020302033924號(hào)
違法和不良信息舉報(bào)電話:173-0602-2364|舉報(bào)郵箱:jubao@eeedong.com
掃描二維碼
下載編程獅App
編程獅公眾號(hào)
聯(lián)系方式:
更多建議: