Aarbiter_fix: add iface setuicontextbyname

@ohos.window.floatView (标准悬浮窗)

标准悬浮窗是悬浮在桌面/应用界面上的小型窗口，提供灵活的窗口管理能力。

本模块提供标准悬浮窗能力，包括判断设备是否支持标准悬浮窗功能、创建标准悬浮窗控制器以启动、更新或停止标准悬浮窗等。

适用场景：

标准悬浮窗适用于需要在独立小窗口中持续展示应用内容或提供快捷操作的场景。例如：

股市盯盘应用：用户在浏览其他应用时，通过标准悬浮窗实时查看股票行情变化，无需频繁切换应用。
手机直播应用：主播在直播过程中使用标准悬浮窗展示自定义的互动面板或控制界面，方便实时操作和互动。

与闪控球联动：

本模块可与@ohos.window.floatingBall（闪控球）联合使用。通过floatView.bind接口将标准悬浮窗控制器与闪控球控制器绑定后，用户点击闪控球可展开为标准悬浮窗，点击标准悬浮窗左上角的缩小按钮可收起为闪控球，实现两种窗口形态的相互切换。

全局悬浮窗和标准悬浮窗对比

共同点：全局悬浮窗和标准悬浮窗均为一种特殊的应用辅助窗口，具备在应用主窗口和对应Ability退至后台后仍然可以在前台显示的能力。可以用于应用退至后台后，使用其继续显示UI。
区别：
- 全局悬浮窗由开发者管理并实现UI绘制，无统一UI及动效。
- 标准悬浮窗由系统管理并统一绘制UI，动效更为高端精致。
- 标准悬浮窗支持与闪控球互相绑定联合使用，实现更复杂场景。

起始版本： 26.0.0

说明：

针对系统能力SystemCapability.Window.SessionManager，请先使用canIUse()接口判断当前设备是否支持此syscap及对应接口。

本模块接口仅可在Stage模型下使用。

导入模块

import { floatView } from '@kit.ArkUI';

floatView.isFloatViewEnabled

isFloatViewEnabled(): boolean

判断当前设备是否支持标准悬浮窗功能。

起始版本： 26.0.0

系统能力： SystemCapability.Window.SessionManager

模型约束： 此接口仅可在Stage模型下使用。

返回值：

类型	说明
boolean	当前设备是否支持标准悬浮窗功能。true表示支持，false则表示不支持。

示例：

let enable: boolean = floatView.isFloatViewEnabled();
console.info('Float view enabled is: ' + enable);

floatView.create

create(config: FloatViewConfiguration): Promise<FloatViewController>

创建标准悬浮窗控制器。使用Promise异步回调。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

参数：

参数名	类型	必填	说明
config	FloatViewConfiguration	是	创建标准悬浮窗控制器的参数。该参数以及构造该参数的context不能为null或者undefined，否则抛出401。其他参数异常情况抛出1300016。

返回值：

类型	说明
Promise<FloatViewController>	Promise对象。返回当前创建的标准悬浮窗控制器。

错误码：

以下错误码的详细介绍请参见通用错误码和窗口错误码。

错误码ID	错误信息
801	Capability not supported. Possible cause: Call the API on unsupported device.
1300002	This window state is abnormal. Possible cause: 1. This window context is abnormal. 2. System error, such as a null pointer, insufficient memory or a JS engine exception.
1300016	Parameter error. Possible cause: Invalid template type.

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';

@Entry
@Component
struct Index {
  private floatViewController: floatView.FloatViewController | undefined = undefined;
  aboutToAppear(): void {
    // 请在组件内获取context，确保this.getUIContext().getHostContext()返回的结果为UIAbilityContext
    let ctx = this.getUIContext().getHostContext() as common.UIAbilityContext;
    let config: floatView.FloatViewConfiguration = {
      context: ctx,
      templateType: floatView.FloatViewTemplateType.ROUNDED_RECTANGLE
    };
    try {
      floatView.create(config).then((data: floatView.FloatViewController) => {
        this.floatViewController = data;
        console.info(`Succeeded in creating float view controller. Data: ${data}`);
      }).catch((err: BusinessError): void => {
        console.error(`Failed to create float view controller. Cause:${err.code}, message:${err.message}`);
      });
    } catch(e) {
      console.error(`Failed to create float view controller. Cause:${e.code}, message:${e.message}`);
    }
  }
}

