nfctech (标准NFC-Tag Nfc 技术)

本模块主要用于采用不同Nfc技术的Tag的读写操作。

说明：

本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

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

NfcATag

NfcATag 提供 NFC-A(ISO 14443-3A)技术的属性和I/O操作的访问，继承自TagSession。

TagSession是所有NFC Tag技术类型的基类， 提供建立连接和发送数据等共同接口。具体请参见TagSession。

以下是NfcATag的独有接口。

NfcATag.getSak

getSak(): number

获取NFC-A标签的SAK值。

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

返回值：

类型 说明
number NfcA 标签的SAK值，十六进制表示，范围是0x00~0xFF。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'nfcA' correctly.
let sak = nfcA.getSak();
console.log("nfcA sak: " + sak);

NfcATag.getAtqa

getAtqa(): number[]

获取NFC-A标签的Atqa值。

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

返回值：

类型 说明
number[] NfcA 标签的Atqa值，每个number十六进制表示，范围是0x00~0xFF。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'nfcA' correctly.
let atqa = nfcA.getAtqa();
console.log("nfcA atqa: " + atqa);

NfcBTag

NfcBTag 提供对NFC-B(ISO 14443-3B)技术的属性和I/O操作的访问，继承自TagSession。

TagSession是所有NFC Tag技术类型的基类，提供建立连接和发送数据等共同接口。具体请参见TagSession。

以下是NfcBTag的独有接口。

NfcBTag.getRespAppData

getRespAppData(): number[]

获取标签的应用程序数据。

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

返回值：

类型 说明
number[] NfcB 标签的应用程序数据，每个number十六进制表示，范围是0x00~0xFF。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'nfcB' correctly.
let respAppData = nfcB.getRespAppData();
console.log("nfcB respAppData: " + respAppData);

NfcBTag.getRespProtocol

getRespProtocol(): number[]

获取标签的协议信息。

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

返回值：

类型 说明
number[] NfcB 标签的协议信息，每个number十六进制表示，范围是0x00~0xFF。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'nfcB' correctly.
let respProtocol = nfcB.getRespProtocol();
console.log("nfcB respProtocol: " + respProtocol);

NfcFTag

NfcFTag 提供对NFC-F(JIS 6319-4)技术的属性和I/O操作的访问，继承自TagSession。

TagSession是所有NFC Tag技术类型的基类， 提供建立连接和发送数据等共同接口。具体请参见TagSession。

以下是NfcFTag的独有接口。

NfcFTag.getSystemCode

getSystemCode(): number[]

从标签实例获取系统代码。

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

返回值：

类型 说明
number[] NfcF 标签的系统代码，每个number十六进制表示，范围是0x00~0xFF。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'nfcF' correctly.
let systemCode = nfcF.getSystemCode();
console.log("nfcF systemCode: " + systemCode);

NfcFTag.getPmm

getPmm(): number[]

从标签实例获取PMm（由IC代码和制造商参数组成）。

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

返回值：

类型 说明
number[] NfcF 标签的PMm信息，每个number十六进制表示，范围是0x00~0xFF。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'nfcF' correctly.
let pmm = nfcF.getPmm();
console.log("nfcF pmm: " + pmm);

NfcVTag

NfcVTag 提供对NFC-V(ISO 15693)技术的属性和I/O操作的访问，继承自TagSession。

TagSession是所有NFC Tag技术类型的基类， 提供建立连接和发送数据等共同接口。具体请参见TagSession。

以下是NfcVTag的独有接口。

NfcvTag.getResponseFlags

getResponseFlags(): number

从标签实例实例获取响应标志。

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

返回值：

类型 说明
number NfcV 标签的响应标志，十六进制表示，范围是0x00~0xFF。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'nfcV' correctly.
let responseFlags = nfcV.getResponseFlags();
console.log("nfcV responseFlags: " + responseFlags);

NfcvTag.getDsfId

getDsfId(): number

从标签实例实例获取数据存储格式标识符（DSFID）。

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

返回值：

类型 说明
number NfcV 标签的数据存储格式标识符，十六进制表示，范围是0x00~0xFF。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'nfcV' correctly.
let dsfId = nfcV.getDsfId();
console.log("nfcV dsfId: " + dsfId);

IsoDepTag9+

IsoDepTag 提供对ISO-DEP(ISO 14443-4)技术的属性和I/O操作的访问，继承自TagSession。

TagSession是所有NFC Tag技术类型的基类， 提供建立连接和发送数据等共同接口。具体请参见TagSession。

以下是IsoDepTag的独有接口。

IsoDepTag.getHistoricalBytes9+

getHistoricalBytes(): number[]

获取标签的历史字节，针对基于NfcA通信技术的IsoDep卡片。

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

返回值：

类型 说明
number[] IsoDepTag 标签的历史字节，每个number十六进制表示，范围是0x00~0xFF。如果该IsoDep类型Tag是基于NfcB技术的，则该返回值为空。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'isoDep' correctly.
let historicalBytes = isoDep.getHistoricalBytes();
console.log("isoDep historicalBytes: " + historicalBytes);

IsoDepTag.getHiLayerResponse9+

getHiLayerResponse(): number[]

获取标签的更高层响应字节，针对基于NfcB通信技术的IsoDep卡片。

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

返回值：

类型 说明
number[] IsoDepTag 标签的更高层响应字节，每个number十六进制表示，范围是0x00~0xFF。如果该IsoDep类型Tag是基于NfcA技术的，则该返回值为空。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'isoDep' correctly.
let hiLayerResponse = isoDep.getHiLayerResponse();
console.log("isoDep hiLayerResponse: " + hiLayerResponse);

