From b9f8696c2be046f289f083d8bbc251e508db3bbd Mon Sep 17 00:00:00 2001 From: zengyawen Date: Fri, 24 Jun 2022 20:59:19 +0800 Subject: [PATCH] update docs Signed-off-by: zengyawen --- .../reference/apis/development-intro.md | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 zh-cn/application-dev/reference/apis/development-intro.md diff --git a/zh-cn/application-dev/reference/apis/development-intro.md b/zh-cn/application-dev/reference/apis/development-intro.md new file mode 100644 index 0000000000..d2e3b7ad38 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/development-intro.md @@ -0,0 +1,51 @@ +# 开发说明 + +API参考主要用于开发者查阅应用开发相关的各类API说明。为了方便开发者使用API文档，对文档描述中的常用字段进行说明。 + +## 版本说明 + +API参考采用两种方式标记组件或接口开始支持的版本号： + +- 对于新增组件或接口，会在章节开头进行说明，如：本模块首批接口从API version 7开始支持。 +- 对于某个已有组件或接口的新增特性，会在对应特性后进行标注，如：“uid8+”表示从API Version 8开始支持属性uid。 + +## Ability框架模型说明 + +Ability是系统调度应用的最小单元，是能够完成一个独立功能的组件。一个应用可以包含一个或多个Ability。Ability框架模型具有两种形态，分为FA模型和Stage模型。具体可参考[Ability框架概述](../../ability/ability-brief.md)。 + +- 如果某个模块的接口仅支持其中一种模型，会在文档开头说明：本模块接口仅可在FA模型/Stage模型下使用。 +- 如果某个接口仅支持其中一种模型，会在具体的接口描述中说明：此接口仅可在FA模型/Stage模型下使用。 +- 如两种框架模型均支持，则不做特殊说明。 + +## 系统接口说明 + +OpenHarmony中提供的接口，部分是仅供OEM厂商使用的system api，普通应用无法使用。 + +针对这种情况，在文档中会进行系统接口的声明： + +- 如果某个模块的接口均为system api，会在文档开头说明：该模块接口为系统接口。 +- 如果某个接口为system api，会在具体的接口描述中说明：此接口为系统接口。 + +## 权限说明 + +默认情况下，应用只能访问有限的系统资源。但某些情况下，应用为了扩展功能的诉求，需要访问额外的系统或其他应用的数据（包括用户个人数据）、功能。具体可参考[访问控制开发概述](../../security/accesstoken-overview.md)。 + +当调用接口访问这些资源时，需要申请对应的权限。申请方式可参考[访问控制开发指导](../../security/accesstoken-guidelines.md)。 + +- 如果应用需要具备某个权限才能调用该接口，会在具体的接口描述中说明：**需要权限**：ohos.permission.xxxx +- 如果应用不需要任何权限即可调用该接口，则不做特殊说明。 + +如果需要判断应用是否可以申请某权限，可参考[权限定义列表](../../security/permission-list.md)。 + +## 系统能力说明 + +系统能力（SystemCapability，简称SysCap），指操作系统中每一个相对独立的特性。不同的设备对应不同的系统能力集，每个系统能力对应多个接口。开发者可根据系统能力来判断是否可以使用某接口。具体可参考[SysCap使用指南](../../quick-start/syscap.md)。 + +文档在每一个接口描述中说明了接口的系统能力，如：**系统能力**：SystemCapability.xxx.xxx + +## 示例代码语言说明 + +OpenHarmony支持使用JS和TS两种开发语言。 + +- 当代码块标注`js`时，示例代码可在JS和eTS工程中使用。 +- 当代码块标注`ts`时，示例代码仅可在eTS工程中使用。 \ No newline at end of file -- GitLab