diff --git a/api/@ohos.app.form.formHost.d.ts b/api/@ohos.app.form.formHost.d.ts index 12eb8ddc62f26ade4aa735d4ca31223d546c263a..e5467631a026b6df379cbad6057e430f1459995c 100644 --- a/api/@ohos.app.form.formHost.d.ts +++ b/api/@ohos.app.form.formHost.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2022-2023 Huawei Device Co., Ltd. + * Copyright (c) 2025 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at @@ -29,7 +29,8 @@ import formInfo from './@ohos.app.form.formInfo'; * @namespace formHost * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace formHost { /** @@ -49,7 +50,8 @@ declare namespace formHost { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function addForm(want: Want): Promise; @@ -72,7 +74,8 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function deleteForm(formId: string, callback: AsyncCallback): void; @@ -95,7 +98,8 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function deleteForm(formId: string): Promise; @@ -119,7 +123,8 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function releaseForm(formId: string, callback: AsyncCallback): void; @@ -144,7 +149,8 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback): void; @@ -169,7 +175,8 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function releaseForm(formId: string, isReleaseCache?: boolean): Promise; @@ -194,7 +201,8 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function requestForm(formId: string, callback: AsyncCallback): void; @@ -219,7 +227,8 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function requestForm(formId: string): Promise; @@ -245,7 +254,8 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function requestFormWithParams(formId: string, wantParams?: Record): Promise; @@ -266,7 +276,8 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function castToNormalForm(formId: string, callback: AsyncCallback): void; @@ -287,7 +298,8 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function castToNormalForm(formId: string): Promise; @@ -308,7 +320,8 @@ declare namespace formHost { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function notifyVisibleForms(formIds: Array, callback: AsyncCallback): void; @@ -329,7 +342,8 @@ declare namespace formHost { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function notifyVisibleForms(formIds: Array): Promise; @@ -350,7 +364,8 @@ declare namespace formHost { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function notifyInvisibleForms(formIds: Array, callback: AsyncCallback): void; @@ -371,7 +386,8 @@ declare namespace formHost { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function notifyInvisibleForms(formIds: Array): Promise; @@ -393,7 +409,8 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function enableFormsUpdate(formIds: Array, callback: AsyncCallback): void; @@ -415,7 +432,8 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function enableFormsUpdate(formIds: Array): Promise; @@ -438,7 +456,8 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function disableFormsUpdate(formIds: Array, callback: AsyncCallback): void; @@ -461,7 +480,8 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function disableFormsUpdate(formIds: Array): Promise; @@ -475,7 +495,8 @@ declare namespace formHost { * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isSystemReady(callback: AsyncCallback): void; @@ -487,7 +508,8 @@ declare namespace formHost { * @throws { BusinessError } 202 - The application is not a system application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isSystemReady(): Promise; @@ -505,7 +527,8 @@ declare namespace formHost { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAllFormsInfo(callback: AsyncCallback>): void; @@ -521,7 +544,8 @@ declare namespace formHost { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAllFormsInfo(): Promise>; @@ -541,7 +565,8 @@ declare namespace formHost { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getFormsInfo(bundleName: string, callback: AsyncCallback>): void; @@ -562,7 +587,8 @@ declare namespace formHost { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getFormsInfo( bundleName: string, @@ -587,7 +613,8 @@ declare namespace formHost { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getFormsInfo(bundleName: string, moduleName?: string): Promise>; @@ -607,7 +634,8 @@ declare namespace formHost { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getFormsInfo(filter: formInfo.FormInfoFilter): Promise>; @@ -628,7 +656,8 @@ declare namespace formHost { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function deleteInvalidForms(formIds: Array, callback: AsyncCallback): void; @@ -648,7 +677,8 @@ declare namespace formHost { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function deleteInvalidForms(formIds: Array): Promise; @@ -669,7 +699,8 @@ declare namespace formHost { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function acquireFormState(want: Want, callback: AsyncCallback): void; @@ -690,7 +721,8 @@ declare namespace formHost { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function acquireFormState(want: Want): Promise; @@ -705,7 +737,8 @@ declare namespace formHost { * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'formUninstall', callback: Callback): void; @@ -720,92 +753,11 @@ declare namespace formHost { * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function off(type: 'formUninstall', callback?: Callback): void; - /** - * Listens to the event of form's overflow. - *

You can use this method to listen to the event of form's overflow.

- * - * @param { 'formOverflow' } type - Indicates event type. - * @param { Callback } callback - The callback of formOverflow. - * @throws { BusinessError } 202 - The application is not a system application. - * @syscap SystemCapability.Ability.Form - * @systemapi - * @since 20 - */ - function on(type: 'formOverflow', callback: Callback): void; - - /** - * Cancels listening to the event of form's overflow. - *

You can use this method to cancel listening to the event of form's overflow.

- * - * @param { 'formOverflow' } type - Indicates event type. - * @param { Callback } callback - The callback of formOverflow. - * @throws { BusinessError } 202 - The application is not a system application. - * @syscap SystemCapability.Ability.Form - * @systemapi - * @since 20 - */ - function off(type: 'formOverflow', callback?: Callback): void; - - /** - * Listens to the event of change scene animation state. - *

You can use this method to listen to the event of change scene animation state.

- * - * @param { 'changeSceneAnimationState' } type - Indicates event type. - * @param { Callback } callback - The callback of - * change scene animation state. - * @throws { BusinessError } 202 - The application is not a system application. - * @syscap SystemCapability.Ability.Form - * @systemapi - * @since 20 - */ - function on(type: 'changeSceneAnimationState', - callback: Callback): void; - - /** - * Cancels listening to the event of change scene animation state. - *

You can use this method to cancel listening to the event of change scene animation state.

- * - * @param { 'changeSceneAnimationState' } type - Indicates event type. - * @param { Callback } callback - The callback of - * change scene animation state. - * @throws { BusinessError } 202 - The application is not a system application. - * @syscap SystemCapability.Ability.Form - * @systemapi - * @since 20 - */ - function off(type: 'changeSceneAnimationState', - callback?: Callback): void; - - /** - * Listens to the event of get form rect. - *

You can use this method to listen to the event of get form rect.

- * - * @param { 'getFormRect' } type - Indicates event type. - * @param { formInfo.GetFormRectInfoCallback } callback - The callback of get form rect. - * @throws { BusinessError } 202 - The application is not a system application. - * @syscap SystemCapability.Ability.Form - * @systemapi - * @since 20 - */ - function on(type: 'getFormRect', callback: formInfo.GetFormRectInfoCallback): void; - - /** - * Cancels listening to the event of get form rect. - *

You can use this method to cancel listening to the event of get form rect.

- * - * @param { 'getFormRect' } type - Indicates event type. - * @param { formInfo.GetFormRectInfoCallback } [callback] - The callback of get form rect. - * @throws { BusinessError } 202 - The application is not a system application. - * @syscap SystemCapability.Ability.Form - * @systemapi - * @since 20 - */ - function off(type: 'getFormRect', callback?: formInfo.GetFormRectInfoCallback): void; - /** * Notify form is Visible *

You can use this method to notify form visible state.

@@ -824,7 +776,8 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function notifyFormsVisible(formIds: Array, isVisible: boolean, callback: AsyncCallback): void; @@ -846,7 +799,8 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function notifyFormsVisible(formIds: Array, isVisible: boolean): Promise; @@ -868,7 +822,8 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function notifyFormsEnableUpdate( formIds: Array, @@ -894,7 +849,8 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function notifyFormsEnableUpdate(formIds: Array, isEnableUpdate: boolean): Promise; @@ -915,7 +871,8 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function shareForm(formId: string, deviceId: string, callback: AsyncCallback): void; @@ -936,7 +893,8 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function shareForm(formId: string, deviceId: string): Promise; @@ -956,7 +914,8 @@ declare namespace formHost { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function notifyFormsPrivacyProtected( formIds: Array, @@ -980,7 +939,8 @@ declare namespace formHost { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function notifyFormsPrivacyProtected(formIds: Array, isProtected: boolean): Promise; @@ -1020,7 +980,8 @@ declare namespace formHost { * @syscap SystemCapability.Ability.Form * @systemapi * @StageModelOnly - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function acquireFormData(formId: string, callback: AsyncCallback>): void; @@ -1060,7 +1021,8 @@ declare namespace formHost { * @syscap SystemCapability.Ability.Form * @systemapi * @StageModelOnly - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function acquireFormData(formId: string): Promise>; @@ -1083,71 +1045,75 @@ declare namespace formHost { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function setRouterProxy(formIds: Array, proxy: Callback, callback: AsyncCallback): void; - /** - * Notify the form framework to set a router proxy for the specified cards. - *

Once a card sets up a router proxy, the form framework will no longer invoke its onRouter callback, - * and FMS will not trigger the actual jump.

- * - * @permission ohos.permission.REQUIRE_FORM - * @param { Array } formIds - Indicates the IDs of the forms that requires setting up a router proxy. - * @param { Callback } proxy - Indicates the router proxy to be set up. - * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 201 - Permissions denied. - * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. - * @throws { BusinessError } 16500050 - IPC connection error. - * @throws { BusinessError } 16500060 - Service connection error. - * @throws { BusinessError } 16501000 - An internal functional error occurred. - * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. - * @syscap SystemCapability.Ability.Form - * @systemapi - * @since 11 - */ + /** + * Notify the form framework to set a router proxy for the specified cards. + *

Once a card sets up a router proxy, the form framework will no longer invoke its onRouter callback, + * and FMS will not trigger the actual jump.

+ * + * @permission ohos.permission.REQUIRE_FORM + * @param { Array } formIds - Indicates the IDs of the forms that requires setting up a router proxy. + * @param { Callback } proxy - Indicates the router proxy to be set up. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permissions denied. + * @throws { BusinessError } 202 - The application is not a system application. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. + * @throws { BusinessError } 16501000 - An internal functional error occurred. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. + * @syscap SystemCapability.Ability.Form + * @systemapi + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 + */ function setRouterProxy(formIds: Array, proxy: Callback): Promise; - /** - * Notify the form framework to clear the router proxy set for the specified cards. - * - * @permission ohos.permission.REQUIRE_FORM - * @param { Array } formIds - Indicates the IDs of the forms that requires clearing of router proxy. - * @param { AsyncCallback } callback - The callback of clearRouterProxy. - * @throws { BusinessError } 201 - Permissions denied. - * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. - * @throws { BusinessError } 16500050 - IPC connection error. - * @throws { BusinessError } 16500060 - Service connection error. - * @throws { BusinessError } 16501000 - An internal functional error occurred. - * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. - * @syscap SystemCapability.Ability.Form - * @systemapi - * @since 11 - */ + /** + * Notify the form framework to clear the router proxy set for the specified cards. + * + * @permission ohos.permission.REQUIRE_FORM + * @param { Array } formIds - Indicates the IDs of the forms that requires clearing of router proxy. + * @param { AsyncCallback } callback - The callback of clearRouterProxy. + * @throws { BusinessError } 201 - Permissions denied. + * @throws { BusinessError } 202 - The application is not a system application. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. + * @throws { BusinessError } 16501000 - An internal functional error occurred. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. + * @syscap SystemCapability.Ability.Form + * @systemapi + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 + */ function clearRouterProxy(formIds: Array, callback: AsyncCallback): void; - /** - * Notify the form framework to clear the router proxy set for the specified cards. - * - * @permission ohos.permission.REQUIRE_FORM - * @param { Array } formIds - Indicates the IDs of the forms that requires clearing of router proxy. - * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 201 - Permissions denied. - * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. - * @throws { BusinessError } 16500050 - IPC connection error. - * @throws { BusinessError } 16500060 - Service connection error. - * @throws { BusinessError } 16501000 - An internal functional error occurred. - * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. - * @syscap SystemCapability.Ability.Form - * @systemapi - * @since 11 - */ + /** + * Notify the form framework to clear the router proxy set for the specified cards. + * + * @permission ohos.permission.REQUIRE_FORM + * @param { Array } formIds - Indicates the IDs of the forms that requires clearing of router proxy. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permissions denied. + * @throws { BusinessError } 202 - The application is not a system application. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. + * @throws { BusinessError } 16501000 - An internal functional error occurred. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. + * @syscap SystemCapability.Ability.Form + * @systemapi + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 + */ function clearRouterProxy(formIds: Array): Promise; /** @@ -1167,7 +1133,8 @@ declare namespace formHost { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function setPublishFormResult(formId: string, result: formInfo.PublishFormResult): void; @@ -1187,7 +1154,8 @@ declare namespace formHost { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function setFormsRecyclable(formIds: Array): Promise; @@ -1207,7 +1175,8 @@ declare namespace formHost { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function setFormsRecyclable(formIds: Array, callback: AsyncCallback): void; @@ -1227,7 +1196,8 @@ declare namespace formHost { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function recycleForms(formIds: Array): Promise; @@ -1247,7 +1217,8 @@ declare namespace formHost { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function recoverForms(formIds: Array): Promise; @@ -1267,7 +1238,8 @@ declare namespace formHost { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function recoverForms(formIds: Array, callback: AsyncCallback): void; @@ -1289,8 +1261,166 @@ declare namespace formHost { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function updateFormLocation(formId: string, location: formInfo.FormLocation): void; + + /** + * Notify form lock state update. + * + * @permission ohos.permission.REQUIRE_FORM + * @param { string } formId - Indicates the form id. + * @param { boolean } isLocked - Indicates whether locked. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permissions denied. + * @throws { BusinessError } 202 - caller is not system app. + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500060 - Service connection error. + * @throws { BusinessError } 16501000 - An internal functional error occurred. + * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. + * @syscap SystemCapability.Ability.Form + * @systemapi + * @since arkts{ '1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 + */ + function updateFormLockedState(formId: string, isLocked: boolean): Promise; + + /** + * Listens to the event of formOverflow. + *

You can use this method to listen to the event of formOverflow.

+ * + * @param { 'formOverflow' } type - Indicates event type. + * @param { Callback } callback - The callback of formOverflow. + * @throws { BusinessError } 202 - The application is not a system application. + * @syscap SystemCapability.Ability.Form + * @systemapi + * @since 20 + * @arkts 1.1&1.2 + */ + function on(type: 'formOverflow', callback: Callback): void; + + /** + * Cancels listening to the event of formOverflow. + *

You can use this method to cancel listening to the event of formOverflow.

+ * + * @param { 'formOverflow' } type - Indicates event type. + * @param { Callback } [callback] - The callback of formOverflow. + * @throws { BusinessError } 202 - The application is not a system application. + * @syscap SystemCapability.Ability.Form + * @systemapi + * @since 20 + * @arkts 1.1&1.2 + */ + function off(type: 'formOverflow', callback?: Callback): void; + +/** + * Update size of the form. + * + * @permission ohos.permission.REQUIRE_FORM + * @param { string } formId - Indicates the form id. + * @param { formInfo.FormDimension } newDimension - The new dimension of the form. + * @param { formInfo.Rect } newRect - The new size of the form. + * @throws { BusinessError } 201 - Permissions denied. + * @throws { BusinessError } 202 - caller is not system app. + * @throws { BusinessError } 16501000 - An internal functional error occurred. + * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. + * @throws { BusinessError } 16501012 - The dimension parameter is incorrect + * @syscap SystemCapability.Ability.Form + * @systemapi + * @since 20 + * @arkts 1.1&1.2 + */ + function updateFormSize(formId: string, newDimension: formInfo.FormDimension, newRect: formInfo.Rect): void; + + /** + * Listens to the event of change scene animation state. + *

You can use this method to listen to the event of change scene animation state.

+ * + * @param { 'changeSceneAnimationState' } type - Indicates event type. + * @param { Callback } callback - The callback of + * change scene animation state. + * @throws { BusinessError } 202 - The application is not a system application. + * @syscap SystemCapability.Ability.Form + * @systemapi + * @since 20 + * @arkts 1.1&1.2 + */ + function on(type: 'changeSceneAnimationState', + callback: Callback): void; + + /** + * Cancels listening to the event of change scene animation state. + *

You can use this method to cancel listening to the event of change scene animation state.

+ * + * @param { 'changeSceneAnimationState' } type - Indicates event type. + * @param { Callback } [callback] - The callback of + * change scene animation state. + * @throws { BusinessError } 202 - The application is not a system application. + * @syscap SystemCapability.Ability.Form + * @systemapi + * @since 20 + * @arkts 1.1&1.2 + */ + function off(type: 'changeSceneAnimationState', + callback?: Callback): void; + + /** + * Listens to the event of get form rect. + * + * @param { 'getFormRect' } type - Indicates event type. + * @param { formInfo.GetFormRectInfoCallback } callback - The callback of get form rect. + * @throws { BusinessError } 202 - The application is not a system application. + * @syscap SystemCapability.Ability.Form + * @systemapi + * @since 20 + * @arkts 1.1&1.2 + */ + function on(type: 'getFormRect', + callback: formInfo.GetFormRectInfoCallback): void; + + /** + * Cancels listening to the event of get form rect. + * + * @param { 'getFormRect' } type - Indicates event type. + * @param { formInfo.GetFormRectInfoCallback } [callback] - The callback of get form rect + * @throws { BusinessError } 202 - The application is not a system application. + * @syscap SystemCapability.Ability.Form + * @systemapi + * @since 20 + * @arkts 1.1&1.2 + */ + function off(type: 'getFormRect', + callback?: formInfo.GetFormRectInfoCallback): void + + /** + * Listens to the event of get live form status. + * + * @param { 'getLiveFormStatus' } type - Indicates event type. + * @param { formInfo.GetLiveFormStatusCallback } callback - The callback of get live form status. + * @throws { BusinessError } 202 - The application is not a system application. + * @syscap SystemCapability.Ability.Form + * @systemapi + * @since 20 + * @arkts 1.1&1.2 + */ + function on(type: 'getLiveFormStatus', + callback: formInfo.GetLiveFormStatusCallback): void; + + /** + * Cancels Listening to the event of get live form status. + * + * @param { 'getLiveFormStatus' } type - Indicates event type. + * @param { formInfo.GetLiveFormStatusCallback } [callback] - The callback of get live form status. + * @throws { BusinessError } 202 - The application is not a system application. + * @syscap SystemCapability.Ability.Form + * @systemapi + * @since 20 + * @arkts 1.1&1.2 + */ + function off(type: 'getLiveFormStatus', + callback?: formInfo.GetLiveFormStatusCallback): void; } export default formHost; diff --git a/api/@ohos.app.form.formInfo.d.ts b/api/@ohos.app.form.formInfo.d.ts index a1d033a4df471ee276132b6fa398069705cdbce0..90f875bdb5b62c2eaf30bafa15b1730db5bc48f3 100644 --- a/api/@ohos.app.form.formInfo.d.ts +++ b/api/@ohos.app.form.formInfo.d.ts @@ -2063,6 +2063,7 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @atomicservice * @since 20 + * @arkts 1.1&1.2 */ interface OverflowInfo { /** @@ -2072,6 +2073,7 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @atomicservice * @since 20 + * @arkts 1.1&1.2 */ area: Rect; @@ -2082,6 +2084,7 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @atomicservice * @since 20 + * @arkts 1.1&1.2 */ duration: number; @@ -2092,6 +2095,7 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @atomicservice * @since 20 + * @arkts 1.1&1.2 */ useDefaultAnimation?: boolean; } @@ -2173,6 +2177,7 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @atomicservice * @since 20 + * @arkts 1.1&1.2 */ interface Rect { /** @@ -2182,6 +2187,7 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @atomicservice * @since 20 + * @arkts 1.1&1.2 */ left: number; @@ -2192,6 +2198,7 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @atomicservice * @since 20 + * @arkts 1.1&1.2 */ top: number; @@ -2202,6 +2209,7 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @atomicservice * @since 20 + * @arkts 1.1&1.2 */ width: number; @@ -2212,6 +2220,7 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @atomicservice * @since 20 + * @arkts 1.1&1.2 */ height: number; } diff --git a/api/@ohos.app.form.formProvider.d.ts b/api/@ohos.app.form.formProvider.d.ts index 02cf9ea01f3c56d0ee78677ad9452993c014fc1f..c2118dfdc6c5be9955ac4f9f496d0cdca2c38d29 100644 --- a/api/@ohos.app.form.formProvider.d.ts +++ b/api/@ohos.app.form.formProvider.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2022-2023 Huawei Device Co., Ltd. + * Copyright (c) 2025 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at @@ -20,9 +20,7 @@ import { AsyncCallback } from './@ohos.base'; import formBindingData from './@ohos.app.form.formBindingData'; -/*** if arkts 1.1 */ import formInfo from './@ohos.app.form.formInfo'; -/*** endif */ import Want from './@ohos.app.ability.Want'; /** @@ -38,7 +36,7 @@ import Want from './@ohos.app.ability.Want'; * @namespace formProvider * @syscap SystemCapability.Ability.Form * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since arkts{ '1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ declare namespace formProvider { @@ -77,7 +75,7 @@ declare namespace formProvider { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 * @arkts 1.1&1.2 */ function setFormNextRefreshTime(formId: string, minute: int, callback: AsyncCallback): void; @@ -117,7 +115,7 @@ declare namespace formProvider { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 * @arkts 1.1&1.2 */ function setFormNextRefreshTime(formId: string, minute: int): Promise; @@ -157,7 +155,8 @@ declare namespace formProvider { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function updateForm( formId: string, @@ -200,7 +199,8 @@ declare namespace formProvider { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Promise; @@ -231,7 +231,8 @@ declare namespace formProvider { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback>): void; @@ -260,7 +261,8 @@ declare namespace formProvider { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function getFormsInfo(callback: AsyncCallback>): void; @@ -291,7 +293,8 @@ declare namespace formProvider { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function getFormsInfo(filter?: formInfo.FormInfoFilter): Promise>; @@ -309,7 +312,8 @@ declare namespace formProvider { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function requestPublishForm( want: Want, @@ -330,7 +334,8 @@ declare namespace formProvider { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function requestPublishForm(want: Want, callback: AsyncCallback): void; @@ -348,7 +353,8 @@ declare namespace formProvider { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData): Promise; @@ -363,7 +369,8 @@ declare namespace formProvider { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isRequestPublishFormSupported(callback: AsyncCallback): void; @@ -376,7 +383,8 @@ declare namespace formProvider { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isRequestPublishFormSupported(): Promise; @@ -392,6 +400,8 @@ declare namespace formProvider { * @syscap SystemCapability.Ability.Form * @atomicservice * @since 18 + * @deprecated since 20 + * @useinstead getPublishedRunningFormInfoById */ function getPublishedFormInfoById(formId: string): Promise; @@ -406,9 +416,42 @@ declare namespace formProvider { * @syscap SystemCapability.Ability.Form * @atomicservice * @since 18 + * @deprecated since 20 + * @useinstead getPublishedRunningFormInfos */ function getPublishedFormInfos(): Promise>; +  /** +   * Get running form info by form id belonging to the current bundle.  + * +   * @param { string } formId - Indicates the form ID. +   * @returns { Promise } Returns the running formInfo. +   * @throws { BusinessError } 16500050 - IPC connection error. +   * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. +   * @throws { BusinessError } 16501000 - An internal functional error occurred. + * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. +   * @syscap SystemCapability.Ability.Form +   * @atomicservice +   * @since 20 +   * @arkts 1.1&1.2 +   */ + function getPublishedRunningFormInfoById(formId: string): Promise; + + /** +   * Get running form infos of all published forms belonging to current bundle.  + * +   * @returns { Promise> } Returns published running formInfo belongs to the caller +   * @throws { BusinessError } 16500050 - IPC connection error. +   * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. +   * @throws { BusinessError } 16501000 - An internal functional error occurred. +   * @syscap SystemCapability.Ability.Form +   * @atomicservice +   * @since 20 +   * @arkts 1.1&1.2 +   */ + function getPublishedRunningFormInfos(): Promise>; + /** * Open the view of forms belonging to current bundle. * Client to communication with FormManagerService. @@ -419,7 +462,8 @@ declare namespace formProvider { * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 18 + * @since arkts{ '1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ function openFormManager(want: Want): void; @@ -436,8 +480,9 @@ declare namespace formProvider { * @syscap SystemCapability.Ability.Form * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - function openFormManagerCrossBundle(want: Want): void + function openFormManagerCrossBundle(want: Want): void; /** * Open the form edit ability @@ -446,99 +491,112 @@ declare namespace formProvider { * @param { string } formId - Indicates the edit form ID. * @param { boolean } isMainPage - Indicates open the main edit page, default is true * - * @throws { BusinessError } 801 - Capability not supported.function openFormEditAbility can not work correctly due to limited device capabilities. + * @throws { BusinessError } 801 - Capability not supported due to limited device capabilities. * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @throws { BusinessError } 16501007 - Form is not trust. * @syscap SystemCapability.Ability.Form - * @since 18 + * @since arkts{ '1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ function openFormEditAbility(abilityName: string, formId: string, isMainPage?: boolean): void; + /** - * Activate scene animation + * Request overflow animation + * + * @param { string } formId + * @param { formInfo.OverflowInfo } overflowInfo * - * @param { string } formId - Indicates the edit form ID. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 801 - Capability not supported.function activateSceneAnimation - * can not work correctly due to limited device capabilities. + * @throws { BusinessError } 801 - Capability not supported.function requestOverflow can not work correctly + * due to limited device capabilities. * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. - * @throws { BusinessError } 16501011 - The form can not support this operation. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. + * @throws { BusinessError } 16501011 - The form can not support this operation, please check your fom_config's * @syscap SystemCapability.Ability.Form - * @systemapi + * @atomicservice * @since 20 + * @arkts 1.1&1.2 */ - function activateSceneAnimation(formId: string): Promise; + function requestOverflow(formId: string, overflowInfo: formInfo.OverflowInfo): Promise; /** - * Deactivate scene animation + * Cancel overflow animation + * + * @param { string } formId * - * @param { string } formId - Indicates the edit form ID. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 202 - The application is not a system application. - * @throws { BusinessError } 801 - Capability not supported.function deactivateSceneAnimation can - * not work correctly due to limited device capabilities. + * @throws { BusinessError } 801 - Capability not supported.function requestOverflow can not work correctly + * due to limited device capabilities. * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. - * @throws { BusinessError } 16501011 - The form can not support this operation. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. + * @throws { BusinessError } 16501011 - The form can not support this operation, please check your fom_config's + * funInteractionParams/sceneAnimationParams configuration infomation is correct or not. * @syscap SystemCapability.Ability.Form - * @systemapi + * @atomicservice * @since 20 + * @arkts 1.1&1.2 */ - function deactivateSceneAnimation(formId: string): Promise; + function cancelOverflow(formId: string): Promise; /** - * Request form's overflow animation + * Activate scene animation * - * @param { string } formId - Indicates the edit form ID. - * @param { formInfo.OverflowInfo } overflowInfo - Indicates the overflow information. - * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 801 - Capability not supported.function requestOverflow can - * not work correctly due to limited device capabilities. + * @param { string } formId + * + * @returns { Promise } + * @throws { BusinessError } 202 - The application is not a system application. + * @throws { BusinessError } 801 - Capability not supported.function activateSceneAnimation can not work correctly + * due to limited device capabilities. * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. - * @throws { BusinessError } 16501011 - The form can not support this operation. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. + * @throws { BusinessError } 16501011 - The form can not support this operation, please check your fom_config's + * funInteractionParams/sceneAnimationParams configuration infomation is correct or not. * @syscap SystemCapability.Ability.Form - * @atomicservice + * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - function requestOverflow(formId: string, overflowInfo: formInfo.OverflowInfo): Promise; + function activateSceneAnimation(formId: string): Promise; /** - * Cancel form's overflow animation + * Deactivate scene animation * - * @param { string } formId - Indicates the edit form ID. - * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 801 - Capability not supported.function cancelOverflow can - * not work correctly due to limited device capabilities. + * @param { string } formId + * + * @returns { Promise } + * @throws { BusinessError } 202 - The application is not a system application. + * @throws { BusinessError } 801 - Capability not supported.function deactivateSceneAnimation can not work correctly + * due to limited device capabilities. * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. - * @throws { BusinessError } 16501003 - The form can not be operated by the current application. - * @throws { BusinessError } 16501011 - The form can not support this operation. + * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. + * @throws { BusinessError } 16501011 - The form can not support this operation, please check your fom_config's + * funInteractionParams/sceneAnimationParams configuration infomation is correct or not. * @syscap SystemCapability.Ability.Form - * @atomicservice + * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - function cancelOverflow(formId: string): Promise; + function deactivateSceneAnimation(formId: string): Promise; /** * Get form rect belonging to current bundle @@ -557,6 +615,7 @@ declare namespace formProvider { * @syscap SystemCapability.Ability.Form * @atomicservice * @since 20 + * @arkts 1.1&1.2 */ function getFormRect(formId: string): Promise; }