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

https://gitee.com/openharmony/interface_sdk-js/issues/I5V12A

Browse Source 
Signed-off-by: yangzk <yangzhongkai@huawei.com>

Change-Id: Ia45851e51eb5527d221971ddf97448180dde8758
This commit is contained in:
yangzk 2022-10-11 11:12:26 +08:00
parent 320b87dc8c
commit 576441c82e
8 changed files with 724 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
api/@ohos.app.form.formBindingData.d.ts vendored Normal file
View File

@ -0,0 +1,45 @@
/*
* Copyright (c) 2022 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.
*/
import { BusinessError } from './basic';
/**
* interface of formBindingData.
* @namespace formBindingData
* @syscap SystemCapability.Ability.Form
* @since 9
*/
declare namespace formBindingData {
/**
* Create an FormBindingData instance.
* @param { Object | string } obj - Indicates the FormBindingData instance data.
* @returns { FormBindingData } Returns the FormBindingData.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @since 9
*/
function createFormBindingData(obj?: Object | string): FormBindingData;
/**
* Defines the createFormBindingData result interface.
* @typedef FormBindingData
* @syscap SystemCapability.Ability.Form
* @since 9
*/
interface FormBindingData {
data: Object
}
}
export default formBindingData;

502
api/@ohos.app.form.formHost.d.ts vendored Normal file
View File

