Ai
46 Star 180 Fork 4.8K

OpenHarmony/interface_sdk-js
关闭

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
AbilityDelegator.d.ts 65.12 KB
一键复制 编辑 原始数据 按行查看 历史
zhangzezhong 提交于 2025-07-15 12:45 +08:00 . merge SDK 0603ToMaster
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350
/*
* Copyright (c) 2021-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 AbilityKit
*/
import { AsyncCallback } from '../@ohos.base';
import { AbilityMonitor } from './AbilityMonitor';
import Context from './Context';
import Want from '../@ohos.app.ability.Want';
import { ShellCmdResult } from './shellCmdResult';
import UIAbility from '../@ohos.app.ability.UIAbility';
import AbilityStage from '../@ohos.app.ability.AbilityStage';
import { AbilityStageMonitor } from './AbilityStageMonitor';
/**
* A global test utility interface used for adding AbilityMonitor objects and control lifecycle states of abilities.
*
* @interface AbilityDelegator
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* A global test utility interface used for adding AbilityMonitor objects and control lifecycle states of abilities.
*
* @interface AbilityDelegator
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* A global test utility interface used for adding AbilityMonitor objects and control lifecycle states of abilities.
*
* @interface AbilityDelegator
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
export interface AbilityDelegator {
/**
* Add an AbilityMonitor object for monitoring the lifecycle state changes of the specified ability in this process.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object
* @param { AsyncCallback<void> } callback - The callback of addAbilityMonitor.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - AddAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Add an AbilityMonitor object for monitoring the lifecycle state changes of the specified ability in this process.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object
* @param { AsyncCallback<void> } callback - The callback of addAbilityMonitor.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - AddAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Add an AbilityMonitor object for monitoring the lifecycle state changes of the specified ability in this process.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object
* @param { AsyncCallback<void> } callback - The callback of addAbilityMonitor.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - Calling AddAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback<void>): void;
/**
* Add an AbilityMonitor object for monitoring the lifecycle state changes of the specified ability in this process.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object
* @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.
* @throws { BusinessError } 16000100 - AddAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Add an AbilityMonitor object for monitoring the lifecycle state changes of the specified ability in this process.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object
* @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.
* @throws { BusinessError } 16000100 - AddAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Add an AbilityMonitor object for monitoring the lifecycle state changes of the specified ability in this process.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object
* @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.
* @throws { BusinessError } 16000100 - Calling AddAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
addAbilityMonitor(monitor: AbilityMonitor): Promise<void>;
/**
* Add an AbilityMonitor object for monitoring the lifecycle state changes of the specified ability in this process.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - AddAbilityMonitorSync failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Add an AbilityMonitor object for monitoring the lifecycle state changes of the specified ability in this process.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - Calling AddAbilityMonitorSync failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
addAbilityMonitorSync(monitor: AbilityMonitor): void;
/**
* Add an AbilityStageMonitor object for monitoring the lifecycle state changes of the specified abilityStage in this process.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @param { AsyncCallback<void> } callback - The callback of addAbilityStageMonitor.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - AddAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Add an AbilityStageMonitor object for monitoring the lifecycle state changes of the specified abilityStage in this process.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @param { AsyncCallback<void> } callback - The callback of addAbilityStageMonitor.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - AddAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Add an AbilityStageMonitor object for monitoring the lifecycle state changes of the specified abilityStage in this process.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @param { AsyncCallback<void> } callback - The callback of addAbilityStageMonitor.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - Calling AddAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
addAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback<void>): void;
/**
* Add an AbilityStageMonitor object for monitoring the lifecycle state changes of the specified abilityStage in this process.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @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.
* @throws { BusinessError } 16000100 - AddAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Add an AbilityStageMonitor object for monitoring the lifecycle state changes of the specified abilityStage in this process.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @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.
* @throws { BusinessError } 16000100 - AddAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Add an AbilityStageMonitor object for monitoring the lifecycle state changes of the specified abilityStage in this process.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @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.
* @throws { BusinessError } 16000100 - Calling AddAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
addAbilityStageMonitor(monitor: AbilityStageMonitor): Promise<void>;
/**
* Add an AbilityStageMonitor object for monitoring the lifecycle state changes of the specified abilityStage in this process.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - AddAbilityStageMonitorSync failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Add an AbilityStageMonitor object for monitoring the lifecycle state changes of the specified abilityStage in this process.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - Calling AddAbilityStageMonitorSync failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
addAbilityStageMonitorSync(monitor: AbilityStageMonitor): void;
/**
* Remove a specified AbilityMonitor object from the application memory.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object.
* @param { AsyncCallback<void> } callback - The callback of removeAbilityMonitor.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - RemoveAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Remove a specified AbilityMonitor object from the application memory.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object.
* @param { AsyncCallback<void> } callback - The callback of removeAbilityMonitor.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - RemoveAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Remove a specified AbilityMonitor object from the application memory.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object.
* @param { AsyncCallback<void> } callback - The callback of removeAbilityMonitor.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - Calling RemoveAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback<void>): void;
/**
* Remove a specified AbilityMonitor object from the application memory.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object.
* @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.
* @throws { BusinessError } 16000100 - RemoveAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Remove a specified AbilityMonitor object from the application memory.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object.
* @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.
* @throws { BusinessError } 16000100 - RemoveAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Remove a specified AbilityMonitor object from the application memory.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object.
* @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.
* @throws { BusinessError } 16000100 - Calling RemoveAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
removeAbilityMonitor(monitor: AbilityMonitor): Promise<void>;
/**
* Remove a specified AbilityMonitor object from the application memory.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - RemoveAbilityMonitorSync failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Remove a specified AbilityMonitor object from the application memory.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - Calling RemoveAbilityMonitorSync failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
removeAbilityMonitorSync(monitor: AbilityMonitor): void;
/**
* Remove a specified AbilityStageMonitor object from the application memory.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @param { AsyncCallback<void> } callback - The callback of removeAbilityStageMonitor.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - RemoveAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Remove a specified AbilityStageMonitor object from the application memory.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @param { AsyncCallback<void> } callback - The callback of removeAbilityStageMonitor.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - RemoveAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Remove a specified AbilityStageMonitor object from the application memory.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @param { AsyncCallback<void> } callback - The callback of removeAbilityStageMonitor.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - Calling RemoveAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
removeAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback<void>): void;
/**
* Remove a specified AbilityStageMonitor object from the application memory.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @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.
* @throws { BusinessError } 16000100 - RemoveAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Remove a specified AbilityStageMonitor object from the application memory.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @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.
* @throws { BusinessError } 16000100 - RemoveAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Remove a specified AbilityStageMonitor object from the application memory.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @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.
* @throws { BusinessError } 16000100 - Calling RemoveAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
removeAbilityStageMonitor(monitor: AbilityStageMonitor): Promise<void>;
/**
* Remove a specified AbilityStageMonitor object from the application memory.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - RemoveAbilityStageMonitorSync failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Remove a specified AbilityStageMonitor object from the application memory.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - Calling RemoveAbilityStageMonitorSync failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
removeAbilityStageMonitorSync(monitor: AbilityStageMonitor): void;
/**
* Wait for and returns the Ability object that matches the conditions set in the given AbilityMonitor.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object.
* @param { AsyncCallback<UIAbility> } callback - The callback is used to return the Ability object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - WaitAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Wait for and returns the Ability object that matches the conditions set in the given AbilityMonitor.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object.
* @param { AsyncCallback<UIAbility> } callback - The callback is used to return the Ability object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - WaitAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Wait for and returns the Ability object that matches the conditions set in the given AbilityMonitor.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object.
* @param { AsyncCallback<UIAbility> } callback - The callback is used to return the Ability object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - Calling WaitAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback<UIAbility>): void;
/**
* Wait for and returns the Ability object that matches the conditions set in the given AbilityMonitor.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object.
* @param { number } timeout - Maximum wait time, in milliseconds.
* @param { AsyncCallback<UIAbility> } callback - The callback is used to return the Ability object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - WaitAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Wait for and returns the Ability object that matches the conditions set in the given AbilityMonitor.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object.
* @param { number } timeout - Maximum wait time, in milliseconds.
* @param { AsyncCallback<UIAbility> } callback - The callback is used to return the Ability object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - WaitAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Wait for and returns the Ability object that matches the conditions set in the given AbilityMonitor.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object.
* @param { number } timeout - Maximum wait time, in milliseconds.
* @param { AsyncCallback<UIAbility> } callback - The callback is used to return the Ability object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - Calling WaitAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCallback<UIAbility>): void;
/**
* Wait for and returns the Ability object that matches the conditions set in the given AbilityMonitor.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object.
* @param { number } [timeout] - Maximum wait time, in milliseconds.
* @returns { Promise<UIAbility> } Returns the Ability object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - WaitAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Wait for and returns the Ability object that matches the conditions set in the given AbilityMonitor.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object.
* @param { number } [timeout] - Maximum wait time, in milliseconds.
* @returns { Promise<UIAbility> } Returns the Ability object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - WaitAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Wait for and returns the Ability object that matches the conditions set in the given AbilityMonitor.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object.
* @param { number } [timeout] - Maximum wait time, in milliseconds.
* @returns { Promise<UIAbility> } Returns the Ability object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - Calling WaitAbilityMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise<UIAbility>;
/**
* Wait for and returns the AbilityStage object that matches the conditions set in the given AbilityStageMonitor.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @param { AsyncCallback<AbilityStage> } callback - The callback is used to return the AbilityStage object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - WaitAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Wait for and returns the AbilityStage object that matches the conditions set in the given AbilityStageMonitor.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @param { AsyncCallback<AbilityStage> } callback - The callback is used to return the AbilityStage object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - WaitAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Wait for and returns the AbilityStage object that matches the conditions set in the given AbilityStageMonitor.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @param { AsyncCallback<AbilityStage> } callback - The callback is used to return the AbilityStage object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - Calling WaitAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
waitAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback<AbilityStage>): void;
/**
* Wait for and returns the AbilityStage object that matches the conditions set in the given AbilityStageMonitor.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @param { number } timeout - Maximum wait time, in milliseconds.
* @param { AsyncCallback<AbilityStage> } callback - The callback is used to return the AbilityStage object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - WaitAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Wait for and returns the AbilityStage object that matches the conditions set in the given AbilityStageMonitor.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @param { number } timeout - Maximum wait time, in milliseconds.
* @param { AsyncCallback<AbilityStage> } callback - The callback is used to return the AbilityStage object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - WaitAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Wait for and returns the AbilityStage object that matches the conditions set in the given AbilityStageMonitor.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @param { number } timeout - Maximum wait time, in milliseconds.
* @param { AsyncCallback<AbilityStage> } callback - The callback is used to return the AbilityStage object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - Calling WaitAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout: number, callback: AsyncCallback<AbilityStage>): void;
/**
* Wait for and returns the AbilityStage object that matches the conditions set in the given AbilityStageMonitor.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @param { number } [timeout] - Maximum wait time, in milliseconds.
* @returns { Promise<AbilityStage> } Returns the AbilityStage object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - WaitAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Wait for and returns the AbilityStage object that matches the conditions set in the given AbilityStageMonitor.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @param { number } [timeout] - Maximum wait time, in milliseconds.
* @returns { Promise<AbilityStage> } Returns the AbilityStage object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - WaitAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Wait for and returns the AbilityStage object that matches the conditions set in the given AbilityStageMonitor.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @param { number } [timeout] - Maximum wait time, in milliseconds.
* @returns { Promise<AbilityStage> } Returns the AbilityStage object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - Calling WaitAbilityStageMonitor failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout?: number): Promise<AbilityStage>;
/**
* Obtain the application context.
*
* @returns { Context } Returns the app Context.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Obtain the application context.
*
* @returns { Context } Returns the app Context.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Obtain the application context.
*
* @returns { Context } Returns the app Context.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
getAppContext(): Context;
/**
* Obtain the lifecycle state of a specified ability.
*
* @param { UIAbility } ability - The Ability object.
* @returns { number } Returns the state of the Ability object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Obtain the lifecycle state of a specified ability.
*
* @param { UIAbility } ability - The Ability object.
* @returns { number } Returns the state of the Ability object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Obtain the lifecycle state of a specified ability.
*
* @param { UIAbility } ability - The Ability object.
* @returns { number } Returns the state of the Ability object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
getAbilityState(ability: UIAbility): number;
/**
* Obtain the ability that is currently being displayed in this process.
*
* @param { AsyncCallback<UIAbility> } callback - The callback is used to return the Ability object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - GetCurrentTopAbility failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Obtain the ability that is currently being displayed in this process.
*
* @param { AsyncCallback<UIAbility> } callback - The callback is used to return the Ability object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - GetCurrentTopAbility failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Obtain the ability that is currently being displayed in this process.
*
* @param { AsyncCallback<UIAbility> } callback - The callback is used to return the Ability object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - Calling GetCurrentTopAbility failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
getCurrentTopAbility(callback: AsyncCallback<UIAbility>): void;
/**
* Obtain the ability that is currently being displayed in this process.
*
* @returns { Promise<UIAbility> } Returns the Ability object.
* @throws { BusinessError } 16000100 - GetCurrentTopAbility failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Obtain the ability that is currently being displayed in this process.
*
* @returns { Promise<UIAbility> } Returns the Ability object.
* @throws { BusinessError } 16000100 - GetCurrentTopAbility failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Obtain the ability that is currently being displayed in this process.
*
* @returns { Promise<UIAbility> } Returns the Ability object.
* @throws { BusinessError } 16000100 - Calling GetCurrentTopAbility failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
getCurrentTopAbility(): Promise<UIAbility>;
/**
* Start a new ability.
*
* @param { Want } want - Indicates the ability to start
* @param { AsyncCallback<void> } callback - The callback of startAbility.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000001 - The specified ability does not exist.
* @throws { BusinessError } 16000002 - Incorrect ability type.
* @throws { BusinessError } 16000004 - Cannot start an invisible component.
* @throws { BusinessError } 16000005 - The specified process does not have the permission.
* @throws { BusinessError } 16000006 - Cross-user operations are not allowed.
* @throws { BusinessError } 16000008 - The crowdtesting application expires.
* @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode.
* @throws { BusinessError } 16000010 - The call with the continuation and prepare continuation flag is forbidden.
* @throws { BusinessError } 16000011 - The context does not exist.
* @throws { BusinessError } 16000050 - Internal error.
* @throws { BusinessError } 16000053 - The ability is not on the top of the UI.
* @throws { BusinessError } 16000055 - Installation-free timed out.
* @throws { BusinessError } 16200001 - The caller has been released.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Start a new ability.
*
* @param { Want } want - Indicates the ability to start
* @param { AsyncCallback<void> } callback - The callback of startAbility.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000001 - The specified ability does not exist.
* @throws { BusinessError } 16000002 - Incorrect ability type.
* @throws { BusinessError } 16000004 - Cannot start an invisible component.
* @throws { BusinessError } 16000005 - The specified process does not have the permission.
* @throws { BusinessError } 16000006 - Cross-user operations are not allowed.
* @throws { BusinessError } 16000008 - The crowdtesting application expires.
* @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode.
* @throws { BusinessError } 16000010 - The call with the continuation and prepare continuation flag is forbidden.
* @throws { BusinessError } 16000011 - The context does not exist.
* @throws { BusinessError } 16000012 - The application is controlled.
* @throws { BusinessError } 16000013 - The application is controlled by EDM.
* @throws { BusinessError } 16000050 - Internal error.
* @throws { BusinessError } 16000053 - The ability is not on the top of the UI.
* @throws { BusinessError } 16000055 - Installation-free timed out.
* @throws { BusinessError } 16200001 - The caller has been released.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Start a new ability.
*
* @param { Want } want - Indicates the ability to start
* @param { AsyncCallback<void> } callback - The callback of startAbility.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000001 - The specified ability does not exist.
* @throws { BusinessError } 16000002 - Incorrect ability type.
* @throws { BusinessError } 16000004 - Cannot start an invisible component.
* @throws { BusinessError } 16000005 - The specified process does not have the permission.
* @throws { BusinessError } 16000006 - Cross-user operations are not allowed.
* @throws { BusinessError } 16000008 - The crowdtesting application expires.
* @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode.
* @throws { BusinessError } 16000010 - The call with the continuation and prepare continuation flag is forbidden.
* @throws { BusinessError } 16000011 - The context does not exist.
* @throws { BusinessError } 16000012 - The application is controlled.
* @throws { BusinessError } 16000013 - The application is controlled by EDM.
* @throws { BusinessError } 16000050 - Internal error.
* @throws { BusinessError } 16000053 - The ability is not on the top of the UI.
* @throws { BusinessError } 16000055 - Installation-free timed out.
* @throws { BusinessError } 16200001 - The caller has been released.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
startAbility(want: Want, callback: AsyncCallback<void>): void;
/**
* Start a new ability.
*
* @param { Want } want - Indicates the ability to start
* @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.
* @throws { BusinessError } 16000001 - The specified ability does not exist.
* @throws { BusinessError } 16000002 - Incorrect ability type.
* @throws { BusinessError } 16000004 - Cannot start an invisible component.
* @throws { BusinessError } 16000005 - The specified process does not have the permission.
* @throws { BusinessError } 16000006 - Cross-user operations are not allowed.
* @throws { BusinessError } 16000008 - The crowdtesting application expires.
* @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode.
* @throws { BusinessError } 16000010 - The call with the continuation and prepare continuation flag is forbidden.
* @throws { BusinessError } 16000011 - The context does not exist.
* @throws { BusinessError } 16000050 - Internal error.
* @throws { BusinessError } 16000053 - The ability is not on the top of the UI.
* @throws { BusinessError } 16000055 - Installation-free timed out.
* @throws { BusinessError } 16200001 - The caller has been released.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Start a new ability.
*
* @param { Want } want - Indicates the ability to start
* @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.
* @throws { BusinessError } 16000001 - The specified ability does not exist.
* @throws { BusinessError } 16000002 - Incorrect ability type.
* @throws { BusinessError } 16000004 - Cannot start an invisible component.
* @throws { BusinessError } 16000005 - The specified process does not have the permission.
* @throws { BusinessError } 16000006 - Cross-user operations are not allowed.
* @throws { BusinessError } 16000008 - The crowdtesting application expires.
* @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode.
* @throws { BusinessError } 16000010 - The call with the continuation and prepare continuation flag is forbidden.
* @throws { BusinessError } 16000011 - The context does not exist.
* @throws { BusinessError } 16000012 - The application is controlled.
* @throws { BusinessError } 16000013 - The application is controlled by EDM.
* @throws { BusinessError } 16000050 - Internal error.
* @throws { BusinessError } 16000053 - The ability is not on the top of the UI.
* @throws { BusinessError } 16000055 - Installation-free timed out.
* @throws { BusinessError } 16200001 - The caller has been released.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Start a new ability.
*
* @param { Want } want - Indicates the ability to start
* @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.
* @throws { BusinessError } 16000001 - The specified ability does not exist.
* @throws { BusinessError } 16000002 - Incorrect ability type.
* @throws { BusinessError } 16000004 - Cannot start an invisible component.
* @throws { BusinessError } 16000005 - The specified process does not have the permission.
* @throws { BusinessError } 16000006 - Cross-user operations are not allowed.
* @throws { BusinessError } 16000008 - The crowdtesting application expires.
* @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode.
* @throws { BusinessError } 16000010 - The call with the continuation and prepare continuation flag is forbidden.
* @throws { BusinessError } 16000011 - The context does not exist.
* @throws { BusinessError } 16000012 - The application is controlled.
* @throws { BusinessError } 16000013 - The application is controlled by EDM.
* @throws { BusinessError } 16000050 - Internal error.
* @throws { BusinessError } 16000053 - The ability is not on the top of the UI.
* @throws { BusinessError } 16000055 - Installation-free timed out.
* @throws { BusinessError } 16200001 - The caller has been released.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
startAbility(want: Want): Promise<void>;
/**
* Invoke the Ability.onForeground() callback of a specified ability without changing its lifecycle state.
*
* @param { UIAbility } ability - The ability object.
* @param { AsyncCallback<void> } callback - The callback of doAbilityForeground.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - DoAbilityForeground failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Invoke the Ability.onForeground() callback of a specified ability without changing its lifecycle state.
*
* @param { UIAbility } ability - The ability object.
* @param { AsyncCallback<void> } callback - The callback of doAbilityForeground.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - DoAbilityForeground failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Invoke the Ability.onForeground() callback of a specified ability without changing its lifecycle state.
*
* @param { UIAbility } ability - The ability object.
* @param { AsyncCallback<void> } callback - The callback of doAbilityForeground.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - Calling DoAbilityForeground failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
doAbilityForeground(ability: UIAbility, callback: AsyncCallback<void>): void;
/**
* Invoke the Ability.onForeground() callback of a specified ability without changing its lifecycle state.
*
* @param { UIAbility } ability - The ability object.
* @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.
* @throws { BusinessError } 16000100 - DoAbilityForeground failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Invoke the Ability.onForeground() callback of a specified ability without changing its lifecycle state.
*
* @param { UIAbility } ability - The ability object.
* @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.
* @throws { BusinessError } 16000100 - DoAbilityForeground failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Invoke the Ability.onForeground() callback of a specified ability without changing its lifecycle state.
*
* @param { UIAbility } ability - The ability object.
* @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.
* @throws { BusinessError } 16000100 - Calling DoAbilityForeground failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
doAbilityForeground(ability: UIAbility): Promise<void>;
/**
* Invoke the Ability.onBackground() callback of a specified ability without changing its lifecycle state.
*
* @param { UIAbility } ability - The ability object.
* @param { AsyncCallback<void> } callback - The callback of doAbilityBackground.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - DoAbilityBackground failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Invoke the Ability.onBackground() callback of a specified ability without changing its lifecycle state.
*
* @param { UIAbility } ability - The ability object.
* @param { AsyncCallback<void> } callback - The callback of doAbilityBackground.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - DoAbilityBackground failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Invoke the Ability.onBackground() callback of a specified ability without changing its lifecycle state.
*
* @param { UIAbility } ability - The ability object.
* @param { AsyncCallback<void> } callback - The callback of doAbilityBackground.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - Calling DoAbilityBackground failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
doAbilityBackground(ability: UIAbility, callback: AsyncCallback<void>): void;
/**
* Invoke the Ability.onBackground() callback of a specified ability without changing its lifecycle state.
*
* @param { UIAbility } ability - The ability object.
* @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.
* @throws { BusinessError } 16000100 - DoAbilityBackground failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Invoke the Ability.onBackground() callback of a specified ability without changing its lifecycle state.
*
* @param { UIAbility } ability - The ability object.
* @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.
* @throws { BusinessError } 16000100 - DoAbilityBackground failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Invoke the Ability.onBackground() callback of a specified ability without changing its lifecycle state.
*
* @param { UIAbility } ability - The ability object.
* @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.
* @throws { BusinessError } 16000100 - Calling DoAbilityBackground failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
doAbilityBackground(ability: UIAbility): Promise<void>;
/**
* Prints log information to the unit testing console.
* The total length of the log information to be printed cannot exceed 1000 characters.
*
* @param { string } msg - Log information
* @param { AsyncCallback<void> } callback - The callback of print.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 8
*/
/**
* Prints log information to the unit testing console.
* The total length of the log information to be printed cannot exceed 1000 characters.
*
* @param { string } msg - Log information
* @param { AsyncCallback<void> } callback - The callback of print.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Prints log information to the unit testing console.
* The total length of the log information to be printed cannot exceed 1000 characters.
*
* @param { string } msg - Log information
* @param { AsyncCallback<void> } callback - The callback of print.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
print(msg: string, callback: AsyncCallback<void>): void;
/**
* Prints log information to the unit testing console.
* The total length of the log information to be printed cannot exceed 1000 characters.
*
* @param { string } msg - Log information
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 8
*/
/**
* Prints log information to the unit testing console.
* The total length of the log information to be printed cannot exceed 1000 characters.
*
* @param { string } msg - Log information
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Prints log information to the unit testing console.
* The total length of the log information to be printed cannot exceed 1000 characters.
*
* @param { string } msg - Log information
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
print(msg: string): Promise<void>;
/**
* Prints log information to the unit testing console.
* The total length of the log information to be printed cannot exceed 1000 characters.
*
* @param { string } msg - Log information.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Prints log information to the unit testing console.
* The total length of the log information to be printed cannot exceed 1000 characters.
*
* @param { string } msg - Log information.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Prints log information to the unit testing console.
* The total length of the log information to be printed cannot exceed 1000 characters.
*
* @param { string } msg - Log information.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
printSync(msg: string): void;
/**
* Execute the given command in the aa tools side.
*
* @param { string } cmd - Shell command
* @param { AsyncCallback<ShellCmdResult> } callback - The callback of executeShellCommand.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 8
*/
/**
* Execute the given command in the aa tools side.
*
* @param { string } cmd - Shell command
* @param { AsyncCallback<ShellCmdResult> } callback - The callback of executeShellCommand.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
executeShellCommand(cmd: string, callback: AsyncCallback<ShellCmdResult>): void;
/**
* Execute the given command in the aa tools side.
*
* @param { string } cmd - Shell command
* @param { number } timeoutSecs - Timeout, in seconds
* @param { AsyncCallback<ShellCmdResult> } callback - The callback of executeShellCommand.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 8
*/
/**
* Execute the given command in the aa tools side.
*
* @param { string } cmd - Shell command
* @param { number } timeoutSecs - Timeout, in seconds
* @param { AsyncCallback<ShellCmdResult> } callback - The callback of executeShellCommand.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback<ShellCmdResult>): void;
/**
* Execute the given command in the aa tools side.
*
* @param { string } cmd - Shell command
* @param { number } [timeoutSecs] - Timeout, in seconds
* @returns { Promise<ShellCmdResult> } the promise returned by the function.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 8
*/
/**
* Execute the given command in the aa tools side.
*
* @param { string } cmd - Shell command
* @param { number } [timeoutSecs] - Timeout, in seconds
* @returns { Promise<ShellCmdResult> } the promise returned by the function.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
executeShellCommand(cmd: string, timeoutSecs?: number): Promise<ShellCmdResult>;
/**
* Finish the test and print log information to the unit testing console.
* The total length of the log information to be printed cannot exceed 1000 characters.
*
* @param { string } msg - Log information.
* @param { number } code - Result code.
* @param { AsyncCallback<void> } callback - The callback of finishTest.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - FinishTest failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Finish the test and print log information to the unit testing console.
* The total length of the log information to be printed cannot exceed 1000 characters.
*
* @param { string } msg - Log information.
* @param { number } code - Result code.
* @param { AsyncCallback<void> } callback - The callback of finishTest.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - FinishTest failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Finish the test and print log information to the unit testing console.
* The total length of the log information to be printed cannot exceed 1000 characters.
*
* @param { string } msg - Log information.
* @param { number } code - Result code.
* @param { AsyncCallback<void> } callback - The callback of finishTest.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000100 - Calling FinishTest failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
finishTest(msg: string, code: number, callback: AsyncCallback<void>): void;
/**
* Finish the test and print log information to the unit testing console.
* The total length of the log information to be printed cannot exceed 1000 characters.
*
* @param { string } msg - Log information.
* @param { number } code - Result code.
* @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.
* @throws { BusinessError } 16000100 - FinishTest failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Finish the test and print log information to the unit testing console.
* The total length of the log information to be printed cannot exceed 1000 characters.
*
* @param { string } msg - Log information.
* @param { number } code - Result code.
* @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.
* @throws { BusinessError } 16000100 - FinishTest failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
/**
* Finish the test and print log information to the unit testing console.
* The total length of the log information to be printed cannot exceed 1000 characters.
*
* @param { string } msg - Log information.
* @param { number } code - Result code.
* @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.
* @throws { BusinessError } 16000100 - Calling FinishTest failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
finishTest(msg: string, code: number): Promise<void>;
/**
* Used to set a list of mock data.
* @param { Record<string, string> } mockList - An object with string keys and string values. The keys represent the
* target path to be replaced and the values represent the path of the
* mock implementation to be used for the replacement.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
* @throws { BusinessError } 16000050 - Internal error.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @atomicservice
* @since 11
*/
setMockList(mockList: Record<string, string>): void;
}
/*** if arkts 1.1 */
export default AbilityDelegator;
/*** endif */
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/openharmony/interface_sdk-js.git
git@gitee.com:openharmony/interface_sdk-js.git
openharmony
interface_sdk-js
interface_sdk-js
master

搜索帮助