IsoDepTag.isExtendedApduSupported9+

isExtendedApduSupported(): Promise<boolean>

检查是否支持扩展的APDU，使用Promise方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

返回值：

类型 说明
Promise<boolean> 检查结果，true: 支持， false: 不支持。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'isoDep' correctly.

// connect the tag at first if not connected.
if (!isoDep.isTagConnected()) {
    if (!isoDep.connectTag()) {
        console.log("isoDep connectTag failed.");
        return;
    }
}

try {
    isoDep.isExtendedApduSupported().then((response) => {
        console.log("isoDep isExtendedApduSupported Promise response: " + response);
    }).catch((err)=> {
        console.log("isoDep isExtendedApduSupported Promise err: " + err);
    });
} catch (busiError) {
    console.log("isoDep isExtendedApduSupported Promise busiError: " + busiError);
}

IsoDepTag.isExtendedApduSupported9+

isExtendedApduSupported(callback: AsyncCallback<boolean>): void

检查是否支持扩展的APDU，使用AsyncCallback方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
callback AsyncCallback<boolean> 是 回调函数，true: 支持， false: 不支持。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'isoDep' correctly.

// connect the tag at first if not connected.
if (!isoDep.isTagConnected()) {
    if (!isoDep.connectTag()) {
        console.log("isoDep connectTag failed.");
        return;
    }
}

try {
    isoDep.isExtendedApduSupported((err, response)=> {
        if (err) {
            console.log("isoDep isExtendedApduSupported AsyncCallback err: " + err);
        } else {
            console.log("isoDep isExtendedApduSupported AsyncCallback response: " + response);
        }
    });
} catch (busiError) {
    console.log("isoDep isExtendedApduSupported AsyncCallback busiError: " + busiError);
}

NdefMessage9+

NdefMessage.getNdefRecords9+

getNdefRecords(): tag.NdefRecord[]

获取NDEF消息中的所有记录。

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

返回值：

类型 说明
tag.NdefRecord[] NDEF标签的Record列表，详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。

示例：

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

// Obtains ndefMessage from tag.ndef.createNdefMessage or ndefTag.getNdefMessage.
// var ndefMessage = tag.ndef.createNdefMessage(...);
// var ndefMessage = ndefTag.getNdefMessage();

let ndefRecords = ndefMessage.getNdefRecords();
console.log("ndef ndefRecords number: " + ndefRecords.length);

NdefTag9+

提供对已格式化为NDEF的NFC标签的数据和操作的访问，继承自TagSession。

TagSession是所有NFC Tag技术类型的基类， 提供建立连接和发送数据等共同接口。具体请参见TagSession。

以下是NdefTag的独有接口。

NdefTag.getNdefTagType9+

getNdefTagType(): tag.NfcForumType

获取NDEF标签的类型。

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

返回值：

类型 说明
tag.NfcForumType NDEF标签类型，包括NFC FORUM TYPE 1/2/3/4等。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefTag' correctly.
let ndefTagType = ndefTag.getNdefTagType();
console.log("ndef ndefTagType: " + ndefTagType);

NdefTag.getNdefMessage9+

getNdefMessage(): NdefMessage

获取发现NDEF标签时，从标签读取的Message。

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

返回值：

类型 说明
NdefMessage NDEF标签的Message，详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefTag' correctly.
let ndefMessage = ndefTag.getNdefMessage();
console.log("ndef ndefMessage: " + ndefMessage);

NdefTag.isNdefWritable9+

isNdefWritable(): boolean;

检查NDEF标签是否可写。在调用写数据接口前，需要先判断是否支持写操作。

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

返回值：

类型 说明
boolean 检查结果，true: 可写， false: 不可写。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefTag' correctly.
var isWritable = ndefTag.isNdefWritable();
console.log("ndef isNdefWritable: " + isWritable);

NdefTag.readNdef9+

readNdef(): Promise<NdefMessage>

读取标签上的NDEF消息，使用Promise方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

返回值：

类型 说明
Promise<NdefMessage> 以Promise形式返回从NDEF标签中读取到的Message数据对象。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefTag' correctly.

// connect the tag at first if not connected.
if (!ndefTag.isTagConnected()) {
    if (!ndefTag.connectTag()) {
        console.log("ndefTag connectTag failed.");
        return;
    }
}

try {
    ndefTag.readNdef().then((ndefmessage) => {
        console.log("ndef readNdef Promise ndefmessage: " + ndefmessage);
    }).catch((err)=> {
        console.log("ndef readNdef Promise err: " + err);
    });
} catch (busiError) {
    console.log("ndef readNdef Promise catched busiError: " + busiError);
}

NdefTag.readNdef9+

readNdef(callback: AsyncCallback<NdefMessage>): void

读取标签上的NDEF消息，使用AsyncCallback方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
callback AsyncCallback<NdefMessage> 是 回调函数，返回从NDEF标签中读取到的Message信息。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefTag' correctly.

// connect the tag at first if not connected.
if (!ndefTag.isTagConnected()) {
    if (!ndefTag.connectTag()) {
        console.log("ndefTag connectTag failed.");
        return;
    }
}

try {
    ndefTag.readNdef((err, ndefmessage)=> {
        if (err) {
            console.log("ndef readNdef AsyncCallback err: " + err);
        } else {
            console.log("ndef readNdef AsyncCallback ndefmessage: " + ndefmessage);
        }
    });
} catch (busiError) {
    console.log("ndef readNdef AsyncCallback catched busiError: " + busiError);
}

NdefTag.writeNdef9+

writeNdef(msg: NdefMessage): Promise<void>;

