提供組件創(chuàng)建、銷毀、前后臺切換等生命周期回調(diào)

導(dǎo)入模塊

import Ability from '@ohos.app.ability.UIAbility';

屬性

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為SystemCapability.Ability.AbilityRuntime.AbilityCore

UIAbility.onCreate

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

Ability創(chuàng)建時回調(diào)，執(zhí)行初始化業(yè)務(wù)邏輯操作。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數(shù)：

示例：

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

UIAbility.onWindowStageCreate

onWindowStageCreate(windowStage: window.WindowStage): void

當WindowStage創(chuàng)建后調(diào)用。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數(shù)：

示例：

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

UIAbility.onWindowStageDestroy

onWindowStageDestroy(): void

當WindowStage銷毀后調(diào)用。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

示例：

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

UIAbility.onWindowStageRestore

onWindowStageRestore(windowStage: window.WindowStage): void

當遷移多實例ability時，恢復(fù)WindowStage后調(diào)用。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數(shù)：

示例：

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

UIAbility.onDestroy

onDestroy(): void | Promise<void>;

Ability生命周期回調(diào)，在銷毀時回調(diào)，執(zhí)行資源清理等操作。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

示例：

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

UIAbility.onForeground

onForeground(): void;

Ability生命周期回調(diào)，當應(yīng)用從后臺轉(zhuǎn)到前臺時觸發(fā)。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

示例：

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

UIAbility.onBackground

onBackground(): void;

Ability生命周期回調(diào)，當應(yīng)用從前臺轉(zhuǎn)到后臺時觸發(fā)。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

示例：

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

UIAbility.onContinue

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

當ability遷移準備遷移時觸發(fā)，保存數(shù)據(jù)。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數(shù)：

返回值：

示例：

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

UIAbility.onNewWant

onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void;

當傳入新的Want，ability再次被拉起時會回調(diào)執(zhí)行該方法。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數(shù)：

示例：

 class MyUIAbility extends Ability {
    onNewWant(want, launchParams) {
        console.log('onNewWant, want:' + want.abilityName);
        console.log('onNewWant, launchParams:' + JSON.stringify(launchParams));
     }
 }

UIAbility.onDump

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

轉(zhuǎn)儲客戶端信息時調(diào)用。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數(shù)：

示例：

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

UIAbility.onSaveState

onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: Object}): AbilityConstant.OnSaveResult;

該API配合appRecovery使用。在應(yīng)用故障時，如果使能了自動保存狀態(tài)，框架將回調(diào)onSaveState保存Ability狀態(tài)。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數(shù)：

返回值：

示例：

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

class MyUIAbility extends Ability {
  onSaveState(reason, wantParam) {
      console.log('onSaveState');
      wantParam['myData'] = 'my1234567';
      return AbilityConstant.OnSaveResult.RECOVERY_AGREE;
  }
}

Caller

通用組件Caller通信客戶端調(diào)用接口, 用來向通用組件服務(wù)端發(fā)送約定數(shù)據(jù)。

Caller.call

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

向通用組件服務(wù)端發(fā)送約定序列化數(shù)據(jù)。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數(shù)：

返回值：

錯誤碼：

示例：

class MyMessageAble{ // 自定義的Parcelable數(shù)據(jù)結(jié)構(gòu)
  name:''
  str:''
  num: 1
  constructor(name, str) {
    this.name = name;
    this.str = str;
  }
  marshalling(messageSequence) {
    messageSequence.writeInt(this.num);
    messageSequence.writeString(this.str);
    console.log('MyMessageAble marshalling num[' + this.num + '] str[' + this.str + ']');
    return true;
  }
  unmarshalling(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;
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('msg', 'world'); // 參考Parcelable數(shù)據(jù)定義
      caller.call(method, msg)
        .then(() => {
          console.log('Caller call() called');
        })
        .catch((callErr) => {
          console.log('Caller.call catch error, error.code: ' + JSON.stringify(callErr.code) +
            ' error.message: ' + JSON.stringify(callErr.message));
        });
    }).catch((err) => {
      console.log('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) +
        ' error.message: ' + JSON.stringify(err.message));
    });
  }
}

Caller.callWithResult

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

向通用組件服務(wù)端發(fā)送約定序列化數(shù)據(jù), 并將服務(wù)端返回的約定序列化數(shù)據(jù)帶回。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數(shù)：

返回值：

錯誤碼：

示例：

