鸿蒙5.0开发进阶:Stage模型-@ohos.app.ability.UIAbility (UIAbility)

HarmonyOS 应用开发之UIAbility组件间交互(设备内) 一个UIAbility可以对应多个页面,在不同的场景下启动该UIAbility时需要展示不同的页面,例如从一个UIAbility的页面中跳转到另外一个UIAbility时,希望启动目标UIAbility的指定页面。UIAbility的启动分为两种情况:UIAbility冷启动和UIAbility热启动。UIAbility冷启动:指的是UIAbility实例处于完全关闭状态下被启动,这需要完整地加载和初始化UIAbility实例的代码、资源等。 阅读详情

往期鸿蒙全套实战文章必看:(文中附带全栈鸿蒙学习资料)


@ohos.app.ability.UIAbility (UIAbility)

UIAbility是包含UI界面的应用组件,继承自Ability,提供组件创建、销毁、前后台切换等生命周期回调,同时也具备组件协同的能力,组件协同主要提供如下常用功能:

  • Caller:由startAbilityByCall接口返回,CallerAbility(调用者)可使用Caller与CalleeAbility(被调用者)进行通信。
  • Callee:UIAbility的内部对象,CalleeAbility(被调用者)可以通过Callee与Caller进行通信。

说明

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

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

导入模块

import { UIAbility } from '@kit.AbilityKit';

属性

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

名称类型只读可选说明
contextUIAbilityContext否否

上下文。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

launchWantWant否否

UIAbility启动时的参数。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

lastRequestWantWant否否

UIAbility最后请求时的参数。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

calleeCallee否否调用Stub(桩)服务对象。

UIAbility.onCreate

onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void

UIAbility实例处于完全关闭状态下被创建完成后进入该生命周期回调,执行初始化业务逻辑操作。即UIAbility实例冷启动时进入该生命周期回调。同步接口,不支持异步回调。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
wantWant是当前UIAbility的Want类型信息,包括ability名称、bundle名称等。
launchParamAbilityConstant.LaunchParam是创建 ability、上次异常退出的原因信息。

示例:

import { UIAbility, AbilityConstant, Want } from '@kit.AbilityKit';

class MyUIAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
    console.log(`onCreate, want: ${want.abilityName}`);
  }
}

UIAbility.onWindowStageCreate

onWindowStageCreate(windowStage: window.WindowStage): void

当WindowStage创建后调用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
windowStagewindow.WindowStage是WindowStage相关信息。

示例:

import { UIAbility } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';

class MyUIAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    console.log('onWindowStageCreate');
  }
}

UIAbility.onWindowStageWillDestroy12+

onWindowStageWillDestroy(windowStage: window.WindowStage): void

当WindowStage即将销毁时调用。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
windowStagewindow.WindowStage是WindowStage相关信息。

示例:

import { UIAbility } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';

class MyUIAbility extends UIAbility {
  onWindowStageWillDestroy(windowStage: window.WindowStage) {
    console.log('onWindowStageWillDestroy');
  }
}

UIAbility.onWindowStageDestroy

onWindowStageDestroy(): void

当WindowStage销毁后调用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

示例:


import { UIAbility } from '@kit.AbilityKit';

class MyUIAbility extends UIAbility {
onWindowStageDestroy() {
console.log('onWindowStageDestroy');
}
}

UIAbility.onWindowStageRestore

onWindowStageRestore(windowStage: window.WindowStage): void

当迁移多实例ability时,恢复WindowStage后调用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
windowStagewindow.WindowStage是WindowStage相关信息。

示例:


import { UIAbility } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';

class MyUIAbility extends UIAbility {
onWindowStageRestore(windowStage: window.WindowStage) {
console.log('onWindowStageRestore');
}
}

UIAbility.onDestroy

onDestroy(): void | Promise<void>

UIAbility生命周期回调,在销毁时回调,执行资源清理等操作。使用同步回调或Promise异步回调。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

返回值:

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

示例:

import { UIAbility } from '@kit.AbilityKit';

class MyUIAbility extends UIAbility {
onDestroy() {
console.log('onDestroy');
}
}

在执行完onDestroy生命周期回调后,应用可能会退出,从而可能导致onDestroy中的异步函数未能正确执行,比如异步写入数据库。可以使用异步生命周期,以确保异步onDestroy完成后再继续后续的生命周期。

import { UIAbility } from '@kit.AbilityKit';

class MyUIAbility extends UIAbility {
async onDestroy() {
console.log('onDestroy');
// 调用异步函数...
}
}

