WindowExtensionAbility

WindowExtensionAbility是一种ExtensionAbility组件,用于提供界面组合扩展能力,允许系统应用进行跨应用的界面拉起和嵌入。

WindowExtensionAbility必须和AbilityComponent一起配合使用,并根据需求处理被拉起应用的业务。WindowExtensionAbility支持以连接形式运行,系统应用必须添加AbilityComponent组件启动WindowExtensionAbility服务。

每个ExtensionAbility都有自己的Context,WindowExtensionAbility通过 WindowExtensionContext提供相关能力。本文描述中称被启动的WindowExtensionAbility为提供方,称启动WindowExtensionAbility的AbilityComponent组件为使用方。

说明:

本接口为系统接口,如果三方开发者想要实现应用进行跨应用的界面拉起和嵌入,请参考full-SDK替换指南将SDK替换为full-SDK。

设置一个嵌入式UIAbility(仅对系统应用开放)

WindowExtensionAbility提供了onConnect()、onDisconnect()和onWindowReady()生命周期回调,根据需要重写对应的回调方法。

  • onWindowReady:当该Ability的应用窗口创建成功时触发该回调。

  • onConnect:当窗口扩展组件AbilityComponent连接该Ability时回调。

  • onDisconnect:当窗口扩展组件AbilityComponent断开与该Ability的连接时回调。

开发步骤

开发者在实现一个嵌入式应用时,需要在DevEco Studio工程中手动新建一个WindowExtensionAbility,具体步骤如下。

  1. 在工程Module对应的ets目录下,右键选择“New > Directory”,新建一个目录并命名为WindowExtAbility。

  2. 在WindowExtAbility目录,右键选择“New > ts File”,新建一个.ts文件并命名为WindowExtAbility.ts。

  3. 打开WindowExtAbility.ts文件,导入WindowExtensionAbility的依赖包,自定义类继承WindowExtensionAbility并实现onWindowReady()、onConnect()和onDisconnect()生命周期回调。

    import Extension from '@ohos.application.WindowExtensionAbility'
    
     export default class WindowExtAbility extends Extension {
         onWindowReady(window) {
             window.loadContent('WindowExtAbility/pages/index1').then(() => {
                 window.getProperties().then((pro) => {
                     console.info("WindowExtension " + JSON.stringify(pro));
                 })
                 window.show();
             })
         }
    
         onConnect(want) {
             console.info('JSWindowExtension onConnect ' + want.abilityName);
         }
    
         onDisconnect(want) {
             console.info('JSWindowExtension onDisconnect ' + want.abilityName);
         }
     }
    
  4. 在工程Module对应的module.json5配置文件中注册WindowExtensionAbility,type标签需要设置为“window”,srcEntry标签表示当前ExtensionAbility组件所对应的代码路径。

    {
      "module": {
        "extensionAbilities": [
             {
                 "name": "WindowExtAbility",
                 "srcEntry": "./ets/WindowExtAbility/WindowExtAbility.ts",
                 "icon": "$media:icon",
                 "description": "WindowExtension",
                 "type": "window",
                 "exported": true,
             }
         ],
      }
    }
    

拉起一个嵌入式UIAbility(仅对系统应用开放)

系统应用可以通过AbilityComponent容器加载创建好的WindowExtensionAbility。

开发步骤

  1. 开发者在连接一个嵌入式应用时,需要在DevEco Studio工程中相应的pages界面中加入AbilityComponent控件。

  2. 在AbilityComponent控件中写入正确的bundleName和abilityName。

  3. 设置好宽高。示例代码如下:

@Entry
@Component
struct Index {
  @State message: string = 'Hello World'

  build() {
    Row() {
      Column() {
        AbilityComponent({ abilityName: "WindowExtAbility", bundleName: "com.example.WindowExtAbility"})
          .width(500)
          .height(500)
      }
      .width('100%')
    }
    .height('100%')
    .backgroundColor(0x64BB5c)
  }
}

相关示例

针对WindowExtensionAbility开发,有以下相关示例可供参考: