/* * Copyright (c) 2022-2023 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @file * @kit FormKit */ import { AsyncCallback } from './@ohos.base'; import 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'; /** * Interface of formProvider. * * @namespace formProvider * @syscap SystemCapability.Ability.Form * @since 9 */ /** * Interface of formProvider. * * @namespace formProvider * @syscap SystemCapability.Ability.Form * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ declare namespace formProvider { /** * Set next update time for a specified form. * * @param { string } formId - Indicates the form ID. * @param { number } minute - Indicates duration minute before next update. * @param { AsyncCallback } callback - The callback of setFormNextRefreshTime. * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. * @throws { BusinessError } 16501002 - The number of forms exceeds upper bound. * @throws { BusinessError } 16501003 - The form can not be operated by the current application. * @syscap SystemCapability.Ability.Form * @since 9 */ /** * Set next update time for a specified form. * * @param { string } formId - Indicates the form ID. * @param { number } minute - Indicates duration minute before next update. * @param { AsyncCallback } callback - The callback of setFormNextRefreshTime. * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. * @throws { BusinessError } 16501002 - The number of forms exceeds the maximum allowed. * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ function setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback): void; /** * Set next update time for a specified form. * * @param { string } formId - Indicates the form ID. * @param { number } minute - Indicates duration minute before next update. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. * @throws { BusinessError } 16501002 - The number of forms exceeds upper bound. * @throws { BusinessError } 16501003 - The form can not be operated by the current application. * @syscap SystemCapability.Ability.Form * @since 9 */ /** * Set next update time for a specified form. * * @param { string } formId - Indicates the form ID. * @param { number } minute - Indicates duration minute before next update. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @throws { BusinessError } 16501001 - The ID of the form to be operated does not exist. * @throws { BusinessError } 16501002 - The number of forms exceeds the maximum allowed. * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ function setFormNextRefreshTime(formId: string, minute: number): Promise; /** * Update a specified form. * Client to communication with FormManagerService. * * @param { string } formId - Indicates the form ID. * @param { formBindingData.FormBindingData } formBindingData - Indicates the form data. * @param { AsyncCallback } callback - The callback of updateForm. * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @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. * @syscap SystemCapability.Ability.Form * @since 9 */ /** * Update a specified form. * Client to communication with FormManagerService. * * @param { string } formId - Indicates the form ID. * @param { formBindingData.FormBindingData } formBindingData - Indicates the form data. * @param { AsyncCallback } callback - The callback of updateForm. * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @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 11 */ function updateForm( formId: string, formBindingData: formBindingData.FormBindingData, callback: AsyncCallback ): void; /** * Update a specified form. * Client to communication with FormManagerService. * * @param { string } formId - Indicates the form ID. * @param { formBindingData.FormBindingData } formBindingData - Indicates the form data. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - An IPC connection error happened. * @throws { BusinessError } 16500060 - A service connection error happened, please try again later. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @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. * @syscap SystemCapability.Ability.Form * @since 9 */ /** * Update a specified form. * Client to communication with FormManagerService. * * @param { string } formId - Indicates the form ID. * @param { formBindingData.FormBindingData } formBindingData - Indicates the form data. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16500060 - Service connection error. * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @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 11 */ function updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Promise; /** * Get info of all forms belonging to current bundle. * Client to communication with FormManagerService. * * @param { formInfo.FormInfoFilter } filter - Indicates the requirements the forms that the formInfos belong to have to meet. * @param { AsyncCallback> } callback - The callback is used to return the formInfo. * @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 } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @since 9 */ /** * Get info of all forms belonging to current bundle. * Client to communication with FormManagerService. * * @param { formInfo.FormInfoFilter } filter - Indicates the requirements the forms that the formInfos belong to have to meet. * @param { AsyncCallback> } callback - The callback is used to return the formInfo. * @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 } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @atomicservice * @since 11 */ function getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback>): void; /** * Get infos of all forms belonging to current bundle. * Client to communication with FormManagerService. * * @param { AsyncCallback> } callback - The callback is used to return the formInfo. * @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 } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @since 9 */ /** * Get infos of all forms belonging to current bundle. * Client to communication with FormManagerService. * * @param { AsyncCallback> } callback - The callback is used to return the formInfo. * @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 } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @atomicservice * @since 11 */ function getFormsInfo(callback: AsyncCallback>): void; /** * Get infos of all forms belonging to current bundle. * Client to communication with FormManagerService. * * @param { formInfo.FormInfoFilter } [filter] - Indicates the requirements the forms that the formInfos belong to have to meet. * @returns { Promise> } Returns the formInfo. * @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 } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @since 9 */ /** * Get infos of all forms belonging to current bundle. * Client to communication with FormManagerService. * * @param { formInfo.FormInfoFilter } [filter] - Indicates the requirements the forms that the formInfos belong to have to meet. * @returns { Promise> } Returns the formInfo. * @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 } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @atomicservice * @since 11 */ function getFormsInfo(filter?: formInfo.FormInfoFilter): Promise>; /** * Request to publish a form to the form host. * * @param { Want } want - The want of the form to publish. * @param { formBindingData.FormBindingData } formBindingData - Indicates the form data. * @param { AsyncCallback } callback - The callback is used to return the form id. * @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 } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 */ function requestPublishForm( want: Want, formBindingData: formBindingData.FormBindingData, callback: AsyncCallback ): void; /** * Request to publish a form to the form host. * * @param { Want } want - The want of the form to publish. * @param { AsyncCallback } callback - The callback is used to return the form id. * @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 } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 */ function requestPublishForm(want: Want, callback: AsyncCallback): void; /** * Request to publish a form to the form host. * * @param { Want } want - The want of the form to publish. * @param { formBindingData.FormBindingData } [formBindingData] - Indicates the form data. * @returns { Promise } Returns the form id. * @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 } 16500100 - Failed to obtain the configuration information. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 */ function requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData): Promise; /** * Check if the request of publishing a form is supported by the host * * @param { AsyncCallback } callback - The callback is used to return true if the request is supported. * @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 */ function isRequestPublishFormSupported(callback: AsyncCallback): void; /** * Check if the request of publishing a form is supported by the host * * @returns { Promise } Returns true if the request is supported. * @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 16500050 - IPC connection error. * @throws { BusinessError } 16501000 - An internal functional error occurred. * @syscap SystemCapability.Ability.Form * @systemapi * @since 9 */ function isRequestPublishFormSupported(): Promise; /** * Get infos of the published form belonging to current bundle. * Client to communicate with FormManagerService. * * @param { string } formId - Indicates the form ID. * @returns { Promise } Returns the formInfo. * @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 18 * @deprecated since 20 * @useinstead getPublishedRunningFormInfoById */ function getPublishedFormInfoById(formId: string): Promise; /** * Get infos of all published forms belonging to current bundle. * Client to communicate with FormManagerService. * * @returns { Promise> } Returns published 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 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 */ 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 */ function getPublishedRunningFormInfos(): Promise> /** * Open the view of forms belonging to current bundle. * Client to communication with FormManagerService. * * @param { Want } want - The want of the form to open. * @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 18 */ function openFormManager(want: Want): void; /** * Open the view of forms belonging to the specified bundle. * Client to communication with FormManagerService. * * @permission ohos.permission.PUBLISH_FORM_CROSS_BUNDLE * @param { Want } want - The want of the form to open. * @throws { BusinessError } 201 - Permissions denied. * @throws { BusinessError } 202 - The application is not a system application. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 16500050 - IPC connection error. * @syscap SystemCapability.Ability.Form * @systemapi * @since 20 */ function openFormManagerCrossBundle(want: Want): void /** * Open the form edit ability * * @param { string } abilityName - Indicates the form edit ability name. * @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 } 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 */ function openFormEditAbility(abilityName: string, formId: string, isMainPage?: boolean): void; /** * Activate scene animation * * @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 } 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. * @syscap SystemCapability.Ability.Form * @systemapi * @since 20 */ function activateSceneAnimation(formId: string): Promise; /** * Deactivate scene animation * * @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 } 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. * @syscap SystemCapability.Ability.Form * @systemapi * @since 20 */ function deactivateSceneAnimation(formId: string): Promise; /** * Request form's overflow 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. * @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. * @syscap SystemCapability.Ability.Form * @atomicservice * @since 20 */ function requestOverflow(formId: string, overflowInfo: formInfo.OverflowInfo): Promise; /** * Cancel form's overflow 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. * @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. * @syscap SystemCapability.Ability.Form * @atomicservice * @since 20 */ function cancelOverflow(formId: string): Promise; /** * Get form rect belonging to current bundle * * @param { string } formId * * @returns { Promise } * @throws { BusinessError } 801 - Capability not supported.function getFormRect 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 cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @atomicservice * @since 20 */ function getFormRect(formId: string): Promise; } export default formProvider;