将NDEF Messsage数据对象写入标签，使用Promise方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
msg NdefMessage 是 NDEF Message数据对象。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefTag' correctly.
// ndefMessage created from raw data, such as:
let ndefMessage = tag.ndef.createNdefMessage([0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]);  // MUST can be parsed as NDEF Record.
// or ndefMessage created from tag.ndef.createNdefMessage(ndefRecords: NdefRecord[])

// connect the tag at first if not connected.
if (!ndefTag.isTagConnected()) {
    if (!ndefTag.connectTag()) {
        console.log("ndefTag connectTag failed.");
        return;
    }
}

try {
    ndefTag.writeNdef(ndefMessage).then(() => {
        console.log("ndef writeNdef Promise success.");
    }).catch((err)=> {
        console.log("ndef writeNdef err: " + err);
    });
} catch (busiError) {
    console.log("ndef writeNdef Promise catch busiError: " + busiError);
}

NdefTag.writeNdef9+

writeNdef(msg: NdefMessage, callback: AsyncCallback<void>): void

将NDEF Message数据对象写入此标签，使用AsyncCallback方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
msg NdefMessage 是 NDEF Message数据对象。
callback AsyncCallback<void> 是 回调函数。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefTag' correctly.
// ndefMessage created from raw data, such as:
let ndefMessage = tag.ndef.createNdefMessage([0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]);  // MUST can be parsed as NDEF Record.
// or ndefMessage created from tag.ndef.createNdefMessage(ndefRecords: NdefRecord[])

// connect the tag at first if not connected.
if (!ndefTag.isTagConnected()) {
    if (!ndefTag.connectTag()) {
        console.log("ndefTag connectTag failed.");
        return;
    }
}

try {
    ndefTag.writeNdef(ndefMessage, (err)=> {
        if (err) {
            console.log("ndef writeNdef AsyncCallback err: " + err);
        } else {
            console.log("ndef writeNdef AsyncCallback success.");
        }
    });
} catch (busiError) {
    console.log("ndef writeNdef AsyncCallback catch busiError: " + busiError);
}

NdefTag.canSetReadOnly9+

canSetReadOnly(): boolean

检查NDEF标签是否可以设置为只读。

需要权限： ohos.permission.NFC_TAG

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

返回值：

类型 说明
boolean true: NDEF标签可设置为只读， false: NDEF标签不可设置为只读。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefTag' correctly.
var canSetReadOnly = ndefTag.canSetReadOnly();
console.log("ndef canSetReadOnly: " + canSetReadOnly);

NdefTag.setReadOnly9+

setReadOnly(): Promise<void>

将NDEF标签设置为只读，使用Promise方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefTag' correctly.

// connect the tag at first if not connected.
if (!ndefTag.isTagConnected()) {
    if (!ndefTag.connectTag()) {
        console.log("ndefTag connectTag failed.");
        return;
    }
}

try {
    ndefTag.setReadOnly().then(() => {
        console.log("ndef setReadOnly Promise success.");
    }).catch((err)=> {
        console.log("ndef setReadOnly Promise err: " + err);
    });
} catch (busiError) {
    console.log("ndef setReadOnly Promise catch busiError: " + busiError);
}

NdefTag.setReadOnly9+

setReadOnly(callback: AsyncCallback<void>): void

将NDEF标签设置为只读，使用AsyncCallback方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
callback AsyncCallback<void> 是 回调函数。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefTag' correctly.

// connect the tag at first if not connected.
if (!ndefTag.isTagConnected()) {
    if (!ndefTag.connectTag()) {
        console.log("ndefTag connectTag failed.");
        return;
    }
}

try {
    ndefTag.setReadOnly((err)=> {
        if (err) {
            console.log("ndef setReadOnly AsyncCallback err: " + err);
        } else {
            console.log("ndef setReadOnly AsyncCallback success.");
        }
    });
} catch (busiError) {
    console.log("ndef setReadOnly AsyncCallback catch busiError: " + busiError);
}

NdefTag.getNdefTagTypeString9+

getNdefTagTypeString(type: tag.NfcForumType): string

将NFC论坛类型，转换为NFC论坛中定义的字符串描述。

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

参数：

参数名 类型 必填 说明
type tag.NfcForumType 是 NDEF标签类型，包括NFC FORUM TYPE 1/2/3/4等。

返回值：

类型 说明
string NFC论坛类型的字符串描述。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefTag' correctly.

try {
    let ndefTypeString = ndefTag.getNdefTagTypeString(tag.NFC_FORUM_TYPE_1);
    console.log("ndef ndefTypeString: " + ndefTypeString);
} catch (busiError) {
    console.log("ndef getNdefTagTypeString catch busiError: " + busiError);
}

MifareClassicTag9+

MifareClassicTag提供对MIFARE Classic属性和I/O操作的访问，继承自TagSession。

TagSession是所有NFC Tag技术类型的基类， 提供建立连接和发送数据等共同接口。具体请参见TagSession。

以下是MifareClassicTag的独有接口。

MifareClassicTag.authenticateSector9+

authenticateSector(sectorIndex: number, key: number[], isKeyA: boolean): Promise<void>

使用密钥对扇区进行身份验证，只有身份验证成功的扇区可以进行操作。使用Promise方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
sectorIndex number 是 待验证的扇区索引，从0开始。
key number[] 是 用于扇区验证的密钥（6字节）。
isKeyA boolean 是 isKeyA标志。true 表示KeyA，false 表示KeyB。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.

// connect the tag at first if not connected.
if (!mifareClassic.isTagConnected()) {
    if (!mifareClassic.connectTag()) {
        console.log("mifareClassic connectTag failed.");
        return;
    }
}