UIAbility.onForeground

onForeground(): void

UIAbility生命周期回调,当应用从后台转到前台时触发。同步接口,不支持异步回调。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

示例:

import { UIAbility } from '@kit.AbilityKit';

class MyUIAbility extends UIAbility {
onForeground() {
console.log('onForeground');
}
}

UIAbility.onBackground

onBackground(): void

UIAbility生命周期回调,当应用从前台转到后台时触发。同步接口,不支持异步回调。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

示例:

import { UIAbility } from '@kit.AbilityKit';

class MyUIAbility extends UIAbility {
onBackground() {
console.log('onBackground');
}
}

UIAbility.onContinue

onContinue(wantParam: Record<string, Object>): AbilityConstant.OnContinueResult | Promise<AbilityConstant.OnContinueResult>

当Ability准备迁移时触发,保存数据。

说明

从API version 12 开始,UIAbility.onContinue生命周期新增支持返回值为Promise<AbilityConstant.OnContinueResult>形式。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
wantParamRecord<string, Object>是want相关参数。

返回值:

类型说明
AbilityConstant.OnContinueResult | Promise<AbilityConstant.OnContinueResult>接续的结果或带接续结果的Promise对象。

示例:

import { UIAbility, AbilityConstant } from '@kit.AbilityKit';

class MyUIAbility extends UIAbility {
    onContinue(wantParams: Record<string, Object>) {
        console.log('onContinue');
        wantParams['myData'] = 'my1234567';
        return AbilityConstant.OnContinueResult.AGREE;
    }
}

支持应用在迁移时,使用异步接口进行数据保存。

import { UIAbility, AbilityConstant } from '@kit.AbilityKit';

class MyUIAbility extends UIAbility {
  async setWant(wantParams: Record<string, Object>) {
    console.log('setWant start');
    for (let time = 0; time < 1000; ++time) {
      wantParams[time] = time;
    }
    console.log('setWant end');
  }

  async onContinue(wantParams: Record<string, Object>) {
      console.log('onContinue');
      return this.setWant(wantParams).then(()=>{
        return AbilityConstant.OnContinueResult.AGREE;
      });
  }
}

UIAbility.onNewWant

onNewWant(want: Want, launchParam: AbilityConstant.LaunchParam): void

UIAbility实例已经启动并在前台运行过,由于某些原因切换到后台,再次启动该UIAbility实例时会回调执行该方法。即UIAbility实例热启动时进入该生命周期回调。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
wantWant是Want类型参数,如ability名称,包名等。
launchParamAbilityConstant.LaunchParam是UIAbility启动的原因、上次异常退出的原因信息。

示例:

import { UIAbility, AbilityConstant, Want } from '@kit.AbilityKit';

class MyUIAbility extends UIAbility {
onNewWant(want: Want, launchParam: AbilityConstant.LaunchParam) {
console.log(`onNewWant, want: ${want.abilityName}`);
console.log(`onNewWant, launchParam: ${JSON.stringify(launchParam)}`);
}
}

UIAbility.onDump

onDump(params: Array<string>): Array<string>

转储客户端信息时调用,可用于转储非敏感信息。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
paramsArray<string>是表示命令形式的参数。

返回值:

类型说明
Array<string>转储信息数组。

示例:

import { UIAbility } from '@kit.AbilityKit';

class MyUIAbility extends UIAbility {
  onDump(params: Array<string>) {
    console.log(`dump, params: ${JSON.stringify(params)}`);
    return ['params'];
  }
}

UIAbility.onSaveState

onSaveState(reason: AbilityConstant.StateType, wantParam: Record<string, Object>): AbilityConstant.OnSaveResult

该API配合appRecovery使用。在应用故障时,如果使能了自动保存状态,框架将回调onSaveState保存UIAbility状态。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
reasonAbilityConstant.StateType是回调保存状态的原因。
wantParamRecord<string, Object>是want相关参数。

返回值:

类型说明
AbilityConstant.OnSaveResult是否同意保存当前UIAbility的状态。

示例:

import { UIAbility, AbilityConstant } from '@kit.AbilityKit';

class MyUIAbility extends UIAbility {
  onSaveState(reason: AbilityConstant.StateType, wantParam: Record<string, Object>) {
    console.log('onSaveState');
    wantParam['myData'] = 'my1234567';
    return AbilityConstant.OnSaveResult.RECOVERY_AGREE;
  }
}

UIAbility.onShare10+

onShare(wantParam: Record<string, Object>): void

在跨端分享场景下,在UIAbility中设置分享方设备要分享的数据。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
wantParamRecord<string, Object>是待分享的数据。

