harmony 鸿蒙开发说明

  • 2022-08-09
  • 浏览 (1293)

开发说明

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

版本说明

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

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

应用模型说明

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

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

系统接口说明

OpenHarmony中提供的接口,部分是仅供OEM厂商使用的system api,普通应用无法使用。

针对这种情况,在文档中会进行系统接口的声明:

  • 如果某个模块的接口均为system api,会在文档开头说明:该模块接口为系统接口。
  • 如果某个接口为system api,会在具体的接口描述中说明:此接口为系统接口。

普通应用即在HarmonyAppProvision配置文件中应用程序类型为hos_normal_app的应用。工程新建时,该字段默认为hos_normal_app。

随DevEco下载的SDK为public-SDK,不包括系统接口。如需使用系统接口,需要: - 参考full-SDK替换指南将SDK替换为full-SDK。 - 参考HarmonyAppProvision配置文件的说明修改HarmonyAppProvision配置文件中的app-feature字段为hos_system_app(系统应用)。

权限说明

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

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

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

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

系统能力说明

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

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

通过系统能力SystemCapability列表,可以速查具体能力集支持的设备。

废弃接口说明

废弃接口会使用上标“deprecated”标注,表示该接口不再推荐使用。

废弃接口均会标注废弃起始版本,从废弃版本起的5个API level仍可以兼容使用,但不推荐此行为。

  • 对于有标注替代接口的,建议开发者查看新接口的文档,尽早适配。
  • 如果没有替代接口,建议开发者参考废弃说明和变更说明(changelog)更换实现方式。

示例代码语言说明

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

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

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙企业设备管理概述(仅对系统应用开放)

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)

harmony 鸿蒙@ohos.WallpaperExtensionAbility (WallpaperExtensionAbility)

1  赞