floatView.bind

bind(floatViewController: FloatViewController, floatingBallController: floatingBall.FloatingBallController, floatingBallParams: floatingBall.FloatingBallParams): Promise<void>

绑定标准悬浮窗和闪控球。需要先创建标准悬浮窗控制器和闪控球控制器，且均未启动。使用Promise异步回调。

说明：

绑定成功后，调用start()或startFloatingBall()均会同时创建标准悬浮窗窗口和闪控球窗口，并触发对应窗口已注册的状态回调。但同一时刻仅展示其中一个窗口，展示顺序取决于先调用哪个控制器的启动接口。

绑定成功后，用户可通过点击操作在标准悬浮窗窗口与闪控球之间进行切换。

绑定成功后，调用任一控制器的停止接口（stop()或stopFloatingBall()）会同时销毁标准悬浮窗窗口和闪控球窗口，并触发对应窗口已注册的状态回调。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

需要权限： ohos.permission.USE_FLOAT_BALL 和 ohos.permission.FLOAT_VIEW

系统能力： SystemCapability.Window.SessionManager

参数：

参数名	类型	必填	说明
floatViewController	FloatViewController	是	标准悬浮窗控制器。
floatingBallController	floatingBall.FloatingBallController	是	闪控球控制器。
floatingBallParams	floatingBall.FloatingBallParams	是	闪控球参数。绑定时设置的参数会覆盖掉闪控球控制器启动时已保存的参数。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见通用错误码和窗口错误码。

错误码ID	错误信息
201	Permission verification failed. Possible cause: The application does not have the permission required to call the API.
801	Capability not supported on this device. Possible cause: Call api on unsupported device.
1300019	Wrong parameters for operating the floating ball. Possible cause: Invalid floating ball params.
1300025	The floating ball state does not support this operation. Possible cause: 1. The floating ball has started but not stopped yet. 2. The floating ball controller has been bound.
1300031	The floatView state does not support this operation. Possible cause: 1. The float view has started but not stopped yet. 2. The float view controller has been bound.

示例：

// Entry.ets
import { BusinessError } from '@kit.BasicServicesKit';
import { floatingBall } from '@kit.ArkUI';

@Entry
@Component
struct Index {
  private floatingBallController: floatingBall.FloatingBallController | undefined = undefined;
  private floatViewController: floatView.FloatViewController | undefined = undefined;
  // 创建控制器
  // ...
  public bindController(): void {
    let floatingBallParams: floatingBall.FloatingBallParams = {
      template: floatingBall.FloatingBallTemplate.EMPHATIC,
      title: 'title',
      content: 'content'
    };

    try {
      if (this.floatViewController && this.floatingBallController) {
        floatView.bind(this.floatViewController!, this.floatingBallController!, floatingBallParams).then(() => {
          console.info('Succeeded in binding float view and floating ball.');
        }).catch((err: BusinessError): void => {
          console.error(`Failed to bind float view and floating ball. Cause:${err.code}, message:${err.message}`);
        });
      }
    } catch(e) {
      console.error(`Failed to bind float view and floating ball. Cause:${e.code}, message:${e.message}`);
    }
  }
}

floatView.unbind

unbind(floatViewController: FloatViewController, floatingBallController: floatingBall.FloatingBallController): Promise<void>

解绑标准悬浮窗和闪控球。需要在标准悬浮窗控制器和闪控球控制器均停止后才可解绑。使用Promise异步回调。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

参数：

参数名	类型	必填	说明
floatViewController	FloatViewController	是	标准悬浮窗控制器。
floatingBallController	floatingBall.FloatingBallController	是	闪控球控制器。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见通用错误码和窗口错误码。