示例:

import { UIAbility } from '@kit.AbilityKit';

class MyUIAbility extends UIAbility {
onShare(wantParams: Record<string, Object>) {
console.log('onShare');
wantParams['ohos.extra.param.key.shareUrl'] = 'example.com';
}
}

UIAbility.onPrepareToTerminate10+

onPrepareToTerminate(): boolean

UIAbility生命周期回调,当系统预关闭开关打开后(配置系统参数persist.sys.prepare_terminate为true打开),在UIAbility关闭时触发,可在回调中定义操作来决定是否继续执行关闭UIAbility的操作。如果UIAbility在退出时需要与用户交互确认是否关闭UIAbility,可在此生命周期回调中定义预关闭操作配合terminateSelf接口退出,如弹窗确认是否关闭,并配置预关闭生命周期返回true取消正常关闭。

需要权限:ohos.permission.PREPARE_APP_TERMINATE

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

返回值:

类型说明
boolean是否执行UIAbility关闭操作,返回true表示本次UIAbility关闭流程取消,不再退出,返回false表示UIAbility继续正常关闭。

示例:

import { UIAbility, Want } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

export default class EntryAbility extends UIAbility {
onPrepareToTerminate() {
// 开发者定义预关闭动作
// 例如拉起另一个ability,根据ability处理结果执行异步关闭
let want: Want = {
bundleName: "com.example.myapplication",
moduleName: "entry",
abilityName: "SecondAbility"
}
this.context.startAbilityForResult(want)
.then((result)=>{
// 获取ability处理结果,当返回结果的resultCode为0关闭当前UIAbility
console.log('startAbilityForResult success, resultCode is ' + result.resultCode);
if (result.resultCode === 0) {
this.context.terminateSelf();
}
}).catch((err: BusinessError)=>{
// 异常处理
console.error('startAbilityForResult failed, err:' + JSON.stringify(err));
this.context.terminateSelf();
})

return true; // 已定义预关闭操作后,返回true表示UIAbility取消关闭
}
}

UIAbility.onBackPressed10+

onBackPressed(): boolean

UIAbility生命周期回调,当UIAbility侧滑返回时触发,根据返回值决定是否销毁UIAbility。

  • 当targetSdkVersion<12时,默认返回值为false,会销毁UIAbility。
  • 当targetSdkVersion>=12时,默认返回值为true,会将UIAbility移动到后台不销毁。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

返回值:

类型说明
boolean返回true表示UIAbility将会被移到后台不销毁,返回false表示UIAbility将正常销毁。

示例:

import { UIAbility } from '@kit.AbilityKit';

export default class EntryAbility extends UIAbility {
onBackPressed() {
return true;
}
}

Caller

通用组件Caller通信客户端调用接口, 用来向通用组件服务端发送约定数据。

Caller.call

call(method: string, data: rpc.Parcelable): Promise<void>

向通用组件服务端发送约定序列化数据。使用Promise异步回调。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
methodstring是约定的服务端注册事件字符串。
datarpc.Parcelable是由开发者实现的Parcelable可序列化数据。

返回值:

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

错误码:

以下错误码详细介绍

错误码ID错误信息
401Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
16200001Caller released. The caller has been released.
16200002Callee invalid. The callee does not exist.
16000050Internal error.

示例:

import { UIAbility, Caller } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
import { rpc } from '@kit.IPCKit';
import { BusinessError } from '@kit.BasicServicesKit';

class MyMessageAble implements rpc.Parcelable { // 自定义的Parcelable数据结构
  name: string
  str: string
  num: number = 1
  constructor(name: string, str: string) {
    this.name = name;
    this.str = str;
  }
  marshalling(messageSequence: rpc.MessageSequence) {
    messageSequence.writeInt(this.num);
    messageSequence.writeString(this.str);
    console.log(`MyMessageAble marshalling num[${this.num}] str[${this.str}]`);
    return true;
  }
  unmarshalling(messageSequence: rpc.MessageSequence) {
    this.num = messageSequence.readInt();
    this.str = messageSequence.readString();
    console.log(`MyMessageAble unmarshalling num[${this.num}] str[${this.str}]`);
    return true;
  }
};
let method = 'call_Function'; // 约定的通知消息字符串
let caller: Caller;

