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

最新推荐文章于 2025-10-27 22:50:46 发布
原创 最新推荐文章于 2025-10-27 22:50:46 发布 · 1.1k 阅读 · 30 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#harmonyos #华为 #android #前端 #鸿蒙系统 #ArkUI #ArkTS

 往期鸿蒙5.0全套实战文章必看：（文中附带全栈鸿蒙5.0学习资料）

@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.
16200002The 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.
16200002The 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.
16200002The 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.
16200004The method has been 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.
16200005The method has not been 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返回的数据对象。

HarmonyOs DevEco Studio小技巧28--部分鸿蒙生命周期详解
hqy1989的博客
11-06 3949
自定义组件：@Component装饰的UI单元，可以组合多个系统组件实现UI的复用，可以调用组件的生命周期。页面：即应用的UI页面。可以由一个或者多个自定义组件组成，@Entry装饰的自定义组件为页面的入口组件，即页面的根节点，一个页面有且仅能有一个@Entry。只有被@Entry装饰的组件才可以调用页面的生命周期。
【鸿蒙开发基础学习】UIAbility 组件生命周期
专注移动开发
08-07 1232
当用户打开、切换和返回到对应应用时，应用中的 UIAbility 实例会在其生命周期的不同状态之间转换。UIAbility 类提供了一系列回调，通过这些回调可以知道当前 UIAbility 实例的某个状态发生改变，会经过 UIAbility 实例的创建和销毁，或者 UIAbility 实例发生了前后台的状态切换。UIAbility 的生命周期包括 Create、Foreground、Background、Destroy 四个状态，如下图所示。
HarmonyOS 5.0应用开发——UIAbility生命周期
高心星的专栏
12-05 1603
UIAbility组件是一种包含UI的应用组件，主要用于和用户交互。 UIAbility组件是系统调度的基本单元，为应用提供绘制界面的窗口。一个应用可以包含一个或多个UIAbility组件。例如，在支付应用中，可以将入口功能和收付款功能分别配置为独立的UIAbility。
HarmonyOS 应用开发之跨端迁移保姆级教程~(1)，2024年最新科学技术协会面试题
2401_84159966的博客
04-20 927
当需要迁移的数据较大（100KB以上）时，也可以选择分布式文件进行数据迁移。支持应用动态选择迁移成功后是否退出迁移源端应用（默认迁移成功后退出迁移源端应用）。如果应用不想让系统自动退出迁移源端应用，则可以设置不退出，参数定义见 SUPPORT_CONTINUE_SOURCE_EXIT_KEY。如果应用不想使用系统默认恢复的页面栈，则可以设置不进行页面栈迁移，而需要在。应用在源端的页面栈中存在Index和Second路由，而在对端恢复时不需要按照源端页面栈进行恢复，需要恢复到指定页面。
鸿蒙5.0&next开发【通过router或call事件刷新卡片内容】开发卡片事件
bbq的博客
01-22 828
使用router事件，点击卡片可拉起对应应用的UIAbility至前台，并刷新卡片。使用call事件，点击卡片可拉起对应应用的UIAbility至后台，并刷新卡片。在卡片页面中可以通过[postCardAction]接口触发router事件或者call事件拉起UIAbility，然后由UIAbility刷新卡片内容，下面是这种刷新方式的简单示例。
鸿蒙NEXT开发：Stage模型能力的接口-@ohos.app.ability.AbilityConstant (AbilityConstant)
ZPYQAQ的博客
02-20 653
AbilityConstant提供UIAbility相关的枚举........
鸿蒙NEXT开发：Stage模型能力的接口-@ohos.app.ability.AbilityStage (AbilityStage)
ZPYQAQ的博客
02-21 690
AbilityStage是HAP的运行时类。
鸿蒙NEXT开发：Stage模型能力的接口-@ohos.app.ability.application (Application)
ZPYQAQ的博客
02-21 790
本模块接口仅可在Stage模型下使用。
鸿蒙NEXT开发：Stage模型能力的接口-@ohos.app.ability.ApplicationStateChangeCallback (ApplicationStateChangeCallba
ZPYQAQ的博客
02-21 345
ApplicationStateChangeCallback模块提供应用上下文ApplicationContext对当前应用前后台变化监听回调的能力。
鸿蒙NEXT开发：ArkData数据管理-@ohos.data.unifiedDataChannel (标准化数据通路)
ZPYQAQ的博客
03-04 1104
本模块为统一数据管理框架（Unified Data Management Framework,UDMF）的组成部分......
HarmonyOS Next开发学习手册——自由流转
maniuT的博客
07-26 1514
随着全场景多设备的生活方式不断深入，用户拥有的设备越来越多，不同设备都能在适合的场景下提供良好的体验，例如手表可以提供及时的信息查看能力，电视可以带来沉浸的观影体验。但是，每个设备也有使用场景的局限，例如在电视上输入文本相对移动设备来说是非常糟糕的体验。当多个设备通过分布式操作系统能够相互感知、进而整合成一个超级终端时，设备与设备之间就可以取长补短、相互帮助，为用户提供更加自然流畅的分布式体验。在HarmonyOS中，将跨多设备的分布式操作统称为流转；
鸿蒙原生应用/元服务开发-Stage模型能力接口（九）上
weixin_69135651的博客
12-21 1441
系统能力：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.AbilityCore。系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore。系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore。系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore。
鸿蒙Ability Kit（程序框架服务）【UIAbility组件生命周期】
鸿蒙的技术博客
05-30 1650
当用户打开、切换和返回到对应应用时，应用中的UIAbility实例会在其生命周期的不同状态之间转换。UIAbility类提供了一系列回调，通过这些回调可以知道当前UIAbility实例的某个状态发生改变，会经过UIAbility实例的创建和销毁，或者UIAbility实例发生了前后台的状态切换。UIAbility的生命周期包括Create、Foreground、Background、Destroy四个状态，如下图所示。UIAbility生命周期状态。
HarmonyOS SDK API 常用模块对应关系
wisdomroc的博客
10-17 1544
但是我的Matepad SE 2024只能连接旧版本的DevEcoStudio4.0.0.600，对应的为API9。这样就可以开始学习HarmonyOS SDK啦！(注意：Page的入口也是在这个文件呦)改为↓↓↓↓↓↓↓↓。
HarmonyOS实战开发：UIAbility组件生命周期
2401_84194030的博客
04-23 1206
UIAbility的生命周期包括Create、Foreground、Background、Destroy四个状态......
基于原生能力的跨应用跳转
hongxiaomeng的博客
06-04 626
鸿蒙5.0开发进阶：FA模型-@ohos.ability.ability (Ability)
Androidbye的博客
11-20 599
Ability模块将二级模块API组织在一起方便开发者进行导出。
鸿蒙API14开发【@ohos.InputMethodExtensionAbility (InputMethodExtensionAbility】卡片开发服务
鸿蒙的技术博客
03-11 330
本模块支持开发者自行开发输入法应用，以及管理输入法应用的生命周期。
可直接落地的「Flutter 桥接鸿蒙 WebSocket」端到端实施方案
最新发布
Code Captain的专栏
10-27 353
Flutter桥接鸿蒙WebSocket端到端方案，已在HarmonyOS NEXT 3.0/Flutter 3.16-ohos验证。实现包含：1）精简JSON协议设计；2）Flutter端Dart封装，提供连接/发送/关闭方法；3）鸿蒙ArkTS插件实现WebSocket功能；4）优化并发安全与性能，支持多连接、大文件传输和自动心跳。方案可直接集成或作为独立插件使用，实测2MB数据传输耗时<30ms。
"D:\DevEco Studio\tools\node\node.exe" "D:\DevEco Studio\tools\hvigor\bin\hvigorw.js" --mode module -p module=entry@default -p product=default -p pageType=page -p compileResInc=true -p requiredDeviceType=phone -p previewMode=true -p buildRoot=.preview PreviewBuild --watch -报错很多-analyze=normal --parallel --incremental --daemon > hvigor ERROR: Failed :entry:default@CangjiePreBuild... > hvigor ERROR: Module-srcEntry 'ohos_app_cangjie_entry.MyAbilityStage' not found. Detail: Make sure ohos_app_cangjie_entry.MyAbilityStage exists. at D:\devecostudioprojects\MyApplication123\entry\src\main\module.json5 > hvigor ERROR: BUILD FAILED in 153 ms Process finished with exit code -1
09-14
根据引用[1]，仓颉插件提供了HarmonyOS NEXT应用开发的能力。请确保你使用的DevEco Studio版本与仓颉插件版本兼容。可以在`.hvigor`文件夹下检查`cangjie-build-support`的版本是否正确。 4. **清理并重新构建** ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值