提交 8f66a7cb 编写于 作者: O openharmony_ci 提交者: zhangxiuping

Correct some api description error of nfc module

Merge pull request !7424 from zengyawen/OpenHarmony-3.2-Beta2
Signed-off-by: Nzhangxiuping <zhangxiuping@huawei.com>
...@@ -4,7 +4,5 @@ ...@@ -4,7 +4,5 @@
- [组件参考(基于JS扩展的类Web开发范式)](arkui-js/Readme-CN.md) - [组件参考(基于JS扩展的类Web开发范式)](arkui-js/Readme-CN.md)
- [接口参考(JS及TS API)](apis/Readme-CN.md) - [接口参考(JS及TS API)](apis/Readme-CN.md)
- 接口参考(Native API) - 接口参考(Native API)
- [OpenHarmony Native API](./native-apis/Readme-CN.md) - [OpenHarmony Native API](native-apis/Readme-CN.md)
- [Native API标准库](native-lib/third_party_libc/musl.md) - [Native API标准库](native-lib/Readme-CN.md)
- [Node_API](native-lib/third_party_napi/napi.md)
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
本模块主要用于操作及管理NFC卡模拟。 本模块主要用于操作及管理NFC卡模拟。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
...@@ -19,7 +19,7 @@ isSupported(feature: number): boolean ...@@ -19,7 +19,7 @@ isSupported(feature: number): boolean
是否支持某种类型的卡模拟 是否支持某种类型的卡模拟
**系统能力**:SystemCapability.Communication.NFC **系统能力**:SystemCapability.Communication.NFC.Core
**返回值:** **返回值:**
...@@ -39,7 +39,7 @@ startHCE(aidList: string[]): boolean ...@@ -39,7 +39,7 @@ startHCE(aidList: string[]): boolean
**需要权限**:ohos.permission.NFC_CARD_EMULATION **需要权限**:ohos.permission.NFC_CARD_EMULATION
**系统能力**:SystemCapability.Communication.NFC **系统能力**:SystemCapability.Communication.NFC.Core
**参数:** **参数:**
...@@ -55,7 +55,7 @@ stopHCE(): boolean ...@@ -55,7 +55,7 @@ stopHCE(): boolean
**需要权限**:ohos.permission.NFC_CARD_EMULATION **需要权限**:ohos.permission.NFC_CARD_EMULATION
**系统能力:** SystemCapability.Communication.NFC **系统能力:** SystemCapability.Communication.NFC.Core
### on ### on
...@@ -65,7 +65,7 @@ on(type: "hceCmd", callback: AsyncCallback<number[]>): void; ...@@ -65,7 +65,7 @@ on(type: "hceCmd", callback: AsyncCallback<number[]>): void;
**需要权限**:ohos.permission.NFC_CARD_EMULATION **需要权限**:ohos.permission.NFC_CARD_EMULATION
**系统能力**:SystemCapability.Communication.NFC **系统能力**:SystemCapability.Communication.NFC.Core
**参数:** **参数:**
...@@ -82,7 +82,7 @@ sendResponse(responseApdu: number[]): void; ...@@ -82,7 +82,7 @@ sendResponse(responseApdu: number[]): void;
**需要权限**:ohos.permission.NFC_CARD_EMULATION **需要权限**:ohos.permission.NFC_CARD_EMULATION
**系统能力**:SystemCapability.Communication.NFC **系统能力**:SystemCapability.Communication.NFC.Core
**参数:** **参数:**
......
...@@ -129,7 +129,7 @@ writeNdefTag(data: string): Promise&lt;void&gt; ...@@ -129,7 +129,7 @@ writeNdefTag(data: string): Promise&lt;void&gt;
## connectedTag.writeNdefTag ## connectedTag.writeNdefTag
writeNdefTag(data: string, callback: AsyncCallback&lt;string&gt;): void writeNdefTag(data: string, callback: AsyncCallback&lt;void&gt;): void
写入内容到有源标签,使用callback方式作为异步方法。 写入内容到有源标签,使用callback方式作为异步方法。
...@@ -219,6 +219,8 @@ off(type: "notify", callback?: Callback&lt;number&gt;): void ...@@ -219,6 +219,8 @@ off(type: "notify", callback?: Callback&lt;number&gt;): void
表示NFC场强状态的枚举。 表示NFC场强状态的枚举。
**系统能力**:SystemCapability.Communication.ConnectedTag
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| NFC_RF_LEAVE | 0 | NFC离场事件 | | NFC_RF_LEAVE | 0 | NFC离场事件 |
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
本模块主要用于操作及管理NFC。 本模块主要用于操作及管理NFC。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## **导入模块** ## **导入模块**
...@@ -19,6 +19,8 @@ isNfcAvailable(): boolean ...@@ -19,6 +19,8 @@ isNfcAvailable(): boolean
查询是否有NFC功能 查询是否有NFC功能
**系统能力**:SystemCapability.Communication.NFC.Core
**返回值:** **返回值:**
| **类型** | **说明** | | **类型** | **说明** |
...@@ -34,7 +36,7 @@ openNfc(): boolean ...@@ -34,7 +36,7 @@ openNfc(): boolean
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS **需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS
**系统能力**:SystemCapability.Communication.NFC **系统能力**:SystemCapability.Communication.NFC.Core
**返回值:** **返回值:**
...@@ -50,7 +52,7 @@ closeNfc(): boolean ...@@ -50,7 +52,7 @@ closeNfc(): boolean
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS **需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS
**系统能力**:SystemCapability.Communication.NFC **系统能力**:SystemCapability.Communication.NFC.Core
**返回值:** **返回值:**
...@@ -64,7 +66,7 @@ isNfcOpen(): boolean ...@@ -64,7 +66,7 @@ isNfcOpen(): boolean
查询NFC是否打开。 查询NFC是否打开。
**系统能力**:SystemCapability.Communication.NFC **系统能力**:SystemCapability.Communication.NFC.Core
**返回值:** **返回值:**
...@@ -78,7 +80,7 @@ getNfcState(): NfcState ...@@ -78,7 +80,7 @@ getNfcState(): NfcState
查询NFC状态。 查询NFC状态。
**系统能力**:SystemCapability.Communication.NFC **系统能力**:SystemCapability.Communication.NFC.Core
**返回值:** **返回值:**
...@@ -92,7 +94,7 @@ on(type: "nfcStateChange", callback: Callback&lt;NfcState&gt;): void ...@@ -92,7 +94,7 @@ on(type: "nfcStateChange", callback: Callback&lt;NfcState&gt;): void
注册NFC开关状态事件。 注册NFC开关状态事件。
**系统能力**:SystemCapability.Communication.NFC **系统能力**:SystemCapability.Communication.NFC.Core
**参数** **参数**
...@@ -109,7 +111,7 @@ off(type: "nfcStateChange", callback?: Callback&lt;NfcState&gt;): void ...@@ -109,7 +111,7 @@ off(type: "nfcStateChange", callback?: Callback&lt;NfcState&gt;): void
取消NFC开关状态事件的注册。 取消NFC开关状态事件的注册。
**系统能力**:SystemCapability.Communication.NFC **系统能力**:SystemCapability.Communication.NFC.Core
**参数** **参数**
...@@ -140,6 +142,8 @@ off(type: "nfcStateChange", callback?: Callback&lt;NfcState&gt;): void ...@@ -140,6 +142,8 @@ off(type: "nfcStateChange", callback?: Callback&lt;NfcState&gt;): void
表示NFC状态的枚举。 表示NFC状态的枚举。
**系统能力**:SystemCapability.Communication.NFC.Core
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| STATE_OFF | 1 | NFC关闭状态 | | STATE_OFF | 1 | NFC关闭状态 |
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
本模块主要用于操作及管理NFC Tag。 本模块主要用于操作及管理NFC Tag。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## **导入模块** ## **导入模块**
...@@ -21,7 +21,7 @@ getNfcATag(tagInfo: TagInfo): NfcATag ...@@ -21,7 +21,7 @@ getNfcATag(tagInfo: TagInfo): NfcATag
**需要权限**:ohos.permission.NFC_TAG **需要权限**:ohos.permission.NFC_TAG
**系统能力**:SystemCapability.Communication.NFC **系统能力**:SystemCapability.Communication.NFC.Core
**返回值:** **返回值:**
...@@ -37,7 +37,7 @@ getNfcBTag(tagInfo: TagInfo): NfcBTag ...@@ -37,7 +37,7 @@ getNfcBTag(tagInfo: TagInfo): NfcBTag
**需要权限**:ohos.permission.NFC_TAG **需要权限**:ohos.permission.NFC_TAG
**系统能力**:SystemCapability.Communication.NFC **系统能力**:SystemCapability.Communication.NFC.Core
**返回值:** **返回值:**
...@@ -53,7 +53,7 @@ getNfcFTag(tagInfo: TagInfo): NfcFTag ...@@ -53,7 +53,7 @@ getNfcFTag(tagInfo: TagInfo): NfcFTag
**需要权限**:ohos.permission.NFC_TAG **需要权限**:ohos.permission.NFC_TAG
**系统能力**:SystemCapability.Communication.NFC **系统能力**:SystemCapability.Communication.NFC.Core
**返回值:** **返回值:**
...@@ -69,7 +69,7 @@ getNfcVTag(tagInfo: TagInfo): NfcVTag ...@@ -69,7 +69,7 @@ getNfcVTag(tagInfo: TagInfo): NfcVTag
**需要权限**:ohos.permission.NFC_TAG **需要权限**:ohos.permission.NFC_TAG
**系统能力**:SystemCapability.Communication.NFC **系统能力**:SystemCapability.Communication.NFC.Core
**返回值:** **返回值:**
......
# Native API标准库 # Native API标准库
- [Node_API](third_party_napi/napi.md)
- [标准库](third_party_libc/musl.md) - [libuv](third_party_libuv/libuv.md)
- [Native API中没有导出的符号列表](third_party_libc/musl-peculiar-symbol.md) - [支持的标准库介绍](third_party_libc/musl.md)
- [Node_API](third_party_napi/napi.md) - 附录
- [libuv](third_party_libuv/libuv.md) - [Native api中没有导出的符号列表](third_party_libc/musl-peculiar-symbol.md)
\ No newline at end of file - [Native api中导出的EGL符号列表](third_party_opengl/egl-symbol.md)
- [Native api中导出的OpenGL ES 3.0符号列表](third_party_opengl/openglesv3-symbol.md)
\ No newline at end of file
**native api中没有导出的符号列表** # Native api中没有导出的符号列表
|符号类型|符号名|备注| |符号类型|符号名|备注|
| --- | --- | --- | | --- | --- | --- |
......
# Native API中支持的标准库 # Native API中支持的标准库
## 简介 ## 简介
**表1** OpenHarmony支持的标准库 **表1** OpenHarmony支持的标准库
| 名称 | 简介 | | 名称 | 简介 |
...@@ -19,8 +15,6 @@ ...@@ -19,8 +15,6 @@
## 标准C库 ## 标准C库
[libc、libm、libdl](https://zh.cppreference.com/w/c/header)组合实现C11标准C库。 [libc、libm、libdl](https://zh.cppreference.com/w/c/header)组合实现C11标准C库。
libc:包含线程相关接口,以及大部分标准接口。 libc:包含线程相关接口,以及大部分标准接口。
...@@ -43,8 +37,6 @@ C标准函数库是在C语言程序设计中,所有符合标准的头文件的 ...@@ -43,8 +37,6 @@ C标准函数库是在C语言程序设计中,所有符合标准的头文件的
## 标准C++库 ## 标准C++库
[libc++](https://libcxx.llvm.org/)是C++标准库的一种实现。 [libc++](https://libcxx.llvm.org/)是C++标准库的一种实现。
**版本** **版本**
...@@ -57,24 +49,12 @@ C++11、C++14标准已完全支持,C++17和C++20标准正在完善。 ...@@ -57,24 +49,12 @@ C++11、C++14标准已完全支持,C++17和C++20标准正在完善。
## OpenSL ES ## OpenSL ES
[OpenSL ES](https://www.khronos.org/registry/OpenSL-ES/)是一个嵌入式跨平台的音频处理库。 [OpenSL ES](https://www.khronos.org/registry/OpenSL-ES/)是一个嵌入式跨平台的音频处理库。
## zlib ## zlib
[Zlib](https://zlib.net/)是基于C/C++语言实现的一个通用的数据压缩库。 [Zlib](https://zlib.net/)是基于C/C++语言实现的一个通用的数据压缩库。
## EGL ## EGL
EGL 是Khronos渲染API (如OpenGL ES 或 OpenVG) 与底层原生窗口系统之间的接口。OpenHarmony 现已支持 EGL。 EGL 是Khronos渲染API (如OpenGL ES 或 OpenVG) 与底层原生窗口系统之间的接口。OpenHarmony 现已支持 EGL。
...@@ -83,8 +63,6 @@ EGL 是Khronos渲染API (如OpenGL ES 或 OpenVG) 与底层原生窗口系统之 ...@@ -83,8 +63,6 @@ EGL 是Khronos渲染API (如OpenGL ES 或 OpenVG) 与底层原生窗口系统之
[native api中导出的EGL符号列表](../third_party_opengl/egl-symbol.md) [native api中导出的EGL符号列表](../third_party_opengl/egl-symbol.md)
## OpenGL ES ## OpenGL ES
OpenGL 是一种跨平台的图形 API,用于为 3D 图形处理硬件指定标准的软件接口。[OpenGL ES](https://www.khronos.org/opengles/) 是 OpenGL 规范的一种形式,适用于嵌入式设备。OpenHarmony 现已支持 OpenGL ES 3.0。 OpenGL 是一种跨平台的图形 API,用于为 3D 图形处理硬件指定标准的软件接口。[OpenGL ES](https://www.khronos.org/opengles/) 是 OpenGL 规范的一种形式,适用于嵌入式设备。OpenHarmony 现已支持 OpenGL ES 3.0。
...@@ -95,5 +73,4 @@ OpenGL ES 3.0 ...@@ -95,5 +73,4 @@ OpenGL ES 3.0
**标准库中导出的符号列表** **标准库中导出的符号列表**
[native api中导出的OpenGL ES 3.0符号列表](../third_party_opengl/openglesv3-symbol.md) [native api中导出的OpenGL ES 3.0符号列表](../third_party_opengl/openglesv3-symbol.md)
\ No newline at end of file
# Node_API # Node-API
## 简介 ## 简介
Node-API是用于封装JavaScript能力为Native插件的API,独立于底层JavaScript,并作为Node.js的一部分。
Node-API是用于封装JavaScript能力为native插件的API,独立于底层JavaScript,并作为Node.js的一部分。
## 支持的能力 ## 支持的能力
Node-API可以去除底层的JavaScript引擎的差异,提供一套稳定的接口。 Node-API可以去除底层的JavaScript引擎的差异,提供一套稳定的接口。
NAPI组件对Node-API的接口进行了重新实现,底层对接了ArkJs等引擎。当前支持Node-API标准库中的部分接口。 OpenHarmony的Native API组件对Node-API的接口进行了重新实现,底层对接了ArkJS等引擎。当前支持Node-API标准库中的部分接口。
**NAPI组件扩展的符号列表** ## Native API组件扩展的符号列表
|符号类型|符号名|备注| |符号类型|符号名|备注|
| --- | --- | --- | | --- | --- | --- |
......
**native api中导出的EGL符号列表** # Native api中导出的EGL符号列表
|符号类型|符号名|备注| |符号类型|符号名|备注|
| --- | --- | --- | | --- | --- | --- |
......
**native api中导出的OpenGL ES 3.0符号列表** # Native api中导出的OpenGL ES 3.0符号列表
|符号类型|符号名|备注| |符号类型|符号名|备注|
| --- | --- | --- | | --- | --- | --- |
......
...@@ -925,4 +925,12 @@ ...@@ -925,4 +925,12 @@
- [OH_NativeXComponent_Callback](reference/native-apis/_o_h___native_x_component___callback.md) - [OH_NativeXComponent_Callback](reference/native-apis/_o_h___native_x_component___callback.md)
- [OH_NativeXComponent_TouchEvent](reference/native-apis/_o_h___native_x_component___touch_event.md) - [OH_NativeXComponent_TouchEvent](reference/native-apis/_o_h___native_x_component___touch_event.md)
- [OH_NativeXComponent_TouchPoint](reference/native-apis/_o_h___native_x_component___touch_point.md) - [OH_NativeXComponent_TouchPoint](reference/native-apis/_o_h___native_x_component___touch_point.md)
- [RawFileDescriptor](reference/native-apis/_raw_file_descriptor.md) - [RawFileDescriptor](reference/native-apis/_raw_file_descriptor.md)
\ No newline at end of file - 标准库
- [Node_API](reference/native-lib/third_party_napi/napi.md)
- [libuv](reference/native-lib/third_party_libuv/libuv.md)
- [支持的标准库介绍](reference/native-lib/third_party_libc/musl.md)
- 附录
- [Native api中没有导出的符号列表](reference/native-lib/third_party_libc/musl-peculiar-symbol.md)
- [Native api中导出的EGL符号列表](reference/native-lib/third_party_opengl/egl-symbol.md)
- [Native api中导出的OpenGL ES 3.0符号列表](reference/native-lib/third_party_opengl/openglesv3-symbol.md)
\ No newline at end of file
...@@ -92,6 +92,10 @@ ...@@ -92,6 +92,10 @@
- [资源调度](release-notes/api-change/v3.1-Release/js-apidiff-resource-scheduler_api-9-canary.md) - [资源调度](release-notes/api-change/v3.1-Release/js-apidiff-resource-scheduler_api-9-canary.md)
- [窗口管理](release-notes/api-change/v3.1-Release/js-apidiff-window_api-9-canary.md) - [窗口管理](release-notes/api-change/v3.1-Release/js-apidiff-window_api-9-canary.md)
- [Native API差异报告](release-notes/api-change/v3.1-Release/native-apidiff-v3.1-release.md) - [Native API差异报告](release-notes/api-change/v3.1-Release/native-apidiff-v3.1-release.md)
- OpenHarmony三方组件
- [OpenHarmony三方组件简介](third-party-components/third-party-components-introduction.md)
- [OpenHarmony JS/TS三方组件使用指导](third-party-components/npm-third-party-guide.md)
- 贡献 - 贡献
- [参与贡献](contribute/参与贡献.md) - [参与贡献](contribute/参与贡献.md)
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册