try {
    let sectorIndex = 1; // change it to be correct index.
    let key = [0x01, 0x02, 0x03, 0x04, 0x05, 0x06]  // MUST be 6 bytes, change it to be correct key.
    mifareClassic.authenticateSector(sectorIndex, key, true).then(() => {
        console.log("mifareClassic authenticateSector Promise success.");
    }).catch((err)=> {
        console.log("mifareClassic authenticateSector Promise err: " + err);
    });
} catch (busiError) {
    console.log("mifareClassic authenticateSector Promise catch busiError: " + busiError);
}

MifareClassicTag.authenticateSector9+

authenticateSector(sectorIndex: number, key: number[], isKeyA: boolean, callback: AsyncCallback<void>): void

使用密钥对扇区进行身份验证，只有身份验证成功的扇区可以进行操作。使用AsyncCallback方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
sectorIndex number 是 待验证的扇区索引，从0开始。
key number[] 是 用于扇区验证的密钥（6字节）。
isKeyA boolean 是 isKeyA标志。true 表示KeyA，false 表示KeyB。
callback AsyncCallback<void> 是 回调函数。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.

// connect the tag at first if not connected.
if (!mifareClassic.isTagConnected()) {
    if (!mifareClassic.connectTag()) {
        console.log("mifareClassic connectTag failed.");
        return;
    }
}

try {
    let sectorIndex = 1; // change it to be correct index.
    let key = [0x01, 0x02, 0x03, 0x04, 0x05, 0x06]  // MUST be 6 bytes, change it to be correct key.
    mifareClassic.authenticateSector(sectorIndex, key, true, (err)=> {
        if (err) {
            console.log("mifareClassic authenticateSector AsyncCallback err: " + err);
        } else {
            console.log("mifareClassic authenticateSector AsyncCallback success.");
        }
    });
} catch (busiError) {
    console.log("mifareClassic authenticateSector AsyncCallback catch busiError: " + busiError);
}

MifareClassicTag.readSingleBlock9+

readSingleBlock(blockIndex: number): Promise<number[]>

读取标签中一个块存储的内容，一个块大小为16字节。使用Promise方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
blockIndex number 是 要读取的块索引，从0开始。

返回值：

类型 说明
Promise<number[]> 读取的块数据。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.

// connect the tag at first if not connected.
if (!mifareClassic.isTagConnected()) {
    if (!mifareClassic.connectTag()) {
        console.log("mifareClassic connectTag failed.");
        return;
    }
}

try {
    let blockIndex = 1; // change it to be correct index.
    mifareClassic.readSingleBlock(blockIndex).then((data) => {
        console.log("mifareClassic readSingleBlock Promise data: " + data);
    }).catch((err)=> {
        console.log("mifareClassic readSingleBlock Promise err: " + err);
    });
} catch (busiError) {
    console.log("mifareClassic readSingleBlock Promise catch busiError: " + busiError);
}

MifareClassicTag.readSingleBlock9+

readSingleBlock(blockIndex: number, callback: AsyncCallback<number[]>): void

读取标签中一个块存储的内容，一个块大小为16字节。使用AsyncCallback方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
blockIndex number 是 要读取的块索引，从0开始。
callback AsyncCallback<number[]> 是 回调函数，返回读取到的数据。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.

// connect the tag at first if not connected.
if (!mifareClassic.isTagConnected()) {
    if (!mifareClassic.connectTag()) {
        console.log("mifareClassic connectTag failed.");
        return;
    }
}

try {
    let blockIndex = 1; // change it to be correct index.
    mifareClassic.readSingleBlock(blockIndex, (err, data)=> {
        if (err) {
            console.log("mifareClassic readSingleBlock AsyncCallback err: " + err);
        } else {
            console.log("mifareClassic readSingleBlock AsyncCallback data: " + data);
        }
    });
} catch (busiError) {
    console.log("mifareClassic readSingleBlock AsyncCallback catch busiError: " + busiError);
}

MifareClassicTag.writeSingleBlock9+

writeSingleBlock(blockIndex: number, data: number[]): Promise<void>

向标签中一个块存储写入内容，一个块大小为16字节。使用Promise方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
blockIndex number 是 要写入的块索引，从0开始。
data number[] 是 要写入的数据，大小必须是16个字节。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.

// connect the tag at first if not connected.
if (!mifareClassic.isTagConnected()) {
    if (!mifareClassic.connectTag()) {
        console.log("mifareClassic connectTag failed.");
        return;
    }
}

try {
    let blockIndex = 1; // change it to be correct index.
    let rawData = [0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A,
        0x0B, 0x0C, 0x0D, 0x0E, 0x0F, 0x10]; // MUST be 16 bytes, change it to be correct data.
    mifareClassic.writeSingleBlock(blockIndex, rawData).then(() => {
        console.log("mifareClassic writeSingleBlock Promise success.");
    }).catch((err)=> {
        console.log("mifareClassic writeSingleBlock Promise err: " + err);
    });
} catch (busiError) {
    console.log("mifareClassic writeSingleBlock Promise catch busiError: " + busiError);
}

MifareClassicTag.writeSingleBlock9+

writeSingleBlock(blockIndex: number, data: number[], callback: AsyncCallback<void>): void

向标签中一个块存储写入内容，一个块大小为16字节。使用AsyncCallback方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
blockIndex number 是 要写入的块索引，从0开始。
data number[] 是 要写入的数据，大小必须是16个字节。
callback AsyncCallback<void> 是 回调函数。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.