@ -0,0 +1,502 @@
/*
* Copyright (c) 2022 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.
*/
import { AsyncCallback } from "./basic";
import { Callback } from "./basic";
import Want from './@ohos.application.Want';
import formInfo from './@ohos.application.formInfo'
/**
* interface of formHost.
* @namespace formHost
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
declare namespace formHost {
/**
* Deletes an obtained form by its ID.
* <p>After this method is called, the form won't be available for use by the application and the Form Manager
* Service no longer keeps the cache information about the form.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the form ID.
* @param { AsyncCallback<void> } callback - The callback of deleteForm.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function deleteForm(formId: string, callback: AsyncCallback<void>): void;
/**
* Deletes an obtained form by its ID.
* <p>After this method is called, the form won't be available for use by the application and the Form Manager
* Service no longer keeps the cache information about the form.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the form ID.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function deleteForm(formId: string): Promise<void>;
/**
* Releases an obtained form by its ID.
* <p>After this method is called, the form won't be available for use by the application, but the Form Manager
* Service still keeps the cache information about the form, so that the application can quickly obtain it based on
* the {@code formId}.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the form ID
* @param { AsyncCallback<void> } callback - The callback of releaseForm.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function releaseForm(formId: string, callback: AsyncCallback<void>): void;
/**
* Releases an obtained form by its ID.
* <p>After this method is called, the form won't be available for use by the application, but the Form Manager
* Service still keeps the cache information about the form, so that the application can quickly obtain it based on
* the {@code formId}.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the form ID
* @param { boolean } isReleaseCache - Indicates whether release cache or not.
* @param { AsyncCallback<void> } callback - The callback of releaseForm.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback<void>): void;
/**
* Releases an obtained form by its ID.
* <p>After this method is called, the form won't be available for use by the application, but the Form Manager
* Service still keeps the cache information about the form, so that the application can quickly obtain it based on
* the {@code formId}.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the form ID
* @param { boolean } isReleaseCache - Indicates whether release cache or not.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function releaseForm(formId: string, isReleaseCache?: boolean): Promise<void>;
/**
* Requests for form update.
* <p>This method must be called when the application has detected that a system setting item (such as the language,
* resolution, or screen orientation) being listened for has changed. Upon receiving the update request, the form
* provider automatically updates the form data (if there is any update) through the form framework, with the update
* process being unperceivable by the application.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the ID of the form to update.
* @param { AsyncCallback<void> } callback - The callback of requestForm.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function requestForm(formId: string, callback: AsyncCallback<void>): void;
/**
* Requests for form update.
* <p>This method must be called when the application has detected that a system setting item (such as the language,
* resolution, or screen orientation) being listened for has changed. Upon receiving the update request, the form
* provider automatically updates the form data (if there is any update) through the form framework, with the update
* process being unperceivable by the application.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the ID of the form to update.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function requestForm(formId: string): Promise<void>;
/**
* Converts a specified temporary form that has been obtained by the application into a normal form.
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the ID of the temporary form to convert.
* @param { AsyncCallback<void> } callback - The callback of castTempForm.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function castTempForm(formId: string, callback: AsyncCallback<void>): void;
/**
* Converts a specified temporary form that has been obtained by the application into a normal form.
* @permission ohos.permission.REQUIRE_FORM
* @param { string } formId - Indicates the ID of the temporary form to convert.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function castTempForm(formId: string): Promise<void>;
/**
* Sends a notification to the form framework to make the specified forms visible.
* <p>After this method is successfully called, onVisibilityChange will be called to notify the form provider of
* the form visibility change event.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms to be made visible.
* @param { AsyncCallback<void> } callback - The callback of notifyVisibleForms.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function notifyVisibleForms(formIds: Array<string>, callback: AsyncCallback<void>): void;
/**
* Sends a notification to the form framework to make the specified forms visible.
* <p>After this method is successfully called, onVisibilityChange will be called to notify the form provider of
* the form visibility change event.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms to be made visible.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function notifyVisibleForms(formIds: Array<string>): Promise<void>;
/**
* Sends a notification to the form framework to make the specified forms invisible.
* <p>After this method is successfully called, onVisibilityChange will be called to notify the form provider of
* the form visibility change event.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms to be made invisible.
* @param { AsyncCallback<void> } callback - The callback of notifyInvisibleForms.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function notifyInvisibleForms(formIds: Array<string>, callback: AsyncCallback<void>): void;
/**
* Sends a notification to the form framework to make the specified forms invisible.
* <p>After this method is successfully called, onVisibilityChange will be called to notify the form provider of
* the form visibility change event.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms to be made invisible.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function notifyInvisibleForms(formIds: Array<string>): Promise<void>;
/**
* Notify the form framework to make the specified forms updatable.
* <p>You can use this method to set form refresh state to true, the form can receive new
* update from service.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms to be made invisible.
* @param { AsyncCallback<void> } callback - The callback of enableFormsUpdate.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function enableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void>): void;
/**
* Notify the form framework to make the specified forms updatable.
* <p>You can use this method to set form refresh state to true, the form can receive new
* update from service.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms to be made invisible.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function enableFormsUpdate(formIds: Array<string>): Promise<void>;
/**
* Notifys the form framework to make the specified forms non updatable.
* <p>You can use this method to set form refresh state to false, the form do not receive
* new update from service.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms to be made invisible.
* @param { AsyncCallback<void> } callback - The callback of disableFormsUpdate.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function disableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void>): void;
/**
* Notifys the form framework to make the specified forms non updatable.
* <p>You can use this method to set form refresh state to false, the form do not receive
* new update from service.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the IDs of the forms to be made invisible.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function disableFormsUpdate(formIds: Array<string>): Promise<void>;
/**
* Checks whether the system is ready.
* <p>You can use this method to obtain the system is ready.</p>
* @param { AsyncCallback<void> } callback - The callback of isSystemReady.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function isSystemReady(callback: AsyncCallback<void>): void;
/**
* Checks whether the system is ready.
* <p>You can use this method to obtain the system is ready.</p>
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function isSystemReady(): Promise<void>;
/**
* Obtains the FormInfo objects provided by all applications on the device.
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
* @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the FormInfo.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function getAllFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): void;
/**
* Obtains the FormInfo objects provided by all applications on the device.
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
* @returns { Promise<Array<formInfo.FormInfo>> } Returns the FormInfo.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function getAllFormsInfo(): Promise<Array<formInfo.FormInfo>>;
/**
* Obtains the FormInfo objects provided by a specified application on the device.
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
* @param { string } bundleName - Indicates the bundle name of the application.
* @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the FormInfo.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function getFormsInfo(bundleName: string, callback: AsyncCallback<Array<formInfo.FormInfo>>): void;
/**
* Obtains the FormInfo objects provided by a specified application on the device.
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
* @param { string } bundleName - Indicates the bundle name of the application.
* @param { string } moduleName - Indicates the module name of the application.
* @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the FormInfo.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback<Array<formInfo.FormInfo>>): void;
/**
* Obtains the FormInfo objects provided by a specified application on the device.
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
* @param { string } bundleName - Indicates the bundle name of the application.
* @param { string } moduleName - Indicates the module name of the application.
* @returns { Promise<Array<formInfo.FormInfo>> } Returns the FormInfo.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function getFormsInfo(bundleName: string, moduleName?: string): Promise<Array<formInfo.FormInfo>>;
/**
* Deletes invalid forms of the application in the Form Manager Service based on the list of.
* <p>You can use this method to delete invalid forms of the application.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the specified form id.
* @param { AsyncCallback<number> } callback - The callback is used to return the number of invalid forms deleted
* by the Form Manager Service.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function deleteInvalidForms(formIds: Array<string>, callback: AsyncCallback<number>): void;
/**
* Deletes invalid forms of the application in the Form Manager Service based on the list of.
* <p>You can use this method to delete invalid forms of the application.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the specified form id.
* @returns { Promise<number> } Returns the number of invalid forms deleted by the Form Manager Service.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function deleteInvalidForms(formIds: Array<string>): Promise<number>;
/**
* Obtains the Form state.
* <p>You can use this method to obtains the form state.</p>
* @permission ohos.permission.REQUIRE_FORM and ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
* @param { Want } want - Indicates want of the form.
* @param { AsyncCallback<formInfo.FormStateInfo> } callback - The callback is used to return the form state.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function acquireFormState(want: Want, callback: AsyncCallback<formInfo.FormStateInfo>): void;
/**
* Obtains the Form state.
* <p>You can use this method to obtains the form state.</p>
* @permission ohos.permission.REQUIRE_FORM and ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
* @param { Want } want - Indicates want of the form.
* @returns { Promise<formInfo.FormStateInfo> } Returns the form state.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function acquireFormState(want: Want): Promise<formInfo.FormStateInfo>;
/**
* Listens to the event of uninstall form.
* <p>You can use this method to listen to the event of uninstall form.</p>
* @param { string } type - Indicates event type.
* @param { Callback<string> } callback - The callback of formUninstall.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function on(type: "formUninstall", callback: Callback<string>): void;
/**
* Cancels listening to the event of uninstall form.
* <p>You can use this method to cancel listening to the event of uninstall form.</p>
* @param { string } type - Indicates event type.
* @param { Callback<string> } callback - The callback of formUninstall.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function off(type: "formUninstall", callback?: Callback<string>): void;
/**
* notify form is Visible
* <p>You can use this method to notify form visible state.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the specified form id.
* @param { boolean } isVisible - Indicates whether visible.
* @param { AsyncCallback<void> } callback - The callback of notifyFormsVisible.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function notifyFormsVisible(formIds: Array<string>, isVisible: boolean, callback: AsyncCallback<void>): void;
/**
* notify form is Visible
* <p>You can use this method to notify form visible state.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the specified form id.
* @param { boolean } isVisible - Indicates whether visible.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function notifyFormsVisible(formIds: Array<string>, isVisible: boolean): Promise<void>;
/**
* notify form enable update state.
* <p>You can use this method to notify form enable update state.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the specified form id.
* @param { boolean } isEnableUpdate - Indicates whether enable update.
* @param { AsyncCallback<void> } callback - The callback of notifyFormsEnableUpdate.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean, callback: AsyncCallback<void>): void;
/**
* notify form enable update state.
* <p>You can use this method to notify form enable update state.</p>
* @permission ohos.permission.REQUIRE_FORM
* @param { Array<string> } formIds - Indicates the specified form id.
* @param { boolean } isEnableUpdate - Indicates whether enable update.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean): Promise<void>;
/**
* Share form by formId and deviceId.
* @permission ohos.permission.REQUIRE_FORM and ohos.permission.DISTRIBUTED_DATASYNC
* @param { string } formId - Indicates the form ID.
* @param { string } deviceId - Indicates the remote device ID.
* @param { AsyncCallback<void> } callback - The callback of shareForm.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function shareForm(formId: string, deviceId: string, callback: AsyncCallback<void>): void;
function shareForm(formId: string, deviceId: string): Promise<void>;
}
export default formHost;

161
api/@ohos.app.form.formProvider.d.ts vendored Normal file
View File

@ -0,0 +1,161 @@
/*
* Copyright (c) 2022 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.
*/
import { AsyncCallback } from "./basic";
import formBindingData from "./@ohos.app.form.formBindingData";
import formInfo from "./@ohos.application.formInfo";
import Want from "./@ohos.application.Want"
/**
* interface of formProvider.
* @namespace formProvider
* @syscap SystemCapability.Ability.Form
* @since 9
*/
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 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @since 9
*/
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 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @since 9
*/
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 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @since 9
*/
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 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @since 9
*/
function updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Promise<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.
* @param { AsyncCallback<Array<formInfo.FormInfo>> } callback - The callback is used to return the formInfo.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @since 9
*/
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 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @since 9
*/
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 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @since 9
*/
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 } 401 - If the input parameter is not valid parameter.
* @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 } 401 - If the input parameter is not valid parameter.
* @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 } 401 - If the input parameter is not valid parameter.
* @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 } 401 - If the input parameter is not valid parameter.
* @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 } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 9
*/
function isRequestPublishFormSupported(): Promise<boolean>;
}
export default formProvider;

2
api/@ohos.application.FormExtension.d.ts vendored
View File

@ -13,7 +13,7 @@
* limitations under the License.
*/
import formBindingData from './@ohos.application.formBindingData';
import formBindingData from './@ohos.app.form.formBindingData';
import formInfo from "./@ohos.application.formInfo";
import FormExtensionContext from "./application/FormExtensionContext";
import Want from './@ohos.application.Want';

2
api/@ohos.application.formBindingData.d.ts vendored
View File

@ -19,6 +19,8 @@
* @name formBindingData
* @since 8
* @syscap SystemCapability.Ability.Form
* @deprecated since 9
* @useinstead @ohos.app.form.formBindingData
*/
declare namespace formBindingData {
/**

2
api/@ohos.application.formHost.d.ts vendored
View File

@ -25,6 +25,8 @@ import formInfo from './@ohos.application.formInfo'
* @since 8
* @syscap SystemCapability.Ability.Form
* @systemapi hide for inner use.
* @deprecated since 9
* @useinstead @ohos.app.form.formHost
*/
declare namespace formHost {
/**

2
api/@ohos.application.formProvider.d.ts vendored
View File

@ -24,6 +24,8 @@ import Want from './@ohos.application.Want';
* @name formProvider
* @since 8
* @syscap SystemCapability.Ability.Form
* @deprecated since 9
* @useinstead @ohos.app.form.formProvider
*/
declare namespace formProvider {
/**

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

@ -15,28 +15,26 @@
import { AsyncCallback } from "../basic";
import ExtensionContext from "./ExtensionContext";
import formBindingData from '../@ohos.application.formBindingData';
import formBindingData from '../@ohos.app.form.formBindingData';
import Want from '../@ohos.application.Want';
/**
* The context of form extension. It allows access to
* formExtension-specific resources.
*
* @since 9
* @syscap SystemCapability.Ability.Form
* @permission N/A
* @StageModelOnly
* @stagemodelonly
* @since 9
*/
export default class FormExtensionContext extends ExtensionContext {
/**
* start an ability within the same bundle.
*
* @since 9
* @param { Want } want - includes ability name, parameters and relative info sending to an ability.
* @param { AsyncCallback<void> } callback - The callback of startAbility.
* @returns { Promise<void> } The promise returned by the function.
* @syscap SystemCapability.Ability.Form
* @systemapi hide for inner use
* @param want includes ability name, parameters and relative info sending to an ability.
* @return -
* @StageModelOnly
* @systemapi
* @stagemodelonly
* @since 9
*/
startAbility(want: Want, callback: AsyncCallback<void>): void;
startAbility(want: Want): Promise<void>;