错误码ID	错误信息
801	Capability not supported on this device. Possible cause: Call api on unsupported device.
1300025	The floating ball state does not support this operation. Possible cause: 1. The floating ball has started but not stopped yet. 2. The floatingBallController has not been bound.
1300031	The floatView state does not support this operation. Possible cause: 1. The float view has started but not stopped yet. 2. The floatViewController has not been bound. 3. The floatViewController and the floatingBallController are not bound together.

示例：

// Entry.ets
import { BusinessError } from '@kit.BasicServicesKit';
import { floatingBall } from '@kit.ArkUI';

@Entry
@Component
struct Index {
  private floatingBallController: floatingBall.FloatingBallController | undefined = undefined;
  private floatViewController: floatView.FloatViewController | undefined = undefined;
  // 创建控制器
  // ...
  public unbindController(): void {
    try {
      // 使用绑定时传入的标准悬浮窗和闪控球控制器
      if (this.floatViewController && this.floatingBallController) {
        floatView.unbind(this.floatViewController!, this.floatingBallController!).then(() => {
          console.info('Succeeded in unbinding float view and floating ball.');
        }).catch((err: BusinessError): void => {
          console.error(`Failed to unbind float view and floating ball. Cause:${err.code}, message:${err.message}`);
        });
      }
    } catch(e) {
      console.error(`Failed to unbind float view and floating ball. Cause:${e.code}, message:${e.message}`);
    }
  }
}

floatView.getFloatViewLimits

getFloatViewLimits(templateType: FloatViewTemplateType): FloatViewLimits

根据传入的模板类型获取对应标准悬浮窗窗口的限制，单位为px。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

参数：

参数名	类型	必填	说明
templateType	FloatViewTemplateType	是	标准悬浮窗模板类型。

返回值：

类型	说明
FloatViewLimits	返回标准悬浮窗窗口的限制，包括最大尺寸、最小尺寸和宽高比的限制范围。

错误码：

以下错误码的详细介绍请参见通用错误码和窗口错误码。

错误码ID	错误信息
801	Capability not supported. Possible cause: Call the API on unsupported device.
1300002	This window state is abnormal. Possible cause: System error, such as a null pointer, insufficient memory or a JS engine exception.
1300003	This window manager service works abnormally. Possible cause: Internal IPC error.
1300016	Parameter error. Possible cause: Invalid template type.

示例：

let limits: floatView.FloatViewLimits = floatView.getFloatViewLimits(floatView.FloatViewTemplateType.ROUNDED_RECTANGLE);
console.info('Float view limits: ' + JSON.stringify(limits));

FloatViewConfiguration

创建标准悬浮窗控制器时需要提供的参数配置。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

名称	类型	只读	可选	说明
context	BaseContext	否	否	表示上下文环境。
templateType	FloatViewTemplateType	否	否	标准悬浮窗的模板类型。

TemplateProperty

切换悬浮窗模板并修改窗口尺寸时需要提供的参数配置。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

名称	类型	只读	可选	说明
templateType	FloatViewTemplateType	否	否	标准悬浮窗的模板类型。
size	window.Size	否	否	更新模板类型时需要提供的窗口尺寸。

FloatViewController

标准悬浮窗控制器实例。用于启动、停止标准悬浮窗以及注册回调等操作。

下列API示例中都需先使用floatView.create()方法获取到标准悬浮窗控制器实例（即floatViewController），再通过此实例调用对应方法。

模型约束： 此接口仅可在Stage模型下使用。

setUIContext

setUIContext(path: string, storage?: LocalStorage): Promise<void>

根据当前工程中指定的页面路径为标准悬浮窗加载具体页面内容，通过LocalStorage传递状态属性至加载页面。使用Promise异步回调。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

参数：

参数名	类型	必填	说明
path	string	是	要加载到窗口中的页面内容的路径，该路径需添加到工程的main_pages.json文件中。不支持相对路径写法，需与main_pages.json中的src取值保持一致。
storage	LocalStorage	否	页面级UI状态存储单元，用于为加载到窗口的页面内容传递状态属性。默认值为空。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见窗口错误码。

