@ohos.arkui.observer (无感监听)

提供UI组件行为变化的无感监听能力。

说明：

从API Version 11开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。

导入模块

import observer from '@ohos.arkui.observer'

NavDestination组件状态。

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称 值 说明
ON_SHOWN 0 NavDestination组件显示。
ON_HIDDEN 1 NavDestination组件隐藏。

RouterPageState

routerPage生命周期触发时对应的状态

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称 值 说明
ABOUT_TO_APPEAR 0 page即将显示
ABOUT_TO_DISAPPEAR 1 page即将销毁
ON_PAGE_SHOW 2 page显示
ON_PAGE_HIDE 3 page隐藏
ON_BACK_PRESS 4 page返回时

NavDestination组件信息。

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称 类型 必填 说明
navigationId ResourceStr 是 包含NavDestination组件的Navigation组件的id。
name ResourceStr 是 NavDestination组件的名称。
state NavDestinationState 是 NavDestination组件的状态。

RouterPageInfo

RouterPageInfo包含的信息。

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称 类型 必填 说明
context UIAbilityContext / UIContext 是 触发生命周期的routerPage页面对应的上下文信息
index number 是 触发生命周期的routerPage在栈中的位置。
name string 是 触发生命周期的routerPage页面的名称。
path string 是 触发生命周期的routerPage页面的路径。
state RouterPageState 是 触发生命周期的routerPage页面的状态

observer.on('navDestinationUpdate')

on(type: 'navDestinationUpdate', callback: Callback<NavDestinationInfo>): void

监听NavDestination组件的状态变化。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为'navDestinationUpdate'，即NavDestination组件的状态变化。
callback Callback<NavDestinationInfo> 是 回调函数。返回当前的NavDestination组件状态。

示例：

observer.on('navDestinationUpdate', (info) => {
    console.info('NavDestination state update', JSON.stringify(info));
});

observer.off('navDestinationUpdate')

off(type: 'navDestinationUpdate', callback?: Callback<NavDestinationInfo>): void

取消监听NavDestination组件的状态变化。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为'navDestinationUpdate'，即NavDestination组件的状态变化。
callback Callback<NavDestinationInfo> 否 回调函数。返回当前的NavDestination组件状态。

示例：

observer.off('navDestinationUpdate');

observer.on('navDestinationUpdate')

on(type: 'navDestinationUpdate', options: { navigationId: ResourceStr }, callback: Callback<NavDestinationInfo>): void

监听NavDestination组件的状态变化。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为'navDestinationUpdate'，即NavDestination组件的状态变化。
options { navigationId: ResourceStr } 是 指定监听的Navigation的id。
callback Callback<NavDestinationInfo> 是 回调函数。返回当前的NavDestination组件状态。

示例：

observer.on('navDestinationUpdate', { navigationId: "testId" }, (info) => {
    console.info('NavDestination state update', JSON.stringify(info));
});

observer.off('navDestinationUpdate')

off(type: 'navDestinationUpdate', options: { navigationId: ResourceStr }, callback?: Callback<NavDestinationInfo>): void

取消监听NavDestination组件的状态变化。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为'navDestinationUpdate'，即NavDestination组件的状态变化。
options { navigationId: ResourceStr } 是 指定监听的Navigation的id。
callback Callback<NavDestinationInfo> 否 回调函数。返回当前的NavDestination组件状态。

示例：

observer.off('navDestinationUpdate', { navigationId: "testId" });

observer.on('routerPageUpdate')11+

on(type: 'routerPageUpdate', context: UIAbilityContext | UIContext, callback: Callback<RouterPageInfo>): void

监听router中page页面的状态变化。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为'routerPageUpdate'，即router中page页面的状态变化。
context UIAbilityContext | UIContext 是 上下文信息，用以指定监听页面的范围
callback Callback<RouterPageInfo> 是 回调函数。携带pageInfo，返回当前的page页面状态。

示例：

// used in UIAbility
import observer from '@ohos.arkui.observer';
import { UIContext } from '@ohos.arkui.UIContext';
function callBackFunc(info: observer.RouterPageInfo) {}
// callBackFunc is user defined function
observer.on('routerPageUpdate', this.context, callBackFunc);
// uiContext could be got by window's function: getUIContext()
uiContext: UIContext | null = null;
observer.on('routerPageUpdate', this.uiContext, callBackFunc);

observer.off('routerPageUpdate')11+

off(type: 'routerPageUpdate', context: UIAbilityContext | UIContext, callback?: Callback<RouterPageInfo>): void

取消监听router中page页面的状态变化。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为'routerPageUpdate'，即router中page页面的状态变化。
context UIAbilityContext | UIContext 是 上下文信息，用以指定监听页面的范围
callback Callback<RouterPageInfo> 否 需要被注销的回调函。

示例：

// used in UIAbility
import observer from '@ohos.arkui.observer';
import { UIContext } from '@ohos.arkui.UIContext';
function callBackFunc(info: observer.RouterPageInfo) {}
// callBackFunc is user defined function
observer.off('routerPageUpdate', this.context, callBackFunc);
// uiContext could be got by window's function: getUIContext()
uiContext: UIContext | null = null;
observer.off('routerPageUpdate', this.uiContext, callBackFunc);