interface_sdk-js/api/@ohos.app.form.formProvider.d.ts
喻志勇 eb1be76d84
update api/@ohos.app.form.formProvider.d.ts.
Signed-off-by: 喻志勇 <yuzhiyong6@huawei.com>
2025-03-04 09:33:21 +00:00

444 lines
22 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*
* 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';
import formInfo from './@ohos.app.form.formInfo';
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 11
*/
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<void> } 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<void> } 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 11
*/
function setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback<void>): 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<void> } 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<void> } 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 11
*/
function setFormNextRefreshTime(formId: string, minute: number): Promise<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.
* @param { AsyncCallback<void> } 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<void> } 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>
): 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<void> } 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<void> } 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<void>;
/**
* 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<Array<formInfo.FormInfo>> } 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<Array<formInfo.FormInfo>> } 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<Array<formInfo.FormInfo>>): void;
/**
* Get infos of all forms belonging to current bundle.
* Client to communication with FormManagerService.
*
* @param { AsyncCallback<Array<formInfo.FormInfo>> } 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<Array<formInfo.FormInfo>> } 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<Array<formInfo.FormInfo>>): 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<Array<formInfo.FormInfo>> } 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<Array<formInfo.FormInfo>> } 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<Array<formInfo.FormInfo>>;
/**
* 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<string> } 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<string>
): void;
/**
* Request to publish a form to the form host.
*
* @param { Want } want - The want of the form to publish.
* @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 } 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<string>): 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<string> } 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<string>;
/**
* Check if the request of publishing a form is supported by the host
*
* @param { AsyncCallback<boolean> } 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<boolean>): void;
/**
* Check if the request of publishing a form is supported by the host
*
* @returns { Promise<boolean> } 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<boolean>;
/**
* Get infos of the published form belonging to current bundle.
* Client to communicate with FormManagerService.
*
* @param { string } formId - Indicates the form ID.
* @returns { Promise<formInfo.FormInfo> } 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 18
*/
function getPublishedFormInfoById(formId: string): Promise<formInfo.FormInfo>;
/**
* Get infos of all published forms belonging to current bundle.
* Client to communicate with FormManagerService.
*
* @returns { Promise<Array<formInfo.FormInfo>> } 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
*/
function getPublishedFormInfos(): Promise<Array<formInfo.FormInfo>>;
/**
* 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 } 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 18
*/
function openFormManager(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;
}
export default formProvider;