UIExtensionContext (系统接口)
UIExtensionContext是UIExtensionAbility的上下文环境,继承自ExtensionContext,提供UIExtensionAbility的相关配置信息以及操作UIAbility的方法,如启动UIAbility等。
说明:
- 本模块首批接口从API version 12开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
- 本模块接口仅可在Stage模型下使用。
- 本模块接口为系统接口。
导入模块
import { common } from '@kit.AbilityKit';
UIExtensionContext.startAbilityForResultAsCaller
startAbilityForResultAsCaller(want: Want, options?: StartOptions): Promise<AbilityResult>
使用设置的caller信息启动一个Ability,caller信息由want携带,在系统服务层识别,Ability可以在onCreate生命周期的want参数中获取到caller信息。使用该接口启动一个Ability时,want的caller信息不会被当前自身的应用信息覆盖,系统服务层可获取到初始caller的信息。使用Promise异步回调。
- 正常情况下可通过调用terminateSelfWithResult接口使之终止并且返回结果给调用方。
- 异常情况下比如杀死Ability会返回异常信息给调用方, 异常信息中resultCode为-1。
- 如果被启动的Ability模式是单实例模式, 不同应用多次调用该接口启动这个Ability,当这个Ability调用terminateSelfWithResult接口使之终止时,只将正常结果返回给最后一个调用方, 其它调用方返回异常信息, 异常信息中resultCode为-1。
说明:
组件启动规则详见:组件启动规则(Stage模型)。
模型约束:此接口仅可在Stage模型下使用。
系统接口:此接口为系统接口。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| want | Want | 是 | 启动Ability的want信息。 |
| options | StartOptions | 否 | 启动Ability所携带的参数。 |
返回值:
| 类型 | 说明 |
|---|---|
| Promise<AbilityResult> | Promise对象,返回Ability结果对象。 |
错误码:
| 错误码ID | 错误信息 |
|---|---|
| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
| 16000001 | The specified ability does not exist. |
| 16000004 | Failed to start the invisible ability. |
| 16000050 | Internal error. |
| 16000073 | The app clone index is invalid. |
示例:
import { UIExtensionAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
export default class UIExtension extends UIExtensionAbility {
onForeground() {
this.context.startAbilityForResultAsCaller({
bundleName: 'com.example.startabilityforresultascaller',
abilityName: 'EntryAbility',
moduleName: 'entry'
}).then((data) => {
console.log('=======>startAbilityForResultAsCaller data Promise ======>' + JSON.stringify(data));
}).catch((error: BusinessError) => {
console.log('=======>startAbilityForResultAsCaller error.code Promise ======>' + error.code);
});
}
}