1 Star 0 Fork 4K

Feng Lin/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.app.form.formHost.d.ts 63.39 KB
一键复制 编辑 原始数据 按行查看 历史
songjindian 提交于 2024-06-13 11:10 +08:00 . sdk格式修改
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214
/*
* Copyright (c) 2022-2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit FormKit
*/
import { AsyncCallback } from './@ohos.base';
import { Callback } from './@ohos.base';
import Want from './@ohos.app.ability.Want';
import formInfo from './@ohos.app.form.formInfo';
/**
* Interface of formHost.
*
* @namespace formHost
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
declare namespace formHost {
/**
* Add a form.
* <p>You can use this method to create a theme form.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Want } want - Indicates want of the form.
* @returns { Promise<formInfo.RunningFormInfo> } Return the form info.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @stagemodelonly
* @since 12
*/
function addForm(want: Want): Promise<formInfo.RunningFormInfo>;
/**
* Deletes an obtained form by its ID.
* <p>After this method is called, the form won't be available for use by the application and the Form Manager
* Service no longer keeps the cache information about the form.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the form ID.
* @param { AsyncCallback<void> } callback - The callback of deleteForm.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function deleteForm(formId: string, callback: AsyncCallback<void>): void;
/**
* Deletes an obtained form by its ID.
* <p>After this method is called, the form won't be available for use by the application and the Form Manager
* Service no longer keeps the cache information about the form.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the form ID.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function deleteForm(formId: string): Promise<void>;
/**
* Releases an obtained form by its ID.
* <p>After this method is called, the form won't be available for use by the application, but the Form Manager
* Service still keeps the cache information about the form, so that the application can quickly obtain it based on
* the {@code formId}.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the form ID
* @param { AsyncCallback<void> } callback - The callback of releaseForm.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function releaseForm(formId: string, callback: AsyncCallback<void>): void;
/**
* Releases an obtained form by its ID.
* <p>After this method is called, the form won't be available for use by the application, but the Form Manager
* Service still keeps the cache information about the form, so that the application can quickly obtain it based on
* the {@code formId}.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the form ID
* @param { boolean } isReleaseCache - Indicates whether release cache or not.
* @param { AsyncCallback<void> } callback - The callback of releaseForm.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback<void>): void;
/**
* Releases an obtained form by its ID.
* <p>After this method is called, the form won't be available for use by the application, but the Form Manager
* Service still keeps the cache information about the form, so that the application can quickly obtain it based on
* the {@code formId}.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the form ID
* @param { boolean } [isReleaseCache] - Indicates whether release cache or not.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function releaseForm(formId: string, isReleaseCache?: boolean): Promise<void>;
/**
* Requests for form update.
* <p>This method must be called when the application has detected that a system setting item (such as the language,
* resolution, or screen orientation) being listened for has changed. Upon receiving the update request, the form
* provider automatically updates the form data (if there is any update) through the form framework, with the update
* process being unperceivable by the application.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the ID of the form to update.
* @param { AsyncCallback<void> } callback - The callback of requestForm.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function requestForm(formId: string, callback: AsyncCallback<void>): void;
/**
* Requests for form update.
* <p>This method must be called when the application has detected that a system setting item (such as the language,
* resolution, or screen orientation) being listened for has changed. Upon receiving the update request, the form
* provider automatically updates the form data (if there is any update) through the form framework, with the update
* process being unperceivable by the application.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the ID of the form to update.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function requestForm(formId: string): Promise<void>;
/**
* Requests for form update.
* <p>This method must be called when the application has detected that a system setting item (such as the language,
* resolution, or screen orientation) being listened for has changed. Upon receiving the update request, the form
* provider automatically updates the form data (if there is any update) through the form framework, with the update
* process being unperceivable by the application.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the ID of the form to update.
* @param { Record<string, Object> } [wantParams] - Indicates want params of the form to update.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 12
*/
function requestFormWithParams(formId: string, wantParams?: Record<string, Object>): Promise<void>;
/**
* Converts a specified temporary form that has been obtained by the application into a normal form.
*
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the ID of the temporary form to convert.
* @param { AsyncCallback<void> } callback - The callback of castToNormalForm.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist.
* @throws { BusinessError } 16501002 - The number of forms exceeds the maximum allowed.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function castToNormalForm(formId: string, callback: AsyncCallback<void>): void;
/**
* Converts a specified temporary form that has been obtained by the application into a normal form.
*
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the ID of the temporary form to convert.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist.
* @throws { BusinessError } 16501002 - The number of forms exceeds the maximum allowed.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function castToNormalForm(formId: string): Promise<void>;
/**
* Sends a notification to the form framework to make the specified forms visible.
* <p>After this method is successfully called, onVisibilityChange will be called to notify the form provider of
* the form visibility change event.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms to be made visible.
* @param { AsyncCallback<void> } callback - The callback of notifyVisibleForms.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function notifyVisibleForms(formIds: Array<string>, callback: AsyncCallback<void>): void;
/**
* Sends a notification to the form framework to make the specified forms visible.
* <p>After this method is successfully called, onVisibilityChange will be called to notify the form provider of
* the form visibility change event.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms to be made visible.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function notifyVisibleForms(formIds: Array<string>): Promise<void>;
/**
* Sends a notification to the form framework to make the specified forms invisible.
* <p>After this method is successfully called, onVisibilityChange will be called to notify the form provider of
* the form visibility change event.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms to be made invisible.
* @param { AsyncCallback<void> } callback - The callback of notifyInvisibleForms.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function notifyInvisibleForms(formIds: Array<string>, callback: AsyncCallback<void>): void;
/**
* Sends a notification to the form framework to make the specified forms invisible.
* <p>After this method is successfully called, onVisibilityChange will be called to notify the form provider of
* the form visibility change event.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms to be made invisible.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function notifyInvisibleForms(formIds: Array<string>): Promise<void>;
/**
* Notify the form framework to make the specified forms updatable.
* <p>You can use this method to set form refresh state to true, the form can receive new
* update from service.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms to be made invisible.
* @param { AsyncCallback<void> } callback - The callback of enableFormsUpdate.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function enableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void>): void;
/**
* Notify the form framework to make the specified forms updatable.
* <p>You can use this method to set form refresh state to true, the form can receive new
* update from service.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms to be made invisible.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function enableFormsUpdate(formIds: Array<string>): Promise<void>;
/**
* Notify the form framework to make the specified forms non-updatable.
* <p>You can use this method to set form refresh state to false, the form do not receive
* new update from service.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms to be made invisible.
* @param { AsyncCallback<void> } callback - The callback of disableFormsUpdate.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function disableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void>): void;
/**
* Notify the form framework to make the specified forms non updatable.
* <p>You can use this method to set form refresh state to false, the form do not receive
* new update from service.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms to be made invisible.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function disableFormsUpdate(formIds: Array<string>): Promise<void>;
/**
* Checks whether the system is ready.
* <p>You can use this method to obtain the system is ready.</p>
*
* @param { AsyncCallback<void> } callback - The callback of isSystemReady.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function isSystemReady(callback: AsyncCallback<void>): void;
/**
* Checks whether the system is ready.
* <p>You can use this method to obtain the system is ready.</p>
*
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 202 - The application is not a system application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function isSystemReady(): Promise<void>;
/**
* Obtains the FormInfo objects provided by all applications on the device.
*
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
* @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the FormInfo.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function getAllFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): void;
/**
* Obtains the FormInfo objects provided by all applications on the device.
*
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
* @returns { Promise<Array<formInfo.FormInfo>> } Returns the FormInfo.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function getAllFormsInfo(): Promise<Array<formInfo.FormInfo>>;
/**
* Obtains the FormInfo objects provided by a specified application on the device.
*
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
* @param { string } bundleName - Indicates the bundle name of the application.
* @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the FormInfo.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function getFormsInfo(bundleName: string, callback: AsyncCallback<Array<formInfo.FormInfo>>): void;
/**
* Obtains the FormInfo objects provided by a specified application on the device.
*
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
* @param { string } bundleName - Indicates the bundle name of the application.
* @param { string } moduleName - Indicates the module name of the application.
* @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the FormInfo.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function getFormsInfo(
bundleName: string,
moduleName: string,
callback: AsyncCallback<Array<formInfo.FormInfo>>
): void;
/**
* Obtains the FormInfo objects provided by a specified application on the device.
*
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
* @param { string } bundleName - Indicates the bundle name of the application.
* @param { string } [moduleName] - Indicates the module name of the application.
* @returns { Promise<Array<formInfo.FormInfo>> } Returns the FormInfo.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function getFormsInfo(bundleName: string, moduleName?: string): Promise<Array<formInfo.FormInfo>>;
/**
* Obtains the FormInfo objects provided by all application with filter on the device.
*
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
* @param { formInfo.FormInfoFilter } filter - Indicates the requirements the forms that the formInfos belong to have to meet.
* @returns { Promise<Array<formInfo.FormInfo>> } Returns the FormInfo.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 12
*/
function getFormsInfo(filter: formInfo.FormInfoFilter): Promise<Array<formInfo.FormInfo>>;
/**
* Deletes invalid forms of the application in the Form Manager Service based on the list of.
* <p>You can use this method to delete invalid forms of the application.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the specified form id.
* @param { AsyncCallback<number> } callback - The callback is used to return the number of invalid forms deleted
* by the Form Manager Service.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function deleteInvalidForms(formIds: Array<string>, callback: AsyncCallback<number>): void;
/**
* Deletes invalid forms of the application in the Form Manager Service based on the list of.
* <p>You can use this method to delete invalid forms of the application.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the specified form id.
* @returns { Promise<number> } Returns the number of invalid forms deleted by the Form Manager Service.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function deleteInvalidForms(formIds: Array<string>): Promise<number>;
/**
* Obtains the Form state.
* <p>You can use this method to obtains the form state.</p>
*
* @permission ohos.permission.REQUIRE_FORM and ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
* @param { Want } want - Indicates want of the form.
* @param { AsyncCallback<formInfo.FormStateInfo> } callback - The callback is used to return the form state.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function acquireFormState(want: Want, callback: AsyncCallback<formInfo.FormStateInfo>): void;
/**
* Obtains the Form state.
* <p>You can use this method to obtains the form state.</p>
*
* @permission ohos.permission.REQUIRE_FORM and ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
* @param { Want } want - Indicates want of the form.
* @returns { Promise<formInfo.FormStateInfo> } Returns the form state.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function acquireFormState(want: Want): Promise<formInfo.FormStateInfo>;
/**
* Listens to the event of uninstall form.
* <p>You can use this method to listen to the event of uninstall form.</p>
*
* @param { 'formUninstall' } type - Indicates event type.
* @param { Callback<string> } callback - The callback of formUninstall.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function on(type: 'formUninstall', callback: Callback<string>): void;
/**
* Cancels listening to the event of uninstall form.
* <p>You can use this method to cancel listening to the event of uninstall form.</p>
*
* @param { 'formUninstall' } type - Indicates event type.
* @param { Callback<string> } [callback] - The callback of formUninstall.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function off(type: 'formUninstall', callback?: Callback<string>): void;
/**
* Notify form is Visible
* <p>You can use this method to notify form visible state.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the specified form id.
* @param { boolean } isVisible - Indicates whether visible.
* @param { AsyncCallback<void> } callback - The callback of notifyFormsVisible.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function notifyFormsVisible(formIds: Array<string>, isVisible: boolean, callback: AsyncCallback<void>): void;
/**
* Notify form is Visible
* <p>You can use this method to notify form visible state.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the specified form id.
* @param { boolean } isVisible - Indicates whether visible.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function notifyFormsVisible(formIds: Array<string>, isVisible: boolean): Promise<void>;
/**
* Notify form enable update state.
* <p>You can use this method to notify form enable update state.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the specified form id.
* @param { boolean } isEnableUpdate - Indicates whether enable update.
* @param { AsyncCallback<void> } callback - The callback of notifyFormsEnableUpdate.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function notifyFormsEnableUpdate(
formIds: Array<string>,
isEnableUpdate: boolean,
callback: AsyncCallback<void>
): void;
/**
* Notify form enable update state.
* <p>You can use this method to notify form enable update state.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the specified form id.
* @param { boolean } isEnableUpdate - Indicates whether enable update.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean): Promise<void>;
/**
* Share form by formId and deviceId.
*
* @permission ohos.permission.REQUIRE_FORM and ohos.permission.DISTRIBUTED_DATASYNC
* @param { string } formId - Indicates the form ID.
* @param { string } deviceId - Indicates the remote device ID.
* @param { AsyncCallback<void> } callback - The callback of shareForm.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function shareForm(formId: string, deviceId: string, callback: AsyncCallback<void>): void;
/**
* Share form by formId and deviceId.
*
* @permission ohos.permission.REQUIRE_FORM and ohos.permission.DISTRIBUTED_DATASYNC
* @param { string } formId - Indicates the form ID.
* @param { string } deviceId - Indicates the remote device ID.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function shareForm(formId: string, deviceId: string): Promise<void>;
/**
* Notify form that privacy whether to be protected.
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the specified form id.
* @param { boolean } isProtected - Indicates whether to be protected.
* @param { AsyncCallback<void> } callback - The callback of notifyFormsPrivacyProtected.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function notifyFormsPrivacyProtected(
formIds: Array<string>,
isProtected: boolean,
callback: AsyncCallback<void>
): void;
/**
* Notify form that privacy whether to be protected.
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the specified form id.
* @param { boolean } isProtected - Indicates whether to be protected.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function notifyFormsPrivacyProtected(formIds: Array<string>, isProtected: boolean): Promise<void>;
/**
* Acquire form data by formId.
*
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the form ID.
* @param { AsyncCallback<{ [key: string]: Object }> } callback - The callback of acquireFormData.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* invalid input parameter during form operation
* @syscap SystemCapability.Ability.Form
* @systemapi
* @StageModelOnly
* @since 10
*/
/**
* Acquire form data by formId.
*
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the form ID.
* @param { AsyncCallback<Record<string, Object>> } callback - The callback of acquireFormData.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* invalid input parameter during form operation
* @syscap SystemCapability.Ability.Form
* @systemapi
* @StageModelOnly
* @since 11
*/
function acquireFormData(formId: string, callback: AsyncCallback<Record<string, Object>>): void;
/**
* Acquire form data by formId.
*
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the form ID.
* @returns { Promise<{ [key: string]: Object }> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* invalid input parameter during form operation
* @syscap SystemCapability.Ability.Form
* @systemapi
* @StageModelOnly
* @since 10
*/
/**
* Acquire form data by formId.
*
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the form ID.
* @returns { Promise<Record<string, Object>> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* invalid input parameter during form operation
* @syscap SystemCapability.Ability.Form
* @systemapi
* @StageModelOnly
* @since 11
*/
function acquireFormData(formId: string): Promise<Record<string, Object>>;
/**
* Notify the form framework to set a router proxy for the specified cards.
* <p>Once a card sets up a router proxy, the form framework will no longer invoke its onRouter callback,
* and FMS will not trigger the actual jump.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms that requires setting up a router proxy.
* @param { Callback<Want> } proxy - Indicates the router proxy to be set up.
* @param { AsyncCallback<void> } callback - The callback of setRouterProxy.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 11
*/
function setRouterProxy(formIds: Array<string>, proxy: Callback<Want>, callback: AsyncCallback<void>): void;
/**
* Notify the form framework to set a router proxy for the specified cards.
* <p>Once a card sets up a router proxy, the form framework will no longer invoke its onRouter callback,
* and FMS will not trigger the actual jump.</p>
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms that requires setting up a router proxy.
* @param { Callback<Want> } proxy - Indicates the router proxy to be set up.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 11
*/
function setRouterProxy(formIds: Array<string>, proxy: Callback<Want>): Promise<void>;
/**
* Notify the form framework to clear the router proxy set for the specified cards.
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms that requires clearing of router proxy.
* @param { AsyncCallback<void> } callback - The callback of clearRouterProxy.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 11
*/
function clearRouterProxy(formIds: Array<string>, callback: AsyncCallback<void>): void;
/**
* Notify the form framework to clear the router proxy set for the specified cards.
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms that requires clearing of router proxy.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 11
*/
function clearRouterProxy(formIds: Array<string>): Promise<void>;
/**
* Set result of publish form.
*
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the form id.
* @param { formInfo.PublishFormResult } result - The result of publish form.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @stagemodelonly
* @since 12
*/
function setPublishFormResult(formId: string, result: formInfo.PublishFormResult): void;
/**
* Set permanent dynamic ArkTS forms recyclable, they will be recycled when memory is low.
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the form id list of permanent dynamic ArkTS forms.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - caller is not system app.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @stagemodelonly
* @since 11
*/
function setFormsRecyclable(formIds: Array<string>): Promise<void>;
/**
* Set permanent dynamic ArkTS forms recyclable, they will be recycled when memory is low.
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the form id list of permanent dynamic ArkTS forms.
* @param { AsyncCallback<void> } callback - The callback of setFormsRecyclable.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - caller is not system app.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @stagemodelonly
* @since 11
*/
function setFormsRecyclable(formIds: Array<string>, callback: AsyncCallback<void>): void;
/**
* Recycle permanent dynamic ArkTS forms.
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms to be recycled.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @stagemodelonly
* @since 12
*/
function recycleForms(formIds: Array<string>): Promise<void>;
/**
* Recover recycled permanent dynamic ArkTS forms.
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the form id list of recycled permanent dynamic ArkTS forms.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - caller is not system app.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @stagemodelonly
* @since 11
*/
function recoverForms(formIds: Array<string>): Promise<void>;
/**
* Recover recycled permanent dynamic ArkTS forms.
*
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the form id list of recycled permanent dynamic ArkTS forms.
* @param { AsyncCallback<void> } callback - The callback of recoverForms.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - caller is not system app.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @stagemodelonly
* @since 11
*/
function recoverForms(formIds: Array<string>, callback: AsyncCallback<void>): void;
/**
* Update location of the form.
*
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the form id.
* @param { formInfo.FormLocation } location - The location of the form.
* @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - caller is not system app.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - IPC connection error.
* @throws { BusinessError } 16500060 - Service connection error.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist.
* @throws { BusinessError } 16501003 - The form cannot be operated by the current application.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @stagemodelonly
* @since 12
*/
function updateFormLocation(formId: string, location: formInfo.FormLocation): void;
}
export default formHost;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/lffl8796/interface_sdk-js.git
git@gitee.com:lffl8796/interface_sdk-js.git
lffl8796
interface_sdk-js
interface_sdk-js
master

搜索帮助