错误码ID	错误信息
1300002	This window state is abnormal. Possible cause: The float view controller object is null.
1300016	Parameter error. Possible causes: Invalid path.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  this.floatViewController?.setUIContext('pages/Index').then(() => {
    console.info('Succeeded in setting UI context.');
  }).catch((err: BusinessError): void => {
    console.error(`Failed to set UI context. Cause:${err.code}, message:${err.message}`);
  });
} catch(e) {
  console.error(`Failed to set UI context. Cause:${e.code}, message:${e.message}`);
}

setUIContextByName

setUIContextByName(name: string, storage?: LocalStorage): Promise<void>

根据指定路由页面名称为当前窗口加载命名路由页面，通过LocalStorage传递状态属性至加载页面，使用Promise异步回调。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

参数：

参数名	类型	必填	说明
name	string	是	命名路由页面的名称。
storage	LocalStorage	否	页面级UI状态存储单元，用于为加载到窗口的页面内容传递状态属性。默认值为空。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见窗口错误码。

错误码ID	错误信息
1300002	This window state is abnormal. Possible cause: The float view controller object is null.
1300016	Parameter error. Possible causes: Invalid name.

示例：

// Index.ets
import { BusinessError } from '@kit.BasicServicesKit';
import { entryName } from './Hello'; // 导入命名路由页面

@Entry
@Component
struct Index {
  private floatViewController: floatView.FloatViewController | undefined = undefined;
  // 创建控制器
  // ...
  public setUIContextByName(): void {
    try {
      this.floatViewController?.setUIContextByName(entryName).then(() => {
        console.info('Succeeded in loading the content.');
      }).catch((err: BusinessError): void => {
        console.error(`Failed to load the content. Cause code: ${err.code}, message: ${err.message}`);
      });
    } catch (e) {
      console.error(`Failed to load the content. Cause code: ${e.code}, message: ${e.message}`);
    }
  }
}

// Hello.ets
export const entryName : string = 'Hello';
@Entry({routeName: entryName, useSharedStorage: true})
@Component
export struct Hello {
  @State message: string = 'Hello World'
  build() {
    Row() {
      Column() {
        Text(this.message)
      }
      .width('100%')
    }
    .height('100%')
  }
}

setWindowSize

setWindowSize(size: window.Size): Promise<void>

设置标准悬浮窗窗口大小。建议先调用getFloatViewLimits接口获取推荐的宽高范围和宽高比范围，再根据推荐值调用本接口。窗口实际大小变化可通过onRectChange接口监听。使用Promise异步回调。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

参数：

参数名	类型	必填	说明
size	window.Size	是	表示窗口的大小。建议大小满足getFloatViewLimits接口返回的限制。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见窗口错误码。

错误码ID	错误信息
1300002	This window state is abnormal. Possible cause: The float view controller object is null.
1300003	This window manager service works abnormally. Possible cause: Internal IPC error.
1300016	Parameter error. Possible cause: The value of the size is less than or equal to 0.

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { window } from '@kit.ArkUI';

let size: window.Size = {
  width: 400,
  height: 600
};
try {
  this.floatViewController?.setWindowSize(size).then(() => {
    console.info('Succeeded in setting window size.');
  }).catch((err: BusinessError): void => {
    console.error(`Failed to set window size. Cause:${err.code}, message:${err.message}`);
  });
} catch(e) {
  console.error(`Failed to set window size. Cause:${e.code}, message:${e.message}`);
}

switchTemplate

switchTemplate(templateProperty: TemplateProperty): Promise<void>

切换标准悬浮窗的模板并改变其窗口尺寸。建议先调用getFloatViewLimits接口获取目标模板类型推荐的宽高范围和宽高比范围，再根据推荐值调用本接口。窗口实际大小变化可通过onRectChange接口监听。使用Promise异步回调。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

参数：

参数名	类型	必填	说明
templateProperty	TemplateProperty	是	表示需要切换的窗口模板类型及大小。建议大小满足getFloatViewLimits接口返回的限制。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见窗口错误码。

错误码ID	错误信息
1300002	This window state is abnormal. Possible cause: The float view controller object is null.
1300003	This window manager service works abnormally. Possible cause: Internal IPC error.
1300016	Parameter error. Possible cause: 1. Invalid template type. 2. The value of the size is less than or equal to 0.

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { window } from '@kit.ArkUI';