export default class MainUIAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    this.context.startAbilityByCall({
      bundleName: 'com.example.myservice',
      abilityName: 'MainUIAbility',
      deviceId: ''
    }).then((obj) => {
      caller = obj;
      let msg = new MyMessageAble('msg', 'world'); // 参考Parcelable数据定义
      caller.call(method, msg)
        .then(() => {
          console.log('Caller call() called');
        })
        .catch((callErr: BusinessError) => {
          console.error(`Caller.call catch error, error.code: ${callErr.code}, error.message: ${callErr.message}`);
        });
    }).catch((err: BusinessError) => {
      console.error(`Caller GetCaller error, error.code: ${err.code}, error.message: ${err.message}`);
    });
  }
}

Caller.callWithResult

callWithResult(method: string, data: rpc.Parcelable): Promise<rpc.MessageSequence>

向通用组件服务端发送约定序列化数据, 并将服务端返回的约定序列化数据带回。使用Promise异步回调。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
methodstring是约定的服务端注册事件字符串。
datarpc.Parcelable是由开发者实现的Parcelable可序列化数据。

返回值:

类型说明
Promise<rpc.MessageSequence>Promise对象,返回通用组件服务端应答数据。

错误码:

以下错误码详细介绍

错误码ID错误信息
401Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
16200001Caller released. The caller has been released.
16200002Callee invalid. The callee does not exist.
16000050Internal error.

示例:


import { UIAbility, Caller } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
import { rpc } from '@kit.IPCKit';
import { BusinessError } from '@kit.BasicServicesKit';

class MyMessageAble implements rpc.Parcelable {
name: string
str: string
num: number = 1
constructor(name: string, str: string) {
this.name = name;
this.str = str;
}
marshalling(messageSequence: rpc.MessageSequence) {
messageSequence.writeInt(this.num);
messageSequence.writeString(this.str);
console.log(`MyMessageAble marshalling num[${this.num}] str[${this.str}]`);
return true;
}
unmarshalling(messageSequence: rpc.MessageSequence) {
this.num = messageSequence.readInt();
this.str = messageSequence.readString();
console.log(`MyMessageAble unmarshalling num[${this.num}] str[${this.str}]`);
return true;
}
};
let method = 'call_Function';
let caller: Caller;

export default class MainUIAbility extends UIAbility {
onWindowStageCreate(windowStage: window.WindowStage) {
this.context.startAbilityByCall({
bundleName: 'com.example.myservice',
abilityName: 'MainUIAbility',
deviceId: ''
}).then((obj) => {
caller = obj;
let msg = new MyMessageAble('msg', 'world');
caller.callWithResult(method, msg)
.then((data) => {
console.log('Caller callWithResult() called');
let retmsg = new MyMessageAble('msg', 'world');
data.readParcelable(retmsg);
})
.catch((callErr: BusinessError) => {
console.error(`Caller.callWithResult catch error, error.code: ${callErr.code}, error.message: ${callErr.message}`);
});
}).catch((err: BusinessError) => {
console.error(`Caller GetCaller error, error.code: ${err.code}, error.message: ${err.message}`);
});
}
}

Caller.release

release(): void

主动释放通用组件服务端的通信接口。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

错误码:

以下错误码详细介绍

错误码ID错误信息
16200001Caller released. The caller has been released.
16200002Callee invalid. The callee does not exist.

示例:

import { UIAbility, Caller } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';

let caller: Caller;

export default class MainUIAbility extends UIAbility {
onWindowStageCreate(windowStage: window.WindowStage) {
this.context.startAbilityByCall({
bundleName: 'com.example.myservice',
abilityName: 'MainUIAbility',
deviceId: ''
}).then((obj) => {
caller = obj;
try {
caller.release();
} catch (releaseErr) {
console.error(`Caller.release catch error, error.code: ${releaseErr.code}, error.message: ${releaseErr.message}`);
}
}).catch((err: BusinessError) => {
console.error(`Caller GetCaller error, error.code: ${err.code}, error.message: ${err.message}`);
});
}
}

Caller.onRelease

onRelease(callback: OnReleaseCallback): void

注册通用组件服务端Stub(桩)断开监听通知。使用callback异步回调。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
callbackOnReleaseCallback是回调函数,返回onRelease回调结果。

错误码:

以下错误码详细介绍

错误码ID错误信息
401Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
16200001Caller released. The caller has been released.

示例:

import { UIAbility, Caller } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';

let caller: Caller;

export default class MainUIAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    this.context.startAbilityByCall({
      bundleName: 'com.example.myservice',
      abilityName: 'MainUIAbility',
      deviceId: ''
    }).then((obj) => {
      caller = obj;
      try {
        caller.onRelease((str) => {
          console.log(`Caller OnRelease CallBack is called ${str}`);
        });
      } catch (error) {
        console.error(`Caller.onRelease catch error, error.code: $error.code}, error.message: ${error.message}`);
      }
    }).catch((err: BusinessError) => {
      console.error(`Caller GetCaller error, error.code: ${err.code}, error.message: ${err.message}`);
    });
  }
}

