Ability

Ability模塊提供對Ability生命周期、上下文環境等調用管理的能力，包括Ability創建、銷毀、轉儲客戶端信息等。

該模塊提供以下Ability相關的常用功能：

• [Caller]：通用組件Caller通信客戶端調用接口, 用來向通用組件服務端發送約定數據。
• [Callee]：通用組件服務端注冊和解除客戶端caller通知送信的callback接口。

說明：

本模塊首批接口從API version 9 開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。
本模塊接口僅可在Stage模型下使用。

導入模塊

import Ability from '@ohos.application.Ability';

鴻蒙開發指導文檔：[qr23.cn/FBD4cY]

屬性

系統能力 ：以下各項對應的系統能力均為SystemCapability.Ability.AbilityRuntime.AbilityCore

Ability.onCreate

onCreate(want: Want, param: AbilityConstant.LaunchParam): void;

Ability創建時回調，執行初始化業務邏輯操作。

系統能力 ：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數：

示例：

class myAbility extends Ability {
    onCreate(want, param) {
        console.log('onCreate, want:' + want.abilityName);
    }
}

Ability.onWindowStageCreate

onWindowStageCreate(windowStage: window.WindowStage): void

當WindowStage創建后調用。

系統能力 ：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數：

示例：

class myAbility extends Ability {
    onWindowStageCreate(windowStage) {
        console.log('onWindowStageCreate');
    }
}

Ability.onWindowStageDestroy

onWindowStageDestroy(): void

當WindowStage銷毀后調用。

系統能力 ：SystemCapability.Ability.AbilityRuntime.AbilityCore

示例：

class myAbility extends Ability {
    onWindowStageDestroy() {
        console.log('onWindowStageDestroy');
    }
}

Ability.onWindowStageRestore

onWindowStageRestore(windowStage: window.WindowStage): void

當遷移多實例ability時，恢復WindowStage后調用。

系統能力 ：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數：

示例：

class myAbility extends Ability {
    onWindowStageRestore(windowStage) {
        console.log('onWindowStageRestore');
    }
}

Ability.onDestroy

onDestroy(): void;

Ability生命周期回調，在銷毀時回調，執行資源清理等操作。

系統能力 ：SystemCapability.Ability.AbilityRuntime.AbilityCore

示例：

class myAbility extends Ability {
    onDestroy() {
        console.log('onDestroy');
    }
}

Ability.onForeground

onForeground(): void;

Ability生命周期回調，當應用從后臺轉到前臺時觸發。

系統能力 ：SystemCapability.Ability.AbilityRuntime.AbilityCore

示例：

class myAbility extends Ability {
    onForeground() {
        console.log('onForeground');
    }
}

Ability.onBackground

onBackground(): void;

Ability生命周期回調，當應用從前臺轉到后臺時觸發。

系統能力 ：SystemCapability.Ability.AbilityRuntime.AbilityCore

示例：

class myAbility extends Ability {
    onBackground() {
        console.log('onBackground');
    }
}

Ability.onContinue

onContinue(wantParam : {[key: string]: any}): AbilityConstant.OnContinueResult;

當ability遷移準備遷移時觸發，保存數據。

系統能力 ：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數：

返回值：

示例：

import AbilityConstant from "@ohos.application.AbilityConstant"
class myAbility extends Ability {
    onContinue(wantParams) {
        console.log('onContinue');
        wantParams["myData"] = "my1234567";
        return AbilityConstant.OnContinueResult.AGREE;
    }
}

Ability.onNewWant

onNewWant(want: Want): void;

當ability的啟動模式設置為單例時回調會被調用。

系統能力 ：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數：

示例：

class myAbility extends Ability {
    onNewWant(want) {
        console.log('onNewWant, want:' + want.abilityName);
    }
}

Ability.onConfigurationUpdated

onConfigurationUpdated(config: Configuration): void;

當系統配置更新時調用。

系統能力 ：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數：

示例：

class myAbility extends Ability {
    onConfigurationUpdated(config) {
        console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
    }
}

Ability.dump

dump(params: Array): Array;

轉儲客戶端信息時調用。

系統能力 ：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數：

示例：

class myAbility extends Ability {
    dump(params) {
        console.log('dump, params:' + JSON.stringify(params));
        return ["params"]
    }
}

Caller

通用組件Caller通信客戶端調用接口, 用來向通用組件服務端發送約定數據。

Caller.call

call(method: string, data: rpc.Sequenceable): Promise;

向通用組件服務端發送約定序列化數據。

系統能力 ：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數：

返回值：

示例：

import Ability from '@ohos.application.Ability';
class MyMessageAble{ // 自定義的Sequenceable數據結構
    name:""
    str:""
    num: 1
    constructor(name, str) {
      this.name = name;
      this.str = str;
    }
    marshalling(messageParcel) {
        messageParcel.writeInt(this.num);
        messageParcel.writeString(this.str);
        console.log('MyMessageAble marshalling num[' + this.num + '] str[' + this.str + ']');
        return true;
    }
    unmarshalling(messageParcel) {
        this.num = messageParcel.readInt();
        this.str = messageParcel.readString();
        console.log('MyMessageAble unmarshalling num[' + this.num + '] str[' + this.str + ']');
        return true;
    }
};
var method = 'call_Function'; // 約定的通知消息字符串
var caller;
export default class MainAbility extends Ability {
    onWindowStageCreate(windowStage) {
      this.context.startAbilityByCall({
          bundleName: "com.example.myservice",
          abilityName: "MainAbility",
          deviceId: ""
      }).then((obj) = > {
          caller = obj;
          let msg = new MyMessageAble(1, "world"); // 參考Sequenceable數據定義
          caller.call(method, msg)
              .then(() = > {
                  console.log('Caller call() called');
              }).catch((e) = > {
              console.log('Caller call() catch error ' + e);
          });
          console.log('Caller GetCaller Get ' + caller);
      }).catch((e) = > {
          console.log('Caller GetCaller error ' + e);
      });
    }
    
}

