!7815 【OpenHarmony开源贡献者计划2022】Add Nfc tags api description

Merge pull request !7815 from guoyanwen/master

!7815 【OpenHarmony开源贡献者计划2022】Add Nfc tags api description
Merge pull request !7815 from guoyanwen/master
69a3a26e · openharmony_ci · Gitee · 525832da · b0a24cb3 · 69a3a26e
3 changed file
--- a/zh-cn/application-dev/reference/apis/js-apis-nfcTag.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-nfcTag.md
@@ -5,19 +5,17 @@
 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
 > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

-
 ## **导入模块**

 ```
 import tag from '@ohos.nfc.tag';
 ```

-
 ## tag.getNfcATag

-getNfcATag(tagInfo: TagInfo): NfcATag
+getNfcATag(tagInfo: [TagInfo](#TagInfo<sup>9+</sup>)): [NfcATag](js-apis-nfctech.md#NfcATag)

-获取NFC A类型Tag对象，通过该对象访问NfcA技术类型的Tag。
+获取NFC A类型Tag对象，通过该对象可访问NfcA技术类型的Tag。

 **需要权限**：ohos.permission.NFC_TAG

@@ -27,13 +25,13 @@ getNfcATag(tagInfo: TagInfo): NfcATag

 | **类型** | **说明** |
 | -------- | -------- |
-| NfcATag | NFC A类型Tag对象 |
+| [NfcATag](js-apis-nfctech.md#NfcATag) | NFC A类型Tag对象。 |

 ## tag.getNfcBTag

-getNfcBTag(tagInfo: TagInfo): NfcBTag
+getNfcBTag(tagInfo: [TagInfo](#TagInfo<sup>9+</sup>)): [NfcBTag](js-apis-nfctech.md#NfcBTag)

-获取NFC B类型Tag对象，通过该对象访问NfcB技术类型的Tag。
+获取NFC B类型Tag对象，通过该对象可访问NfcB技术类型的Tag。

 **需要权限**：ohos.permission.NFC_TAG

@@ -43,13 +41,13 @@ getNfcBTag(tagInfo: TagInfo): NfcBTag

 | **类型** | **说明**         |
 | -------- | ---------------- |
-| NfcBTag  | NFC B类型Tag对象 |
+| [NfcBTag](js-apis-nfctech.md#NfcBTag)  | NFC B类型Tag对象。 |

 ## tag.getNfcFTag

-getNfcFTag(tagInfo: TagInfo): NfcFTag
+getNfcFTag(tagInfo: [TagInfo](#TagInfo<sup>9+</sup>)): [NfcFTag](js-apis-nfctech.md#NfcFTag)

-获取NFC F类型Tag对象，通过该对象访问NfcF技术类型的Tag。
+获取NFC F类型Tag对象，通过该对象可访问NfcF技术类型的Tag。

 **需要权限**：ohos.permission.NFC_TAG

@@ -59,13 +57,13 @@ getNfcFTag(tagInfo: TagInfo): NfcFTag

 | **类型** | **说明**         |
 | -------- | ---------------- |
-| NfcFTag  | NFC F类型Tag对象 |
+| [NfcFTag](js-apis-nfctech.md#NfcFTag)  | NFC F类型Tag对象。 |

 ## tag.getNfcVTag

-getNfcVTag(tagInfo: TagInfo): NfcVTag
+getNfcVTag(tagInfo: [TagInfo](#TagInfo<sup>9+</sup>)): [NfcVTag](js-apis-nfctech.md#NfcVTag)

-获取NFC V类型Tag对象，通过该对象访问NfcV技术类型的Tag。
+获取NFC V类型Tag对象，通过该对象可访问NfcV技术类型的Tag。

 **需要权限**：ohos.permission.NFC_TAG

@@ -75,4 +73,99 @@ getNfcVTag(tagInfo: TagInfo): NfcVTag

 | **类型** | **说明**         |
 | -------- | ---------------- |
-| NfcVTag  | NFC V类型Tag对象 |
+| [NfcVTag](js-apis-nfctech.md#NfcVTag)  | NFC V类型Tag对象。 |
+
+## tag.getIsoDepTag<sup>9+</sup>
+
+getIsoDepTag(tagInfo: [TagInfo](#TagInfo<sup>9+</sup>)): [IsoDepTag](js-apis-nfctech.md#IsoDepTag )
+
+获取IsoDep类型Tag对象，通过该对象可访问Iso Dep技术类型的Tag。
+
+
+**需要权限**：ohos.permission.NFC_TAG
+
+**系统能力**：SystemCapability.Communication.NFC.Core
+
+**返回值：**
+
+| **类型** | **说明**            |
+| ---------- | ------------------|
+| [IsoDepTag](js-apis-nfctech.md#IsoDepTag>)  | Iso Dep类型Tag对象。 |
+
+## tag.getNdefTag<sup>9+</sup>
+
+getNdefTag(tagInfo: [TagInfo](#TagInfo<sup>9+</sup>)): [NdefTag](js-apis-nfctech.md#NdefTag-5)
+
+获取Ndef类型Tag对象，通过该对象可访问Ndef技术类型的Tag。
+
+
+**需要权限**：ohos.permission.NFC_TAG
+
+**系统能力**：SystemCapability.Communication.NFC.Core
+
+**返回值：**
+
+| **类型** | **说明**        |
+| ---------| -------------- |
+| [NdefTag](js-apis-nfctech.md#NdefTag)  | Ndef类型Tag对象。|
+
+## tag.getMifareClassicTag<sup>9+</sup>
+
+getMifareClassicTag(tagInfo: [TagInfo](#TagInfo<sup>9+</sup>)): [MifareClassicTag](js-apis-nfctech.md#MifareClassicTag)
+
+获取Mifare Classic类型Tag对象，通过该对象访问Mifare Classic技术类型的Tag。
+
+**需要权限**：ohos.permission.NFC_TAG
+
+**系统能力**：SystemCapability.Communication.NFC.Core
+
+**返回值：**
+
+| **类型** | **说明**                          |
+| ----------------- | ------------------------|
+| [MifareClassicTag](js-apis-nfctech.md#MifareClassicTag)  | Mifare Classic类型Tag对象 |
+
+## tag.getMifareUltralightTag<sup>9+</sup>
+
+getMifareUltralightTag(tagInfo: [TagInfo](#TagInfo<sup>9+</sup>)): [MifareUltralightTag](js-apis-nfctech.md#MifareUltralightTag)
+
+获取Mifare Ultralight类型Tag对象，通过该对象可访问Mifare Ultralight技术类型的Tag。
+
+**需要权限**：ohos.permission.NFC_TAG
+
+**系统能力**：SystemCapability.Communication.NFC.Core
+
+**返回值：**
+
+| **类型** | **说明**                                |
+| -------------------- | ---------------------------|
+| [MifareUltralightTag](js-apis-nfctech.md#MifareUltralightTag)  | Mifare Ultralight类型Tag对象 |
+
+## tag.getNdefFormatableTag<sup>9+</sup>
+
+getNdefFormatableTag(tagInfo: [TagInfo](#TagInfo<sup>9+</sup>)): [NdefFormatableTag](js-apis-nfctech.md#NdefFormatableTag)
+
+获取Ndef Formatable类型Tag对象，通过该对象可访问Ndef Formatable技术类型的Tag。
+
+**需要权限**：ohos.permission.NFC_TAG
+
+**系统能力**：SystemCapability.Communication.NFC.Core
+
+**返回值：**
+
+| **类型** | **说明**                             |
+| ------------------ | --------------------------|
+| [NdefFormatableTag](js-apis-nfctech.md#NdefFormatableTag)  | Ndef Formatable类型Tag对象。 |
+
+## TagInfo<sup>9+</sup>
+
+nfc服务在调度标签时给出的对象。
+
+| **参数名** | **类型** |  **说明** |
+| -------- | -------- | -------- |
+| uid | string |  标签的uid。 |
+| technology | number[] |  支持的技术类型。 |
+| extrasData | PacMap[] |  标签的额外信息。 |
+| tagRfDiscId | number |  标签的RF discovery id。 |
+| remoteTagService | rpc.RemoteObject |  标签服务的rpc远程对象。 |
+| supportedProfiles | number[] |  支持的技术类型。 |
\ No newline at end of file
--- a/zh-cn/application-dev/reference/apis/js-apis-nfctech.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-nfctech.md
--- a/zh-cn/application-dev/reference/apis/js-apis-tagSession.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-tagSession.md
+# 标准NFC-Tag  TagSession
+
+本模块是对NFC TagSession的使用说明。
+
+> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
+
+## **导入模块**
+
+```
+import tag from '@ohos.nfc.tag';
+```
+
+## tagSession
+
+tagSession是所有[Nfc tag 技术类型](js-apis-nfctech.md)的基类， 提供建立连接和发送数据等共同接口。
+
+需要通过其子类来访问以下接口。在下面的示例中 统一用 getXXTag表示获取子类实例的方法。
+
+具体使用时,请根据实际采用的Nfc tag技术，选择对应的方法，具体请参见[nfcTag](js-apis-nfcTag.md)文档。
+
+### tagSession.connectTag
+
+connectTag(): boolean;
+
+和标签建立连接；
+在从标签读取数据或将数据写入标签之前，必须调用此方法。
+
+**需要权限**：ohos.permission.NFC_TAG
+
+**系统能力**：SystemCapability.Communication.NFC.Core
+
+**返回值：**
+
+| **类型** | **说明**                             |
+| ------------------ | --------------------------|
+| boolean  | 连接建立成功返回 true，失败返回false。 |
+
+**示例：**
+
+```js
+import tag from '@ohos.nfc.tag';
+
+// tagInfo is an Object given by nfc service when tag is dispatched.
+let isNfcConnected = tag.getXXXTag(taginfo).connectTag(); 
+console.log("isNfcConnected:" +isNfcConnected);
+```
+
+### tagSession.reset()
+
+reset(): void
+
+重置与标签的连接，并恢复将数据写入标签的默认超时时间。
+
+**需要权限**：ohos.permission.NFC_TAG
+
+**系统能力**：SystemCapability.Communication.NFC.Core
+
+**返回值：**
+
+| **类型** | **说明**                             |
+| ------------------ | --------------------------|
+| boolean  | 方法执行成功返回 true，失败返回false。 |
+
+**示例：**
+
+```js
+import tag from '@ohos.nfc.tag';
+
+// tagInfo is an Object given by nfc service when tag is dispatched.
+let reset = tag.getXXXTag(taginfo).reset(); 
+console.log("reset:" +reset);
+```
+
+### tagSession.isTagConnected
+
+isTagConnected(): boolean
+
+检查是否已与标签建立连接。
+
+**需要权限**：ohos.permission.NFC_TAG
+
+**系统能力**：SystemCapability.Communication.NFC.Core
+
+**返回值：**
+
+| **类型** | **说明**                             |
+| ------------------ | --------------------------|
+| boolean  | 已建立连接返回 true，未建立连接返回false。 |
+
+**示例：**
+
+```js
+import tag from '@ohos.nfc.tag';
+
+// tagInfo is an Object given by nfc service when tag is dispatched.
+let isTagConnected = tag.getXXXTag(taginfo).isTagConnected(); 
+console.log("isTagConnected:" +isTagConnected);
+```
+
+### tagSession.getMaxSendLength
+
+getMaxSendLength(): number
+
+查询可以发送到标签的最大数据长度。
+
+**需要权限**：ohos.permission.NFC_TAG
+
+**系统能力**：SystemCapability.Communication.NFC.Core
+
+**返回值：**
+
+| **类型** | **说明**                             |
+| ------------------ | --------------------------|
+| number  | 可以发送到标签的最大数据长度。 |
+
+**示例：**
+
+```js
+import tag from '@ohos.nfc.tag';
+
+// tagInfo is an Object given by nfc service when tag is dispatched.
+let mazSendLen = tag.getXXXTag(taginfo).getMaxSendLength(); 
+console.log("mazSendLen:" +mazSendLen);
+```
\ No newline at end of file