js-apis-application-WindowExtensionAbility.md 2.9 KB
Newer Older
1
# 窗口扩展能力
2
WindowExtensionAbility基于ExtensionAbility。WindowExtensionAbility中展示的内容可作为一个控件(AbilityComponent)内容展示在其他应用窗口中。
3 4 5 6 7 8 9

> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 
> 本模块接口为系统接口。
>
10
> 本模块接口仅可在Stage模型下使用。 
11 12 13 14 15 16 17 18 19

## 导入模块

```ts
import WindowExtensionAbility from '@ohos.application.WindowExtensionAbility';
```

## 属性

20
**系统能力:** SystemCapability.WindowManager.WindowManager.Core
21 22 23 24 25 26 27

| 名称      | 参数类型 | 可读 | 可写 | 说明                      |
| --------- | -------- | ---- | ---- | ------------------------- |
| context      | [ExtensionContext](js-apis-extension-context.md)   | 是   | 否   | 上下文。      |

## WindowExtensionAbility.onConnect

28
onConnect(want: Want): void
29 30 31

当窗口扩展组件第一次连接ability时回调。

32
**系统能力:** SystemCapability.WindowManager.WindowManager.Core
33

34 35
**参数:**

36 37 38 39 40 41 42 43 44
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 当前ability的Want类型信息,包括ability名称、bundle名称等。 |

**示例:** 

```ts
export default class MyWindowExtensionAbility extends WindowExtensionAbility {

45
  onConnect(want) {
46 47 48 49 50 51 52 53 54 55 56 57
    console.info('WindowExtAbility onConnect ' + want.abilityName);
  }

}
```

## WindowExtensionAbility.onDisconnect

onDisconnect(want: Want): void

当所有连接到窗口扩展组件的ability断开连接时回调。

58
**系统能力:** SystemCapability.WindowManager.WindowManager.Core
59

60 61
**参数:**

62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 当前Ability的Want类型信息,包括ability名称、bundle名称等。 |


**示例:** 

```ts
export default class MyWindowExtensionAbility extends WindowExtensionAbility {

  onDisconnect(want) {
    console.info('WindowExtAbility onDisconnect ' + want.abilityName);
  }

}
```

## WindowExtensionAbility.onWindowReady

X
xiahaiqin 已提交
81
onWindowReady(window: window.Window): void
82 83 84

当窗口被创建时回调。

85
**系统能力:** SystemCapability.WindowManager.WindowManager.Core
86

87 88
**参数:**

89 90
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
X
xiahaiqin 已提交
91
| window | [window.Window](js-apis-window.md#window) | 是 | 当前窗口实例。 |
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109


**示例:** 

```ts
export default class MyWindowExtensionAbility extends WindowExtensionAbility {

  onWindowReady(window) {
    window.loadContent('WindowExtAbility/pages/index1').then(() => {
      window.getProperties().then((pro) => {
        console.log("WindowExtension " + JSON.stringify(pro));
      })
      window.show();
    })
  }

}
```