操作及管理NFC Tag

声明技术

开发Tag读写相关应用时，需要在应用的属性配置文件中，声明与NFC相关的属性值，比如，在module.json5文件中，声明下面属性值：

{
    "module": {
        // other declared attributes.

        "abilities": [
            {
                "skills": [
                    {
                        "actions": [
                            // other declared actions,

                            // add the nfc tag action
                            "ohos.nfc.tag.action.TAG_FOUND"
                        ]
                    }
                ],
                "metadata": [
                    {
                        "name": "tag-tech",
                        "value": "NfcA"
                    },
                    {
                        "name": "tag-tech",
                        "value": "IsoDep"
                    },
                    // add other technology if neccessary,
                    // such as: NfcB/NfcF/NfcV/Ndef/MifareClassic/MifareUL/NdefFormatable
                ]
            }
        ],
        "requestPermissions": [
            "name": "ohos.permission.NFC_TAG",
            "reason": "tag",
        ]
    }
}

导入模块

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

tag.TagInfo

在对相关Tag类型卡片进行读写之前，必须先获取TagInfo相关属性值，以确认设备读取到的Tag卡片支持哪些技术类型。这样Tag应用程序才能调用正确的接口和所读取到的Tag卡片进行通信。

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

onCreate(want, launchParam) {
    // add other code here...

    // want is initialized by nfc service, contains tag info for this found tag
    var tagInfo;
    try {
        tagInfo = tag.getTagInfo(want);
    } catch (error) {
        console.log("tag.getTagInfo catched error: " + error);
    }
    if (tagInfo == null || tagInfo == undefined) {
        console.log("no TagInfo to be created, ignore it.");
        return;
    }

    // get the supported technologies for this found tag.
    var isNfcATag =  false;
    var isIsoDepTag =  false;
    for (var i = 0; i < tagInfo.technology.length; i++) {
        if (tagInfo.technology[i] == tag.NFC_A) {
            isNfcATag = true;
        }

        if (tagInfo.technology[i] == tag.ISO_DEP) {
            isIsoDepTag = true;
        }
        // also check for technology: tag.NFC_B/NFC_F/NFC_V/NDEF/MIFARE_CLASSIC/MIFARE_ULTRALIGHT/NDEF_FORMATABLE
    }

    // use NfcA APIs to access the found tag.
    if (isNfcATag) {
        var nfcA;
        try {
            nfcA = tag.getNfcATag(taginfo);
        } catch (error) {
            console.log("tag.getNfcATag catched error: " + error);
        }
        // other code to read or write this found tag.
    }

    // use getIsoDep APIs to access the found tag.
    if (isIsoDepTag) {
        var isoDep;
        try {
            isoDep = tag.getIsoDep(taginfo);
        } catch (error) {
            console.log("tag.getIsoDep catched error: " + error);
        }
        // other code to read or write this found tag.
    }

    // use the same code to handle for "NfcA/NfcB/NfcF/NfcV/Ndef/MifareClassic/MifareUL/NdefFormatable".
}

tag.getNfcATag

getNfcATag(tagInfo: TagInfo): NfcATag

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

系统能力： SystemCapability.Communication.NFC.Tag

参数：

返回值：

tag.getNfcA9+

getNfcA(tagInfo: TagInfo): NfcATag

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

系统能力： SystemCapability.Communication.NFC.Tag

参数：

返回值：

错误码：

以下错误码的详细介绍请参见NFC错误码。

tag.getNfcBTag

getNfcBTag(tagInfo: TagInfo): NfcBTag

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

系统能力： SystemCapability.Communication.NFC.Tag

参数：

返回值：

tag.getNfcB9+

getNfcB(tagInfo: TagInfo): NfcBTag

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

系统能力： SystemCapability.Communication.NFC.Tag

参数：

返回值：

错误码：

以下错误码的详细介绍请参见NFC错误码。

tag.getNfcFTag

getNfcFTag(tagInfo: TagInfo): NfcFTag

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

系统能力： SystemCapability.Communication.NFC.Tag

参数：

返回值：

tag.getNfcF9+

getNfcF(tagInfo: TagInfo): NfcFTag

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

系统能力： SystemCapability.Communication.NFC.Tag

参数：

返回值：

错误码：

以下错误码的详细介绍请参见NFC错误码。

tag.getNfcVTag

getNfcVTag(tagInfo: TagInfo): NfcVTag

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

系统能力： SystemCapability.Communication.NFC.Tag

参数：

返回值：

tag.getNfcV9+

getNfcV(tagInfo: TagInfo): NfcVTag

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

系统能力： SystemCapability.Communication.NFC.Tag

参数：

返回值：

错误码：

以下错误码的详细介绍请参见NFC错误码。

tag.getIsoDep9+

getIsoDep(tagInfo: TagInfo): IsoDepTag

获取IsoDep类型Tag对象，通过该对象可访问支持IsoDep技术类型的Tag。

系统能力： SystemCapability.Communication.NFC.Tag

参数：

返回值：

错误码：

以下错误码的详细介绍请参见NFC错误码。

tag.getNdef9+

getNdef(tagInfo: TagInfo): NdefTag