let newSize: window.Size = {
  width: 800,
  height: 100
};
let templateProperty: floatView.TemplateProperty = {
  templateType: floatView.FloatViewTemplateType.HORIZONTAL_BAR,
  size: newSize,
}
try {
  this.floatViewController?.switchTemplate(templateProperty).then(() => {
    console.info('Succeeded in switching window type and size.');
  }).catch((err: BusinessError): void => {
    console.error(`Failed to switch window type and size. Cause:${err.code}, message:${err.message}`);
  });
} catch(e) {
  console.error(`Failed to switch window type and size. Cause:${e.code}, message:${e.message}`);
}

start

start(): Promise<void>

启动标准悬浮窗窗口。接口返回不表示start流程结束，需要通过onStateChange接口监听到STARTED回调时判断启动成功。建议在调用setUIContext()或setUIContextByName()后调用start()。使用Promise异步回调。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

需要权限： ohos.permission.FLOAT_VIEW

系统能力： SystemCapability.Window.SessionManager

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见通用错误码和窗口错误码。

错误码ID	错误信息
201	Permission verification failed. Possible cause: The application does not have the permission required to call the API.
1300002	This window state is abnormal. Possible cause: The float view controller object is null.
1300003	This window manager service works abnormally. Possible cause: Internal IPC error.
1300030	Repeated operations on the float view. Possible cause: The float view is starting or has already started.
1300031	The float view state does not support this operation. Possible cause: The float view is stopping.
1300033	Failed to start float view. Possible causes: 1. Start multiple float views. 2. The main window of context is not foreground.
1300034	This operation conflicts with other floating windows. Possible cause: App has already started floating ball or pip window.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  this.floatViewController?.start().then(() => {
    console.info('Succeeded in starting float view.');
  }).catch((err: BusinessError): void => {
    console.error(`Failed to start float view. Cause:${err.code}, message:${err.message}`);
  });
} catch(e) {
  console.error(`Failed to start float view. Cause:${e.code}, message:${e.message}`);
}

stop

stop(): Promise<void>

停止标准悬浮窗窗口。接口返回不表示stop流程结束，需要通过onStateChange接口监听到STOPPED回调时判断停止成功。使用Promise异步回调。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见窗口错误码。

错误码ID	错误信息
1300002	This window state is abnormal. Possible cause: The float view controller object is null.
1300003	This window manager service works abnormally. Possible cause: Internal IPC error.
1300030	Repeated operations on the float view. Possible cause: The float view is stopping or has already stopped.
1300031	This operation is not supported on the float view in the current state. Possible cause: The float view window is not started.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  this.floatViewController?.stop().then(() => {
    console.info('Succeeded in stopping float view.');
  }).catch((err: BusinessError): void => {
    console.error(`Failed to stop float view. Cause:${err.code}, message:${err.message}`);
  });
} catch(e) {
  console.error(`Failed to stop float view. Cause:${e.code}, message:${e.message}`);
}

setFloatViewVisibilityInApp

setFloatViewVisibilityInApp(isVisible: boolean): Promise<void>

设置应用在前台时标准悬浮窗窗口是否可见。使用Promise异步回调。

创建标准悬浮窗后未调用此接口前，默认其在应用处于前台时为可见状态。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

参数：

参数名	类型	必填	说明
isVisible	boolean	是	应用在前台时标准悬浮窗是否可见，true表示可见，false表示不可见。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见窗口错误码。

错误码ID	错误信息
1300002	This window state is abnormal. Possible cause: The float view controller object is null.
1300003	This window manager service works abnormally. Possible cause: Internal IPC error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  this.floatViewController?.setFloatViewVisibilityInApp(true).then(() => {
    console.info('Succeeded in setting float view visibility in app.');
  }).catch((err: BusinessError): void => {
    console.error(`Failed to set float view visibility in app. Cause:${err.code}, message:${err.message}`);
  });
} catch(e) {
  console.error(`Failed to set float view visibility in app. Cause:${e.code}, message:${e.message}`);
}

