开发说明

版本说明

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

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

应用模型说明

随着系统的演进发展，先后提供了两种应用模型，FA模型和Stage模型。

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

权限说明

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

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

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

系统能力说明

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

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

通过系统能力SystemCapability使用指南，可以速查具体能力集支持的设备。

服务卡片能力说明

将应用/元服务的重要信息或操作前置到服务卡片（简称“卡片”），可达到服务直达、减少跳转层级的体验效果。

对于支持在ArkTS服务卡片中使用的接口，将会添加“卡片能力”的标记： 从API version x开始，该接口支持在ArkTS卡片中使用。

废弃接口说明

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

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

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

示例代码语言说明

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

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

接口使用说明

请参见导入HarmonyOS SDK的开放能力。

元服务API集

元服务是HarmonyOS提供的一种轻量应用程序形态，具备服务直达、跨设备等特征。

元服务可独立上架、分发、运行，独立实现业务闭环，可大幅提升信息与服务的获取效率。

元服务基于HarmonyOS SDK（只能使用“元服务API集”）开发，支持运行在1+8+N设备上，供用户在合适的场景、合适的设备上便捷使用。

支持在元服务中使用的接口，将会添加“元服务API”的标记： 从API version x开始，该接口支持在元服务中使用。