Caller.onRemoteStateChange10+

onRemoteStateChange(callback: OnRemoteStateChangeCallback): void

注册协同场景下跨设备组件状态变化监听通知。使用callback异步回调。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
callbackOnRemoteStateChangeCallback是回调函数,返回onRemoteStateChange回调结果。

错误码:

以下错误码详细介绍

错误码ID错误信息
401Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
16200001Caller released. The caller has been released.

示例:

import { UIAbility, Caller } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';

let caller: Caller;
let dstDeviceId: string;

export default class MainAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    this.context.startAbilityByCall({
      bundleName: 'com.example.myservice',
      abilityName: 'MainUIAbility',
      deviceId: dstDeviceId
    }).then((obj) => {
      caller = obj;
      try {
        caller.onRemoteStateChange((str) => {
          console.log('Remote state changed ' + str);
        });
      } catch (error) {
        console.error(`Caller.onRemoteStateChange catch error, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}`);
      }
    }).catch((err: BusinessError) => {
      console.error(`Caller GetCaller error, error.code: ${JSON.stringify(err.code)}, error.message: ${JSON.stringify(err.message)}`);
    })
  }
}

Caller.on('release')

on(type: 'release', callback: OnReleaseCallback): void

注册通用组件服务端Stub(桩)断开监听通知。使用callback异步回调。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
typestring是监听releaseCall事件,固定为'release'。
callbackOnReleaseCallback是回调函数,返回on回调结果。

错误码:

以下错误码详细介绍

错误码ID错误信息
401Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
16200001Caller released. The caller has been released.

示例:

import { UIAbility, Caller } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';

let caller: Caller;

export default class MainUIAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    this.context.startAbilityByCall({
      bundleName: 'com.example.myservice',
      abilityName: 'MainUIAbility',
      deviceId: ''
    }).then((obj) => {
      caller = obj;
      try {
        caller.on('release', (str) => {
          console.log(`Caller OnRelease CallBack is called ${str}`);
        });
      } catch (error) {
        console.error(`Caller.on catch error, error.code: ${error.code}, error.message: ${error.message}`);
      }
    }).catch((err: BusinessError) => {
      console.error(`Caller GetCaller error, error.code: ${err.code}, error.message: ${err.message}`);
    });
  }
}

Caller.off('release')

off(type: 'release', callback: OnReleaseCallback): void

取消注册通用组件服务端Stub(桩)断开监听通知。预留能力,当前暂未支持。使用callback异步回调。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
typestring是监听releaseCall事件,固定为'release'。
callbackOnReleaseCallback是回调函数,返回off回调结果。

错误码:

以下错误码详细介绍

错误码ID错误信息
401Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

import { UIAbility, Caller, OnReleaseCallback } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';

let caller: Caller;

export default class MainUIAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    this.context.startAbilityByCall({
      bundleName: 'com.example.myservice',
      abilityName: 'MainUIAbility',
      deviceId: ''
    }).then((obj) => {
      caller = obj;
      try {
        let onReleaseCallBack: OnReleaseCallback = (str) => {
          console.log(`Caller OnRelease CallBack is called ${str}`);
        };
        caller.on('release', onReleaseCallBack);
        caller.off('release', onReleaseCallBack);
      } catch (error) {
        console.error(`Caller.on or Caller.off catch error, error.code: ${error.code}, error.message: ${error.message}`);
      }
    }).catch((err: BusinessError) => {
      console.error(`Caller GetCaller error, error.code: ${err.code}, error.message: ${err.message}`);
    });
  }
}

Caller.off('release')

off(type: 'release'): void

取消注册通用组件服务端Stub(桩)断开监听通知。预留能力,当前暂未支持。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
typestring是监听releaseCall事件,固定为'release'。

错误码:

以下错误码详细介绍

错误码ID错误信息
401Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

import { UIAbility, Caller, OnReleaseCallback } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';

let caller: Caller;

