• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# WindowExtensionAbility（仅对系统应用开放）
2
3
4[WindowExtensionAbility](../reference/apis/js-apis-application-windowExtensionAbility.md)是一种ExtensionAbility组件，用于提供界面组合扩展能力，允许系统应用进行跨应用的界面拉起和嵌入。
5
6
7WindowExtensionAbility必须和[AbilityComponent](../reference/arkui-ts/ts-container-ability-component.md)一起配合使用，并根据需求处理被拉起应用的业务。WindowExtensionAbility支持以连接形式运行，系统应用必须添加AbilityComponent组件启动WindowExtensionAbility服务。
8
9每个ExtensionAbility都有自己的Context，WindowExtensionAbility通过
10[WindowExtensionContext](../reference/apis/js-apis-inner-application-windowExtensionContext.md)提供相关能力。本文描述中称被启动的WindowExtensionAbility为提供方，称启动WindowExtensionAbility的AbilityComponent组件为使用方。
11
12> **说明：**
13>
14> 本接口为系统接口，如果三方开发者想要实现应用进行跨应用的界面拉起和嵌入，请参考[full-SDK替换指南](../faqs/full-sdk-switch-guide.md)将SDK替换为full-SDK。
15>
16
17
18## 设置一个嵌入式UIAbility
19
20WindowExtensionAbility提供了onConnect()、onDisconnect()和onWindowReady()生命周期回调，根据需要重写对应的回调方法。
21
22- **onWindowReady**：当该Ability的应用窗口创建成功时触发该回调。
23
24- **onConnect**：当窗口扩展组件AbilityComponent连接该Ability时回调。
25
26- **onDisconnect**：当窗口扩展组件AbilityComponent断开与该Ability的连接时回调。
27
28
29**开发步骤**
30
31开发者在实现一个嵌入式应用时，需要在DevEco Studio工程中手动新建一个WindowExtensionAbility，具体步骤如下。
32
331. 在工程Module对应的ets目录下，右键选择“New > Directory”，新建一个目录并命名为WindowExtAbility。
34
352. 在WindowExtAbility目录，右键选择“New > ts File”，新建一个.ts文件并命名为WindowExtAbility.ts。
36
373. 打开WindowExtAbility.ts文件，导入WindowExtensionAbility的依赖包，自定义类继承WindowExtensionAbility并实现onWindowReady()、onConnect()和onDisconnect()生命周期回调。
38
39   ```ts
40    import Extension from '@ohos.application.WindowExtensionAbility'
41    import Want from '@ohos.app.ability.Want';
42    import window from '@ohos.window';
43
44    export default class WindowExtAbility extends Extension {
45        onWindowReady(window: window.Window) {
46            window.loadContent('WindowExtAbility/pages/index1').then(() => {
47                window.getProperties().then((pro) => {
48                    console.info("WindowExtension " + JSON.stringify(pro));
49                })
50                window.show();
51            })
52        }
53
54        onConnect(want: Want) {
55            console.info('JSWindowExtension onConnect ' + want.abilityName);
56        }
57
58        onDisconnect(want: Want) {
59            console.info('JSWindowExtension onDisconnect ' + want.abilityName);
60        }
61    }
62   ```
63
644. 在工程Module对应的[module.json5配置文件](../quick-start/module-configuration-file.md)中注册WindowExtensionAbility，type标签需要设置为“window”，srcEntry标签表示当前ExtensionAbility组件所对应的代码路径。
65
66   ```json
67   {
68     "module": {
69       "extensionAbilities": [
70            {
71                "name": "WindowExtAbility",
72                "srcEntry": "./ets/WindowExtAbility/WindowExtAbility.ts",
73                "icon": "$media:icon",
74                "description": "WindowExtension",
75                "type": "window",
76                "exported": true,
77            }
78        ],
79     }
80   }
81   ```
82
83
84## 拉起一个嵌入式UIAbility
85
86系统应用可以通过AbilityComponent容器加载创建好的WindowExtensionAbility。
87
88**开发步骤**
89
901. 开发者在连接一个嵌入式应用时，需要在DevEco Studio工程中相应的pages界面中加入AbilityComponent控件。
91
922. 在AbilityComponent控件中写入正确的bundleName和abilityName。
93
943. 设置好宽高。示例代码如下：
95
96```ts
97@Entry
98@Component
99struct Index {
100  @State message: string = 'Hello World'
101
102  build() {
103    Row() {
104      Column() {
105        AbilityComponent({ abilityName: "WindowExtAbility", bundleName: "com.example.WindowExtAbility"})
106          .width(500)
107          .height(500)
108      }
109      .width('100%')
110    }
111    .height('100%')
112    .backgroundColor(0x64BB5c)
113  }
114}
115```
116
117## 相关实例
118
119针对WindowExtensionAbility开发，有以下相关实例可供参考：
120
121- [窗口扩展应用（ArkTS）（API9）（Full SDK）](https://gitee.com/openharmony/applications_app_samples/tree/OpenHarmony-4.0-Release/code/SystemFeature/WindowManagement/WindowExtAbility)
122