1 Star 0 Fork 4K

Feng Lin/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.app.form.formObserver.d.ts 31.87 KB
一键复制 编辑 原始数据 按行查看 历史
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632
/*
* Copyright (c) 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 { Callback } from './@ohos.base';
import formInfo from './@ohos.app.form.formInfo';
/**
* Interface of formObserver.
*
* @namespace formObserver
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 10
*/
declare namespace formObserver {
/**
* Listens to the event of add form.
* <p>You can use this method to listen to the event of add form.</p>
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'formAdd' } type - Indicates event type.
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running
* form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 10
*/
function on(type: 'formAdd', observerCallback: Callback<formInfo.RunningFormInfo>): void;
/**
* Listens to the event of add form.
* <p>You can use this method to listen to the event of add form for a particular card host.</p>
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'formAdd' } type - Indicates event type.
* @param { string } hostBundleName - Indicates the bundle name of the form host application.
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running
* form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 10
*/
function on(type: 'formAdd', hostBundleName: string, observerCallback: Callback<formInfo.RunningFormInfo>): void;
/**
* Cancels listening to the event of add form.
* <p>You can use this method to cancel listening to the event of add form.</p>
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'formAdd' } type - Indicates event type.
* @param { string } [hostBundleName] - Indicates the bundle name of the form host application.
* @param { Callback<formInfo.RunningFormInfo> } [observerCallback] - The callback is used to return the running
* form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 10
*/
function off(type: 'formAdd', hostBundleName?: string, observerCallback?: Callback<formInfo.RunningFormInfo>): void;
/**
* Listens to the event of remove form.
* <p>You can use this method to listen to the event of remove form.</p>
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'formRemove' } type - Indicates event type.
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running
* form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 10
*/
function on(type: 'formRemove', observerCallback: Callback<formInfo.RunningFormInfo>): void;
/**
* Listens to the event of remove form.
* <p>You can use this method to listen to the event of remove form for a particular card host.</p>
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'formRemove' } type - Indicates event type.
* @param { string } hostBundleName - Indicates the bundle name of the form host application.
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running
* form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 10
*/
function on(type: 'formRemove', hostBundleName: string, observerCallback: Callback<formInfo.RunningFormInfo>): void;
/**
* Cancels listening to the event of remove form.
* <p>You can use this method to cancel listening to the event of remove form.</p>
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'formRemove' } type - Indicates event type.
* @param { string } [hostBundleName] - Indicates the bundle name of the form host application.
* @param { Callback<formInfo.RunningFormInfo> } [observerCallback] - The callback is used to return the running
* form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 10
*/
function off(type: 'formRemove', hostBundleName?: string, observerCallback?: Callback<formInfo.RunningFormInfo>): void;
/**
* Listens to the event of notifyVisible type change.
* <p>You can use this method to listen to the event of notifyVisible type change.</p>
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'notifyVisible' } type - Indicates event type.
* @param { Callback<Array<formInfo.RunningFormInfo>> } observerCallback - The callback is used to return
* the running form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 10
*/
function on(type: 'notifyVisible', observerCallback: Callback<Array<formInfo.RunningFormInfo>>): void;
/**
* Listens to the event of notifyVisible type change.
* <p>You can use this method to listen to the event of notifyVisible type change for a particular card host.</p>
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'notifyVisible' } type - Indicates event type.
* @param { string } hostBundleName - Indicates the bundle name of the form host application.
* @param { Callback<Array<formInfo.RunningFormInfo>> } observerCallback - The callback is used to return
* the running form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 10
*/
function on(
type: 'notifyVisible',
hostBundleName: string,
observerCallback: Callback<Array<formInfo.RunningFormInfo>>
): void;
/**
* Listens to the event of notifyInvisible type change.
* <p>You can use this method to listen to the event of notifyInvisible type change.</p>
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'notifyInvisible' } type - Indicates event type.
* @param { Callback<Array<formInfo.RunningFormInfo>> } observerCallback - The callback is used to return
* the running form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 10
*/
function on(type: 'notifyInvisible', observerCallback: Callback<Array<formInfo.RunningFormInfo>>): void;
/**
* Listens to the event of notifyInvisible type change.
* <p>You can use this method to listen to the event of notifyInvisible type change for a particular card host.</p>
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'notifyInvisible' } type - Indicates event type.
* @param { string } hostBundleName - Indicates the bundle name of the form host application.
* @param { Callback<Array<formInfo.RunningFormInfo>> } observerCallback - The callback is used to return
* the running form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 10
*/
function on(
type: 'notifyInvisible',
hostBundleName: string,
observerCallback: Callback<Array<formInfo.RunningFormInfo>>,
): void;
/**
* Cancels listening to the event of notifyVisible type change.
* <p>You can use this method to cancel listening to the event of notifyVisible type change.</p>
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'notifyVisible' } type - Indicates event type.
* @param { string } [hostBundleName] - Indicates the bundle name of the form host application.
* @param { Callback<Array<formInfo.RunningFormInfo>> } [observerCallback] - The callback is used to return
* the running form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 10
*/
function off(
type: 'notifyVisible',
hostBundleName?: string,
observerCallback?: Callback<Array<formInfo.RunningFormInfo>>
): void;
/**
* Cancels listening to the event of notifyInvisible type change.
* <p>You can use this method to cancel listening to the event of notifyInvisible type change.</p>
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'notifyInvisible' } type - Indicates event type.
* @param { string } hostBundleName - Indicates the bundle name of the form host application.
* @param { Callback<Array<formInfo.RunningFormInfo>> } [observerCallback] - The callback is used to return
* the running form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 10
*/
function off(
type: 'notifyInvisible',
hostBundleName?: string,
observerCallback?: Callback<Array<formInfo.RunningFormInfo>>
): void;
/**
* Obtains the RunningFormInfo objects provided by a specific card host application on the device.
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { AsyncCallback<Array<formInfo.RunningFormInfo>> } callback - The callback is used to return the
* RunningFormInfo.
* @param { string } [hostBundleName] - Indicates the bundle name of the form host application.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 10
*/
function getRunningFormInfos(callback: AsyncCallback<Array<formInfo.RunningFormInfo>>, hostBundleName?: string): void;
/**
* Obtains the RunningFormInfo objects provided by a specific card host application on the device.
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { AsyncCallback<Array<formInfo.RunningFormInfo>> } callback - The callback is used to return the
* RunningFormInfo.
* @param { boolean } isUnusedIncluded - Indicates whether to include unused form.
* @param { string } [hostBundleName] - Indicates the bundle name of the form host application.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 11
*/
function getRunningFormInfos(
callback: AsyncCallback<Array<formInfo.RunningFormInfo>>,
isUnusedIncluded: boolean,
hostBundleName?: string
): void;
/**
* Obtains the RunningFormInfo objects provided by a specific card host application on the device.
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { string } [hostBundleName] - Indicates the bundle name of the form host application.
* @returns { Promise<Array<formInfo.RunningFormInfo>> } Returns the RunningFormInfo.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 10
*/
function getRunningFormInfos(hostBundleName?: string): Promise<Array<formInfo.RunningFormInfo>>;
/**
* Obtains the RunningFormInfo objects provided by a specific card host application on the device.
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { boolean } isUnusedIncluded - Indicates whether to include unused form.
* @param { string } [hostBundleName] - Indicates the bundle name of the form host application.
* @returns { Promise<Array<formInfo.RunningFormInfo>> } Returns the RunningFormInfo.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 11
*/
function getRunningFormInfos(
isUnusedIncluded: boolean,
hostBundleName?: string
): Promise<Array<formInfo.RunningFormInfo>>;
/**
* Obtains the RunningFormInfo objects by FormProviderFilter.
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { formInfo.FormProviderFilter } formProviderFilter - Indicates the form provider app info.
* @returns { Promise<Array<formInfo.RunningFormInfo>> } 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 } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @stagemodelonly
* @since 10
*/
function getRunningFormInfosByFilter(
formProviderFilter: formInfo.FormProviderFilter
): Promise<Array<formInfo.RunningFormInfo>>;
/**
* Obtains the RunningFormInfo objects by FormProviderFilter.
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { formInfo.FormProviderFilter } formProviderFilter - Indicates the form provider app info.
* @param { AsyncCallback<Array<formInfo.RunningFormInfo>> } callback - The callback of getFormInstancesByFilter.
* @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 } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @stagemodelonly
* @since 10
*/
function getRunningFormInfosByFilter(
formProviderFilter: formInfo.FormProviderFilter,
callback: AsyncCallback<Array<formInfo.RunningFormInfo>>
): void;
/**
* Obtains the RunningFormInfo object by formId.
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { string } formId - Indicates the form provider formId.
* @returns { Promise<formInfo.RunningFormInfo> } 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 } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @stagemodelonly
* @since 10
*/
function getRunningFormInfoById(formId: string): Promise<formInfo.RunningFormInfo>;
/**
* Obtains the RunningFormInfo object by formId.
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { string } formId - Indicates the form provider formId.
* @param { boolean } isUnusedIncluded - Indicates whether to include unused form.
* @returns { Promise<formInfo.RunningFormInfo> } 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 } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @stagemodelonly
* @since 11
*/
function getRunningFormInfoById(formId: string, isUnusedIncluded: boolean): Promise<formInfo.RunningFormInfo>;
/**
* Obtains the RunningFormInfo object by formId.
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { string } formId - Indicates the form provider formId.
* @param { AsyncCallback<formInfo.RunningFormInfo> } callback - The callback of getFormInstancesById.
* @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 } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @stagemodelonly
* @since 10
*/
function getRunningFormInfoById(formId: string, callback: AsyncCallback<formInfo.RunningFormInfo>): void;
/**
* Obtains the RunningFormInfo object by formId.
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { string } formId - Indicates the form provider formId.
* @param { boolean } isUnusedIncluded - Indicates whether to include unused form.
* @param { AsyncCallback<formInfo.RunningFormInfo> } callback - The callback of getFormInstancesById.
* @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 } 16500100 - Failed to obtain the configuration information.
* @throws { BusinessError } 16501000 - An internal functional error occurred.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @stagemodelonly
* @since 11
*/
function getRunningFormInfoById(
formId: string,
isUnusedIncluded: boolean,
callback: AsyncCallback<formInfo.RunningFormInfo>
): void;
/**
* Router event listening in registered form.
* <p>This interface requires permission to receive callback.</p>
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'router' } type - Indicates event type.
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running
* form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 11
*/
function on(type: 'router', observerCallback: Callback<formInfo.RunningFormInfo>): void;
/**
* Router event listening in registered form.
* <p>This interface requires permission to receive callback.</p>
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'router' } type - Indicates event type.
* @param { string } hostBundleName - Indicates the bundle name of the form host application.
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running
* form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 11
*/
function on(type: 'router', hostBundleName: string, observerCallback: Callback<formInfo.RunningFormInfo>): void;
/**
* Unregister form router event Listening.
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'router' } type - Indicates event type.
* @param { string } [hostBundleName] - Indicates the bundle name of the form host application.
* @param { Callback<formInfo.RunningFormInfo> } [observerCallback] - The callback is used to return the running
* form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 11
*/
function off(type: 'router', hostBundleName?: string, observerCallback?: Callback<formInfo.RunningFormInfo>): void;
/**
* Message event listening in registered form.
* <p>This interface requires permission to receive callback.</p>
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'message' } type - Indicates event type.
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running
* form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 11
*/
function on(type: 'message', observerCallback: Callback<formInfo.RunningFormInfo>): void;
/**
* Message event listening in registered form.
* <p>This interface requires permission to receive callback.</p>
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'message' } type - Indicates event type.
* @param { string } hostBundleName - Indicates the bundle name of the form host application.
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running
* form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 11
*/
function on(type: 'message', hostBundleName: string, observerCallback: Callback<formInfo.RunningFormInfo>): void;
/**
* Unregister form message event Listening.
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'message' } type - Indicates event type.
* @param { string } [hostBundleName] - Indicates the bundle name of the form host application.
* @param { Callback<formInfo.RunningFormInfo> } [observerCallback] - The callback is used to return the running
* form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 11
*/
function off(type: 'message', hostBundleName?: string, observerCallback?: Callback<formInfo.RunningFormInfo>): void;
/**
* Call event listening in registered form.
* <p>This interface requires permission to receive callback.</p>
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'call' } type - Indicates event type.
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running
* form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 11
*/
function on(type: 'call', observerCallback: Callback<formInfo.RunningFormInfo>): void;
/**
* Call event listening in registered form.
* <p>This interface requires permission to receive callback.</p>
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'call' } type - Indicates event type.
* @param { string } hostBundleName - Indicates the bundle name of the form host application.
* @param { Callback<formInfo.RunningFormInfo> } observerCallback - The callback is used to return the running
* form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 11
*/
function on(type: 'call', hostBundleName: string, observerCallback: Callback<formInfo.RunningFormInfo>): void;
/**
* Unregister form call event Listening.
*
* @permission ohos.permission.OBSERVE_FORM_RUNNING
* @param { 'call' } type - Indicates event type.
* @param { string } [hostBundleName] - Indicates the bundle name of the form host application.
* @param { Callback<formInfo.RunningFormInfo> } [observerCallback] - The callback is used to return the running
* form info.
* @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.
* @syscap SystemCapability.Ability.Form
* @systemapi
* @since 11
*/
function off(type: 'call', hostBundleName?: string, observerCallback?: Callback<formInfo.RunningFormInfo>): void;
}
export default formObserver;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/lffl8796/interface_sdk-js.git
git@gitee.com:lffl8796/interface_sdk-js.git
lffl8796
interface_sdk-js
interface_sdk-js
master

搜索帮助