@ohos.app.ability.UIExtensionContentSession (带界面扩展能力界面操作类)

UIExtensionContentSession是UIExtensionAbility加载界面内容时创建的实例对象，当UIExtensionComponent控件拉起指定的UIExtensionAbility时，UIExtensionAbility会创建UIExtensionContentSession对象，并通过onSessionCreate回调传递给开发者。一个UIExtensionComponent控件对应一个UIExtensionContentSession对象，提供界面加载，结果通知等方法。每个UIExtensionAbility的UIExtensionContentSession之间互不影响，可以各自进行操作。

说明：

本模块首批接口从API version 10 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

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

导入模块

import UIExtensionContentSession from '@ohos.app.ability.UIExtensionContentSession';

UIExtensionContentSession.loadContent

loadContent(path: string, storage?: LocalStorage): void

为当前UIExtensionComponent控件对应的窗口加载与LocalStorage相关联的具体页面内容。

系统能力： SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名 类型 必填 说明
path string 是 设置加载页面的路径。
storage LocalStorage 否 存储单元，为应用程序范围内的可变状态属性和非可变状态属性提供存储。默认为空。

错误码：

错误码ID 错误信息
16000050 Internal error.

错误码详细介绍请参考元能力子系统错误码。

UIExtensionContentSession.terminateSelf

terminateSelf(callback: AsyncCallback<void>): void

停止UIExtensionContentSession对应的窗口界面对象。使用callback异步回调。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名 类型 必填 说明
callback AsyncCallback<void> 是 回调函数。当停止UIExtensionContentSession对应的窗口界面对象成功，err为undefined，否则为错误对象。

UIExtensionContentSession.terminateSelf

terminateSelf(): Promise<void>

停止UIExtensionContentSession对应的窗口界面对象。使用Promise异步回调。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

返回值：

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

UIExtensionContentSession.terminateSelfWithResult

terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback<void>): void

停止UIExtensionContentSession对应的窗口界面对象，并将结果返回给UIExtensionComponent控件。使用callback异步回调。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名 类型 必填 说明
parameter AbilityResult 是 返回给UIExtensionComponent控件的信息。
callback AsyncCallback<void> 是 回调函数。当停止成功，err为undefined，否则为错误对象。

UIExtensionContentSession.terminateSelfWithResult

terminateSelfWithResult(parameter: AbilityResult): Promise<void>

停止UIExtensionContentSession对应的窗口界面对象，并将结果返回给UIExtensionComponent控件。使用Promise异步回调。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名 类型 必填 说明
parameter AbilityResult 是 返回给UIExtensionComponent控件的信息。

返回值：

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

UIExtensionContentSession.setWindowPrivacyMode

setWindowPrivacyMode(isPrivacyMode: boolean): Promise<void>

设置窗口是否为隐私模式。设置为隐私模式的窗口，窗口内容将无法被截屏或录屏。使用Promise异步回调。

系统能力： SystemCapability.Ability.AbilityRuntime.Core

需要权限： ohos.permission.PRIVACY_WINDOW

参数：

参数名 类型 必填 说明
isPrivacyMode boolean 是 窗口是否为隐私模式。true表示模式开启；false表示模式关闭。

返回值：

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

UIExtensionContentSession.setWindowPrivacyMode

setWindowPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback<void>): void

设置窗口是否为隐私模式。设置为隐私模式的窗口，窗口内容将无法被截屏或录屏。使用callback异步回调。

系统能力： SystemCapability.Ability.AbilityRuntime.Core

需要权限： ohos.permission.PRIVACY_WINDOW

参数：

参数名 类型 必填 说明
isPrivacyMode boolean 是 窗口是否为隐私模式。true表示模式开启；false表示模式关闭。
callback AsyncCallback<void> 是 回调函数。当设置成功，err为undefined，否则为错误对象。

UIExtensionContentSession.startAbilityByType11+

startAbilityByType(type: string, wantParam: Record<string, Object>, abilityStartCallback: AbilityStartCallback, callback: AsyncCallback<void>): void

通过type隐式启动UIExtensionAbility。使用callback异步回调。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名 类型 必填 说明
type string 是 显示拉起的UIExtensionAbility类型。
wantParam Record<string, Object> 是 表示扩展参数。
abilityStartCallback AbilityStartCallback 是 回调函数，返回启动失败后的详细错误信息。
callback AsyncCallback<void> 是 回调函数。当启动Ability成功，err为undefined，否则为错误对象。

错误码：

错误码ID 错误信息
16000001 The specified ability does not exist.
16000002 Incorrect ability type.
16000004 Can not start invisible component.
16000050 Internal error.
16200001 The caller has been released.

错误码详细介绍请参考元能力子系统错误码。

UIExtensionContentSession.startAbilityByType11+

startAbilityByType(type: string, wantParam: Record<string, Object>, abilityStartCallback: AbilityStartCallback): Promise<void>

通过type隐式启动UIExtensionAbility。使用Promise异步回调。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名 类型 必填 说明
type string 是 显示拉起的UIExtensionAbility类型。
wantParam Record<string, Object> 是 表示扩展参数。
abilityStartCallback AbilityStartCallback 是 回调函数，返回启动失败后的详细错误信息。

返回值：

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

错误码：

错误码ID 错误信息
16000001 The specified ability does not exist.
16000002 Incorrect ability type.
16000004 Can not start invisible component.
16000050 Internal error.
16200001 The caller has been released.

错误码详细介绍请参考元能力子系统错误码。