!6702 元能力部分同步接口整改

Merge pull request !6702 from songjindian/master
This commit is contained in:
openharmony_ci 2023-08-23 09:29:22 +00:00 committed by Gitee
commit d612caba3c
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
2 changed files with 104 additions and 14 deletions

View File

@ -84,6 +84,18 @@ export interface AbilityDelegator {
*/
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 - If the input parameter is not valid parameter.
* @throws { BusinessError } 16000100 - AddAbilityMonitorSync failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
addAbilityMonitorSync(monitor: AbilityMonitor): void;
/**
* Add an AbilityStageMonitor object for monitoring the lifecycle state changes of the specified abilityStage in this process.
*
@ -130,6 +142,18 @@ export interface AbilityDelegator {
*/
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 - If the input parameter is not valid parameter.
* @throws { BusinessError } 16000100 - AddAbilityStageMonitorSync failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
addAbilityStageMonitorSync(monitor: AbilityStageMonitor): void;
/**
* Remove a specified AbilityMonitor object from the application memory.
*
@ -176,6 +200,18 @@ export interface AbilityDelegator {
*/
removeAbilityMonitor(monitor: AbilityMonitor): Promise<void>;
/**
* Remove a specified AbilityMonitor object from the application memory.
*
* @param { AbilityMonitor } monitor - AbilityMonitor object.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @throws { BusinessError } 16000100 - RemoveAbilityMonitorSync failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
removeAbilityMonitorSync(monitor: AbilityMonitor): void;
/**
* Remove a specified AbilityStageMonitor object from the application memory.
*
@ -222,6 +258,18 @@ export interface AbilityDelegator {
*/
removeAbilityStageMonitor(monitor: AbilityStageMonitor): Promise<void>;
/**
* Remove a specified AbilityStageMonitor object from the application memory.
*
* @param { AbilityStageMonitor } monitor - AbilityStageMonitor object.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @throws { BusinessError } 16000100 - RemoveAbilityStageMonitorSync failed.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @crossplatform
* @since 10
*/
removeAbilityStageMonitorSync(monitor: AbilityStageMonitor): void;
/**
* Wait for and returns the Ability object that matches the conditions set in the given AbilityMonitor.
*

View File

@ -48,11 +48,15 @@ export default class ApplicationContext extends Context {
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
* @deprecated since 10
* @useinstead ApplicationContext#on(type: 'abilityLifecycleEvent', callback: AbilityLifecycleCallback)
*/
on(type: 'abilityLifecycle', callback: AbilityLifecycleCallback): number;
/**
* Register ability lifecycle callback.
*
* @param { 'abilityLifecycle' } type - abilityLifecycle.
* @param { 'abilityLifecycleEvent' } type - abilityLifecycleEvent.
* @param { AbilityLifecycleCallback } callback - The ability lifecycle callback.
* @returns { number } Returns the number code of the callback.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
@ -61,7 +65,7 @@ export default class ApplicationContext extends Context {
* @crossplatform
* @since 10
*/
on(type: 'abilityLifecycle', callback: AbilityLifecycleCallback): number;
on(type: 'abilityLifecycleEvent', callback: AbilityLifecycleCallback): number;
/**
* Unregister ability lifecycle callback.
@ -73,18 +77,8 @@ export default class ApplicationContext extends Context {
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
/**
* Unregister ability lifecycle callback.
*
* @param { 'abilityLifecycle' } type - abilityLifecycle.
* @param { number } callbackId - Indicates the number code of the callback.
* @param { AsyncCallback<void> } callback - The callback of off.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @crossplatform
* @since 10
* @deprecated since 10
* @useinstead ApplicationContext#off(type: 'abilityLifecycleEvent', callbackId: number)
*/
off(type: 'abilityLifecycle', callbackId: number, callback: AsyncCallback<void>): void;
@ -98,9 +92,25 @@ export default class ApplicationContext extends Context {
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
* @deprecated since 10
* @useinstead ApplicationContext#off(type: 'abilityLifecycleEvent', callbackId: number)
*/
off(type: 'abilityLifecycle', callbackId: number): Promise<void>;
/**
* Unregister ability lifecycle callback.
*
* @param { 'abilityLifecycleEvent' } type - abilityLifecycleEvent.
* @param { number } callbackId - Indicates the number code of the callback.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @throws { BusinessError } 16000050 - Internal error.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @crossplatform
* @since 10
*/
off(type: 'abilityLifecycleEvent', callbackId: number): void;
/**
* Register environment callback.
*
@ -111,9 +121,24 @@ export default class ApplicationContext extends Context {
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
* @deprecated since 10
* @useinstead ApplicationContext#off(type: 'environmentEvent', callback: EnvironmentCallback)
*/
on(type: 'environment', callback: EnvironmentCallback): number;
/**
* Register environment callback.
*
* @param { 'environmentEvent' } type - environmentEvent.
* @param { EnvironmentCallback } callback - The environment callback.
* @returns { number } Returns the number code of the callback.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 10
*/
on(type: 'environmentEvent', callback: EnvironmentCallback): number;
/**
* Unregister environment callback.
*
@ -124,6 +149,8 @@ export default class ApplicationContext extends Context {
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
* @deprecated since 10
* @useinstead ApplicationContext#off(type: 'environmentEvent', callbackId: number)
*/
off(type: 'environment', callbackId: number, callback: AsyncCallback<void>): void;
@ -137,9 +164,24 @@ export default class ApplicationContext extends Context {
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
* @deprecated since 10
* @useinstead ApplicationContext#off(type: 'environmentEvent', callbackId: number)
*/
off(type: 'environment', callbackId: number): Promise<void>;
/**
* Unregister environment callback.
*
* @param { 'environmentEvent' } type - environmentEvent.
* @param { number } callbackId - Indicates the number code of the callback.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @throws { BusinessError } 16000050 - Internal error.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 10
*/
off(type: 'environmentEvent', callbackId: number): void;
/**
* Register applicationStateChange callback.
*