openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2024-11-23 07:10:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

formKit interface 401错误码描述整改

Browse Source 
Signed-off-by: duao oh <duao@huawei.com>
This commit is contained in:
duao oh 2024-05-27 16:27:12 +08:00
parent 8894811407
commit b20e8e90dd
6 changed files with 226 additions and 115 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
api/@ohos.app.form.formAgent.d.ts vendored
View File

@ -38,8 +38,8 @@ declare namespace formAgent {
* @param { Want } want - The want of the form to publish. * @param { Want } want - The want of the form to publish.
* @param { AsyncCallback<string> } callback - The callback is used to return the form id. * @param { AsyncCallback<string> } callback - The callback is used to return the form id.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * @throws { BusinessError } 401 - Parameter error. Possible causes:
* 2. Incorrect parameter types; 3. Parameter verification failed. * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -73,8 +73,8 @@ declare namespace formAgent {
* @param { Want } want - The want of the form to publish. * @param { Want } want - The want of the form to publish.
* @returns { Promise<string> } Returns the form id. * @returns { Promise<string> } Returns the form id.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * @throws { BusinessError } 401 - Parameter error. Possible causes:
* 2. Incorrect parameter types; 3. Parameter verification failed. * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.

6
api/@ohos.app.form.formBindingData.d.ts vendored
View File

@ -41,7 +41,8 @@ declare namespace formBindingData {
* *
* @param { Object | string } [obj] - Indicates the FormBindingData instance data. * @param { Object | string } [obj] - Indicates the FormBindingData instance data.
* @returns { FormBindingData } Returns the FormBindingData. * @returns { FormBindingData } Returns the FormBindingData.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @since 9 * @since 9
*/ */
@ -50,7 +51,8 @@ declare namespace formBindingData {
* *
* @param { Object | string } [obj] - Indicates the FormBindingData instance data. * @param { Object | string } [obj] - Indicates the FormBindingData instance data.
* @returns { FormBindingData } Returns the FormBindingData. * @returns { FormBindingData } Returns the FormBindingData.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @atomicservice * @atomicservice
* @since 11 * @since 11

159
api/@ohos.app.form.formHost.d.ts vendored
View File

@ -41,7 +41,8 @@ declare namespace formHost {
* @returns { Promise<formInfo.RunningFormInfo> } Return the form info. * @returns { Promise<formInfo.RunningFormInfo> } Return the form info.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -62,7 +63,8 @@ declare namespace formHost {
* @param { AsyncCallback<void> } callback - The callback of deleteForm. * @param { AsyncCallback<void> } callback - The callback of deleteForm.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -84,7 +86,8 @@ declare namespace formHost {
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -107,7 +110,8 @@ declare namespace formHost {
* @param { AsyncCallback<void> } callback - The callback of releaseForm. * @param { AsyncCallback<void> } callback - The callback of releaseForm.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -131,7 +135,8 @@ declare namespace formHost {
* @param { AsyncCallback<void> } callback - The callback of releaseForm. * @param { AsyncCallback<void> } callback - The callback of releaseForm.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -155,7 +160,8 @@ declare namespace formHost {
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -179,7 +185,8 @@ declare namespace formHost {
* @param { AsyncCallback<void> } callback - The callback of requestForm. * @param { AsyncCallback<void> } callback - The callback of requestForm.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -203,7 +210,8 @@ declare namespace formHost {
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -228,7 +236,8 @@ declare namespace formHost {
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -248,7 +257,8 @@ declare namespace formHost {
* @param { AsyncCallback<void> } callback - The callback of castToNormalForm. * @param { AsyncCallback<void> } callback - The callback of castToNormalForm.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist.
@ -268,7 +278,8 @@ declare namespace formHost {
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist.
@ -290,7 +301,8 @@ declare namespace formHost {
* @param { AsyncCallback<void> } callback - The callback of notifyVisibleForms. * @param { AsyncCallback<void> } callback - The callback of notifyVisibleForms.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -310,7 +322,8 @@ declare namespace formHost {
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -330,7 +343,8 @@ declare namespace formHost {
* @param { AsyncCallback<void> } callback - The callback of notifyInvisibleForms. * @param { AsyncCallback<void> } callback - The callback of notifyInvisibleForms.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -350,7 +364,8 @@ declare namespace formHost {
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -370,7 +385,8 @@ declare namespace formHost {
* @param { AsyncCallback<void> } callback - The callback of enableFormsUpdate. * @param { AsyncCallback<void> } callback - The callback of enableFormsUpdate.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -391,7 +407,8 @@ declare namespace formHost {
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -412,7 +429,8 @@ declare namespace formHost {
* @param { AsyncCallback<void> } callback - The callback of disableFormsUpdate. * @param { AsyncCallback<void> } callback - The callback of disableFormsUpdate.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -434,7 +452,8 @@ declare namespace formHost {
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -452,7 +471,8 @@ declare namespace formHost {
* *
* @param { AsyncCallback<void> } callback - The callback of isSystemReady. * @param { AsyncCallback<void> } callback - The callback of isSystemReady.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 9 * @since 9
@ -478,7 +498,8 @@ declare namespace formHost {
* @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the FormInfo. * @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the FormInfo.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -512,7 +533,8 @@ declare namespace formHost {
* @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the FormInfo. * @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the FormInfo.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
@ -532,7 +554,8 @@ declare namespace formHost {
* @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the FormInfo. * @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the FormInfo.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
@ -556,7 +579,8 @@ declare namespace formHost {
* @returns { Promise<Array<formInfo.FormInfo>> } Returns the FormInfo. * @returns { Promise<Array<formInfo.FormInfo>> } Returns the FormInfo.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
@ -575,7 +599,8 @@ declare namespace formHost {
* @returns { Promise<Array<formInfo.FormInfo>> } Returns the FormInfo. * @returns { Promise<Array<formInfo.FormInfo>> } Returns the FormInfo.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
@ -596,7 +621,8 @@ declare namespace formHost {
* by the Form Manager Service. * by the Form Manager Service.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -615,7 +641,8 @@ declare namespace formHost {
* @returns { Promise<number> } Returns the number of invalid forms deleted by the Form Manager Service. * @returns { Promise<number> } Returns the number of invalid forms deleted by the Form Manager Service.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -634,7 +661,8 @@ declare namespace formHost {
* @param { AsyncCallback<formInfo.FormStateInfo> } callback - The callback is used to return the form state. * @param { AsyncCallback<formInfo.FormStateInfo> } callback - The callback is used to return the form state.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
@ -654,7 +682,8 @@ declare namespace formHost {
* @returns { Promise<formInfo.FormStateInfo> } Returns the form state. * @returns { Promise<formInfo.FormStateInfo> } Returns the form state.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
@ -672,7 +701,8 @@ declare namespace formHost {
* @param { 'formUninstall' } type - Indicates event type. * @param { 'formUninstall' } type - Indicates event type.
* @param { Callback<string> } callback - The callback of formUninstall. * @param { Callback<string> } callback - The callback of formUninstall.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 9 * @since 9
@ -686,7 +716,8 @@ declare namespace formHost {
* @param { 'formUninstall' } type - Indicates event type. * @param { 'formUninstall' } type - Indicates event type.
* @param { Callback<string> } [callback] - The callback of formUninstall. * @param { Callback<string> } [callback] - The callback of formUninstall.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 9 * @since 9
@ -703,7 +734,8 @@ declare namespace formHost {
* @param { AsyncCallback<void> } callback - The callback of notifyFormsVisible. * @param { AsyncCallback<void> } callback - The callback of notifyFormsVisible.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -724,7 +756,8 @@ declare namespace formHost {
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -745,7 +778,8 @@ declare namespace formHost {
* @param { AsyncCallback<void> } callback - The callback of notifyFormsEnableUpdate. * @param { AsyncCallback<void> } callback - The callback of notifyFormsEnableUpdate.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -770,7 +804,8 @@ declare namespace formHost {
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -790,7 +825,8 @@ declare namespace formHost {
* @param { AsyncCallback<void> } callback - The callback of shareForm. * @param { AsyncCallback<void> } callback - The callback of shareForm.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist.
@ -810,7 +846,8 @@ declare namespace formHost {
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
* @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist.
@ -830,7 +867,8 @@ declare namespace formHost {
* @param { AsyncCallback<void> } callback - The callback of notifyFormsPrivacyProtected. * @param { AsyncCallback<void> } callback - The callback of notifyFormsPrivacyProtected.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -853,7 +891,8 @@ declare namespace formHost {
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -870,7 +909,8 @@ declare namespace formHost {
* @param { string } formId - Indicates the form ID. * @param { string } formId - Indicates the form ID.
* @param { AsyncCallback<{ [key: string]: Object }> } callback - The callback of acquireFormData. * @param { AsyncCallback<{ [key: string]: Object }> } callback - The callback of acquireFormData.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
@ -888,7 +928,8 @@ declare namespace formHost {
* @param { string } formId - Indicates the form ID. * @param { string } formId - Indicates the form ID.
* @param { AsyncCallback<Record<string, Object>> } callback - The callback of acquireFormData. * @param { AsyncCallback<Record<string, Object>> } callback - The callback of acquireFormData.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
@ -908,7 +949,8 @@ declare namespace formHost {
* @param { string } formId - Indicates the form ID. * @param { string } formId - Indicates the form ID.
* @returns { Promise<{ [key: string]: Object }> } The promise returned by the function. * @returns { Promise<{ [key: string]: Object }> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
@ -926,7 +968,8 @@ declare namespace formHost {
* @param { string } formId - Indicates the form ID. * @param { string } formId - Indicates the form ID.
* @returns { Promise<Record<string, Object>> } The promise returned by the function. * @returns { Promise<Record<string, Object>> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
@ -950,7 +993,8 @@ declare namespace formHost {
* @param { AsyncCallback<void> } callback - The callback of setRouterProxy. * @param { AsyncCallback<void> } callback - The callback of setRouterProxy.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -972,7 +1016,8 @@ declare namespace formHost {
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -991,7 +1036,8 @@ declare namespace formHost {
* @param { AsyncCallback<void> } callback - The callback of clearRouterProxy. * @param { AsyncCallback<void> } callback - The callback of clearRouterProxy.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -1010,7 +1056,8 @@ declare namespace formHost {
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -1049,7 +1096,8 @@ declare namespace formHost {
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - caller is not system app. * @throws { BusinessError } 202 - caller is not system app.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -1068,7 +1116,8 @@ declare namespace formHost {
* @param { AsyncCallback<void> } callback - The callback of setFormsRecyclable. * @param { AsyncCallback<void> } callback - The callback of setFormsRecyclable.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - caller is not system app. * @throws { BusinessError } 202 - caller is not system app.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -1087,7 +1136,8 @@ declare namespace formHost {
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -1106,7 +1156,8 @@ declare namespace formHost {
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - caller is not system app. * @throws { BusinessError } 202 - caller is not system app.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -1125,7 +1176,8 @@ declare namespace formHost {
* @param { AsyncCallback<void> } callback - The callback of recoverForms. * @param { AsyncCallback<void> } callback - The callback of recoverForms.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - caller is not system app. * @throws { BusinessError } 202 - caller is not system app.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -1144,7 +1196,8 @@ declare namespace formHost {
* @param { formInfo.FormLocation } location - The location of the form. * @param { formInfo.FormLocation } location - The location of the form.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - caller is not system app. * @throws { BusinessError } 202 - caller is not system app.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.

93
api/@ohos.app.form.formObserver.d.ts vendored
View File

@ -40,7 +40,8 @@ declare namespace formObserver {
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running * @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running
* form info. * form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 10 * @since 10
@ -57,7 +58,8 @@ declare namespace formObserver {
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running * @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running
* form info. * form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 10 * @since 10
@ -74,7 +76,8 @@ declare namespace formObserver {
* @param { Callback<formInfo.RunningFormInfo> } [observerCallback] - The callback is used to return the running * @param { Callback<formInfo.RunningFormInfo> } [observerCallback] - The callback is used to return the running
* form info. * form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 10 * @since 10
@ -90,7 +93,8 @@ declare namespace formObserver {
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running * @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running
* form info. * form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 10 * @since 10
@ -107,7 +111,8 @@ declare namespace formObserver {
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running * @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running
* form info. * form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 10 * @since 10
@ -124,7 +129,8 @@ declare namespace formObserver {
* @param { Callback<formInfo.RunningFormInfo> } [observerCallback] - The callback is used to return the running * @param { Callback<formInfo.RunningFormInfo> } [observerCallback] - The callback is used to return the running
* form info. * form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 10 * @since 10
@ -140,7 +146,8 @@ declare namespace formObserver {
* @param { Callback<Array<formInfo.RunningFormInfo>> } observerCallback - The callback is used to return * @param { Callback<Array<formInfo.RunningFormInfo>> } observerCallback - The callback is used to return
* the running form info. * the running form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 10 * @since 10
@ -157,7 +164,8 @@ declare namespace formObserver {
* @param { Callback<Array<formInfo.RunningFormInfo>> } observerCallback - The callback is used to return * @param { Callback<Array<formInfo.RunningFormInfo>> } observerCallback - The callback is used to return
* the running form info. * the running form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 10 * @since 10
@ -177,7 +185,8 @@ declare namespace formObserver {
* @param { Callback<Array<formInfo.RunningFormInfo>> } observerCallback - The callback is used to return * @param { Callback<Array<formInfo.RunningFormInfo>> } observerCallback - The callback is used to return
* the running form info. * the running form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 10 * @since 10
@ -194,7 +203,8 @@ declare namespace formObserver {
* @param { Callback<Array<formInfo.RunningFormInfo>> } observerCallback - The callback is used to return * @param { Callback<Array<formInfo.RunningFormInfo>> } observerCallback - The callback is used to return
* the running form info. * the running form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 10 * @since 10
@ -215,7 +225,8 @@ declare namespace formObserver {
* @param { Callback<Array<formInfo.RunningFormInfo>> } [observerCallback] - The callback is used to return * @param { Callback<Array<formInfo.RunningFormInfo>> } [observerCallback] - The callback is used to return
* the running form info. * the running form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 10 * @since 10
@ -236,7 +247,8 @@ declare namespace formObserver {
* @param { Callback<Array<formInfo.RunningFormInfo>> } [observerCallback] - The callback is used to return * @param { Callback<Array<formInfo.RunningFormInfo>> } [observerCallback] - The callback is used to return
* the running form info. * the running form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 10 * @since 10
@ -256,7 +268,8 @@ declare namespace formObserver {
* @param { string } [hostBundleName] - Indicates the bundle name of the form host application. * @param { string } [hostBundleName] - Indicates the bundle name of the form host application.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @syscap SystemCapability.Ability.Form * @syscap SystemCapability.Ability.Form
@ -275,7 +288,8 @@ declare namespace formObserver {
* @param { string } [hostBundleName] - Indicates the bundle name of the form host application. * @param { string } [hostBundleName] - Indicates the bundle name of the form host application.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @syscap SystemCapability.Ability.Form * @syscap SystemCapability.Ability.Form
@ -296,7 +310,8 @@ declare namespace formObserver {
* @returns { Promise<Array<formInfo.RunningFormInfo>> } Returns the RunningFormInfo. * @returns { Promise<Array<formInfo.RunningFormInfo>> } Returns the RunningFormInfo.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @syscap SystemCapability.Ability.Form * @syscap SystemCapability.Ability.Form
@ -314,7 +329,8 @@ declare namespace formObserver {
* @returns { Promise<Array<formInfo.RunningFormInfo>> } Returns the RunningFormInfo. * @returns { Promise<Array<formInfo.RunningFormInfo>> } Returns the RunningFormInfo.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @syscap SystemCapability.Ability.Form * @syscap SystemCapability.Ability.Form
@ -334,7 +350,8 @@ declare namespace formObserver {
* @returns { Promise<Array<formInfo.RunningFormInfo>> } The promise returned by the function. * @returns { Promise<Array<formInfo.RunningFormInfo>> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -355,7 +372,8 @@ declare namespace formObserver {
* @param { AsyncCallback<Array<formInfo.RunningFormInfo>> } callback - The callback of getFormInstancesByFilter. * @param { AsyncCallback<Array<formInfo.RunningFormInfo>> } callback - The callback of getFormInstancesByFilter.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -377,7 +395,8 @@ declare namespace formObserver {
* @returns { Promise<formInfo.RunningFormInfo> } The promise returned by the function. * @returns { Promise<formInfo.RunningFormInfo> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -397,7 +416,8 @@ declare namespace formObserver {
* @returns { Promise<formInfo.RunningFormInfo> } The promise returned by the function. * @returns { Promise<formInfo.RunningFormInfo> } The promise returned by the function.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -416,7 +436,8 @@ declare namespace formObserver {
* @param { AsyncCallback<formInfo.RunningFormInfo> } callback - The callback of getFormInstancesById. * @param { AsyncCallback<formInfo.RunningFormInfo> } callback - The callback of getFormInstancesById.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -436,7 +457,8 @@ declare namespace formObserver {
* @param { AsyncCallback<formInfo.RunningFormInfo> } callback - The callback of getFormInstancesById. * @param { AsyncCallback<formInfo.RunningFormInfo> } callback - The callback of getFormInstancesById.
* @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 201 - Permissions denied.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -460,7 +482,8 @@ declare namespace formObserver {
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running * @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running
* form info. * form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 11 * @since 11
@ -477,7 +500,8 @@ declare namespace formObserver {
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running * @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running
* form info. * form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 11 * @since 11
@ -493,7 +517,8 @@ declare namespace formObserver {
* @param { Callback<formInfo.RunningFormInfo> } [observerCallback] - The callback is used to return the running * @param { Callback<formInfo.RunningFormInfo> } [observerCallback] - The callback is used to return the running
* form info. * form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 11 * @since 11
@ -509,7 +534,8 @@ declare namespace formObserver {
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running * @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running
* form info. * form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 11 * @since 11
@ -526,7 +552,8 @@ declare namespace formObserver {
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running * @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running
* form info. * form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 11 * @since 11
@ -542,7 +569,8 @@ declare namespace formObserver {
* @param { Callback<formInfo.RunningFormInfo> } [observerCallback] - The callback is used to return the running * @param { Callback<formInfo.RunningFormInfo> } [observerCallback] - The callback is used to return the running
* form info. * form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 11 * @since 11
@ -558,7 +586,8 @@ declare namespace formObserver {
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running * @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running
* form info. * form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 11 * @since 11
@ -575,7 +604,8 @@ declare namespace formObserver {
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running * @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running
* form info. * form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 11 * @since 11
@ -591,7 +621,8 @@ declare namespace formObserver {
* @param { Callback<formInfo.RunningFormInfo> } [observerCallback] - The callback is used to return the running * @param { Callback<formInfo.RunningFormInfo> } [observerCallback] - The callback is used to return the running
* form info. * form info.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 * @syscap SystemCapability.Ability.Form
* @systemapi * @systemapi
* @since 11 * @since 11

54
api/@ohos.app.form.formProvider.d.ts vendored
View File

@ -45,7 +45,8 @@ declare namespace formProvider {
* @param { string } formId - Indicates the form ID. * @param { string } formId - Indicates the form ID.
* @param { number } minute - Indicates duration minute before next update. * @param { number } minute - Indicates duration minute before next update.
* @param { AsyncCallback<void> } callback - The callback of setFormNextRefreshTime. * @param { AsyncCallback<void> } callback - The callback of setFormNextRefreshTime.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
@ -62,7 +63,8 @@ declare namespace formProvider {
* @param { string } formId - Indicates the form ID. * @param { string } formId - Indicates the form ID.
* @param { number } minute - Indicates duration minute before next update. * @param { number } minute - Indicates duration minute before next update.
* @param { AsyncCallback<void> } callback - The callback of setFormNextRefreshTime. * @param { AsyncCallback<void> } callback - The callback of setFormNextRefreshTime.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
@ -82,7 +84,8 @@ declare namespace formProvider {
* @param { string } formId - Indicates the form ID. * @param { string } formId - Indicates the form ID.
* @param { number } minute - Indicates duration minute before next update. * @param { number } minute - Indicates duration minute before next update.
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
@ -99,7 +102,8 @@ declare namespace formProvider {
* @param { string } formId - Indicates the form ID. * @param { string } formId - Indicates the form ID.
* @param { number } minute - Indicates duration minute before next update. * @param { number } minute - Indicates duration minute before next update.
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
@ -120,7 +124,8 @@ declare namespace formProvider {
* @param { string } formId - Indicates the form ID. * @param { string } formId - Indicates the form ID.
* @param { formBindingData.FormBindingData } formBindingData - Indicates the form data. * @param { formBindingData.FormBindingData } formBindingData - Indicates the form data.
* @param { AsyncCallback<void> } callback - The callback of updateForm. * @param { AsyncCallback<void> } callback - The callback of updateForm.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
@ -137,7 +142,8 @@ declare namespace formProvider {
* @param { string } formId - Indicates the form ID. * @param { string } formId - Indicates the form ID.
* @param { formBindingData.FormBindingData } formBindingData - Indicates the form data. * @param { formBindingData.FormBindingData } formBindingData - Indicates the form data.
* @param { AsyncCallback<void> } callback - The callback of updateForm. * @param { AsyncCallback<void> } callback - The callback of updateForm.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
@ -161,7 +167,8 @@ declare namespace formProvider {
* @param { string } formId - Indicates the form ID. * @param { string } formId - Indicates the form ID.
* @param { formBindingData.FormBindingData } formBindingData - Indicates the form data. * @param { formBindingData.FormBindingData } formBindingData - Indicates the form data.
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
@ -178,7 +185,8 @@ declare namespace formProvider {
* @param { string } formId - Indicates the form ID. * @param { string } formId - Indicates the form ID.
* @param { formBindingData.FormBindingData } formBindingData - Indicates the form data. * @param { formBindingData.FormBindingData } formBindingData - Indicates the form data.
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
@ -197,7 +205,8 @@ declare namespace formProvider {
* *
* @param { formInfo.FormInfoFilter } filter - Indicates the requirements the forms that the formInfos belong to have to meet. * @param { formInfo.FormInfoFilter } filter - Indicates the requirements the forms that the formInfos belong to have to meet.
* @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the formInfo. * @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the formInfo.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -210,7 +219,8 @@ declare namespace formProvider {
* *
* @param { formInfo.FormInfoFilter } filter - Indicates the requirements the forms that the formInfos belong to have to meet. * @param { formInfo.FormInfoFilter } filter - Indicates the requirements the forms that the formInfos belong to have to meet.
* @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the formInfo. * @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the formInfo.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -225,7 +235,8 @@ declare namespace formProvider {
* Client to communication with FormManagerService. * Client to communication with FormManagerService.
* *
* @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the formInfo. * @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the formInfo.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -237,7 +248,8 @@ declare namespace formProvider {
* Client to communication with FormManagerService. * Client to communication with FormManagerService.
* *
* @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the formInfo. * @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the formInfo.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -253,7 +265,8 @@ declare namespace formProvider {
* *
* @param { formInfo.FormInfoFilter } [filter] - Indicates the requirements the forms that the formInfos belong to have to meet. * @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. * @returns { Promise<Array<formInfo.FormInfo>> } Returns the formInfo.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -266,7 +279,8 @@ declare namespace formProvider {
* *
* @param { formInfo.FormInfoFilter } [filter] - Indicates the requirements the forms that the formInfos belong to have to meet. * @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. * @returns { Promise<Array<formInfo.FormInfo>> } Returns the formInfo.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -283,7 +297,8 @@ declare namespace formProvider {
* @param { formBindingData.FormBindingData } formBindingData - Indicates the form data. * @param { formBindingData.FormBindingData } formBindingData - Indicates the form data.
* @param { AsyncCallback<string> } callback - The callback is used to return the form id. * @param { AsyncCallback<string> } callback - The callback is used to return the form id.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -303,7 +318,8 @@ declare namespace formProvider {
* @param { Want } want - The want of the form to publish. * @param { Want } want - The want of the form to publish.
* @param { AsyncCallback<string> } callback - The callback is used to return the form id. * @param { AsyncCallback<string> } callback - The callback is used to return the form id.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -320,7 +336,8 @@ declare namespace formProvider {
* @param { formBindingData.FormBindingData } [formBindingData] - Indicates the form data. * @param { formBindingData.FormBindingData } [formBindingData] - Indicates the form data.
* @returns { Promise<string> } Returns the form id. * @returns { Promise<string> } Returns the form id.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -335,7 +352,8 @@ declare namespace formProvider {
* *
* @param { AsyncCallback<boolean> } callback - The callback is used to return true if the request is supported. * @param { AsyncCallback<boolean> } callback - The callback is used to return true if the request is supported.
* @throws { BusinessError } 202 - If the application is not a system application. * @throws { BusinessError } 202 - If the application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form * @syscap SystemCapability.Ability.Form

21
api/application/FormExtensionContext.d.ts vendored
View File

@ -49,7 +49,8 @@ export default class FormExtensionContext extends ExtensionContext {
* @param { Want } want - includes ability name, parameters and relative info sending to an ability. * @param { Want } want - includes ability name, parameters and relative info sending to an ability.
* @param { AsyncCallback<void> } callback - The callback of startAbility. * @param { AsyncCallback<void> } callback - The callback of startAbility.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16500101 - The application is not a system application. * @throws { BusinessError } 16500101 - The application is not a system application.
@ -65,7 +66,8 @@ export default class FormExtensionContext extends ExtensionContext {
* @param { Want } want - includes ability name, parameters and relative info sending to an ability. * @param { Want } want - includes ability name, parameters and relative info sending to an ability.
* @param { AsyncCallback<void> } callback - The callback of startAbility. * @param { AsyncCallback<void> } callback - The callback of startAbility.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -82,7 +84,8 @@ export default class FormExtensionContext extends ExtensionContext {
* @param { Want } want - includes ability name, parameters and relative info sending to an ability. * @param { Want } want - includes ability name, parameters and relative info sending to an ability.
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16500101 - The application is not a system application. * @throws { BusinessError } 16500101 - The application is not a system application.
@ -98,7 +101,8 @@ export default class FormExtensionContext extends ExtensionContext {
* @param { Want } want - includes ability name, parameters and relative info sending to an ability. * @param { Want } want - includes ability name, parameters and relative info sending to an ability.
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 202 - The application is not a system application.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @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 } 16500050 - An IPC connection error happened.
* @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501000 - An internal functional error occurred.
@ -123,7 +127,8 @@ export default class FormExtensionContext extends ExtensionContext {
* @param { ConnectOptions } options - Indicates the callback of connection. * @param { ConnectOptions } options - Indicates the callback of connection.
* @returns { number } Returns the connection id. * @returns { number } Returns the connection id.
* @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 201 - The application does not have permission to call the interface.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16000001 - The specified ability does not exist. * @throws { BusinessError } 16000001 - The specified ability does not exist.
* @throws { BusinessError } 16000002 - Incorrect ability type. * @throws { BusinessError } 16000002 - Incorrect ability type.
* @throws { BusinessError } 16000004 - Can not start invisible component. * @throws { BusinessError } 16000004 - Can not start invisible component.
@ -146,7 +151,8 @@ export default class FormExtensionContext extends ExtensionContext {
* *
* @param { number } connection - the connection id returned from connectServiceExtensionAbility api. * @param { number } connection - the connection id returned from connectServiceExtensionAbility api.
* @param { AsyncCallback<void> } callback - The callback of disconnectServiceExtensionAbility. * @param { AsyncCallback<void> } callback - The callback of disconnectServiceExtensionAbility.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000011 - The context does not exist.
* @throws { BusinessError } 16000050 - Internal error. * @throws { BusinessError } 16000050 - Internal error.
* @syscap SystemCapability.Ability.Form * @syscap SystemCapability.Ability.Form
@ -161,7 +167,8 @@ export default class FormExtensionContext extends ExtensionContext {
* *
* @param { number } connection - the connection id returned from connectServiceExtensionAbility api. * @param { number } connection - the connection id returned from connectServiceExtensionAbility api.
* @returns { Promise<void> } The promise returned by the function. * @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 16000011 - The context does not exist. * @throws { BusinessError } 16000011 - The context does not exist.
* @throws { BusinessError } 16000050 - Internal error. * @throws { BusinessError } 16000050 - Internal error.
* @syscap SystemCapability.Ability.Form * @syscap SystemCapability.Ability.Form