获取NDEF类型Tag对象，通过该对象可访问支持NDEF技术类型的Tag。

系统能力： SystemCapability.Communication.NFC.Tag

参数：

返回值：

错误码：

以下错误码的详细介绍请参见NFC错误码。

tag.getMifareClassic9+

getMifareClassic(tagInfo: TagInfo): MifareClassicTag

获取MIFARE Classic类型Tag对象，通过该对象访问支持MIFARE Classic技术类型的Tag。

系统能力： SystemCapability.Communication.NFC.Tag

参数：

返回值：

错误码：

以下错误码的详细介绍请参见NFC错误码。

tag.getMifareUltralight9+

getMifareUltralight(tagInfo: TagInfo): MifareUltralightTag

获取MIFARE Ultralight类型Tag对象，通过该对象可访问支持MIFARE Ultralight技术类型的Tag。

系统能力： SystemCapability.Communication.NFC.Tag

参数：

返回值：

错误码：

以下错误码的详细介绍请参见NFC错误码。

tag.getNdefFormatable9+

getNdefFormatable(tagInfo: TagInfo): NdefFormatableTag

获取NDEF Formatable类型Tag对象，通过该对象可访问支持NDEF Formatable技术类型的Tag。

系统能力： SystemCapability.Communication.NFC.Tag

返回值：

错误码：

以下错误码的详细介绍请参见NFC错误码。

tag.getTagInfo9+

getTagInfo(want: Want): TagInfo

从Want中获取TagInfo，Want是被NFC服务初始化，包含了TagInfo所需的属性值。

系统能力： SystemCapability.Communication.NFC.Tag

参数：

返回值：

tag.ndef.makeUriRecord9+

makeUriRecord(uri: string): NdefRecord;

根据输入的URI，构建NDEF标签的Record数据对象。

系统能力： SystemCapability.Communication.NFC.Tag

参数：

返回值：

示例：

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.makeTextRecord9+

makeTextRecord(text: string, locale: string): NdefRecord;

根据输入的文本数据和编码类型，构建NDEF标签的Record。

系统能力： SystemCapability.Communication.NFC.Tag

参数：

返回值：

示例：

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.makeMimeRecord9+

makeMimeRecord(mimeType: string, mimeData: number[]): NdefRecord;

根据输入的MIME数据和类型，构建NDEF标签的Record。

系统能力： SystemCapability.Communication.NFC.Tag

参数：

返回值：

示例：

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.makeExternalRecord9+

makeExternalRecord(domainName: string, type: string, externalData: number[]): NdefRecord;

根据应用程序特定的外部数据，构建NDEF标签的Record。

系统能力： SystemCapability.Communication.NFC.Tag

参数：

返回值：

示例：

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.messageToBytes9+

messageToBytes(ndefMessage: NdefMessage): number[];

把输入的NDEF消息数据对象，转换为字节格式的数据。

系统能力： SystemCapability.Communication.NFC.Tag

参数：

返回值：

示例：

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.createNdefMessage9+

createNdefMessage(data: number[]): NdefMessage

使用原始字节数据创建NDEF标签的Message。该数据必须符合NDEF Record数据格式，如果不符合格式，则返回的NdeMessage数据对象，所包含的NDE Record列表会为空。

系统能力： SystemCapability.Communication.NFC.Tag

参数：

返回值：

示例：

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.createNdefMessage9+

createNdefMessage(ndefRecords: NdefRecord[]): NdefMessage

使用NDEF Records列表，创建NDEF Message。

系统能力： SystemCapability.Communication.NFC.Tag

参数：

返回值：

示例：

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

NFC服务在读取到标签时给出的对象，通过改对象属性，应用知道该标签支持哪些技术类型，并使用匹配的技术类型来调用相关接口。

系统能力： SystemCapability.Communication.NFC.Tag

需要权限： ohos.permission.NFC_TAG

NdefRecord9+

NDEF标签Record属性的定义，参考NDEF标签技术规范《NFCForum-TS-NDEF_1.0》的定义细节。

系统能力： SystemCapability.Communication.NFC.Tag

技术类型定义

NFC Tag有多种不同的技术类型，定义常量描述不同的技术类型。

系统能力： SystemCapability.Communication.NFC.Tag

TnfType9+

NDEF Record的TNF(Type Name Field)类型值，参考NDEF标签技术规范《NFCForum-TS-NDEF_1.0》的定义细节。

系统能力： SystemCapability.Communication.NFC.Tag

NDEF Record RTD类型定义

NDEF Record的RTD(Record Type Definition)类型值，参考NDEF标签技术规范《NFCForum-TS-NDEF_1.0》的定义细节。

系统能力： SystemCapability.Communication.NFC.Tag

NfcForumType9+

NFC Forum标准里面Tag类型的定义。

系统能力： SystemCapability.Communication.NFC.Tag

MifareClassicType9+

MIFARE Classic标签类型的定义。

系统能力： SystemCapability.Communication.NFC.Tag

MifareClassicSize9+

MIFARE Classic标签存储大小的定义。

系统能力： SystemCapability.Communication.NFC.Tag

MifareUltralightType9+

MIFARE Ultralight标签类型的定义。

系统能力： SystemCapability.Communication.NFC.Tag