export default class MainUIAbility extends UIAbility {
onWindowStageCreate(windowStage: window.WindowStage) {
this.context.startAbilityByCall({
bundleName: 'com.example.myservice',
abilityName: 'MainUIAbility',
deviceId: ''
}).then((obj) => {
caller = obj;
try {
let onReleaseCallBack: OnReleaseCallback = (str) => {
console.log(`Caller OnRelease CallBack is called ${str}`);
};
caller.on('release', onReleaseCallBack);
caller.off('release');
} catch (error) {
console.error(`Caller.on or Caller.off catch error, error.code: ${error.code}, error.message: ${error.message}`);
}
}).catch((err: BusinessError) => {
console.error(`Caller GetCaller error, error.code: ${err.code}, error.message: ${err.message}`);
});
}
}

Callee

通用组件服务端注册和解除客户端caller通知送信的callback接口。

Callee.on

on(method: string, callback: CalleeCallback): void

通用组件服务端注册消息通知callback。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
methodstring是与客户端约定的通知消息字符串。
callbackCalleeCallback是一个rpc.MessageSequence类型入参的js通知同步回调函数, 回调函数至少要返回一个空的rpc.Parcelable数据对象, 其他视为函数执行错误。

错误码:

以下错误码详细介绍

错误码ID错误信息
401Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
16200004Method registered. The method has registered.
16000050Internal error.

示例:

import { UIAbility, AbilityConstant, Want } from '@kit.AbilityKit';
import { rpc } from '@kit.IPCKit';

class MyMessageAble implements rpc.Parcelable {
  name: string
  str: string
  num: number = 1
  constructor(name: string, str: string) {
    this.name = name;
    this.str = str;
  }
  marshalling(messageSequence: rpc.MessageSequence) {
    messageSequence.writeInt(this.num);
    messageSequence.writeString(this.str);
    console.log(`MyMessageAble marshalling num[${this.num}] str[${this.str}]`);
    return true;
  }
  unmarshalling(messageSequence: rpc.MessageSequence) {
    this.num = messageSequence.readInt();
    this.str = messageSequence.readString();
    console.log(`MyMessageAble unmarshalling num[${this.num}] str[${this.str}]`);
    return true;
  }
};
let method = 'call_Function';

function funcCallBack(pdata: rpc.MessageSequence) {
  console.log(`Callee funcCallBack is called ${pdata}`);
  let msg = new MyMessageAble('test', '');
  pdata.readParcelable(msg);
  return new MyMessageAble('test1', 'Callee test');
}
export default class MainUIAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
    console.log('Callee onCreate is called');
    try {
      this.callee.on(method, funcCallBack);
    } catch (error) {
      console.error(`Callee.on catch error, error.code: ${error.code}, error.message: ${error.message}`);
    }
  }
}

Callee.off

off(method: string): void

解除通用组件服务端注册消息通知callback。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
methodstring是已注册的通知事件字符串。

错误码:

以下错误码详细介绍

错误码ID错误信息
401Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
16200005Method not registered. The method has not registered.
16000050Internal error.

示例:

import { UIAbility, AbilityConstant, Want } from '@kit.AbilityKit';

let method = 'call_Function';

export default class MainUIAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
    console.log('Callee onCreate is called');
    try {
      this.callee.off(method);
    } catch (error) {
      console.error(`Callee.off catch error, error.code: ${error.code}, error.message: ${error.message}`);
    }
  }
}

OnReleaseCallback

(msg: string)

(msg: string): void

注册通用组件服务端Stub(桩)断开监听通知的回调函数类型。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
msgstring是用于传递释放消息。

OnRemoteStateChangeCallback10+

(msg: string)

(msg: string): void

注册协同场景下跨设备组件状态变化监听通知的回调函数类型。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
msgstring是用于传递释放消息。

CalleeCallback

(indata: rpc.MessageSequence)

(indata: rpc.MessageSequence): rpc.Parcelable

通用组件服务端注册消息通知的回调函数类型。

系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore

参数:

参数名类型必填说明
indatarpc.MessageSequence是发送需传递的数据。

返回值:

类型说明
rpc.Parcelable返回的数据对象。

鸿蒙NEXT开发:Stage模型能力的接口-@ohos.app.ability.AbilityConstant (AbilityConstant) AbilityConstant提供UIAbility相关的枚举........ 阅读详情

相关推荐

鸿蒙NEXT开发:Stage模型能力的接口-@ohos.app.ability.UIAbility (UIAbility)

UIAbility是包含UI界面的应用组件.................

ZPYQAQ的博客 1228

HarmonyOS实战开发:@ohos.app.ability.UIAbility (UIAbility)

UIAbility是包含UI界面的应用组件

2401_84194030的博客 1021

鸿蒙NEXT开发:Stage模型能力的接口-@ohos.app.ability.childProcessManager (childProcessManager)

