diff --git a/zh-cn/application-dev/reference/apis/js-apis-window.md b/zh-cn/application-dev/reference/apis/js-apis-window.md index 60d0ddcdfb2a8f66639a8eaff58591703c266c9a..ba74712186d850dfa65d80583c2cad657e5a4a4b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-window.md +++ b/zh-cn/application-dev/reference/apis/js-apis-window.md @@ -296,6 +296,21 @@ import window from '@ohos.window'; | y | number | 否 | 是 | Y轴的平移参数,默认值为0.0。 | | z | number | 否 | 是 | Z轴的平移参数,默认值为0.0。 | +## WindowEventType10+ + +窗口生命周期。 + +**系统接口:** 此接口为系统接口。 + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +| 名称 | 值 | 说明 | +| ---------- | ------ | ---------- | +| SHOWN | 1 | 切到前台。 | +| ACTIVE | 2 | 获焦状态。 | +| INACTIVE | 3 | 失焦状态。 | +| HIDDEN | 4 | 切到后台。 | + ## window.createWindow9+ createWindow(config: Configuration, callback: AsyncCallback<Window>): void @@ -2787,6 +2802,62 @@ try { } ``` +### on('windowEvent')10+ + +on(type: 'windowEvent', callback: Callback<WindowEventType>): void + +开启窗口生命周期变化的监听。 + +**系统接口:** 此接口为系统接口。 + +**系统能力:** SystemCapability.WindowManager.WindowManager.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------------------------- | ---- | ------------------------------------------------------------ | +| type | string | 是 | 监听事件,固定为'windowEvent',即窗口生命周期变化事件。 | +| callback | Callback<[WindowEventType](#windoweventtype10)> | 是 | 回调函数。返回当前的窗口生命周期状态。 | + +**示例:** + +```js +try { + windowClass.on('windowEvent', (data) => { + console.info('Window event happened. Event:' + JSON.stringify(data)); + }); +} catch (exception) { + console.error('Failed to register callback. Cause: ' + JSON.stringify(exception)); +} +``` + +### off('windowEvent')10+ + +off(type: 'windowEvent', callback?: Callback<WindowEventType >): void + +关闭窗口生命周期变化的监听。 + +**系统接口:** 此接口为系统接口。 + +**系统能力:** SystemCapability.WindowManager.WindowManager.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------------------------- | ---- | ------------------------------------------------------------ | +| type | string | 是 | 监听事件,固定为'windowEvent',即窗口生命周期变化事件。 | +| callback | Callback<[WindowEventType](#windoweventtype10)> | 否 | 回调函数。返回当前的窗口生命周期状态。 | + +**示例:** + +```js +try { + windowClass.off('windowEvent'); +} catch (exception) { + console.error('Failed to unregister callback. Cause: ' + JSON.stringify(exception)); +} +``` + ### bindDialogTarget9+ bindDialogTarget(token: rpc.RemoteObject, deathCallback: Callback<void>, callback: AsyncCallback<void>): void