restoreMainWindow

restoreMainWindow(wantParameters?: Record<string, Object>): Promise<void>

恢复标准悬浮窗的主窗口到前台显示。如果主窗口已处于前台时调用，将抬升主窗口层级。此接口只能在标准悬浮窗窗口被点击后使用。当主窗口处于PAUSED生命周期或处于多任务状态时，调用接口将抛出错误码1300032。使用Promise异步回调。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

参数：

参数名	类型	必填	说明
wantParameters	Record<string, Object>	否	恢复标准悬浮窗的主窗口时会给主窗口传递的自定义参数，主窗口会在触发onNewWant回调时收到。默认值为空，代表不向主窗传入任何自定义参数。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见窗口错误码。

错误码ID	错误信息
1300002	This window state is abnormal. Possible cause: The float view controller object is null.
1300003	This window manager service works abnormally. Possible cause: Internal IPC error.
1300031	This operation is not supported on the float view in the current state. Possible cause: The float view window is not started when restoring.
1300032	Failed to restore the main window. Possible cause: 1. User has never clicked the float view window before restore. 2. The float view window is not in the foreground. 3. The main window is in PAUSED lifecycle state. 4. The main window is in background during recent.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let param: Record<string, Object> = {
  "info": "helloworld",
};
// 标准悬浮窗状态需是STARTED
try {
  this.floatViewController?.restoreMainWindow(param).then(() => {
    console.info('Succeeded in restoring main window.');
  }).catch((err: BusinessError): void => {
    console.error(`Failed to restore main window. Cause:${err.code}, message:${err.message}`);
  });
} catch(e) {
  console.error(`Failed to restore main window. Cause:${e.code}, message:${e.message}`);
}

getWindowProperties

getWindowProperties(): FloatViewProperties

获取标准悬浮窗窗口的属性。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

返回值：

类型	说明
FloatViewProperties	返回标准悬浮窗窗口的属性。

错误码：

以下错误码的详细介绍请参见窗口错误码。

错误码ID	错误信息
1300002	This window state is abnormal. Possible cause: The float view controller object is null.
1300031	This operation is not supported on the float view in the current state. Possible cause: The float view window has not started, has stopped, or is in an error state.

示例：

try {
  let properties: floatView.FloatViewProperties | undefined = this.floatViewController?.getWindowProperties();
  console.info('Float view properties: ' + JSON.stringify(properties));
} catch(e) {
  console.error(`Failed to get window properties. Cause:${e.code}, message:${e.message}`);
}

onStateChange

onStateChange(callback: Callback<FloatViewStateChangeInfo>): void

注册标准悬浮窗状态变化的监听事件。不再使用时，取消监听以避免内存泄漏。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

参数：

参数名	类型	必填	说明
callback	Callback<FloatViewStateChangeInfo>	是	回调函数。返回当前的标准悬浮窗状态变化信息。

错误码：

以下错误码的详细介绍请参见窗口错误码。

错误码ID	错误信息
1300002	This window state is abnormal. Possible cause: The float view controller object is null.
1300030	Repeated operations on the float view. Possible cause: The callback has already registered.

示例：

let onStateChange = (info: floatView.FloatViewStateChangeInfo) => {
  console.info('Float view stateChange: ' + JSON.stringify(info));
};
try {
  this.floatViewController?.onStateChange(onStateChange);
} catch(e) {
  console.error(`Failed to on stateChange float view. Cause:${e.code}, message:${e.message}`);
}

offStateChange

offStateChange(callback?: Callback<FloatViewStateChangeInfo>): void

取消标准悬浮窗状态变化的监听事件。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

参数：

参数名	类型	必填	说明
callback	Callback<FloatViewStateChangeInfo>	否	回调函数。返回当前的标准悬浮窗状态变化信息。若传入参数，则停止该监听。若未传入参数，则停止所有标准悬浮窗状态变化的监听。

错误码：

以下错误码的详细介绍请参见窗口错误码。

错误码ID	错误信息
1300002	This window state is abnormal. Possible cause: The float view controller object is null.

示例：