// connect the tag at first if not connected.
if (!mifareClassic.isTagConnected()) {
    if (!mifareClassic.connectTag()) {
        console.log("mifareClassic connectTag failed.");
        return;
    }
}

try {
    let blockIndex = 1; // change it to be correct index.
    let rawData = [0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A,
        0x0B, 0x0C, 0x0D, 0x0E, 0x0F, 0x10]; // MUST be 16 bytes, change it to be correct data.
    mifareClassic.writeSingleBlock(blockIndex, rawData, (err)=> {
        if (err) {
            console.log("mifareClassic writeSingleBlock AsyncCallback err: " + err);
        } else {
            console.log("mifareClassic writeSingleBlock AsyncCallback success.");
        }
    });
} catch (busiError) {
    console.log("mifareClassic writeSingleBlock AsyncCallback catch busiError: " + busiError);
}

MifareClassicTag.incrementBlock9+

incrementBlock(blockIndex: number, value: number): Promise<void>

对指定块的内容，增加指定的数值。使用Promise方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
blockIndex number 是 要指定增加的块索引，从0开始。
value number 是 要指定增加的数据，非负数。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.

// connect the tag at first if not connected.
if (!mifareClassic.isTagConnected()) {
    if (!mifareClassic.connectTag()) {
        console.log("mifareClassic connectTag failed.");
        return;
    }
}

try {
    let blockIndex = 1; // change it to be correct index.
    let value = 0x20; // change it to be correct data.
    mifareClassic.incrementBlock(blockIndex, value).then(() => {
        console.log("mifareClassic incrementBlock Promise success.");
    }).catch((err)=> {
        console.log("mifareClassic incrementBlock Promise err: " + err);
    });
} catch (busiError) {
    console.log("mifareClassic incrementBlock Promise catch busiError: " + busiError);
}

MifareClassicTag.incrementBlock9+

incrementBlock(blockIndex: number, value: number, callback: AsyncCallback<void>): void

对指定块的内容，增加指定的数值。使用AsyncCallback方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
blockIndex number 是 要被运算的块索引，从0开始。
value number 是 要增加的数值，非负数。
callback AsyncCallback<void> 是 回调函数。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.

// connect the tag at first if not connected.
if (!mifareClassic.isTagConnected()) {
    if (!mifareClassic.connectTag()) {
        console.log("mifareClassic connectTag failed.");
        return;
    }
}

try {
    let blockIndex = 1; // change it to be correct index.
    let value = 0x20; // change it to be correct data.
    mifareClassic.incrementBlock(blockIndex, value, (err)=> {
        if (err) {
            console.log("mifareClassic incrementBlock AsyncCallback err: " + err);
        } else {
            console.log("mifareClassic incrementBlock AsyncCallback success.");
        }
    });
} catch (busiError) {
    console.log("mifareClassic incrementBlock AsyncCallback catch busiError: " + busiError);
}

MifareClassicTag.decrementBlock9+

decrementBlock(blockIndex: number, value: number): Promise<void>

对指定块的内容，减少指定的数值。使用Promise方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
blockIndex number 是 要被运算的块索引，从0开始。
value number 是 要减少的数值，非负数。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.

// connect the tag at first if not connected.
if (!mifareClassic.isTagConnected()) {
    if (!mifareClassic.connectTag()) {
        console.log("mifareClassic connectTag failed.");
        return;
    }
}

try {
    let blockIndex = 1; // change it to be correct index.
    let value = 0x20; // change it to be correct data.
    mifareClassic.decrementBlock(blockIndex, value).then(() => {
        console.log("mifareClassic decrementBlock Promise success.");
    }).catch((err)=> {
        console.log("mifareClassic decrementBlock Promise err: " + err);
    });
} catch (busiError) {
    console.log("mifareClassic decrementBlock Promise catch busiError: " + busiError);
}

MifareClassicTag.decrementBlock9+

decrementBlock(blockIndex: number, value: number, callback: AsyncCallback<void>): void

对指定块的内容，减少指定的数值。使用AsyncCallback方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
blockIndex number 是 要被运算的块索引，从0开始。
value number 是 要减少的数值，非负数。
callback AsyncCallback<void> 是 回调函数。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.

// connect the tag at first if not connected.
if (!mifareClassic.isTagConnected()) {
    if (!mifareClassic.connectTag()) {
        console.log("mifareClassic connectTag failed.");
        return;
    }
}

try {
    let blockIndex = 1; // change it to be correct index.
    let value = 0x20; // change it to be correct data.
    mifareClassic.decrementBlock(blockIndex, value, (err)=> {
        if (err) {
            console.log("mifareClassic decrementBlock AsyncCallback err: " + err);
        } else {
            console.log("mifareClassic decrementBlock AsyncCallback success.");
        }
    });
} catch (busiError) {
    console.log("mifareClassic decrementBlock AsyncCallback catch busiError: " + busiError);
}

MifareClassicTag.transferToBlock9+

transferToBlock(blockIndex: number): Promise<void>

将临时寄存器的值转移到指定的块。使用Promise方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
blockIndex number 是 被操作的块的索引，从0开始。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.

// connect the tag at first if not connected.
if (!mifareClassic.isTagConnected()) {
    if (!mifareClassic.connectTag()) {
        console.log("mifareClassic connectTag failed.");
        return;
    }
}

try {
    let blockIndex = 1; // change it to be correct index.
    mifareClassic.transferToBlock(blockIndex).then(() => {
        console.log("mifareClassic transferToBlock Promise success.");
    }).catch((err)=> {
        console.log("mifareClassic transferToBlock Promise err: " + err);
    });
} catch (busiError) {
    console.log("mifareClassic transferToBlock Promise catch busiError: " + busiError);
}