childProcessManager模块提供子进程管理能力,支持子进程启动操作。

ZPYQAQ的博客 944

HarmonyOS4.0系统性深入开发03UIAbility组件详解(中)

UIAbility组件的基本用法包括:指定UIAbility的启动页面以及获取UIAbility的上下文。

qq_46189388的博客 1809

鸿蒙NEXT开发:Stage模型能力的接口-@ohos.app.ability.InsightIntentExecutor (意图调用执行基类)

本模块提供意图调用执行基类.............

ZPYQAQ的博客 886

【华为鸿蒙系统学习】- 从零到一:基于Stage模型与DevEco Studio的鸿蒙App开发实战指南

本文详细介绍了基于华为鸿蒙系统的Stage模型与DevEco Studio的App开发实战指南。从开发环境搭建、Stage模型优势到项目创建流程和核心配置文件解析,帮助开发者快速掌握鸿蒙App开发技巧,提升开发效率。

weixin_33966095的博客 521

HarmonyOS/OpenHarmony应用开发-Stage模型UIAbility组件使用(六)

HarmonyOS/OpenHarmony应用开发-Stage模型UIAbility组件使用(六)

weixin_69135651的博客 1583

OpenHarmony实战开发-@ohos.app.ability.Ability (Ability基类)

UIAbility和ExtensionAbility的基类,提供系统配置更新回调和系统内存调整回调。不支持开发者直接继承该基类。说明:本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。本模块接口仅可在Stage模型下使用。

m0_70749039的博客 824

鸿蒙5.0开发进阶:Stage模型-@ohos.app.ability.AbilityConstant (AbilityConstant)

AbilityConstant提供UIAbility相关的枚举,包括设置初次启动原因、上次退出原因、迁移结果、窗口类型等。

Androidbye的博客 965

【AAAI 2025】轻量级特征增强新范式!FCM 模块助力小目标检测,即插即用提升模型泛化能力

本文介绍了AAAI 2025提出的轻量级特征增强新范式FCM模块,它通过显式分离并双向交互语义与空间特征,有效解决了小目标检测中特征信息失配的核心难题。该模块设计精巧,计算开销极低,能够即插即用式地嵌入YOLO等主流检测网络,显著提升模型对小目标的泛化检测能力,尤其适用于遥感、自动驾驶等对计算资源敏感的实际场景。

weixin_29056145的博客 291

别再为电路自激发愁了:手把手教你用吸波材料搞定微波腔体谐振(附HFSS仿真设置)

本文详细解析了微波腔体谐振问题的工程解决方案,重点介绍了吸波材料的选型、安装工艺及HFSS仿真设置。通过实际案例和计算工具,帮助射频工程师有效抑制腔体自激,提升系统稳定性。特别适用于35GHz毫米波雷达等高频电路设计场景。

weixin_42662293的博客 384

鸿蒙5.0开发进阶:Stage模型-@ohos.app.ability.Ability (Ability基类)

UIAbility和ExtensionAbility的基类,提供系统配置更新回调和系统内存调整回调。

Androidbye的博客 604

阻抗匹配与史密斯(Smith)圆图

在找到点B和B'后,我们就能够测量A'到B和B'到D的弧长,前者就是C的归一化电纳值,后者为L的归一化电抗值。当然,表面上看新的点好像是一个不同的阻抗,实际上Z和1/Y表示的是同一个元件(这个新值在圆图上呈现为一个不同的点,而且反射系数也不相同,依次类推)。出现这种情况的原因是我们的图形本身是一个阻抗图,而新的点代表的是一个导纳。这个方程是在复平面(Γr, Γi)上、圆的参数方程(x - a)² + (y - b)² = R²,它以[r/(r + 1), 0]为圆心,半径为1/(1 + r)。

qq_55759599的博客 3963

鸿蒙5.0开发进阶:Stage模型-@ohos.app.ability.InsightIntentExecutor (意图调用执行基类)

本模块提供意图调用执行基类,开发者通过意图调用执行基类对接端侧意图框架,实现响应意图调用的业务逻辑。

Androidbye的博客 1223

自动配胶机的PLC控制系统设计

我们根据自动配胶机的控制需求,编写了相应的PLC程序。PID温度控制算法的实现方面,我们采用了经典的PID控制算法,通过不断调整加热器的功率,实现对胶水混合温度的精确控制。在PLC程序中,我们编写了PID控制算法的程序模块,通过实时采集温度传感器的数据,计算温度偏差和偏差变化率,并根据PID控制算法计算出加热器的功率输出值,实现对温度的精确控制。在系统调试阶段,我们对自动配胶机的各个部分进行了详细的测试和调试,包括气路和液路的开关测试、传感器的精度测试、步进电机的位置和速度测试以及PLC程序的逻辑测试等。