let onStateChange = (info: floatView.FloatViewStateChangeInfo) => {
  console.info('Float view stateChange: ' + JSON.stringify(info));
};
try {
  this.floatViewController?.offStateChange(onStateChange);
} catch(e) {
  console.error(`Failed to off stateChange float view. Cause:${e.code}, message:${e.message}`);
}

onRectChange

onRectChange(callback: Callback<FloatViewRectChangeInfo>): void

注册标准悬浮窗矩形区域（位置和大小）变化的监听事件。不再使用时，取消监听以避免内存泄漏。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

参数：

参数名	类型	必填	说明
callback	Callback<FloatViewRectChangeInfo>	是	回调函数。返回当前的标准悬浮窗矩形区域变化信息。

错误码：

以下错误码的详细介绍请参见窗口错误码。

错误码ID	错误信息
1300002	This window state is abnormal. Possible cause: The float view controller object is null.
1300030	Repeated operations on the float view. Possible cause: The callback has already registered.

示例：

let onRectChange = (info: floatView.FloatViewRectChangeInfo) => {
  console.info('Float view rectChange: ' + JSON.stringify(info));
};
try {
  this.floatViewController?.onRectChange(onRectChange);
} catch(e) {
  console.error(`Failed to on rectChange float view. Cause:${e.code}, message:${e.message}`);
}

offRectChange

offRectChange(callback?: Callback<FloatViewRectChangeInfo>): void

取消标准悬浮窗矩形区域变化的监听事件。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

参数：

参数名	类型	必填	说明
callback	Callback<FloatViewRectChangeInfo>	否	回调函数。返回当前的标准悬浮窗矩形区域变化信息。若传入参数，则停止该监听。若未传入参数，则停止所有标准悬浮窗矩形区域变化的监听。

错误码：

以下错误码的详细介绍请参见窗口错误码。

错误码ID	错误信息
1300002	This window state is abnormal. Possible cause: The float view controller object is null.

示例：

let onRectChange = (info: floatView.FloatViewRectChangeInfo) => {
  console.info('Float view rectChange: ' + JSON.stringify(info));
};
try {
  this.floatViewController?.offRectChange(onRectChange);
} catch(e) {
  console.error(`Failed to off rectChange float view. Cause:${e.code}, message:${e.message}`);
}

onLimitsChange

onLimitsChange(callback: Callback<FloatViewLimits>): void

注册标准悬浮窗限制变化的监听事件，当限制规格变化时触发回调，例如设备折叠或者展开。不再使用时，取消监听以避免内存泄漏。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

参数：

参数名	类型	必填	说明
callback	Callback<FloatViewLimits>	是	回调函数。返回当前的标准悬浮窗限制变化信息。

错误码：

以下错误码的详细介绍请参见窗口错误码。

错误码ID	错误信息
1300002	This window state is abnormal. Possible cause: The float view controller object is null.
1300030	Repeated operations on the float view. Possible cause: The callback has already registered.

示例：

let onLimitsChange = (limits: floatView.FloatViewLimits) => {
  console.info('Float view limitsChange: ' + JSON.stringify(limits));
};
try {
  this.floatViewController?.onLimitsChange(onLimitsChange);
} catch(e) {
  console.error(`Failed to on limitsChange float view. Cause:${e.code}, message:${e.message}`);
}

offLimitsChange

offLimitsChange(callback?: Callback<FloatViewLimits>): void

取消标准悬浮窗限制变化的监听事件。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

参数：

参数名	类型	必填	说明
callback	Callback<FloatViewLimits>	否	回调函数。返回当前的标准悬浮窗限制变化信息。若传入参数，则停止该监听。若未传入参数，则停止所有标准悬浮窗限制变化的监听。

错误码：

以下错误码的详细介绍请参见窗口错误码。

错误码ID	错误信息
1300002	This window state is abnormal. Possible cause: The float view controller object is null.

示例：

let onLimitsChange = (limits: floatView.FloatViewLimits) => {
  console.info('Float view limitsChange: ' + JSON.stringify(limits));
};
try {
  this.floatViewController?.offLimitsChange(onLimitsChange);
} catch(e) {
  console.error(`Failed to off limitsChange float view. Cause:${e.code}, message:${e.message}`);
}