MifareClassicTag.transferToBlock9+

transferToBlock(blockIndex: number, callback: AsyncCallback<void>): void

将临时寄存器的值转移到指定的块。使用AsyncCallback方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
blockIndex number 是 被操作的块的索引，从0开始。
callback AsyncCallback<void> 是 回调函数。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.

// connect the tag at first if not connected.
if (!mifareClassic.isTagConnected()) {
    if (!mifareClassic.connectTag()) {
        console.log("mifareClassic connectTag failed.");
        return;
    }
}

try {
    let blockIndex = 1; // change it to be correct index.
    mifareClassic.transferToBlock(blockIndex, (err)=> {
        if (err) {
            console.log("mifareClassic transferToBlock AsyncCallback err: " + err);
        } else {
            console.log("mifareClassic transferToBlock AsyncCallback success.");
        }
    });
} catch (busiError) {
    console.log("mifareClassic transferToBlock AsyncCallback catch busiError: " + busiError);
}

MifareClassicTag.restoreFromBlock9+

restoreFromBlock(blockIndex: number): Promise<void>

将指定块的值复制到临时寄存器。使用Promise方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
blockIndex number 是 被操作的块的索引，从0开始。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.

// connect the tag at first if not connected.
if (!mifareClassic.isTagConnected()) {
    if (!mifareClassic.connectTag()) {
        console.log("mifareClassic connectTag failed.");
        return;
    }
}

try {
    let blockIndex = 1; // change it to be correct index.
    mifareClassic.restoreFromBlock(blockIndex).then(() => {
        console.log("mifareClassic restoreFromBlock Promise success.");
    }).catch((err)=> {
        console.log("mifareClassic restoreFromBlock Promise err: " + err);
    });
} catch (busiError) {
    console.log("mifareClassic restoreFromBlock Promise catch busiError: " + busiError);
}

MifareClassicTag.restoreFromBlock9+

restoreFromBlock(blockIndex: number, callback: AsyncCallback<void>): void

将指定块的值复制到临时寄存器。使用AsyncCallback方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
blockIndex number 是 被操作的块的索引，从0开始。
callback AsyncCallback<void> 是 回调函数。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.

// connect the tag at first if not connected.
if (!mifareClassic.isTagConnected()) {
    if (!mifareClassic.connectTag()) {
        console.log("mifareClassic connectTag failed.");
        return;
    }
}

try {
    let blockIndex = 1; // change it to be correct index.
    mifareClassic.restoreFromBlock(blockIndex, (err)=> {
        if (err) {
            console.log("mifareClassic restoreFromBlock AsyncCallback err: " + err);
        } else {
            console.log("mifareClassic restoreFromBlock AsyncCallback success.");
        }
    });
} catch (busiError) {
    console.log("mifareClassic restoreFromBlock AsyncCallback catch busiError: " + busiError);
}

MifareClassicTag.getSectorCount9+

getSectorCount(): number

获取MIFARE Classic标签中的扇区数。

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

返回值：

类型 说明
number 标签中的扇区数量。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.
let sectorCount = mifareClassic.getSectorCount();
console.log("mifareClassic sectorCount: " + sectorCount);

MifareClassicTag.getBlockCountInSector9+

getBlockCountInSector(sectorIndex: number): number

获取指定扇区中的块数。

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

参数：

参数名 类型 必填 说明
sectorIndex number 是 扇区序号，从0开始。

返回值：

类型 说明
number 该扇区内的块数量。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.

try {
    let sectorIndex = 1; // change it to be correct index.
    let blockCnt = mifareClassic.getBlockCountInSector(sectorIndex);
    console.log("mifareClassic blockCnt: " + blockCnt);
} catch (busiError) {
    console.log("mifareClassic getBlockCountInSector catch busiError: " + busiError);
}

MifareClassicTag.getType9+

getType(): tag.MifareClassicType

获取MIFARE Classic标签的类型。

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

返回值：

类型 说明
tag.MifareClassicType MifareClassic标签的类型。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.
let getType = mifareClassic.getType();
console.log("mifareClassic getType: " + getType);

MifareClassicTag.getTagSize9+

getTagSize(): number

获取标签的存储空间大小，具体请参见MifareClassicSize。

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

返回值：

类型 说明
number 标签的大小，单位为字节，请参见MifareClassicSize。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.
let tagSize = mifareClassic.getTagSize();
console.log("mifareClassic tagSize: " + tagSize);

MifareClassicTag.isEmulatedTag9+

isEmulatedTag(): boolean

检查标签是不是被模拟的。

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

返回值：

类型 说明
boolean 检查结果，true: 是；false：否。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.
let isEmulatedTag = mifareClassic.isEmulatedTag();
console.log("mifareClassic isEmulatedTag: " + isEmulatedTag);

MifareClassicTag.getBlockIndex9+

getBlockIndex(sectorIndex: number): number

获取特定扇区的第一个块的序号。

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

参数：

参数名 类型 必填 说明
sectorIndex number 是 扇区序号，从0开始。

返回值：

类型 说明
number 该扇区内的第一个块的序号，从0开始。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.

try {
    let sectorIndex = 1; // change it to be correct index.
    let blockIndex = mifareClassic.getBlockIndex(sectorIndex);
    console.log("mifareClassic blockIndex: " + blockIndex);
} catch (busiError) {
    console.log("mifareClassic getBlockIndex catch busiError: " + busiError);
}

MifareClassicTag.getSectorIndex9+

getSectorIndex(blockIndex: number): number

获取包含指定块号的扇区序号。

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

参数：

