鸿蒙NEXT开发【@ohos.arkui.uiExtension (uiExtension)】 UI界面API

用于EmbeddedUIExtensionAbility（或UIExtensionAbility）中获取宿主应用的窗口信息或对应的EmbeddedComponent组件的信息。

说明

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

导入模块

import { uiExtension } from '@kit.ArkUI'

WindowProxy

getWindowAvoidArea

getWindowAvoidArea(type: window.AvoidAreaType): window.AvoidArea

获取宿主应用窗口内容规避的区域；如系统栏区域、刘海屏区域、手势区域、软键盘区域等与宿主窗口内容重叠时，需要宿主窗口内容避让的区域。

元服务API：  从API version 12开始，该接口支持在元服务中使用。

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

参数名	类型	必填	说明
type	[window.AvoidAreaType]	是	表示规避区类型。

返回值：

类型	说明
[window.AvoidArea]	宿主窗口内容规避区域。

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameters types; 3. Parameter verification failed.

示例

// ExtensionProvider.ts
import { EmbeddedUIExtensionAbility, UIExtensionContentSession, Want } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';

export default class EntryAbility extends EmbeddedUIExtensionAbility {
  onSessionCreate(want: Want, session: UIExtensionContentSession) {
    const extensionWindow = session.getUIExtensionWindowProxy();
    // 获取宿主应用窗口的避让信息
    let avoidArea: window.AvoidArea | undefined = extensionWindow?.getWindowAvoidArea(window.AvoidAreaType.TYPE_SYSTEM);
    console.info(`avoidArea: ${JSON.stringify(avoidArea)}`);
  }
}

on(‘avoidAreaChange’)

on(type: ‘avoidAreaChange’, callback: Callback): void

注册系统规避区变化的监听。

元服务API：  从API version 12开始，该接口支持在元服务中使用。

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

参数名	类型	必填	说明
type	string	是	监听的事件类型，固定为’avoidAreaChange’，即系统规避区变化事件。
callback	[Callback]<[AvoidAreaInfo]>	是	回调函数：入参用于接收当前规避区的信息。

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameters types; 3. Parameter verification failed.

示例

// ExtensionProvider.ts
import { EmbeddedUIExtensionAbility, UIExtensionContentSession, Want } from '@kit.AbilityKit';
import { uiExtension } from '@kit.ArkUI';

export default class EntryAbility extends EmbeddedUIExtensionAbility {
  onSessionCreate(want: Want, session: UIExtensionContentSession) {
    const extensionWindow = session.getUIExtensionWindowProxy();
    // 注册避让区变化的监听