class MyMessageAble{
  name:''
  str:''
  num: 1
  constructor(name, str) {
    this.name = name;
    this.str = str;
  }
  marshalling(messageSequence) {
    messageSequence.writeInt(this.num);
    messageSequence.writeString(this.str);
    console.log('MyMessageAble marshalling num[' + this.num + '] str[' + this.str + ']');
    return true;
  }
  unmarshalling(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;
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.readParcelable(retmsg);
        })
        .catch((callErr) => {
          console.log('Caller.callWithResult catch error, error.code: ' + JSON.stringify(callErr.code) +
            ' error.message: ' + JSON.stringify(callErr.message));
        });
    }).catch((err) => {
      console.log('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) +
        ' error.message: ' + JSON.stringify(err.message));
    });
  }
}

Caller.release

release(): void;

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

系統(tǒng)能力：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore

錯誤碼：

示例：

let 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 (releaseErr) {
        console.log('Caller.release catch error, error.code: ' + JSON.stringify(releaseErr.code) +
          ' error.message: ' + JSON.stringify(releaseErr.message));
      }
    }).catch((err) => {
      console.log('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) +
        ' error.message: ' + JSON.stringify(err.message));
    });
  }
}

Caller.onRelease

onRelease(callback: OnReleaseCallback): void;

注冊通用組件服務(wù)端Stub（樁）斷開監(jiān)聽通知。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數(shù)：

示例：

let 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 (error) {
          console.log('Caller.onRelease catch error, error.code: ' + JSON.stringify(error.code) +
            ' error.message: ' + JSON.stringify(error.message));
        }
    }).catch((err) => {
      console.log('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) +
        ' error.message: ' + JSON.stringify(err.message));
    });
  }
}

Caller.on

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

注冊通用組件服務(wù)端Stub（樁）斷開監(jiān)聽通知。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數(shù)：

錯誤碼：

示例：

let 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.on('release', (str) => {
              console.log(' Caller OnRelease CallBack is called ' + str);
          });
        } catch (error) {
          console.log('Caller.on catch error, error.code: ' + JSON.stringify(error.code) +
            ' error.message: ' + JSON.stringify(error.message));
        }
    }).catch((err) => {
      console.log('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) +
        ' error.message: ' + JSON.stringify(err.message));
    });
  }
}

Caller.off

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

取消注冊通用組件服務(wù)端Stub（樁）斷開監(jiān)聽通知。預(yù)留能力，當前暫未支持。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數(shù)：

錯誤碼：

示例：

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

Caller.off

off(type: 'release'): void;

取消注冊通用組件服務(wù)端Stub（樁）斷開監(jiān)聽通知。預(yù)留能力，當前暫未支持。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數(shù)：

錯誤碼：

示例：

let caller;
export default class MainUIAbility extends Ability {
  onWindowStageCreate(windowStage) {
    this.context.startAbilityByCall({
      bundleName: 'com.example.myservice',
      abilityName: 'MainUIAbility',
      deviceId: ''
    }).then((obj) => {
        caller = obj;
        try {
          let 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: ' + JSON.stringify(error.code) +
            ' error.message: ' + JSON.stringify(error.message));
        }
    }).catch((err) => {
      console.error('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) +
        ' error.message: ' + JSON.stringify(err.message));
    });
  }
}

Callee

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

Callee.on

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

通用組件服務(wù)端注冊消息通知callback。

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

參數(shù)：

錯誤碼：

示例：

class MyMessageAble{
    name:''
    str:''
    num: 1
    constructor(name, str) {
      this.name = name;
      this.str = str;
    }
    marshalling(messageSequence) {
        messageSequence.writeInt(this.num);
        messageSequence.writeString(this.str);
        console.log('MyMessageAble marshalling num[' + this.num + '] str[' + this.str + ']');
        return true;
    }
    unmarshalling(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) {
    console.log('Callee funcCallBack is called ' + pdata);
    let msg = new MyMessageAble('test', '');
    pdata.readParcelable(msg);
    return new MyMessageAble('test1', 'Callee test');
}
export default class MainAbility extends Ability {
  onCreate(want, launchParam) {
    console.log('Callee onCreate is called');
    try {
      this.callee.on(method, funcCallBack);
    } catch (error) {
      console.log('Callee.on catch error, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
    }
  }
}

Callee.off

off(method: string): void;

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

系統(tǒng)能力：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore

參數(shù)：

錯誤碼：

示例：

let method = 'call_Function';
export default class MainAbility extends Ability {
  onCreate(want, launchParam) {
    console.log('Callee onCreate is called');
    try {
      this.callee.off(method);
    } catch (error) {
      console.log('Callee.off catch error, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
    }
  }
}

OnReleaseCallback

(msg: string): void;

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

CalleeCallback

(indata: rpc.MessageSequence): rpc.Parcelable;

系統(tǒng)能力：SystemCapability.Ability.AbilityRuntime.AbilityCore