lagougongzuoshi的博客 1228

BAPI_REPMANCONF1_CREATE_MTS实战:从MFBF事务码到精准零件反冲的代码级解析

本文深入解析了如何通过BAPI_REPMANCONF1_CREATE_MTS函数实现SAP生产模块中的零件反冲自动化。文章对比了MFBF事务码的手动操作与BAPI编程的优劣,详细拆解了函数的核心参数、数据结构、调用流程及事务控制,并提供了从数据准备到凭证获取的完整代码示例与避坑指南,帮助开发者实现高效、精准的批量投料过账。

weixin_29240343的博客 195

鸿蒙5.0开发进阶:Stage模型-@ohos.app.ability.abilityLifecycleCallback (AbilityLifecycleCallback)

AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命周期发生变化时触发相应回调的能力。

Androidbye的博客 971

【一看就会】Autoware.universe的“规划”部分源码梳理【0】——Planning综述(持续更新中)

单独开一篇planning综述,作为整个规划系列的开篇。本篇综述会持续更新,希望能帮助大家更好的整体理解规划部分。这个部分会持续更新。

weixin_48386130的博客 1967

鸿蒙NEXT开发:Stage模型能力的接口-@ohos.app.ability.abilityLifecycleCallback (AbilityLifecycleCallback)

AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命周期发生变化时触发相应回调的能力。

ZPYQAQ的博客 904

量化 insider 爆料! 散户打板必亏?(打板必看!量化资金如何“隔日砸盘”收割散户)

量化开发 insider 爆料💥 散户追的涨停板📉,可能是机构故意做的陷阱!本文从技术视角拆解“涨停陷阱”,帮你看清市场真实逻辑🧠。

XiaoqiangClub的博客 459

手把手写深度学习(27):如果获得相机位姿态的plücker embedding?以RealEstate10K为例

用plücker embedding表示相机的位姿是一种非常常用的方法,这篇博客以RealEstate10K数据集为例子,详细讲解如何从相机的轨迹坐标中获得plücker embedding,用于下一步模型的学习。

沉迷单车的追风少年 2241

鸿蒙NEXT开发:Stage模型能力的接口-@ohos.app.ability.Ability (Ability基类)

UIAbility和ExtensionAbility的基类,提供系统配置更新回调和系统内存调整回调。

ZPYQAQ的博客 593

最新的sdio 4.0 spec 协议标准 带书签 高清完整PDF版

Part-E1-SDIO-Specification-Ver4.00-Final-120220.pdf:最新的sdio 4.0 spec 协议标准 带书签 高清完整PDF版,包括SDIO 接口的外设,SDIO 接口官方协议等。

鸿蒙API14开发【@ohos.app.ability.AbilityConstant (AbilityConstant)】应用框架api

AbilityConstant提供UIAbility相关的枚举,包括设置初次启动原因、上次退出原因、迁移结果、窗口类型等。

bbq的博客 746

ET2012新版免狗免安装绿色软件

ET2012新版免狗免安祖昂绿色软件。,新界面,新视觉,

SAP B1中文培訓教材_SDK

公司内部培训资料,对开发工具 ,DIAPI, UIAPI,Add-ON有详细解说

鸿蒙NEXT开发:Stage模型能力的接口-@ohos.app.ability.EmbeddableUIAbility (可嵌入式UIAbility)

EmbeddableUIAbility是为元服务提供可以嵌入式启动的UIAbility...........

ZPYQAQ的博客 423

老版QQ原生表情gif动态

这是老版的QQ表情,不过全是动态的的,Windows照片查看器是不会动的,可以右击用浏览器打开查看,再说一遍是老版的,只是分享给宁愿用老版也要动态的人。

鸿蒙API13开发【@ohos.app.ability.AbilityConstant (AbilityConstant)】Stage模型能力的接口

AbilityConstant提供UIAbility相关的枚举,包括设置初次启动原因、上次退出原因、迁移结果、窗口类型等。

鸿蒙的技术博客 975
上一篇: 鸿蒙5.0开发进阶:Stage模型-@ohos.app.ability.StartOptions (StartOptions)
下一篇: 鸿蒙5.0开发进阶:Stage模型-@ohos.app.ability.UIExtensionAbility (带界面扩展能力基类)
懂你的大海
博客等级 码龄6年 9049粉丝 1381原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值