Caller.callWithResult

callWithResult(method: string, data: rpc.Sequenceable): Promise;

向通用組件服務端發送約定序列化數據, 并將服務端返回的約定序列化數據帶回。

系統能力 ：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數：

返回值：

示例：

import Ability from '@ohos.application.Ability';
class MyMessageAble{
    name:""
    str:""
    num: 1
    constructor(name, str) {
      this.name = name;
      this.str = str;
    }
    marshalling(messageParcel) {
        messageParcel.writeInt(this.num);
        messageParcel.writeString(this.str);
        console.log('MyMessageAble marshalling num[' + this.num + '] str[' + this.str + ']');
        return true;
    }
    unmarshalling(messageParcel) {
        this.num = messageParcel.readInt();
        this.str = messageParcel.readString();
        console.log('MyMessageAble unmarshalling num[' + this.num + '] str[' + this.str + ']');
        return true;
    }
};
var method = 'call_Function';
var caller;
export default class MainAbility extends Ability {
    onWindowStageCreate(windowStage) {
      this.context.startAbilityByCall({
          bundleName: "com.example.myservice",
          abilityName: "MainAbility",
          deviceId: ""
      }).then((obj) = > {
          caller = obj;
          let msg = new MyMessageAble(1, "world");
          caller.callWithResult(method, msg)
              .then((data) = > {
                  console.log('Caller callWithResult() called');
                  let retmsg = new MyMessageAble(0, "");
                  data.readSequenceable(retmsg);
              }).catch((e) = > {
              console.log('Caller callWithResult() catch error ' + e);
          });
          console.log('Caller GetCaller Get ' + caller);
      }).catch((e) = > {
          console.log('Caller GetCaller error ' + e);
      });
    }
}

Caller.release

release(): void;

主動釋放通用組件服務端的通信接口。

系統能力 ：SystemCapability.Ability.AbilityRuntime.AbilityCore

示例：

import Ability from '@ohos.application.Ability';
var caller;
export default class MainAbility extends Ability {
    onWindowStageCreate(windowStage) {
      this.context.startAbilityByCall({
          bundleName: "com.example.myservice",
          abilityName: "MainAbility",
          deviceId: ""
      }).then((obj) = > {
          caller = obj;
          try {
              caller.release();
          } catch (e) {
              console.log('Caller Release error ' + e);
          }
          console.log('Caller GetCaller Get ' + caller);
      }).catch((e) = > {
          console.log('Caller GetCaller error ' + e);
      });
    }
}

Caller.onRelease

onRelease(callback: OnReleaseCallBack): void;

注冊通用組件服務端Stub（樁）斷開監聽通知。

系統能力 ：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數：

示例：

import Ability from '@ohos.application.Ability';
var caller;
export default class MainAbility extends Ability {
    onWindowStageCreate(windowStage) {
      this.context.startAbilityByCall({
          bundleName: "com.example.myservice",
          abilityName: "MainAbility",
          deviceId: ""
      }).then((obj) = > {
          caller = obj;
          try {
              caller.onRelease((str) = > {
                  console.log(' Caller OnRelease CallBack is called ' + str);
              });
          } catch (e) {
              console.log('Caller Release error ' + e);
          }
          console.log('Caller GetCaller Get ' + caller);
      }).catch((e) = > {
          console.log('Caller GetCaller error ' + e);
      });
    }
}

Callee

通用組件服務端注冊和解除客戶端caller通知送信的callback接口。

Callee.on

on(method: string, callback: CaleeCallBack): void;

通用組件服務端注冊消息通知callback。

系統能力 ：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數：

示例：

import Ability from '@ohos.application.Ability';
class MyMessageAble{
    name:""
    str:""
    num: 1
    constructor(name, str) {
      this.name = name;
      this.str = str;
    }
    marshalling(messageParcel) {
        messageParcel.writeInt(this.num);
        messageParcel.writeString(this.str);
        console.log('MyMessageAble marshalling num[' + this.num + '] str[' + this.str + ']');
        return true;
    }
    unmarshalling(messageParcel) {
        this.num = messageParcel.readInt();
        this.str = messageParcel.readString();
        console.log('MyMessageAble unmarshalling num[' + this.num + '] str[' + this.str + ']');
        return true;
    }
};
var method = 'call_Function';
function funcCallBack(pdata) {
    console.log('Callee funcCallBack is called ' + pdata);
    let msg = new MyMessageAble(0, "");
    pdata.readSequenceable(msg);
    return new MyMessageAble(10, "Callee test");
}
export default class MainAbility extends Ability {
    onCreate(want, launchParam) {
        console.log('Callee onCreate is called');
        this.callee.on(method, funcCallBack);
    }
}

Callee.off

off(method: string): void;

解除通用組件服務端注冊消息通知callback。

系統能力 ：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數：

示例：

import Ability from '@ohos.application.Ability';
var method = 'call_Function';
export default class MainAbility extends Ability {
    onCreate(want, launchParam) {
        console.log('Callee onCreate is called');
        this.callee.off(method);
    }
}

OnReleaseCallBack

(msg: string): void;

系統能力 ：SystemCapability.Ability.AbilityRuntime.AbilityCore

CaleeCallBack

(indata: rpc.MessageParcel): rpc.Sequenceable;

系統能力 ：SystemCapability.Ability.AbilityRuntime.AbilityCore

審核編輯 黃宇