Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
“5fc96f8ccf93fd468989ca52f11d5a088335d3ae”上不存在“...vnode/tsdb/git@gitcode.net:qq_37101384/tdengine.git”
提交 aa41b0a1 编写于 作者: Z zhangxiuping
浏览文件
操作

update doc for nfc ndef functions. 

Signed-off-by: Nzhangxiuping <zhangxiuping@huawei.com>
上级 22acdecf
隐藏空白更改
内联 并排
Showing with 338 addition and 346 deletion
zh-cn/application-dev/reference/apis/js-apis-cardEmulation.md
浏览文件 @ aa41b0a1
...@@ -30,8 +30,6 @@ isSupported(feature: number): boolean ...@@ -30,8 +30,6 @@ isSupported(feature: number): boolean
是否支持某种类型的卡模拟。 是否支持某种类型的卡模拟。
**需要权限**：ohos.permission.NFC_CARD_EMULATION
**系统能力**：SystemCapability.Communication.NFC.Core **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
......
zh-cn/application-dev/reference/apis/js-apis-nfcTag.md
浏览文件 @ aa41b0a1
...@@ -315,12 +315,272 @@ getTagInfo(want: [Want](js-apis-application-Want.md#Want)): [TagInfo](#taginfo) ...@@ -315,12 +315,272 @@ getTagInfo(want: [Want](js-apis-application-Want.md#Want)): [TagInfo](#taginfo)
| ------------------ | --------------------------| | ------------------ | --------------------------|
| [TagInfo](#taginfo) | TagInfo对象，用于获取不同技术类型的Tag对象。 | | [TagInfo](#taginfo) | TagInfo对象，用于获取不同技术类型的Tag对象。 |
## tag.ndef.makeUriRecord<sup>9+</sup>
makeUriRecord(uri: string): [NdefRecord](#ndefrecord9);
根据输入的URI，构建NDEF标签的Record数据对象。
**系统能力**：SystemCapability.Communication.NFC.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| uri | string | 是 | 写入到NDEF Record里面的数据内容。 |
**返回值：**
| **类型** | **说明** |
| ------------------ | --------------------------|
| [NdefRecord](#ndefrecord9) | NDEF标签的Record，详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。 |
**示例：**
```js
import tag from '@ohos.nfc.tag';
try {
let uri = "https://gitee.com/openharmony"; // change it to be correct.
let ndefRecord = tag.ndef.makeUriRecord(uri);
if (ndefRecord != undefined) {
console.log("ndefMessage makeUriRecord rtdType: " + ndefRecord.rtdType);
console.log("ndefMessage makeUriRecord payload: " + ndefRecord.payload);
} else {
console.log("ndefMessage makeUriRecord ndefRecord: " + ndefRecord);
}
} catch (busiError) {
console.log("ndefMessage makeUriRecord catched busiError: " + busiError);
}
```
## tag.ndef.makeTextRecord<sup>9+</sup>
makeTextRecord(text: string, locale: string): [NdefRecord](#ndefrecord9);
根据输入的文本数据和编码类型，构建NDEF标签的Record。
**系统能力**：SystemCapability.Communication.NFC.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| text | string | 是 | 写入到NDEF Record里面的文本数据内容。 |
| locale | string | 是 | 文本数据内容的编码方式。 |
**返回值：**
| **类型** | **说明** |
| ------------------ | --------------------------|
| [NdefRecord](#ndefrecord9) | NDEF标签的Record，详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。 |
**示例：**
```js
import tag from '@ohos.nfc.tag';
try {
let text = "Hello World"; // change it to be correct.
let locale = "en"; // change it to be correct.
let ndefRecord = tag.ndef.makeTextRecord(text, locale);
if (ndefRecord != undefined) {
console.log("ndefMessage makeTextRecord rtdType: " + ndefRecord.rtdType);
console.log("ndefMessage makeTextRecord payload: " + ndefRecord.payload);
} else {
console.log("ndefMessage makeTextRecord ndefRecord: " + ndefRecord);
}
} catch (busiError) {
console.log("ndefMessage makeTextRecord catched busiError: " + busiError);
}
```
## tag.ndef.makeMimeRecord<sup>9+</sup>
makeMimeRecord(mimeType: string, mimeData: number[]): [NdefRecord](#ndefrecord9);
根据输入的MIME数据和类型，构建NDEF标签的Record。
**系统能力**：SystemCapability.Communication.NFC
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| mimeType | string | 是 | 符合RFC规则的MIME类型，比如"text/plain"或"image/jpeg"。 |
| mimeData | number[] | 是 | MIME数据内容，每个number十六进制表示，范围是0x00~0xFF。 |
**返回值：**
| **类型** | **说明** |
| ------------------ | --------------------------|
| [NdefRecord](#ndefrecord9) | NDEF标签的Record，详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。 |
**示例：**
```js
import tag from '@ohos.nfc.tag';
try {
let mimeType = "text/plain"; // change it to be correct.
let mimeData = [0x01, 0x02, 0x03, 0x04, ...]; // change it to be correct.
let ndefRecord = tag.ndef.makeMimeRecord(mimeType, mimeData);
if (ndefRecord != undefined) {
console.log("ndefMessage makeMimeRecord rtdType: " + ndefRecord.rtdType);
console.log("ndefMessage makeMimeRecord payload: " + ndefRecord.payload);
} else {
console.log("ndefMessage makeMimeRecord ndefRecord: " + ndefRecord);
}
} catch (busiError) {
console.log("ndefMessage makeMimeRecord catched busiError: " + busiError);
}
```
## tag.ndef.makeExternalRecord<sup>9+</sup>
makeExternalRecord(domainName: string, type: string, externalData: number[]): [NdefRecord](#ndefrecord9);
根据应用程序特定的外部数据，构建NDEF标签的Record。
**系统能力**：SystemCapability.Communication.NFC
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| domainName | string | 是 | 外部数据发布组织的域名，一般是应用程序的包名。 |
| type | string | 是 | 外部数据的指定类型。 |
| externalData | number[] | 是 | 外部数据内容，每个number十六进制表示，范围是0x00~0xFF。 |
**返回值：**
| **类型** | **说明** |
| ------------------ | --------------------------|
| [NdefRecord](#ndefrecord9) | NDEF标签的Record，详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。 |
**示例：**
```js
import tag from '@ohos.nfc.tag';
try {
let domainName = "ohos.nfc.application"; // change it to be correct.
let type = "test"; // change it to be correct.
let externalData = [0x01, 0x02, 0x03, 0x04, ...]; // change it to be correct.
let ndefRecord = tag.ndef.makeExternalRecord(domainName, type, externalData);
if (ndefRecord != undefined) {
console.log("ndefMessage makeExternalRecord rtdType: " + ndefRecord.rtdType);
console.log("ndefMessage makeExternalRecord payload: " + ndefRecord.payload);
} else {
console.log("ndefMessage makeExternalRecord ndefRecord: " + ndefRecord);
}
} catch (busiError) {
console.log("ndefMessage makeExternalRecord catched busiError: " + busiError);
}
```
## tag.ndef.messageToBytes<sup>9+</sup>
messageToBytes(ndefMessage: [NdefMessage](js-apis-nfctech.md#ndefmessage9)): number[];
把输入的NDEF消息数据对象，转换为字节格式的数据。
**系统能力**：SystemCapability.Communication.NFC
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| ndefMessage | [NdefMessage](js-apis-nfctech.md#ndefmessage9) | 是 | NDEF消息数据对象。 |
**返回值：**
| **类型** | **说明** |
| ------------------ | --------------------------|
| number[] | NDEF消息数据对象，所转换成的字节格式的数据。每个number十六进制表示，范围是0x00~0xFF。 |
**示例：**
```js
import tag from '@ohos.nfc.tag';
let rawData = [0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]; // MUST can be parsed as NDEF Record.
let ndefMessage;
try {
ndefMessage = tag.ndef.createNdefMessage(rawData);
console.log("ndef createNdefMessage, ndefMessage: " + ndefMessage);
} catch (busiError) {
console.log("ndef createNdefMessage busiError: " + busiError);
}
try {
let rawData2 = tag.ndef.messageToBytes(ndefMessage);
console.log("ndefMessage messageToBytes rawData2: " + rawData2);
} catch (busiError) {
console.log("ndefMessage messageToBytes catched busiError: " + busiError);
}
```
## tag.ndef.createNdefMessage<sup>9+</sup>
createNdefMessage(data: number[]): [NdefMessage](js-apis-nfctech.md#ndefmessage9)
使用原始字节数据创建NDEF标签的Message。该数据必须符合NDEF Record数据格式，如果不符合格式，则返回的NdeMessage数据对象，所包含的NDE Record列表会为空。
**系统能力**：SystemCapability.Communication.NFC
**参数：**
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| data | number[] | 是 | 原始字节，每个number十六进制表示，范围是0x00~0xFF。要求必须满足NDEF Record的格式。 |
**返回值：**
| **类型** | **说明** |
| ------------------ | --------------------------|
| [NdefMessage](js-apis-nfctech.md#ndefmessage9) | NDEF标签的Message，详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。 |
**示例：**
```js
import tag from '@ohos.nfc.tag';
let rawData = [0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]; // MUST can be parsed as NDEF Record.
let ndefMessage;
try {
ndefMessage = tag.ndef.createNdefMessage(rawData);
console.log("ndef createNdefMessage, ndefMessage: " + ndefMessage);
} catch (busiError) {
console.log("ndef createNdefMessage busiError: " + busiError);
}
```
## tag.ndef.createNdefMessage<sup>9+</sup>
createNdefMessage(ndefRecords: NdefRecord[]): [NdefMessage](js-apis-nfctech.md#ndefmessage9)
使用NDEF Records列表，创建NDEF Message。
**系统能力**：SystemCapability.Communication.NFC.Core
**参数：**
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| ndefRecords | [NdefRecord](js-apis-nfcTag.md#ndefrecord9)[] | 是 | NDEF标签的Record列表，详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。 |
**返回值：**
| **类型** | **说明** |
| ------------------ | --------------------------|
| [NdefMessage](js-apis-nfctech.md#ndefmessage9) | NDEF标签的Message，详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。|
**示例：**
```js
import tag from '@ohos.nfc.tag';
let uriRecord = tag.ndef.makeUriRecord("https://gitee.com/openharmony");
let textRecord = tag.ndef.makeTextRecord("Hello World", "en");
let ndefRecords = [uriRecord, textRecord];
let ndefMessage;
try {
ndefMessage = tag.ndef.createNdefMessage(ndefRecords);
console.log("ndef createNdefMessage ndefMessage: " + ndefMessage);
} catch (busiError) {
console.log("ndef createNdefMessage busiError: " + busiError);
}
```
## TagInfo ## TagInfo
NFC服务在读取到标签时给出的对象，通过改对象属性，应用知道该标签支持哪些技术类型，并使用匹配的技术类型来调用相关接口。 NFC服务在读取到标签时给出的对象，通过改对象属性，应用知道该标签支持哪些技术类型，并使用匹配的技术类型来调用相关接口。
**系统能力**：SystemCapability.Communication.NFC.Core **系统能力**：SystemCapability.Communication.NFC.Core
**需要权限**：ohos.permission.NFC_TAG
| **参数名** | **类型** | **说明** | | **参数名** | **类型** | **说明** |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| uid<sup>9+</sup> | number[] | 标签的uid，每个number值是十六进制表示，范围是0x00~0xFF。 | | uid<sup>9+</sup> | number[] | 标签的uid，每个number值是十六进制表示，范围是0x00~0xFF。 |
...@@ -331,6 +591,7 @@ NFC服务在读取到标签时给出的对象，通过改对象属性，应用 ...@@ -331,6 +591,7 @@ NFC服务在读取到标签时给出的对象，通过改对象属性，应用
NDEF标签Record属性的定义，参考NDEF标签技术规范《NFCForum-TS-NDEF_1.0》的定义细节。 NDEF标签Record属性的定义，参考NDEF标签技术规范《NFCForum-TS-NDEF_1.0》的定义细节。
**系统能力**：SystemCapability.Communication.NFC.Core **系统能力**：SystemCapability.Communication.NFC.Core
| **参数名** | **类型** | **说明** | | **参数名** | **类型** | **说明** |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| tnf | number | NDEF Record的TNF(Type Name Field)。 | | tnf | number | NDEF Record的TNF(Type Name Field)。 |
...@@ -342,22 +603,24 @@ NDEF标签Record属性的定义，参考NDEF标签技术规范《NFCForum-TS-NDE ...@@ -342,22 +603,24 @@ NDEF标签Record属性的定义，参考NDEF标签技术规范《NFCForum-TS-NDE
NFC Tag有多种不同的技术类型，定义常量描述不同的技术类型。 NFC Tag有多种不同的技术类型，定义常量描述不同的技术类型。
**系统能力**：SystemCapability.Communication.NFC.Core **系统能力**：SystemCapability.Communication.NFC.Core
| **参数名** | **常量值** | **说明** | | **参数名** | **常量值** | **说明** |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| NFC_A | 1 | NFC-A(ISO 14443-3A)技术。| | NFC_A | 1 | NFC-A (ISO 14443-3A)技术。|
| NFC_B | 2 | NFC-A(ISO 14443-3B)技术。| | NFC_B | 2 | NFC-A (ISO 14443-3B)技术。|
| ISO_DEP | 3 | ISO-DEP(ISO 14443-4)技术。| | ISO_DEP | 3 | ISO-DEP (ISO 14443-4)技术。|
| NFC_F | 4 | NFC-F(JIS 6319-4)技术。| | NFC_F | 4 | NFC-F (JIS 6319-4)技术。|
| NFC_V | 5 | NFC-V(ISO 15693)技术。| | NFC_V | 5 | NFC-V (ISO 15693)技术。|
| NDEF | 6 | NDEF技术。| | NDEF | 6 | NDEF技术。|
| NDEF_FORMATABLE<sup>9+</sup> | 7 | 可以格式化的NDEF技术。|
| MIFARE_CLASSIC | 8 | MIFARE Classic技术。| | MIFARE_CLASSIC | 8 | MIFARE Classic技术。|
| MIFARE_ULTRALIGHT | 9 | MIFARE Utralight技术。| | MIFARE_ULTRALIGHT | 9 | MIFARE Utralight技术。|
| NDEF_FORMATABLE<sup>9+</sup> | 10 | 可以格式化的NDEF技术。|
## TnfType<sup>9+</sup> ## TnfType<sup>9+</sup>
NDEF Record的TNF(Type Name Field)类型值，参考NDEF标签技术规范《NFCForum-TS-NDEF_1.0》的定义细节。 NDEF Record的TNF(Type Name Field)类型值，参考NDEF标签技术规范《NFCForum-TS-NDEF_1.0》的定义细节。
**系统能力**：SystemCapability.Communication.NFC.Core **系统能力**：SystemCapability.Communication.NFC.Core
| **参数名** | **常量值** | **说明** | | **参数名** | **常量值** | **说明** |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| TNF_EMPTY | 0x0 | Empty。| | TNF_EMPTY | 0x0 | Empty。|
...@@ -372,6 +635,7 @@ NDEF Record的TNF(Type Name Field)类型值，参考NDEF标签技术规范《NFC ...@@ -372,6 +635,7 @@ NDEF Record的TNF(Type Name Field)类型值，参考NDEF标签技术规范《NFC
NDEF Record的RTD(Record Type Definition)类型值，参考NDEF标签技术规范《NFCForum-TS-NDEF_1.0》的定义细节。 NDEF Record的RTD(Record Type Definition)类型值，参考NDEF标签技术规范《NFCForum-TS-NDEF_1.0》的定义细节。
**系统能力**：SystemCapability.Communication.NFC.Core **系统能力**：SystemCapability.Communication.NFC.Core
| **参数名** | **常量值** | **说明** | | **参数名** | **常量值** | **说明** |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| RTD_TEXT<sup>9+</sup> | [0x54] | 文本类型的NDEF Record。| | RTD_TEXT<sup>9+</sup> | [0x54] | 文本类型的NDEF Record。|
...@@ -381,6 +645,7 @@ NDEF Record的RTD(Record Type Definition)类型值，参考NDEF标签技术规 ...@@ -381,6 +645,7 @@ NDEF Record的RTD(Record Type Definition)类型值，参考NDEF标签技术规
NFC Forum标准里面Tag类型的定义。 NFC Forum标准里面Tag类型的定义。
**系统能力**：SystemCapability.Communication.NFC.Core **系统能力**：SystemCapability.Communication.NFC.Core
| **参数名** | **常量值** | **说明** | | **参数名** | **常量值** | **说明** |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| NFC_FORUM_TYPE_1 | 1 | NFC论坛类型1。 | | NFC_FORUM_TYPE_1 | 1 | NFC论坛类型1。 |
...@@ -393,9 +658,10 @@ NFC Forum标准里面Tag类型的定义。 ...@@ -393,9 +658,10 @@ NFC Forum标准里面Tag类型的定义。
MIFARE Classic标签类型的定义。 MIFARE Classic标签类型的定义。
**系统能力**：SystemCapability.Communication.NFC.Core **系统能力**：SystemCapability.Communication.NFC.Core
| **参数名** | **常量值** | **说明** | | **参数名** | **常量值** | **说明** |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| TYPE_UNKNOWN | 0 | 未知MIFARE类型。 | | TYPE_UNKNOWN | 0 | 未知的MIFARE类型。 |
| TYPE_CLASSIC | 1 | MIFARE Classic类型。| | TYPE_CLASSIC | 1 | MIFARE Classic类型。|
| TYPE_PLUS | 2 | MIFARE Plus类型。| | TYPE_PLUS | 2 | MIFARE Plus类型。|
| TYPE_PRO | 3 | MIFARE Pro类型。 | | TYPE_PRO | 3 | MIFARE Pro类型。 |
...@@ -404,6 +670,7 @@ MIFARE Classic标签类型的定义。 ...@@ -404,6 +670,7 @@ MIFARE Classic标签类型的定义。
MIFARE Classic标签存储大小的定义。 MIFARE Classic标签存储大小的定义。
**系统能力**：SystemCapability.Communication.NFC.Core **系统能力**：SystemCapability.Communication.NFC.Core
| **参数名** | **常量值** | **说明** | | **参数名** | **常量值** | **说明** |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| MC_SIZE_MINI | 320 | 每个标签5个扇区，每个扇区4个块。 | | MC_SIZE_MINI | 320 | 每个标签5个扇区，每个扇区4个块。 |
...@@ -415,6 +682,7 @@ MIFARE Classic标签存储大小的定义。 ...@@ -415,6 +682,7 @@ MIFARE Classic标签存储大小的定义。
MIFARE Ultralight标签类型的定义。 MIFARE Ultralight标签类型的定义。
**系统能力**：SystemCapability.Communication.NFC.Core **系统能力**：SystemCapability.Communication.NFC.Core
| **参数名** | **常量值** | **说明** | | **参数名** | **常量值** | **说明** |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| TYPE_UNKOWN | 0 | 未知的 MIFARE 类型。 | | TYPE_UNKOWN | 0 | 未知的 MIFARE 类型。 |
......
zh-cn/application-dev/reference/apis/js-apis-nfctech.md
浏览文件 @ aa41b0a1
...@@ -173,7 +173,7 @@ getPmm(): number[] ...@@ -173,7 +173,7 @@ getPmm(): number[]
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**返回值：** **返回值：**
...@@ -207,7 +207,7 @@ getResponseFlags(): number ...@@ -207,7 +207,7 @@ getResponseFlags(): number
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**返回值：** **返回值：**
...@@ -233,7 +233,7 @@ getDsfId(): number ...@@ -233,7 +233,7 @@ getDsfId(): number
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**返回值：** **返回值：**
...@@ -265,7 +265,7 @@ getHistoricalBytes(): number[] ...@@ -265,7 +265,7 @@ getHistoricalBytes(): number[]
获取标签的历史字节，针对基于NfcA通信技术的IsoDep卡片。 获取标签的历史字节，针对基于NfcA通信技术的IsoDep卡片。
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**返回值：** **返回值：**
| **类型** | **说明** | | **类型** | **说明** |
...@@ -287,7 +287,7 @@ getHiLayerResponse(): number[] ...@@ -287,7 +287,7 @@ getHiLayerResponse(): number[]
获取标签的更高层响应字节，针对基于NfcB通信技术的IsoDep卡片。 获取标签的更高层响应字节，针对基于NfcB通信技术的IsoDep卡片。
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**返回值：** **返回值：**
| **类型** | **说明** | | **类型** | **说明** |
...@@ -311,7 +311,7 @@ isExtendedApduSupported(): Promise&lt;boolean&gt; ...@@ -311,7 +311,7 @@ isExtendedApduSupported(): Promise&lt;boolean&gt;
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**返回值：** **返回值：**
| **类型** | **说明** | | **类型** | **说明** |
...@@ -358,7 +358,7 @@ isExtendedApduSupported(callback: AsyncCallback\<boolean>): void ...@@ -358,7 +358,7 @@ isExtendedApduSupported(callback: AsyncCallback\<boolean>): void
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -405,7 +405,7 @@ getNdefRecords(): [NdefRecord](js-apis-nfcTag.md#ndefrecord9)[] ...@@ -405,7 +405,7 @@ getNdefRecords(): [NdefRecord](js-apis-nfcTag.md#ndefrecord9)[]
获取NDEF消息中的所有记录。 获取NDEF消息中的所有记录。
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**返回值：** **返回值：**
| **类型** | **说明** | | **类型** | **说明** |
...@@ -416,213 +416,14 @@ getNdefRecords(): [NdefRecord](js-apis-nfcTag.md#ndefrecord9)[] ...@@ -416,213 +416,14 @@ getNdefRecords(): [NdefRecord](js-apis-nfcTag.md#ndefrecord9)[]
```js ```js
import tag from '@ohos.nfc.tag'; import tag from '@ohos.nfc.tag';
// see NdefTag, obtains ndefMessage from ndefTag.createNdefMessage or ndefTag.getNdefMessage. // Obtains ndefMessage from tag.ndef.createNdefMessage or ndefTag.getNdefMessage.
// var ndefMessage = ndefTag.createNdefMessage(...); // var ndefMessage = tag.ndef.createNdefMessage(...);
// var ndefMessage = ndefTag.getNdefMessage(); // var ndefMessage = ndefTag.getNdefMessage();
let ndefRecords = ndefMessage.getNdefRecords(); let ndefRecords = ndefMessage.getNdefRecords();
console.log("ndef ndefRecords number: " + ndefRecords.length); console.log("ndef ndefRecords number: " + ndefRecords.length);
``` ```
### NdefMessage.makeUriRecord<sup>9+</sup>
makeUriRecord(uri: string): [NdefRecord](js-apis-nfcTag.md#ndefrecord9);
根据输入的URI，构建NDEF标签的Record数据对象。
**系统能力**：SystemCapability.Communication.NFC
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| uri | string | 是 | 写入到NDEF Record里面的数据内容。 |
**返回值：**
| **类型** | **说明** |
| ------------------ | --------------------------|
| [NdefRecord](js-apis-nfcTag.md#ndefrecord9) | NDEF标签的Record，详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。 |
**示例：**
```js
import tag from '@ohos.nfc.tag';
// see NdefTag, obtains ndefMessage from ndefTag.createNdefMessage or ndefTag.getNdefMessage. Such as:
// var ndefMessage = ndefTag.createNdefMessage(...);
// var ndefMessage = ndefTag.getNdefMessage();
try {
let uri = "https://gitee.com/openharmony"; // change it to be correct.
let ndefRecord = ndefMessage.makeUriRecord(uri);
if (ndefRecord != undefined) {
console.log("ndefMessage makeUriRecord rtdType: " + ndefRecord.rtdType);
console.log("ndefMessage makeUriRecord payload: " + ndefRecord.payload);
} else {
console.log("ndefMessage makeUriRecord ndefRecord: " + ndefRecord);
}
} catch (busiError) {
console.log("ndefMessage makeUriRecord catched busiError: " + busiError);
}
```
### NdefMessage.makeTextRecord<sup>9+</sup>
makeTextRecord(text: string, locale: string): [NdefRecord](js-apis-nfcTag.md#ndefrecord9);
根据输入的文本数据和编码类型，构建NDEF标签的Record。
**系统能力**：SystemCapability.Communication.NFC
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| text | string | 是 | 写入到NDEF Record里面的文本数据内容。 |
| locale | string | 是 | 文本数据内容的编码方式。 |
**返回值：**
| **类型** | **说明** |
| ------------------ | --------------------------|
| [NdefRecord](js-apis-nfcTag.md#ndefrecord9) | NDEF标签的Record，详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。 |
**示例：**
```js
import tag from '@ohos.nfc.tag';
// see NdefTag, obtains ndefMessage from ndefTag.createNdefMessage or ndefTag.getNdefMessage. Such as:
// var ndefMessage = ndefTag.createNdefMessage(...);
// var ndefMessage = ndefTag.getNdefMessage();
try {
let text = "Hello World"; // change it to be correct.
let locale = "utf8"; // change it to be correct.
let ndefRecord = ndefMessage.makeTextRecord(text, locale);
if (ndefRecord != undefined) {
console.log("ndefMessage makeTextRecord rtdType: " + ndefRecord.rtdType);
console.log("ndefMessage makeTextRecord payload: " + ndefRecord.payload);
} else {
console.log("ndefMessage makeTextRecord ndefRecord: " + ndefRecord);
}
} catch (busiError) {
console.log("ndefMessage makeTextRecord catched busiError: " + busiError);
}
```
### NdefMessage.makeMimeRecord<sup>9+</sup>
makeMimeRecord(mimeType: string, mimeData: number[]): [NdefRecord](js-apis-nfcTag.md#ndefrecord9);
根据输入的MIME数据和类型，构建NDEF标签的Record。
**系统能力**：SystemCapability.Communication.NFC
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| mimeType | string | 是 | MIME数据的类型。 |
| mimeData | number[] | 是 | MIME数据内容。 |
**返回值：**
| **类型** | **说明** |
| ------------------ | --------------------------|
| [NdefRecord](js-apis-nfcTag.md#ndefrecord9) | NDEF标签的Record，详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。 |
**示例：**
```js
import tag from '@ohos.nfc.tag';
// see NdefTag, obtains ndefMessage from ndefTag.createNdefMessage or ndefTag.getNdefMessage. Such as:
// var ndefMessage = ndefTag.createNdefMessage(...);
// var ndefMessage = ndefTag.getNdefMessage();
try {
let mimeType = "media"; // change it to be correct.
let mimeData = [0x01, 0x02, 0x03, 0x04]; // change it to be correct.
let ndefRecord = ndefMessage.makeMimeRecord(mimeType, mimeData);
if (ndefRecord != undefined) {
console.log("ndefMessage makeMimeRecord rtdType: " + ndefRecord.rtdType);
console.log("ndefMessage makeMimeRecord payload: " + ndefRecord.payload);
} else {
console.log("ndefMessage makeMimeRecord ndefRecord: " + ndefRecord);
}
} catch (busiError) {
console.log("ndefMessage makeMimeRecord catched busiError: " + busiError);
}
```
### NdefMessage.makeExternalRecord<sup>9+</sup>
makeExternalRecord(domainName: string, serviceName: string, externalData: number[]): [NdefRecord](js-apis-nfcTag.md#ndefrecord9);
根据应用程序特定的外部数据，构建NDEF标签的Record。
**系统能力**：SystemCapability.Communication.NFC
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| domainName | string | 是 | 外部数据发布组织的域名，一般是应用程序的包名。 |
| serviceName | string | 是 | 外部数据的指定类型。 |
| externalData | number[] | 是 | 外部数据内容。 |
**返回值：**
| **类型** | **说明** |
| ------------------ | --------------------------|
| [NdefRecord](js-apis-nfcTag.md#ndefrecord9) | NDEF标签的Record，详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。 |
**示例：**
```js
import tag from '@ohos.nfc.tag';
// see NdefTag, obtains ndefMessage from ndefTag.createNdefMessage or ndefTag.getNdefMessage. Such as:
// var ndefMessage = ndefTag.createNdefMessage(...);
// var ndefMessage = ndefTag.getNdefMessage();
try {
let domainName = "ohos.nfc.application"; // change it to be correct.
let type = "nfc"; // change it to be correct.
let externalData = [0x01, 0x02, 0x03, 0x04]; // change it to be correct.
let ndefRecord = ndefMessage.makeExternalRecord(domainName, type, externalData);
if (ndefRecord != undefined) {
console.log("ndefMessage makeExternalRecord rtdType: " + ndefRecord.rtdType);
console.log("ndefMessage makeExternalRecord payload: " + ndefRecord.payload);
} else {
console.log("ndefMessage makeExternalRecord ndefRecord: " + ndefRecord);
}
} catch (busiError) {
console.log("ndefMessage makeExternalRecord catched busiError: " + busiError);
}
```
### NdefMessage.messageToBytes<sup>9+</sup>
messageToBytes(ndefMessage: [NdefMessage](#ndefmessage9)): number[];
把输入的NDEF消息数据对象，转换为字节格式的数据。
**系统能力**：SystemCapability.Communication.NFC
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| ndefMessage | [NdefMessage](#ndefmessage9) | 是 | NDEF消息数据对象。 |
**返回值：**
| **类型** | **说明** |
| ------------------ | --------------------------|
| number[] | NDEF消息数据对象，所转换成的字节格式的数据。每个number十六进制表示，范围是0x00~0xFF。 |
**示例：**
```js
import tag from '@ohos.nfc.tag';
// see NdefTag, obtains ndefMessage from ndefTag.createNdefMessage or ndefTag.getNdefMessage. Such as:
// var ndefMessage = ndefTag.createNdefMessage(...);
// var ndefMessage = ndefTag.getNdefMessage();
try {
// the parameter 'ndefMessage' can be different from the instance object.
let rawData = ndefMessage.messageToBytes(ndefMessage);
console.log("ndefMessage messageToBytes rawData: " + rawData);
} catch (busiError) {
console.log("ndefMessage messageToBytes catched busiError: " + busiError);
}
```
## NdefTag<sup>9+</sup> ## NdefTag<sup>9+</sup>
提供对已格式化为NDEF的NFC标签的数据和操作的访问，继承自TagSession。 提供对已格式化为NDEF的NFC标签的数据和操作的访问，继承自TagSession。
...@@ -631,88 +432,13 @@ TagSession是所有NFC Tag技术类型的基类， 提供建立连接和发送 ...@@ -631,88 +432,13 @@ TagSession是所有NFC Tag技术类型的基类， 提供建立连接和发送
以下是NdefTag的独有接口。 以下是NdefTag的独有接口。
### NdefTag.createNdefMessage<sup>9+</sup>
createNdefMessage(data: number[]): [NdefMessage](#ndefmessage9)
使用原始字节数据创建NDEF标签的Message。该数据必须符合NDEF Record数据格式，如果不符合格式，则返回的NdeMessage数据对象，所包含的NDE Record列表会为空。
**系统能力**：SystemCapability.Communication.NFC
**参数：**
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| data | number[] | 是 | 原始字节，每个number十六进制表示，范围是0x00~0xFF。 |
**返回值：**
| **类型** | **说明** |
| ------------------ | --------------------------|
| [NdefMessage](#ndefmessage9) | NDEF标签的Message，详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。 |
**示例：**
```js
import tag from '@ohos.nfc.tag';
// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefTag' correctly.
let rawData = [0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]; // change the raw data bytes to be correct.
let ndefMessage;
try {
ndefMessage = ndefTag.createNdefMessage(rawData);
console.log("ndef createNdefMessage, ndefMessage: " + ndefMessage);
} catch (busiError) {
console.log("ndef createNdefMessage busiError: " + busiError);
}
```
### NdefTag.createNdefMessage<sup>9+</sup>
createNdefMessage(ndefRecords: NdefRecord[]): [NdefMessage](#ndefmessage9)
使用NDEF Records列表，创建NDEF Message。
**系统能力**：SystemCapability.Communication.NFC
**参数：**
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| ndefRecords | [NdefRecord](js-apis-nfcTag.md#ndefrecord9)[] | 是 | NDEF标签的Record列表，详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。 |
**返回值：**
| **类型** | **说明** |
| ------------------ | --------------------------|
| [NdefMessage](#ndefmessage9) | NDEF标签的Message，详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。|
**示例：**
```js
import tag from '@ohos.nfc.tag';
// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefTag' correctly.
let ndefRecords = [
// record format: tnf, rtdType, id, payload
// 1st record:
{tnf: 0x01, rtdType: [0x54], id: [0x01, 0x02, ...], payload: [0x00, 0xa4, 0x04, ...]},
// 2nd record:
{tnf: 0x02, rtdType: [0x55], id: [0x03, 0x04, ...], payload: [0x00, 0xa4, 0x04, ...]},
// other record if has one ...
];
let ndefMessage;
try {
ndefMessage = ndefTag.createNdefMessage(ndefRecords);
console.log("ndef createNdefMessage ndefMessage: " + ndefMessage);
} catch (busiError) {
console.log("ndef createNdefMessage busiError: " + busiError);
}
```
### NdefTag.getNdefTagType<sup>9+</sup> ### NdefTag.getNdefTagType<sup>9+</sup>
getNdefTagType(): NfcForumType getNdefTagType(): NfcForumType
获取NDEF标签的类型。 获取NDEF标签的类型。
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**返回值：** **返回值：**
| **类型** | **说明** | | **类型** | **说明** |
...@@ -734,7 +460,7 @@ getNdefMessage(): NdefMessage ...@@ -734,7 +460,7 @@ getNdefMessage(): NdefMessage
获取发现NDEF标签时，从标签读取的Message。 获取发现NDEF标签时，从标签读取的Message。
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**返回值：** **返回值：**
| **类型** | **说明** | | **类型** | **说明** |
...@@ -756,7 +482,7 @@ isNdefWritable(): boolean; ...@@ -756,7 +482,7 @@ isNdefWritable(): boolean;
检查NDEF标签是否可写。在调用写数据接口前，需要先判断是否支持写操作。 检查NDEF标签是否可写。在调用写数据接口前，需要先判断是否支持写操作。
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**返回值：** **返回值：**
| **类型** | **说明** | | **类型** | **说明** |
...@@ -780,7 +506,7 @@ readNdef(): Promise\<NdefMessage> ...@@ -780,7 +506,7 @@ readNdef(): Promise\<NdefMessage>
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**返回值：** **返回值：**
| **类型** | **说明** | | **类型** | **说明** |
...@@ -826,7 +552,7 @@ readNdef(callback: AsyncCallback\<[NdefMessage](#ndefmessage9)>): void ...@@ -826,7 +552,7 @@ readNdef(callback: AsyncCallback\<[NdefMessage](#ndefmessage9)>): void
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -874,7 +600,7 @@ writeNdef(msg: NdefMessage): Promise\<void>; ...@@ -874,7 +600,7 @@ writeNdef(msg: NdefMessage): Promise\<void>;
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -893,8 +619,8 @@ import tag from '@ohos.nfc.tag'; ...@@ -893,8 +619,8 @@ import tag from '@ohos.nfc.tag';
// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefTag' correctly. // see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefTag' correctly.
// ndefMessage created from raw data, such as: // ndefMessage created from raw data, such as:
let ndefMessage = ndefTag.createNdefMessage([0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]); // change the raw data to be correct. let ndefMessage = tag.ndef.createNdefMessage([0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]); // MUST can be parsed as NDEF Record.
// or ndefMessage created from ndefTag.createNdefMessage(ndefRecords: NdefRecord[]) // or ndefMessage created from tag.ndef.createNdefMessage(ndefRecords: NdefRecord[])
// connect the tag at first if not connected. // connect the tag at first if not connected.
if (!ndefTag.isTagConnected()) { if (!ndefTag.isTagConnected()) {
...@@ -923,7 +649,7 @@ writeNdef(msg: NdefMessage, callback: AsyncCallback\<void>): void ...@@ -923,7 +649,7 @@ writeNdef(msg: NdefMessage, callback: AsyncCallback\<void>): void
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -943,8 +669,8 @@ import tag from '@ohos.nfc.tag'; ...@@ -943,8 +669,8 @@ import tag from '@ohos.nfc.tag';
// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefTag' correctly. // see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefTag' correctly.
// ndefMessage created from raw data, such as: // ndefMessage created from raw data, such as:
let ndefMessage = ndefTag.createNdefMessage([0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]); // change the raw data to be correct. let ndefMessage = tag.ndef.createNdefMessage([0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]); // MUST can be parsed as NDEF Record.
// or ndefMessage created from ndefTag.createNdefMessage(ndefRecords: NdefRecord[]) // or ndefMessage created from tag.ndef.createNdefMessage(ndefRecords: NdefRecord[])
// connect the tag at first if not connected. // connect the tag at first if not connected.
if (!ndefTag.isTagConnected()) { if (!ndefTag.isTagConnected()) {
...@@ -975,7 +701,7 @@ canSetReadOnly(): boolean ...@@ -975,7 +701,7 @@ canSetReadOnly(): boolean
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**返回值：** **返回值：**
| **类型** | **说明** | | **类型** | **说明** |
...@@ -1005,7 +731,7 @@ setReadOnly(): Promise\<void> ...@@ -1005,7 +731,7 @@ setReadOnly(): Promise\<void>
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**错误码：** **错误码：**
以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)。 以下错误码的详细介绍请参见[NFC错误码](../errorcodes/errorcode-nfc.md)。
...@@ -1046,7 +772,7 @@ setReadOnly(callback: AsyncCallback\<void>): void ...@@ -1046,7 +772,7 @@ setReadOnly(callback: AsyncCallback\<void>): void
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1092,7 +818,7 @@ getNdefTagTypeString(type: [NfcForumType](js-apis-nfcTag.md#nfcforumtype9)): str ...@@ -1092,7 +818,7 @@ getNdefTagTypeString(type: [NfcForumType](js-apis-nfcTag.md#nfcforumtype9)): str
将NFC论坛类型，转换为NFC论坛中定义的字符串描述。 将NFC论坛类型，转换为NFC论坛中定义的字符串描述。
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1134,7 +860,7 @@ authenticateSector(sectorIndex: number, key: number[], isKeyA: boolean): Promise ...@@ -1134,7 +860,7 @@ authenticateSector(sectorIndex: number, key: number[], isKeyA: boolean): Promise
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1184,7 +910,7 @@ authenticateSector(sectorIndex: number, key: number[], isKeyA: boolean, callback ...@@ -1184,7 +910,7 @@ authenticateSector(sectorIndex: number, key: number[], isKeyA: boolean, callback
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1237,7 +963,7 @@ readSingleBlock(blockIndex: number): Promise\<number[]> ...@@ -1237,7 +963,7 @@ readSingleBlock(blockIndex: number): Promise\<number[]>
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1289,7 +1015,7 @@ readSingleBlock(blockIndex: number, callback: AsyncCallback\<number[]>): void ...@@ -1289,7 +1015,7 @@ readSingleBlock(blockIndex: number, callback: AsyncCallback\<number[]>): void
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1339,7 +1065,7 @@ writeSingleBlock(blockIndex: number, data: number[]): Promise\<void> ...@@ -1339,7 +1065,7 @@ writeSingleBlock(blockIndex: number, data: number[]): Promise\<void>
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1388,7 +1114,7 @@ writeSingleBlock(blockIndex: number, data: number[], callback: AsyncCallback\<vo ...@@ -1388,7 +1114,7 @@ writeSingleBlock(blockIndex: number, data: number[], callback: AsyncCallback\<vo
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1440,7 +1166,7 @@ incrementBlock(blockIndex: number, value: number): Promise\<void> ...@@ -1440,7 +1166,7 @@ incrementBlock(blockIndex: number, value: number): Promise\<void>
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1489,7 +1215,7 @@ incrementBlock(blockIndex: number, value: number, callback: AsyncCallback\<void> ...@@ -1489,7 +1215,7 @@ incrementBlock(blockIndex: number, value: number, callback: AsyncCallback\<void>
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1541,7 +1267,7 @@ decrementBlock(blockIndex: number, value: number): Promise\<void> ...@@ -1541,7 +1267,7 @@ decrementBlock(blockIndex: number, value: number): Promise\<void>
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1590,7 +1316,7 @@ decrementBlock(blockIndex: number, value: number, callback: AsyncCallback\<void> ...@@ -1590,7 +1316,7 @@ decrementBlock(blockIndex: number, value: number, callback: AsyncCallback\<void>
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1642,7 +1368,7 @@ transferToBlock(blockIndex: number): Promise\<void> ...@@ -1642,7 +1368,7 @@ transferToBlock(blockIndex: number): Promise\<void>
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1689,7 +1415,7 @@ transferToBlock(blockIndex: number, callback: AsyncCallback\<void>): void ...@@ -1689,7 +1415,7 @@ transferToBlock(blockIndex: number, callback: AsyncCallback\<void>): void
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1739,7 +1465,7 @@ restoreFromBlock(blockIndex: number): Promise\<void> ...@@ -1739,7 +1465,7 @@ restoreFromBlock(blockIndex: number): Promise\<void>
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1786,7 +1512,7 @@ restoreFromBlock(blockIndex: number, callback: AsyncCallback\<void>): void ...@@ -1786,7 +1512,7 @@ restoreFromBlock(blockIndex: number, callback: AsyncCallback\<void>): void
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1834,7 +1560,7 @@ getSectorCount(): number ...@@ -1834,7 +1560,7 @@ getSectorCount(): number
获取MIFARE Classic标签中的扇区数。 获取MIFARE Classic标签中的扇区数。
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**返回值：** **返回值：**
| **类型** | **说明** | | **类型** | **说明** |
...@@ -1856,7 +1582,7 @@ getBlockCountInSector(sectorIndex: number): number ...@@ -1856,7 +1582,7 @@ getBlockCountInSector(sectorIndex: number): number
获取指定扇区中的块数。 获取指定扇区中的块数。
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1889,7 +1615,7 @@ getType(): [MifareClassicType](js-apis-nfcTag.md#mifareclassictype9) ...@@ -1889,7 +1615,7 @@ getType(): [MifareClassicType](js-apis-nfcTag.md#mifareclassictype9)
获取MIFARE Classic标签的类型。 获取MIFARE Classic标签的类型。
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**返回值：** **返回值：**
| **类型** | **说明** | | **类型** | **说明** |
...@@ -1911,7 +1637,7 @@ getTagSize(): number ...@@ -1911,7 +1637,7 @@ getTagSize(): number
获取标签的存储空间大小，具体请参见[MifareClassicSize](js-apis-nfcTag.md#mifareclassicsize9)。 获取标签的存储空间大小，具体请参见[MifareClassicSize](js-apis-nfcTag.md#mifareclassicsize9)。
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**返回值：** **返回值：**
| **类型** | **说明** | | **类型** | **说明** |
...@@ -1933,7 +1659,7 @@ isEmulatedTag(): boolean ...@@ -1933,7 +1659,7 @@ isEmulatedTag(): boolean
检查标签是不是被模拟的。 检查标签是不是被模拟的。
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**返回值：** **返回值：**
| **类型** | **说明** | | **类型** | **说明** |
...@@ -1955,7 +1681,7 @@ getBlockIndex(sectorIndex: number): number ...@@ -1955,7 +1681,7 @@ getBlockIndex(sectorIndex: number): number
获取特定扇区的第一个块的序号。 获取特定扇区的第一个块的序号。
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1990,7 +1716,7 @@ getSectorIndex(blockIndex: number): number ...@@ -1990,7 +1716,7 @@ getSectorIndex(blockIndex: number): number
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -2033,7 +1759,7 @@ readMultiplePages(pageIndex: number): Promise\<number[]> ...@@ -2033,7 +1759,7 @@ readMultiplePages(pageIndex: number): Promise\<number[]>
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
...@@ -2087,7 +1813,7 @@ readMultiplePages(pageIndex: number, callback: AsyncCallback\<number[]>): void ...@@ -2087,7 +1813,7 @@ readMultiplePages(pageIndex: number, callback: AsyncCallback\<number[]>): void
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -2137,7 +1863,7 @@ writeSinglePage(pageIndex: number, data: number[]): Promise\<void> ...@@ -2137,7 +1863,7 @@ writeSinglePage(pageIndex: number, data: number[]): Promise\<void>
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -2186,7 +1912,7 @@ writeSinglePage(pageIndex: number, data: number[], callback: AsyncCallback\<void ...@@ -2186,7 +1912,7 @@ writeSinglePage(pageIndex: number, data: number[], callback: AsyncCallback\<void
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -2236,7 +1962,7 @@ getType(): MifareUltralightType ...@@ -2236,7 +1962,7 @@ getType(): MifareUltralightType
获取MIFARE Ultralight标签的类型，具体请参见 [MifareUltralightType](js-apis-nfcTag.md#mifareultralighttype9)。 获取MIFARE Ultralight标签的类型，具体请参见 [MifareUltralightType](js-apis-nfcTag.md#mifareultralighttype9)。
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**返回值：** **返回值：**
| **类型** | **说明** | | **类型** | **说明** |
...@@ -2268,7 +1994,7 @@ format(message: [NdefMessage](#ndefmessage9)): Promise\<void> ...@@ -2268,7 +1994,7 @@ format(message: [NdefMessage](#ndefmessage9)): Promise\<void>
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -2298,8 +2024,8 @@ if (!ndefFormatable.isTagConnected()) { ...@@ -2298,8 +2024,8 @@ if (!ndefFormatable.isTagConnected()) {
try { try {
// ndefMessage created from raw data, such as: // ndefMessage created from raw data, such as:
let ndefMessage = ndefTag.createNdefMessage([0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]); // change the raw data to be correct. let ndefMessage = tag.ndef.createNdefMessage([0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]); // MUST can be parsed as NDEF Record.
// or ndefMessage created from ndefTag.createNdefMessage(ndefRecords: NdefRecord[]) // or ndefMessage created from tag.ndef.createNdefMessage(ndefRecords: NdefRecord[])
ndefFormatable.format(ndefMessage).then(() => { ndefFormatable.format(ndefMessage).then(() => {
console.log("ndefFormatable format Promise success."); console.log("ndefFormatable format Promise success.");
...@@ -2319,7 +2045,7 @@ format(message: [NdefMessage](#ndefmessage9), callback: AsyncCallback\<void>): v ...@@ -2319,7 +2045,7 @@ format(message: [NdefMessage](#ndefmessage9), callback: AsyncCallback\<void>): v
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -2348,8 +2074,8 @@ if (!ndefFormatable.isTagConnected()) { ...@@ -2348,8 +2074,8 @@ if (!ndefFormatable.isTagConnected()) {
try { try {
// ndefMessage created from raw data, such as: // ndefMessage created from raw data, such as:
let ndefMessage = ndefTag.createNdefMessage([0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]); // change the raw data to be correct. let ndefMessage = tag.ndef.createNdefMessage([0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]); // MUST can be parsed as NDEF Record.
// or ndefMessage created from ndefTag.createNdefMessage(ndefRecords: NdefRecord[]) // or ndefMessage created from tag.ndef.createNdefMessage(ndefRecords: NdefRecord[])
ndefFormatable.format(ndefMessage, (err)=> { ndefFormatable.format(ndefMessage, (err)=> {
if (err) { if (err) {
...@@ -2371,7 +2097,7 @@ formatReadOnly(message: [NdefMessage](#ndefmessage9)): Promise\<void> ...@@ -2371,7 +2097,7 @@ formatReadOnly(message: [NdefMessage](#ndefmessage9)): Promise\<void>
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -2400,8 +2126,8 @@ if (!ndefFormatable.isTagConnected()) { ...@@ -2400,8 +2126,8 @@ if (!ndefFormatable.isTagConnected()) {
try { try {
// ndefMessage created from raw data, such as: // ndefMessage created from raw data, such as:
let ndefMessage = ndefTag.createNdefMessage([0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]); // change the raw data to be correct. let ndefMessage = tag.ndef.createNdefMessage([0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]); // MUST can be parsed as NDEF Record.
// or ndefMessage created from ndefTag.createNdefMessage(ndefRecords: NdefRecord[]) // or ndefMessage created from tag.ndef.createNdefMessage(ndefRecords: NdefRecord[])
ndefFormatable.formatReadOnly(ndefMessage).then(() => { ndefFormatable.formatReadOnly(ndefMessage).then(() => {
console.log("ndefFormatable formatReadOnly Promise success."); console.log("ndefFormatable formatReadOnly Promise success.");
...@@ -2421,7 +2147,7 @@ formatReadOnly(message: [NdefMessage](#ndefmessage9), callback: AsyncCallback\<v ...@@ -2421,7 +2147,7 @@ formatReadOnly(message: [NdefMessage](#ndefmessage9), callback: AsyncCallback\<v
**需要权限**：ohos.permission.NFC_TAG **需要权限**：ohos.permission.NFC_TAG
**系统能力**：SystemCapability.Communication.NFC **系统能力**：SystemCapability.Communication.NFC.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -2450,8 +2176,8 @@ if (!ndefFormatable.isTagConnected()) { ...@@ -2450,8 +2176,8 @@ if (!ndefFormatable.isTagConnected()) {
try { try {
// ndefMessage created from raw data, such as: // ndefMessage created from raw data, such as:
let ndefMessage = ndefTag.createNdefMessage([0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]); // change the raw data to be correct. let ndefMessage = tag.ndef.createNdefMessage([0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]); // MUST can be parsed as NDEF Record.
// or ndefMessage created from ndefTag.createNdefMessage(ndefRecords: NdefRecord[]) // or ndefMessage created from tag.ndef.createNdefMessage(ndefRecords: NdefRecord[])
ndefFormatable.formatReadOnly(ndefMessage, (err)=> { ndefFormatable.formatReadOnly(ndefMessage, (err)=> {
if (err) { if (err) {
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或