HarmonyOS API：Stage模型能力的接口

joytrian

发布于 2023-3-31 17:41

浏览

0收藏

版本：v3.1 Beta

开发说明

更新时间: 2023-02-17 09:19

API参考主要用于开发者查阅应用开发相关的各类API说明。为了方便开发者使用API文档，对文档描述中的常用字段进行说明。

版本说明

API参考采用两种方式标记组件或接口开始支持的版本号：

对于新增组件或接口，会在章节开头进行说明，如：本模块首批接口从API version 7开始支持。
对于某个已有组件或接口的新增特性，会在对应特性后进行标注，如：“uid⁸⁺”表示从API Version 8开始支持属性uid。

应用模型说明

随着系统的演进发展，HarmonyOS先后提供了两种应用模型，FA模型和Stage模型，两者的差异说明可参考应用模型解读。

如果某个模块的接口仅支持其中一种模型，会在文档开头说明：本模块接口仅可在FA模型/Stage模型下使用。
如果某个接口仅支持其中一种模型，会在具体的接口描述中说明：此接口仅可在FA模型/Stage模型下使用。
如两种框架模型均支持，则不做特殊说明。

权限说明

默认情况下，应用只能访问有限的系统资源。但某些情况下，应用为了扩展功能的诉求，需要访问额外的系统或其他应用的数据（包括用户个人数据）、功能。具体可参考访问控制开发概述。

当调用接口访问这些资源时，需要申请对应的权限。申请方式可参考访问控制开发指导。

如果应用需要具备某个权限才能调用该接口，会在具体的接口描述中说明：需要权限：ohos.permission.xxxx
如果应用不需要任何权限即可调用该接口，则不做特殊说明。

如果需要判断应用是否可以申请某权限，可参考权限申请使用的工作流程。

系统能力说明

系统能力（SystemCapability，简称SysCap），指操作系统中每一个相对独立的特性。不同的设备对应不同的系统能力集，每个系统能力对应多个接口。开发者可根据系统能力来判断是否可以使用某接口。具体可参考系统能力SystemCapability使用指南。

文档在每一个接口描述中说明了接口的系统能力，如：系统能力：SystemCapability.xxx.xxx

通过系统能力SystemCapability列表，可以速查具体能力集的含义。

示例代码语言说明

HarmonyOS支持使用JS和TS两种开发语言。

当代码块标注js时，示例代码可在JS和ArkTS工程中使用。
当代码块标注ts时，示例代码仅可在ArkTS工程中使用。

@ohos.app.ability.Ability（Ability基类）

更新时间: 2023-02-17 09:19

Ability模块提供对Ability生命周期、上下文环境等调用管理的能力，包括Ability创建、销毁、转储客户端信息等。

说明

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

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

导入模块

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

Ability.onConfigurationUpdate

onConfigurationUpdate(newConfig: Configuration): void;

当系统配置更新时调用。

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

参数：

参数名	类型	必填	说明
newConfig	Configuration	是	表示需要更新的配置信息。

示例：

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

Ability.onMemoryLevel

onMemoryLevel(level: AbilityConstant.MemoryLevel): void;

当系统已决定调整内存时调用。例如，当该功能在后台运行时，没有足够的内存来运行尽可能多的后台进程时可以使用。

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

参数：

参数名	类型	必填	说明
level	AbilityConstant.MemoryLevel	是	回调返回内存微调级别，显示当前内存使用状态。

示例：

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

@ohos.app.ability.AbilityConstant (AbilityConstant)

更新时间: 2023-02-17 09:19

AbilityConstant是启动参数的接口。

AbilityConstant提供启动参数的接口的能力，包括设置初次开始原因的类型、上次退出原因的类型、继续结果的类型。

说明

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

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