参数名 类型 必填 说明
blockIndex number 是 块序号，从0开始。

返回值：

类型 说明
number 扇区序号，从0开始。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareClassic' correctly.

try {
    let blockIndex = 1; // change it to be correct index.
    let sectorIndex = mifareClassic.getSectorIndex(blockIndex);
    console.log("mifareClassic sectorIndex: " + sectorIndex);
} catch (busiError) {
    console.log("mifareClassic getSectorIndex catch busiError: " + busiError);
}

MifareUltralightTag9+

MifareUltralightTag 提供对MIFARE Ultralight属性和I/O操作的访问，继承自TagSession。

TagSession是所有NFC Tag技术类型的基类， 提供建立连接和发送数据等共同接口。具体请参见TagSession。

以下是MifareUltralightTag的独有接口。

MifareUltralightTag.readMultiplePages9+

readMultiplePages(pageIndex: number): Promise<number[]>

读取标签的4页数据，共16字节的数据。每个页面数据大小为4字节。使用Promise方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
pageIndex number 是 要读取页面的索引，从0开始。

返回值：

类型 说明
Promise<number[]> 读取的4页的数据，共16字节。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：


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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareUltralight' correctly.

// connect the tag at first if not connected.
if (!mifareUltralight.isTagConnected()) {
    if (!mifareUltralight.connectTag()) {
        console.log("mifareUltralight connectTag failed.");
        return;
    }
}

try {
    let pageIndex = 1; // change it to be correct index.
    mifareUltralight.readMultiplePages(pageIndex).then((data) => {
        console.log("mifareUltralight readMultiplePages Promise data = " + data);
    }).catch((err)=> {
        console.log("mifareUltralight readMultiplePages Promise err: " + err);
    });
} catch (busiError) {
    console.log("mifareUltralight readMultiplePages Promise catch busiError: " + busiError);
}

MifareUltralightTag.readMultiplePages9+

readMultiplePages(pageIndex: number, callback: AsyncCallback<number[]>): void

读取标签的4页数据，共16字节的数据。每个页面数据大小为4字节。使用AsyncCallback方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
pageIndex number 是 要读取页面的索引，从0开始。
callback AsyncCallback<number[]> 是 回调函数，返回读取到的数据，共16字节。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareUltralight' correctly.

// connect the tag at first if not connected.
if (!mifareUltralight.isTagConnected()) {
    if (!mifareUltralight.connectTag()) {
        console.log("mifareUltralight connectTag failed.");
        return;
    }
}

try {
    let pageIndex = 1; // change it to be correct index.
    mifareUltralight.readMultiplePages(pageIndex, (err, data)=> {
        if (err) {
            console.log("mifareUltralight readMultiplePages AsyncCallback err: " + err);
        } else {
            console.log("mifareUltralight readMultiplePages AsyncCallback data: " + data);
        }
    });
} catch (busiError) {
    console.log("mifareUltralight readMultiplePages AsyncCallback catch busiError: " + busiError);
}

MifareUltralightTag.writeSinglePage9+

writeSinglePage(pageIndex: number, data: number[]): Promise<void>

写入一页数据，数据大小为4字节。使用Promise方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
pageIndex number 是 要写入页面的索引，从0开始。
data number[] 是 要写入页面的数据内容，必须是4个字节大小。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareUltralight' correctly.

// connect the tag at first if not connected.
if (!mifareUltralight.isTagConnected()) {
    if (!mifareUltralight.connectTag()) {
        console.log("mifareUltralight connectTag failed.");
        return;
    }
}

try {
    let pageIndex = 1; // change it to be correct index.
    let rawData = [0x01, 0x02, 0x03, 0x04]; // MUST be 4 bytes, change it to be correct raw data.
    mifareUltralight.writeSinglePage(pageIndex, rawData).then(() => {
        console.log("mifareUltralight writeSinglePage Promise success.");
    }).catch((err)=> {
        console.log("mifareUltralight writeSinglePage Promise err: " + err);
    });
} catch (busiError) {
    console.log("mifareUltralight writeSinglePage Promise catch busiError: " + busiError);
}

MifareUltralightTag.writeSinglePage9+

writeSinglePage(pageIndex: number, data: number[], callback: AsyncCallback<void>): void

写入一页数据，数据大小为4字节。使用AsyncCallback方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
pageIndex number 是 要写入页面的索引，从0开始。
data number[] 是 要写入页面的数据内容，必须是4个字节大小。
callback AsyncCallback<void> 是 回调函数。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareUltralight' correctly.

// connect the tag at first if not connected.
if (!mifareUltralight.isTagConnected()) {
    if (!mifareUltralight.connectTag()) {
        console.log("mifareUltralight connectTag failed.");
        return;
    }
}

try {
    let pageIndex = 1; // change it to be correct index.
    let rawData = [0x01, 0x02, 0x03, 0x04]; // MUST be 4 bytes, change it to be correct raw data.
    mifareUltralight.writeSinglePage(pageIndex, rawData, (err)=> {
        if (err) {
            console.log("mifareUltralight writeSinglePage AsyncCallback err: " + err);
        } else {
            console.log("mifareUltralight writeSinglePage AsyncCallback success.");
        }
    });
} catch (busiError) {
    console.log("mifareUltralight writeSinglePage AsyncCallback catch busiError: " + busiError);
}

MifareUltralightTag.getType9+

getType(): tag.MifareUltralightType

获取MIFARE Ultralight标签的类型。

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

返回值：

类型 说明
tag.MifareUltralightType MIFARE Ultralight标签的类型。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'mifareUltralight' correctly.
let getType = mifareClassic.getType();
console.log("mifareUltralight getType: " + getType);

