Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
b9f8696c
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
b9f8696c
编写于
6月 24, 2022
作者:
Z
zengyawen
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update docs
Signed-off-by:
N
zengyawen
<
zengyawen1@huawei.com
>
上级
4442d605
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
51 addition
and
0 deletion
+51
-0
zh-cn/application-dev/reference/apis/development-intro.md
zh-cn/application-dev/reference/apis/development-intro.md
+51
-0
未找到文件。
zh-cn/application-dev/reference/apis/development-intro.md
0 → 100644
浏览文件 @
b9f8696c
# 开发说明
API参考主要用于开发者查阅应用开发相关的各类API说明。为了方便开发者使用API文档,对文档描述中的常用字段进行说明。
## 版本说明
API参考采用两种方式标记组件或接口开始支持的版本号:
-
对于新增组件或接口,会在章节开头进行说明,如:本模块首批接口从API version 7开始支持。
-
对于某个已有组件或接口的新增特性,会在对应特性后进行标注,如:“uid
<sup>
8+
</sup>
”表示从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
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录