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