NdefFormatableTag9+

NdefFormatableTag为NDEF Formattable的标签提供格式化操作，继承自TagSession。

TagSession是所有NFC Tag 技术类型的基类， 提供建立连接和发送数据等共同接口。具体请参见TagSession。

以下是NdefFormatableTag的独有接口。

NdefFormatableTag.format9+

format(message: NdefMessage): Promise<void>

将标签格式化为NDEF标签，将NDEF消息写入NDEF标签。使用Promise方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
message NdefMessage 是 格式化成功时要写入的NDEF消息。可以为null，为null时仅格式化标签，不写入内容。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefFormatable' correctly.

// connect the tag at first if not connected.
if (!ndefFormatable.isTagConnected()) {
    if (!ndefFormatable.connectTag()) {
        console.log("ndefFormatable connectTag failed.");
        return;
    }
}

try {
    // ndefMessage created from raw data, such as:
    let ndefMessage = tag.ndef.createNdefMessage([0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]);  // MUST can be parsed as NDEF Record.
    // or ndefMessage created from tag.ndef.createNdefMessage(ndefRecords: NdefRecord[])

    ndefFormatable.format(ndefMessage).then(() => {
        console.log("ndefFormatable format Promise success.");
    }).catch((err)=> {
        console.log("ndefFormatable format Promise err: " + err);
    });
} catch (busiError) {
    console.log("ndefFormatable format Promise catch busiError: " + busiError);
}

NdefFormatableTag.format9+

format(message: NdefMessage, callback: AsyncCallback<void>): void

将标签格式化为NDEF标签，然后将NDEF消息写入NDEF标签。使用AsyncCallback方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
message NdefMessage 是 格式化成功时要写入的Ndef消息。可以为null，为null时仅格式化标签，不写入内容。

返回值：

类型 说明
callback: AsyncCallback<void> 回调函数。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefFormatable' correctly.

// connect the tag at first if not connected.
if (!ndefFormatable.isTagConnected()) {
    if (!ndefFormatable.connectTag()) {
        console.log("ndefFormatable connectTag failed.");
        return;
    }
}

try {
    // ndefMessage created from raw data, such as:
    let ndefMessage = tag.ndef.createNdefMessage([0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]);  // MUST can be parsed as NDEF Record.
    // or ndefMessage created from tag.ndef.createNdefMessage(ndefRecords: NdefRecord[])

    ndefFormatable.format(ndefMessage, (err)=> {
        if (err) {
            console.log("ndefFormatable format AsyncCallback err: " + err);
        } else {
            console.log("ndefFormatable format AsyncCallback success.");
        }
    });
} catch (busiError) {
    console.log("ndefFormatable format AsyncCallback catch busiError: " + busiError);
}

NdefFormatableTag.formatReadOnly9+

formatReadOnly(message: NdefMessage): Promise<void>

将标签格式化为NDEF标签，将NDEF消息写入NDEF标签，之后将标签设置为只读。使用Promise方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
message NdefMessage 是 格式化成功时要写入的NDEF消息。可以为null，为null时仅格式化标签，不写入内容。

错误码：

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

错误码ID 错误信息
3100201 Tag running state is abnormal in service.

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefFormatable' correctly.

// connect the tag at first if not connected.
if (!ndefFormatable.isTagConnected()) {
    if (!ndefFormatable.connectTag()) {
        console.log("ndefFormatable connectTag failed.");
        return;
    }
}

try {
    // ndefMessage created from raw data, such as:
    let ndefMessage = tag.ndef.createNdefMessage([0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]);  // MUST can be parsed as NDEF Record.
    // or ndefMessage created from tag.ndef.createNdefMessage(ndefRecords: NdefRecord[])

    ndefFormatable.formatReadOnly(ndefMessage).then(() => {
        console.log("ndefFormatable formatReadOnly Promise success.");
    }).catch((err)=> {
        console.log("ndefFormatable formatReadOnly Promise err: " + err);
    });
} catch (busiError) {
    console.log("ndefFormatable formatReadOnly Promise catch busiError: " + busiError);
}

NdefFormatableTag.formatReadOnly9+

formatReadOnly(message: NdefMessage, callback: AsyncCallback<void>): void

将标签格式化为NDEF标签，然后将NDEF消息写入NDEF标签，之后将标签设置为只读。使用callback方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

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

参数：

参数名 类型 必填 说明
message NdefMessage 是 格式化成功时要写入的NDEF消息。可以为null，为null时仅格式化标签，不写入内容。

返回值：

类型 说明
callback: AsyncCallback<void> 回调函数。

示例：

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

// see 'tag.TagInfo' at 'js-apis-nfcTag.md', obtains the 'ndefFormatable' correctly.

// connect the tag at first if not connected.
if (!ndefFormatable.isTagConnected()) {
    if (!ndefFormatable.connectTag()) {
        console.log("ndefFormatable connectTag failed.");
        return;
    }
}

try {
    // ndefMessage created from raw data, such as:
    let ndefMessage = tag.ndef.createNdefMessage([0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]);  // MUST can be parsed as NDEF Record.
    // or ndefMessage created from tag.ndef.createNdefMessage(ndefRecords: NdefRecord[])

    ndefFormatable.formatReadOnly(ndefMessage, (err)=> {
        if (err) {
            console.log("ndefFormatable formatReadOnly AsyncCallback err: " + err);
        } else {
            console.log("ndefFormatable formatReadOnly AsyncCallback success.");
        }
    });
} catch (busiError) {
    console.log("ndefFormatable formatReadOnly AsyncCallback catch busiError: " + busiError);
}