FloatViewTemplateType

标准悬浮窗模板类型的枚举。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

名称	值	说明
ROUNDED_RECTANGLE	0	圆角矩形。
HORIZONTAL_BAR	1	水平的条状矩形。

FloatViewProperties

标准悬浮窗窗口的属性。

起始版本： 26.0.0

系统能力： SystemCapability.Window.SessionManager

模型约束： 此接口仅可在Stage模型下使用。

名称	类型	只读	可选	说明
templateType	FloatViewTemplateType	否	否	标准悬浮窗的模板类型。
windowId	number	否	否	标准悬浮窗窗口ID。
displayId	number	否	否	标准悬浮窗所在屏幕ID。
windowRect	window.Rect	否	否	标准悬浮窗窗口矩形区域。
windowScale	number	否	否	标准悬浮窗窗口缩放比例。
avoidArea	window.AvoidArea	否	否	标准悬浮窗内容的避让区域。注意：通过setUIContext()或setUIContextByName()加载的页面中，位于避让区域的组件将不响应手势事件，添加需要手势响应事件的组件时，请注意避让这些区域。
inSidebar	boolean	否	否	标准悬浮窗是否在侧边栏中。true为在侧边栏中，false为不在侧边栏中。

RatioLimit

标准悬浮窗的宽高比限制范围。宽高比比值由窗口矩形区域的宽除以高获得。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

名称	类型	只读	可选	说明
minRatio	number	否	否	标准悬浮窗的宽高比最小值。
maxRatio	number	否	否	标准悬浮窗的宽高比最大值。

FloatViewLimits

标准悬浮窗窗口的限制。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

名称	类型	只读	可选	说明
minSize	window.Size	否	否	标准悬浮窗的最小尺寸。
maxSize	window.Size	否	否	标准悬浮窗的最大尺寸。
ratioLimits	Array<RatioLimit>	否	否	标准悬浮窗的宽高比限制范围。

FloatViewStateChangeInfo

标准悬浮窗状态变化信息。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

名称	类型	只读	可选	说明
state	FloatViewState	否	否	标准悬浮窗的状态。
stopReason	string	否	否	标准悬浮窗停止的原因。该参数仅在状态为FloatViewState.STOPPED时有效，在其他状态下默认为空字符串。停止原因和对应含义如下： "APP_STOP"：应用主动停止 "STOP_IN_SIDEBAR"：在侧边栏被关闭 "TITLE_BAR_STOP_CLICK"：标题栏点击关闭按钮 "DUMPSTER_STOP"：拖入垃圾桶停止 "REPLACE_STOP"：被其他标准悬浮窗挤占 "FLOATING_BALL_STOP"：绑定状态下跟随闪控球停止 "MAIN_WINDOW_DESTROY_STOP"：context关联的主窗被销毁后停止

FloatViewState

标准悬浮窗状态的枚举。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

名称	值	说明
STARTED	1	标准悬浮窗已启动并显示。
HIDDEN	2	标准悬浮窗已隐藏。上滑进入多任务界面时触发、使用setFloatViewVisibilityInApp接口设置了应用在前台时隐藏标准悬浮窗且应用处于前台时触发。
STOPPED	3	标准悬浮窗已停止。
IN_SIDEBAR	4	标准悬浮窗在侧边栏中。
IN_FLOATING_BALL	5	标准悬浮窗切换为闪控球。
ERROR	6	标准悬浮窗发生异常。

FloatViewRectChangeInfo

标准悬浮窗矩形区域变化信息。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Window.SessionManager

名称	类型	只读	可选	说明
windowRect	window.Rect	否	否	标准悬浮窗窗口矩形区域。
windowScale	number	否	否	标准悬浮窗窗口缩放比例。
reason	string	否	否	标准悬浮窗矩形区域变化的原因。原因和对应含义如下： "POSITION_CHANGE"：位置变化 "SIZE_CHANGE"：大小变化 "RECT_CHANGE"：位置大小同时变化