js-apis-nfctech.md 62.1 KB
Newer Older
A
Annie_wang 已提交
1
# NFC Tag Technologies
A
Annie_wang 已提交
2

A
Annie_wang 已提交
3
The **nfctech** module provides APIs for reading and writing tags that use different Near-Field Communication (NFC) technologies.
A
Annie_wang 已提交
4 5 6 7 8 9 10 11 12 13 14 15

> **NOTE**
> The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.

## **Modules to Import**

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

## NfcATag

A
Annie_wang 已提交
16
Provides access to NFC-A (ISO 14443-3A) properties and I/O operations. This class inherits from **TagSession**.
A
Annie_wang 已提交
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35

**TagSession** is the base class of all NFC tag technologies. It provides common interfaces for establishing connections and transferring data. For more details, see [TagSession](js-apis-tagSession.md).

The following describes the unique interfaces of **NfcATag**.

### NfcATag.getSak

getSak(): number

Obtains the SAK value of this NFC-A tag.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC.Core

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
36
| number  | SAK value obtained. The SAK is a hexadecimal number ranging from **0x00** to **0xFF**.|
A
Annie_wang 已提交
37 38 39 40 41 42

**Example**

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

A
Annie_wang 已提交
43 44 45 46
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'nfcA' correctly.

let sak = nfcA.getSak();
console.log("nfcA sak: " + sak);
A
Annie_wang 已提交
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
```

### NfcATag.getAtqa

getAtqa(): number[]

Obtains the ATQA value of this NFC-A tag.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC.Core

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
63
| number[]  | ATQA value obtained. Each number of the ATQA is a hexadecimal number ranging from **0x00** to **0xFF**.|
A
Annie_wang 已提交
64 65 66 67 68 69

**Example**

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

A
Annie_wang 已提交
70 71 72
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'nfcA' correctly.
let atqa = nfcA.getAtqa();
console.log("nfcA atqa: " + atqa);
A
Annie_wang 已提交
73 74 75 76
```

## NfcBTag

A
Annie_wang 已提交
77
Provides access to NFC-B (ISO 14443-3B) properties and I/O operations. This class inherits from **TagSession**.
A
Annie_wang 已提交
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96

**TagSession** is the base class of all NFC tag technologies. It provides common interfaces for establishing connections and transferring data. For more details, see [TagSession](js-apis-tagSession.md).

The following describes the unique interfaces of **NfcBTag**.

### NfcBTag.getRespAppData

getRespAppData(): number[]

Obtains the application data of this NFC-B tag.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC.Core

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
97
| number[]  | Application data obtained. Each number in the return result is a hexadecimal number ranging from **0x00** to **0xFF**.|
A
Annie_wang 已提交
98 99 100 101 102 103

**Example**

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

A
Annie_wang 已提交
104 105 106
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'nfcB' correctly.
let respAppData = nfcB.getRespAppData();
console.log("nfcB respAppData: " + respAppData);
A
Annie_wang 已提交
107 108 109 110 111 112
```

### NfcBTag.getRespProtocol

getRespProtocol(): number[]

A
Annie_wang 已提交
113
Obtains the protocol information of this NFC-B tag.
A
Annie_wang 已提交
114 115 116 117 118 119 120 121 122

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC.Core

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
123
| number[]  | Protocol information obtained. Each number in the return result is a hexadecimal number ranging from **0x00** to **0xFF**.|
A
Annie_wang 已提交
124 125 126 127 128 129

**Example**

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

A
Annie_wang 已提交
130 131 132
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'nfcB' correctly.
let respProtocol = nfcB.getRespProtocol();
console.log("nfcB respProtocol: " + respProtocol);
A
Annie_wang 已提交
133 134 135 136
```

## NfcFTag

A
Annie_wang 已提交
137
Provides access to NFC-F (JIS 6319-4) properties and I/O operations. This class inherits from **TagSession**.
A
Annie_wang 已提交
138 139 140 141 142 143 144 145 146

**TagSession** is the base class of all NFC tag technologies. It provides common interfaces for establishing connections and transferring data. For more details, see [TagSession](js-apis-tagSession.md).

The following describes the unique interfaces of **NfcFTag**.

### NfcFTag.getSystemCode

getSystemCode(): number[]

A
Annie_wang 已提交
147
Obtains the system code from this NFC-F tag.
A
Annie_wang 已提交
148 149 150 151 152 153 154 155 156

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC.Core

**Return value**

| **Type**| **Description**                           |
| ------------------ | --------------------------|
A
Annie_wang 已提交
157
| number[]  | System code obtained. Each number in the system code is a hexadecimal number ranging from **0x00** to **0xFF**.|
A
Annie_wang 已提交
158 159 160 161 162 163

**Example**

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

A
Annie_wang 已提交
164 165 166
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'nfcF' correctly.
let systemCode = nfcF.getSystemCode();
console.log("nfcF systemCode: " + systemCode);
A
Annie_wang 已提交
167 168 169 170 171 172
```

### NfcFTag.getPmm

getPmm(): number[]

A
Annie_wang 已提交
173
Obtains the PMm (consisting of the IC code and manufacturer parameters) information from this NFC-F tag.
A
Annie_wang 已提交
174 175 176 177 178 179 180 181 182

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
183
| number[]  | PMm information obtained. Each number in the return result is a hexadecimal number ranging from **0x00** to **0xFF**.|
A
Annie_wang 已提交
184 185 186 187 188 189

**Example**

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

A
Annie_wang 已提交
190 191 192
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'nfcF' correctly.
let pmm = nfcF.getPmm();
console.log("nfcF pmm: " + pmm);
A
Annie_wang 已提交
193 194 195 196
```

## NfcVTag

A
Annie_wang 已提交
197
Provides access to NFC-V (ISO 15693) properties and I/O operations. This class inherits from **TagSession**.
A
Annie_wang 已提交
198 199 200 201 202 203 204 205 206

**TagSession** is the base class of all NFC tag technologies. It provides common interfaces for establishing connections and transferring data. For more details, see [TagSession](js-apis-tagSession.md).

The following describes the unique interfaces of **NfcVTag**.

### NfcvTag.getResponseFlags

getResponseFlags(): number

A
Annie_wang 已提交
207
Obtains the response flags from this NFC-V tag.
A
Annie_wang 已提交
208 209 210 211 212 213 214 215 216

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
217
| number | Response flags obtained. The value is a hexadecimal number ranging from **0x00** to **0xFF**.|
A
Annie_wang 已提交
218 219 220 221 222 223

**Example**

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

A
Annie_wang 已提交
224 225 226
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'nfcV' correctly.
let responseFlags = nfcV.getResponseFlags();
console.log("nfcV responseFlags: " + responseFlags);
A
Annie_wang 已提交
227 228 229 230 231 232
```

### NfcvTag.getDsfId

getDsfId(): number

A
Annie_wang 已提交
233
Obtains the data storage format identifier (DSFID) from this NFC-V tag.
A
Annie_wang 已提交
234 235 236 237 238 239 240 241 242

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
243
| number | DSFID obtained. The value is a hexadecimal number ranging from **0x00** to **0xFF**.|
A
Annie_wang 已提交
244 245 246 247 248 249

**Example**

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

A
Annie_wang 已提交
250 251 252
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'nfcV' correctly.
let dsfId = nfcV.getDsfId();
console.log("nfcV dsfId: " + dsfId);
A
Annie_wang 已提交
253 254 255 256
```

## IsoDepTag<sup>9+</sup> 

A
Annie_wang 已提交
257
Provides access to ISO-DEP (ISO 14443-4) properties and I/O operations. This class inherits from **TagSession**.
A
Annie_wang 已提交
258 259 260 261 262 263 264

**TagSession** is the base class of all NFC tag technologies. It provides common interfaces for establishing connections and transferring data. For more details, see [TagSession](js-apis-tagSession.md).

The following describes the unique interfaces of **IsoDepTag**.

### IsoDepTag.getHistoricalBytes<sup>9+</sup>

A
Annie_wang 已提交
265
getHistoricalBytes(): number[]
A
Annie_wang 已提交
266 267 268 269 270 271 272 273 274 275 276

Obtains the historical bytes of this tag.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
277
| number[] | Historical bytes obtained. Each number in the return result is a hexadecimal number ranging from **0x00** to **0xFF**.|
A
Annie_wang 已提交
278 279 280 281 282 283

**Example**

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

A
Annie_wang 已提交
284 285 286
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'isoDep' correctly.
let historicalBytes = isoDep.getHistoricalBytes();
console.log("isoDep historicalBytes: " + historicalBytes);
A
Annie_wang 已提交
287 288 289 290
```

### IsoDepTag.getHiLayerResponse<sup>9+</sup>

A
Annie_wang 已提交
291
getHiLayerResponse(): number[]
A
Annie_wang 已提交
292 293 294 295 296 297 298 299 300 301 302

Obtains the HiLayer response of this tag.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
303
| number[] | HiLayer response obtained. Each number in the return result is a hexadecimal number ranging from **0x00** to **0xFF**.|
A
Annie_wang 已提交
304 305 306 307 308 309

**Example**

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

A
Annie_wang 已提交
310 311 312
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'isoDep' correctly.
let hiLayerResponse = isoDep.getHiLayerResponse();
console.log("isoDep hiLayerResponse: " + hiLayerResponse);
A
Annie_wang 已提交
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
```

### IsoDepTag.isExtendedApduSupported<sup>9+</sup>

isExtendedApduSupported(): Promise&lt;boolean&gt;

Checks whether an extended application protocol data unit (APDU) is supported. This API uses a promise to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| Promise&lt;boolean&gt; | Promise used to return the result. If the extended APDU is supported, **true** is returned; otherwise, **false** is returned.|

**Example**

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

A
Annie_wang 已提交
336 337 338 339 340 341 342
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'isoDep' correctly.
isoDep.isExtendedApduSupported()
    .then((data) => {
        console.log("isoDep isExtendedApduSupported data: " + data);
    }).catch((err)=> {
        console.log("isoDep isExtendedApduSupported err: " + err);
    });
A
Annie_wang 已提交
343 344 345 346 347 348
```

### IsoDepTag.isExtendedApduSupported<sup>9+</sup>

isExtendedApduSupported(callback: AsyncCallback\<boolean>): void

A
Annie_wang 已提交
349
Checks whether an extended APDU is supported. This API uses an asynchronous callback to return the result.
A
Annie_wang 已提交
350 351 352 353 354 355 356 357 358 359 360 361 362 363

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback\<boolean> | Yes  | Callback invoked to return the result. If the extended APDU is supported, **true** is returned; otherwise, **false** is returned.|

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

A
Annie_wang 已提交
364 365 366 367 368 369 370 371
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'isoDep' correctly.
isoDep.isExtendedApduSupported((err, data)=> {
    if (err) {
        console.log("isoDep isExtendedApduSupported err: " + err);
    } else {
        console.log("isoDep isExtendedApduSupported data: " + data);
    }
});
A
Annie_wang 已提交
372 373 374 375
```

## NdefTag<sup>9+</sup>

A
Annie_wang 已提交
376
Provides access to the tags in the NFC Data Exchange Format (NDEF). This class inherits from **TagSession**.
A
Annie_wang 已提交
377 378 379 380 381 382 383

**TagSession** is the base class of all NFC tag technologies. It provides common interfaces for establishing connections and transferring data. For more details, see [TagSession](js-apis-tagSession.md).

The following describes the unique interfaces of **NdefTag**.

### NdefTag.createNdefMessage<sup>9+</sup>

A
Annie_wang 已提交
384
createNdefMessage(data: number[]): [NdefMessage](#ndefmessage9)
A
Annie_wang 已提交
385 386 387 388 389 390 391 392 393 394 395

Creates an NDEF message using raw bytes.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- |
A
Annie_wang 已提交
396
| data | number[] | Yes| Raw bytes used to create the message. Each number is a hexadecimal number ranging from **0x00** to **0xFF**.|
A
Annie_wang 已提交
397 398 399 400 401

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
402
| [NdefMessage](#ndefmessage9) | NDEF message created. For details, see *NFCForum-TS-NDEF_1.0*.|
A
Annie_wang 已提交
403 404 405 406 407 408

**Example**

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

A
Annie_wang 已提交
409 410 411 412
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndef' correctly.
let rawData = [0x00, 0xa4, 0x04, ......]; // change the raw data bytes tobe correct.
let ndefMessage = ndef.createNdefMessage(rawData);
console.log("ndef ndefMessage: " + ndefMessage);
A
Annie_wang 已提交
413 414 415 416 417 418
```

## NdefMessage<sup>9+</sup>

### NdefMessage.getNdefRecords<sup>9+</sup>

A
Annie_wang 已提交
419
getNdefRecords(): [NdefRecord](js-apis-nfcTag.md#ndefrecord9)[ ]
A
Annie_wang 已提交
420 421 422 423 424 425 426 427 428 429 430

Obtains all NDEF records.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
431
| [NdefRecord](js-apis-nfcTag.md#ndefrecord9)[ ] | List of NDEF records obtained. For details, see *NFCForum-TS-NDEF_1.0*.|
A
Annie_wang 已提交
432 433 434 435 436 437

**Example**

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

A
Annie_wang 已提交
438 439 440
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndef' correctly.
let ndefRecords = ndef.getNdefRecords();
console.log("ndef ndefRecords number: " + ndefRecords.length);
A
Annie_wang 已提交
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
```

### NdefTag.createNdefMessage<sup>9+</sup>

createNdefMessage(ndefRecords: NdefRecord[]): [NdefMessage](#ndefmessage9)

Creates an NDEF message using the NDEF records.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**
| **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- |
A
Annie_wang 已提交
456
| ndefRecords | [NdefRecord](js-apis-nfcTag.md#ndefrecord9)[] | Yes| NDEF records used to create the NDEF message. For details, see *NFCForum-TS-NDEF_1.0*.|
A
Annie_wang 已提交
457 458 459 460 461

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
462
| [NdefMessage](#ndefmessage9) | NDEF message created. For details, see *NFCForum-TS-NDEF_1.0*.|
A
Annie_wang 已提交
463 464 465 466 467 468

**Example**

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

A
Annie_wang 已提交
469 470 471 472 473 474 475 476 477 478 479 480 481
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndef' 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 = ndef.createNdefMessage(ndefRecords);
console.log("ndef ndefMessage: " + ndefMessage);
A
Annie_wang 已提交
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
```

### NdefTag.getNdefTagType<sup>9+</sup>

getNdefTagType(): NfcForumType

Obtains the type of this NDEF tag.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
498
| [NfcForumType](js-apis-nfcTag.md#nfcforumtype9) | NDEF tag type obtained. It can be NFC FORUM TYPE 1, 2, 3, or 4.|
A
Annie_wang 已提交
499 500 501 502 503 504

**Example**

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

A
Annie_wang 已提交
505 506 507
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndef' correctly.
let ndefTagType = ndef.getNdefTagType();
console.log("ndef ndefTagType: " + ndefTagType);
A
Annie_wang 已提交
508 509 510 511 512 513
```

### NdefTag.getNdefMessage<sup>9+</sup>

getNdefMessage(): NdefMessage

A
Annie_wang 已提交
514
Obtains the NDEF message.
A
Annie_wang 已提交
515 516 517 518 519 520 521 522 523

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
524
| [NdefMessage](#ndefmessage9)  | NDEF message obtained. For details, see *NFCForum-TS-NDEF_1.0*.|
A
Annie_wang 已提交
525 526 527 528 529 530

**Example**

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

A
Annie_wang 已提交
531 532 533
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndef' correctly.
let ndefMessage = ndef.getNdefMessage();
console.log("ndef ndefMessage: " + ndefMessage);
A
Annie_wang 已提交
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
```

### NdefTag.isNdefWritable<sup>9+</sup>

isNdefWritable(): Promise&lt;boolean&gt;

Checks whether the NDEF tag is writable. This API uses a promise to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| Promise&lt;boolean&gt; | Promise used to return the result. If the tag is writable, **true** is returned; otherwise, **false** is returned.|

**Example**

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

A
Annie_wang 已提交
557 558 559 560 561 562 563
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndef' correctly.
ndef.isNdefWritable()
    .then((data) => {
        console.log("ndef isNdefWritable data: " + data);
    }).catch((err)=> {
        console.log("ndef isNdefWritable err: " + err);
    });
A
Annie_wang 已提交
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
```

### NdefTag.isNdefWritable<sup>9+</sup>

isNdefWritable(callback: AsyncCallback&lt;boolean&gt;): void;

Checks whether the NDEF tag is writable. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback\<boolean> | Yes  | Callback invoked to return the result. If the tag is writable, **true** is returned; otherwise, **false** is returned.|

**Example**

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

A
Annie_wang 已提交
587 588 589 590 591 592 593 594
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndef' correctly.
ndef.isNdefWritable((err, data)=> {
    if (err) {
        console.log("ndef isNdefWritable err: " + err);
    } else {
        console.log("ndef isNdefWritable data: " + data);
    }
});
A
Annie_wang 已提交
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
```

### NdefTag.readNdef<sup>9+</sup>

readNdef(): Promise\<NdefMessage>

Reads the NDEF message from this tag. This API uses a promise to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
611
| Promise\<[NdefMessage](#ndefmessage9)> | Promise used to return the message read.|
A
Annie_wang 已提交
612 613 614 615 616 617

**Example**

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

A
Annie_wang 已提交
618 619 620 621 622 623 624
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndef' correctly.
ndef.readNdef()
    .then((data) => {
        console.log("ndef readNdef data: " + data);
    }).catch((err)=> {
        console.log("ndef readNdef err: " + err);
    });
A
Annie_wang 已提交
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
```

### NdefTag.readNdef<sup>9+</sup>

readNdef(callback: AsyncCallback\<[NdefMessage](#ndefmessage9)>): void

Reads the NDEF message from this tag. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback\<[NdefMessage](#ndefmessage9)> | Yes  | Callback invoked to return the result.|

**Example**

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

A
Annie_wang 已提交
648 649 650 651 652 653 654 655
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndef' correctly.
ndef.readNdef((err, data)=> {
    if (err) {
        console.log("ndef readNdef err: " + err);
    } else {
        console.log("ndef readNdef data: " + data);
    }
});
A
Annie_wang 已提交
656 657 658 659 660 661
```

### NdefTag.writeNdef<sup>9+</sup>

writeNdef(msg: NdefMessage): Promise\<number>;

A
Annie_wang 已提交
662
Writes an NDEF message to this tag. This API uses a promise to return the result.
A
Annie_wang 已提交
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| msg | NdefMessage | Yes  | NDEF message to write.|

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| Promise\<number> | Promise used to return the result. If **0** is returned, the operation is successful. If the operation fails, an error code is returned.|

**Example**

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

A
Annie_wang 已提交
685 686 687 688 689 690 691 692 693
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndef' correctly.
let ndefMessage = ndef.createNdefMessage([0x01, 0x02, ...]); // change the raw data to be correct.

ndef.writeNdef(ndefMessage)
    .then((data) => {
        console.log("ndef writeNdef data: " + data);
    }).catch((err)=> {
        console.log("ndef writeNdef err: " + err);
    });
A
Annie_wang 已提交
694 695 696 697 698 699
```

### NdefTag.writeNdef<sup>9+</sup>

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

A
Annie_wang 已提交
700
Writes an NDEF message to this tag. This API uses an asynchronous callback to return the result.
A
Annie_wang 已提交
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| msg | NdefMessage | Yes  | NDEF message to write.|
| callback | AsyncCallback\<number> | Yes  | Callback invoked to return the result.|

**Example**

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

A
Annie_wang 已提交
718 719 720 721 722 723 724 725 726
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndef' correctly.
let ndefMessage = ndef.createNdefMessage([0x01, 0x02, ...]); // change the raw data to be correct.
ndef.writeNdef(ndefMessage, (err, data)=> {
    if (err) {
        console.log("ndef writeNdef err: " + err);
    } else {
        console.log("ndef writeNdef data: " + data);
    }
});
A
Annie_wang 已提交
727 728 729 730
```

### NdefTag.canSetReadOnly<sup>9+</sup>

A
Annie_wang 已提交
731
canSetReadOnly(): boolean
A
Annie_wang 已提交
732

A
Annie_wang 已提交
733
Checks whether this NDEF tag can be set to read-only.
A
Annie_wang 已提交
734 735 736 737 738 739 740 741 742

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
743
| boolean| Returns **true** if the tag can be set to read-only; returns **false** otherwise.|
A
Annie_wang 已提交
744 745 746 747 748 749

**Example**

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

A
Annie_wang 已提交
750 751 752
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndef' correctly.
var canSetReadOnly = ndef.canSetReadOnly();
console.log("ndef canSetReadOnly: " + canSetReadOnly);
A
Annie_wang 已提交
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775
```

### NdefTag.setReadOnly<sup>9+</sup>

setReadOnly(): Promise\<number>

Sets this NDEF tag to read-only. This API uses a promise to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| Promise&lt;number&gt; | Promise used to return the result. If the operation is successful, **0** is returned; otherwise, an error code is returned.|

**Example**

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

A
Annie_wang 已提交
776 777 778 779 780 781 782
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndef' correctly.
ndef.setReadOnly()
    .then((data) => {
        console.log("ndef setReadOnly data: " + data);
    }).catch((err)=> {
        console.log("ndef setReadOnly err: " + err);
    });
A
Annie_wang 已提交
783 784 785 786
```

### NdefTag.setReadOnly<sup>9+</sup>

A
Annie_wang 已提交
787
setReadOnly(callback: AsyncCallback\<number>): void
A
Annie_wang 已提交
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805

Sets this NDEF tag to read-only. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback\<number> | Yes  | Callback invoked to return the result.|

**Example**

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

A
Annie_wang 已提交
806 807 808 809 810 811 812 813
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndef' correctly.
ndef.setReadOnly((err, data)=> {
    if (err) {
        console.log("ndef setReadOnly err: " + err);
    } else {
        console.log("ndef setReadOnly data: " + data);
    }
});
A
Annie_wang 已提交
814 815 816 817
```

### NdefTag.getNdefTagTypeString<sup>9+</sup>

A
Annie_wang 已提交
818
getNdefTagTypeString(type: [NfcForumType](js-apis-nfcTag.md#nfcforumtype9)): string
A
Annie_wang 已提交
819

A
Annie_wang 已提交
820
Converts an NFC Forum Type tag to a byte array defined in the NFC Forum.
A
Annie_wang 已提交
821 822 823 824 825 826 827 828 829

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
A
Annie_wang 已提交
830
| type | [NfcForumType](js-apis-nfcTag.md#nfcforumtype9) | Yes  | NDEF tag type. It can be NFC FORUM type 1, 2, 3, or 4.|
A
Annie_wang 已提交
831 832 833 834 835 836 837 838 839 840 841 842

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| string | Byte array obtained.|

**Example**

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

A
Annie_wang 已提交
843 844 845
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndef' correctly.
let ndefTypeString = ndef.getNdefTagTypeString(tag.NFC_FORUM_TYPE_1);
console.log("ndef ndefTypeString: " + ndefTypeString);
A
Annie_wang 已提交
846 847
```

A
Annie_wang 已提交
848
## MifareClassicTag<sup>9+</sup>
A
Annie_wang 已提交
849

A
Annie_wang 已提交
850
Provides access to MIFARE Classic properties and I/O operations. This class inherits from **TagSession**.
A
Annie_wang 已提交
851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884

**TagSession** is the base class of all NFC tag technologies. It provides common interfaces for establishing connections and transferring data. For more details, see [TagSession](js-apis-tagSession.md).

The following describes the unique interfaces of **MifareClassicTag**.

### MifareClassicTag.authenticateSector<sup>9+</sup>

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

Authenticates a sector using the key. The sector can be accessed only after the authentication is successful. This API uses a promise to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| sectorIndex | number | Yes  | Index of the sector to authenticate.|
| key | number[]| Yes  | Key (6 bytes) used for authentication.|
| isKeyA | boolean | Yes  | Whether the key is key A. The value **true** indicates key A, and **false** indicates key B.|

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| Promise\<boolean> | Promise used to return the result. If the authentication is successful, **true** is returned. Otherwise, **false** is returned.|

**Example**

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

A
Annie_wang 已提交
885 886 887 888 889 890 891 892 893
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let sectorIndex = 1; // change it to be correct index.
let key = [0x04, 0x05, ....];  // change it to be correct key.
mifareClassic.authenticateSector(sectorIndex, key, true);
    .then((data) => {
        console.log("mifareClassic authenticateSector data: " + data);
    }).catch((err)=> {
        console.log("mifareClassic authenticateSector err: " + err);
    });
A
Annie_wang 已提交
894 895 896 897
```

### MifareClassicTag.authenticateSector<sup>9+</sup>

A
Annie_wang 已提交
898
authenticateSector(sectorIndex: number, key: number[], isKeyA: boolean, callback: AsyncCallback\<boolean>): void
A
Annie_wang 已提交
899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919

Authenticates a sector using the key. The sector can be accessed only after the authentication is successful. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| sectorIndex | number | Yes  | Index of the sector to authenticate.|
| key | number[]| Yes  | Key (6 bytes) used for authentication.|
| isKeyA | boolean | Yes  | Whether the key is key A. The value **true** indicates key A, and **false** indicates key B.|
| callback | AsyncCallback\<boolean> | Yes  | Callback invoked to return the result.|

**Example**

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

A
Annie_wang 已提交
920 921 922 923 924 925 926 927 928 929
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let sectorIndex = 1; // change it to be correct index.
let key = [0x04, 0x05, ....];  // change it to be correct key.
mifareClassic.authenticateSector(sectorIndex, key, true, (err, data)=> {
    if (err) {
        console.log("mifareClassic authenticateSector err: " + err);
    } else {
        console.log("mifareClassic authenticateSector data: " + data);
    }
});
A
Annie_wang 已提交
930 931 932 933
```

### MifareClassicTag.readSingleBlock<sup>9+</sup>

A
Annie_wang 已提交
934
readSingleBlock(blockIndex: number): Promise\<number[]>
A
Annie_wang 已提交
935

A
Annie_wang 已提交
936
Reads a block (16 bytes) on the tag. This API uses a promise to return the result.
A
Annie_wang 已提交
937 938 939 940 941 942 943 944 945 946 947 948 949 950 951

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| blockIndex | number | Yes  | Index of the block to read.|

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
952
| Promise\<number[]> | Promise used to return the block data read.|
A
Annie_wang 已提交
953 954 955 956 957 958

**Example**

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

A
Annie_wang 已提交
959 960 961 962 963 964 965 966 967
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let blockIndex = 1; // change it to be correct index.
mifareClassic.readSingleBlock(blockIndex, (err, data)=> {
    if (err) {
        console.log("mifareClassic readSingleBlock err: " + err);
    } else {
        console.log("mifareClassic readSingleBlock data: " + data);
    }
});
A
Annie_wang 已提交
968 969 970 971
```

### MifareClassicTag.readSingleBlock<sup>9+</sup>

A
Annie_wang 已提交
972
readSingleBlock(blockIndex: number, callback: AsyncCallback\<number[]>): void
A
Annie_wang 已提交
973

A
Annie_wang 已提交
974
Reads a block (16 bytes) on the tag. This API uses an asynchronous callback to return the result.
A
Annie_wang 已提交
975 976 977 978 979 980 981 982 983 984

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| blockIndex | number | Yes  | Index of the block to read.|
A
Annie_wang 已提交
985
| callback | AsyncCallback\<number[]> | Yes  | Callback invoked to return the block read.|
A
Annie_wang 已提交
986 987 988 989 990 991

**Example**

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

A
Annie_wang 已提交
992 993 994 995 996 997 998 999 1000
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let blockIndex = 1; // change it to be correct index.
mifareClassic.readSingleBlock(blockIndex, (err, data)=> {
    if (err) {
        console.log("mifareClassic readSingleBlock err: " + err);
    } else {
        console.log("mifareClassic readSingleBlock data: " + data);
    }
});
A
Annie_wang 已提交
1001 1002 1003 1004
```

### MifareClassicTag.writeSingleBlock<sup>9+</sup>

A
Annie_wang 已提交
1005
writeSingleBlock(blockIndex: number, data: number[]): Promise\<number>
A
Annie_wang 已提交
1006

A
Annie_wang 已提交
1007
Writes data to a block on the tag. This API uses a promise to return the result.
A
Annie_wang 已提交
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| blockIndex | number | Yes  | Index of the target block.|
A
Annie_wang 已提交
1018
| data | number[] | Yes  | Data to write.|
A
Annie_wang 已提交
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| Promise\<number> | Promise used to return the result. If **0** is returned, the operation is successful. If the operation fails, an error code is returned.|

**Example**

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

A
Annie_wang 已提交
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let blockIndex = 1; // change it to be correct index.
let rawData = [0x0a, 0x14, ...]; // change it to be correct data.
mifareClassic.writeSingleBlock(blockIndex, rawData, (err, data)=> {
    if (err) {
        console.log("mifareClassic writeSingleBlock err: " + err);
    } else {
        console.log("mifareClassic writeSingleBlock data: " + data);
    }
});
A
Annie_wang 已提交
1041 1042 1043 1044
```

### MifareClassicTag.writeSingleBlock<sup>9+</sup>

A
Annie_wang 已提交
1045
writeSingleBlock(blockIndex: number, data: number[], callback: AsyncCallback\<number>): void
A
Annie_wang 已提交
1046

A
Annie_wang 已提交
1047
Writes data to a block on the tag. This API uses an asynchronous callback to return the result.
A
Annie_wang 已提交
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| blockIndex | number | Yes  | Index of the target block.|
A
Annie_wang 已提交
1058
| data | number[] | Yes  | Data to write.|
A
Annie_wang 已提交
1059 1060 1061 1062 1063 1064 1065
| callback | AsyncCallback\<number> | Yes  | Callback invoked to return the result.|

**Example**

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

A
Annie_wang 已提交
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let blockIndex = 1; // change it to be correct index.
let rawData = [0x0a, 0x14, ...]; // change it to be correct data.
mifareClassic.writeSingleBlock(blockIndex, rawData, (err, data)=> {
    if (err) {
        console.log("mifareClassic writeSingleBlock err: " + err);
    } else {
        console.log("mifareClassic writeSingleBlock data: " + data);
    }
});
A
Annie_wang 已提交
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
```

### MifareClassicTag.incrementBlock<sup>9+</sup>

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

Increments a block with data. This API uses a promise to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| blockIndex | number | Yes  | Index of the block to increment.|
| value | number | Yes  | Block data to increment. The value is a non-negative number.|

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| Promise\<number> | Promise used to return the result. If **0** is returned, the operation is successful. If the operation fails, an error code is returned.|

**Example**

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

A
Annie_wang 已提交
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let blockIndex = 1; // change it to be correct index.
let value = 0x20; // change it to be correct data.
mifareClassic.incrementBlock(blockIndex, value, (err, data)=> {
    if (err) {
        console.log("mifareClassic incrementBlock err: " + err);
    } else {
        console.log("mifareClassic incrementBlock data: " + data);
    }
});
A
Annie_wang 已提交
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
```

### MifareClassicTag.incrementBlock<sup>9+</sup>

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

Increments a block with data. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| blockIndex | number | Yes  | Index of the block to increment.|
| value | number | Yes  | Block data to increment. The value is a non-negative number.|
| callback | AsyncCallback\<number> | Yes  | Callback invoked to return the result.|

**Example**

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

A
Annie_wang 已提交
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let blockIndex = 1; // change it to be correct index.
let value = 0x20; // change it to be correct data.
mifareClassic.incrementBlock(blockIndex, value, (err, data)=> {
    if (err) {
        console.log("mifareClassic incrementBlock err: " + err);
    } else {
        console.log("mifareClassic incrementBlock data: " + data);
    }
});
A
Annie_wang 已提交
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
```

### MifareClassicTag.decrementBlock<sup>9+</sup>

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

Decrements a block with data. This API uses a promise to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| blockIndex | number | Yes  | Index of the block to decrement.|
| value | number | Yes  | Block data to decrement. The value is a non-negative number.|

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| Promise\<number> | Promise used to return the result. If **0** is returned, the operation is successful. If the operation fails, an error code is returned.|

**Example**

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

A
Annie_wang 已提交
1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let blockIndex = 1; // change it to be correct index.
let value = 0x20; // change it to be correct data.
mifareClassic.decrementBlock(blockIndex, value, (err, data)=> {
    if (err) {
        console.log("mifareClassic decrementBlock err: " + err);
    } else {
        console.log("mifareClassic decrementBlock data: " + data);
    }
});
A
Annie_wang 已提交
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
```

### MifareClassicTag.decrementBlock<sup>9+</sup>

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

Decrements a block with data. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| blockIndex | number | Yes  | Index of the block to decrement.|
| value | number | Yes  | Block data to decrement. The value is a non-negative number.|
| callback | AsyncCallback\<number> | Yes  | Callback invoked to return the result.|

**Example**

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

A
Annie_wang 已提交
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let blockIndex = 1; // change it to be correct index.
let value = 0x20; // change it to be correct data.
mifareClassic.decrementBlock(blockIndex, value, (err, data)=> {
    if (err) {
        console.log("mifareClassic decrementBlock err: " + err);
    } else {
        console.log("mifareClassic decrementBlock data: " + data);
    }
});
A
Annie_wang 已提交
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
```

### MifareClassicTag.transferToBlock<sup>9+</sup>

transferToBlock(blockIndex: number): Promise\<number>

Copies data from the register to a block. This API uses a promise to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| blockIndex | number | Yes  | Index of the destination block.|

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| Promise\<number> | Promise used to return the result. If **0** is returned, the operation is successful. If the operation fails, an error code is returned.|

**Example**

```js

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

A
Annie_wang 已提交
1256 1257 1258 1259 1260 1261 1262 1263 1264
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let blockIndex = 1; // change it to be correct index.
mifareClassic.transferToBlock(blockIndex, (err, data)=> {
    if (err) {
        console.log("mifareClassic transferToBlock err: " + err);
    } else {
        console.log("mifareClassic transferToBlock data: " + data);
    }
});
A
Annie_wang 已提交
1265 1266
```

A
Annie_wang 已提交
1267
### MifareClassicTag.transferToBlock<sup>9+</sup>
A
Annie_wang 已提交
1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288

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

Copies data from the register to a block. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| blockIndex | number | Yes  | Index of the destination block.|
| callback | AsyncCallback\<number> | Yes  | Callback invoked to return the result.|

**Example**

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

A
Annie_wang 已提交
1289 1290 1291 1292 1293 1294 1295 1296 1297
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let blockIndex = 1; // change it to be correct index.
mifareClassic.transferToBlock(blockIndex, (err, data)=> {
    if (err) {
        console.log("mifareClassic transferToBlock err: " + err);
    } else {
        console.log("mifareClassic transferToBlock data: " + data);
    }
});
A
Annie_wang 已提交
1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327
```

### MifareClassicTag.restoreFromBlock<sup>9+</sup>

restoreFromBlock(blockIndex: number): Promise\<number>

Copies data from a block to the register. This API uses a promise to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| blockIndex | number | Yes  | Index of the source block.|

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| Promise\<number> | Promise used to return the result. If **0** is returned, the operation is successful. If the operation fails, an error code is returned.|

**Example**

```js

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

A
Annie_wang 已提交
1328 1329 1330 1331 1332 1333 1334 1335
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let blockIndex = 1; // change it to be correct index.
mifareClassic.restoreFromBlock(blockIndex)
    .then((data) => {
        console.log("mifareClassic restoreFromBlock data: " + data);
    }).catch((err)=> {
        console.log("mifareClassic isExtendrestoreFromBlockedApduSupported err: " + err);
    });
A
Annie_wang 已提交
1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359
```

### MifareClassicTag.restoreFromBlock<sup>9+</sup>

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

Copies data from a block to the register. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| blockIndex | number | Yes  | Index of the source block.|
| callback | AsyncCallback\<number> | Yes  | Callback invoked to return the result.|

**Example**

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

A
Annie_wang 已提交
1360 1361 1362 1363 1364 1365 1366 1367 1368
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let blockIndex = 1; // change it to be correct index.
mifareClassic.restoreFromBlock(blockIndex, (err, data)=> {
    if (err) {
        console.log("mifareClassic restoreFromBlock err: " + err);
    } else {
        console.log("mifareClassic restoreFromBlock data: " + data);
    }
});
A
Annie_wang 已提交
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391
```

### MifareClassicTag.getSectorCount<sup>9+</sup>

getSectorCount(): number

Obtains the number of sectors in this MIFARE Classic tag.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| number | Number of sectors obtained.|

**Example**

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

A
Annie_wang 已提交
1392 1393 1394
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let sectorCount = mifareClassic.getSectorCount();
console.log("mifareClassic sectorCount: " + sectorCount);
A
Annie_wang 已提交
1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423
```

### MifareClassicTag.getBlockCountInSector<sup>9+</sup>

getBlockCountInSector(sectorIndex: number): number

Obtains the number of blocks in a sector.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| sectorIndex | number | Yes  | Index of the sector.|

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| number | Number of blocks obtained.|

**Example**

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

A
Annie_wang 已提交
1424 1425 1426
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let blockCountInSector = mifareClassic.getBlockCountInSector();
console.log("mifareClassic blockCountInSector: " + blockCountInSector);
A
Annie_wang 已提交
1427 1428 1429 1430
```

### MifareClassicTag.getType<sup>9+</sup>

A
Annie_wang 已提交
1431
getType(): [MifareClassicType](js-apis-nfcTag.md#mifareclassictype9)
A
Annie_wang 已提交
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442

Obtains the type of this MIFARE Classic tag.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
1443
| [MifareClassicType](js-apis-nfcTag.md#mifareclassictype9) | Type of the MIFARE Classic tag obtained.|
A
Annie_wang 已提交
1444 1445 1446 1447 1448 1449

**Example**

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

A
Annie_wang 已提交
1450 1451 1452
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let getType = mifareClassic.getType();
console.log("mifareClassic getType: " + getType);
A
Annie_wang 已提交
1453 1454 1455 1456 1457 1458
```

### MifareClassicTag.getTagSize<sup>9+</sup>

getTagSize(): number

A
Annie_wang 已提交
1459
Obtains the tag size (in bytes). For details, see [MifareClassicSize](js-apis-nfcTag.md#mifareclassicsize9).
A
Annie_wang 已提交
1460 1461 1462 1463 1464 1465 1466 1467 1468

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
1469
| number | Tag size obtained, in bytes. For details, see [MifareClassicSize](js-apis-nfcTag.md#mifareclassicsize9).|
A
Annie_wang 已提交
1470 1471 1472 1473 1474 1475

**Example**

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

A
Annie_wang 已提交
1476 1477 1478
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let tagSize = mifareClassic.getTagSize();
console.log("mifareClassic tagSize: " + tagSize);
A
Annie_wang 已提交
1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501
```

### MifareClassicTag.isEmulatedTag<sup>9+</sup>

isEmulatedTag(): boolean

Checks whether the tag is an emulated tag.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| boolean |Returns **true** if the tag is an emulated tag; returns **false** otherwise.|

**Example**

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

A
Annie_wang 已提交
1502 1503 1504
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let isEmulatedTag = mifareClassic.isEmulatedTag();
console.log("mifareClassic isEmulatedTag: " + isEmulatedTag);
A
Annie_wang 已提交
1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533
```

### MifareClassicTag.getBlockIndex<sup>9+</sup>

getBlockIndex(sectorIndex: number): number

Obtains the first block of a sector.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| sectorIndex | number | Yes  | Index of the sector.|

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| number | Index of the first block obtained.|

**Example**

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

A
Annie_wang 已提交
1534 1535 1536 1537
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let sectorIndex = 1; // change it to be correct index.
let blockIndex = mifareClassic.getBlockIndex(sectorIndex);
console.log("mifareClassic blockIndex: " + blockIndex);
A
Annie_wang 已提交
1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566
```

### MifareClassicTag.getSectorIndex<sup>9+</sup>

getSectorIndex(blockIndex: number): number

Obtains the index of a sector that contains the specified block.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| blockIndex | number | Yes  | Index of the block contained in the sector.|

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| number | Index of the sector obtained.|

**Example**

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

A
Annie_wang 已提交
1567 1568 1569 1570
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareClassic' correctly.
let blockIndex = 1; // change it to be correct index.
let sectorIndex = mifareClassic.getSectorIndex(blockIndex);
console.log("mifareClassic sectorIndex: " + sectorIndex);
A
Annie_wang 已提交
1571 1572 1573 1574
```

## MifareUltralightTag<sup>9+</sup>

A
Annie_wang 已提交
1575
Provides access to MIFARE Ultralight properties and I/O operations. This class inherits from **TagSession**.
A
Annie_wang 已提交
1576 1577 1578 1579 1580 1581 1582

**TagSession** is the base class of all NFC tag technologies. It provides common interfaces for establishing connections and transferring data. For more details, see [TagSession](js-apis-tagSession.md).

The following describes the unique interfaces of **MifareUltralightTag**.

### MifareUltralightTag.readMultiplePages<sup>9+</sup>

A
Annie_wang 已提交
1583
readMultiplePages(pageIndex: number): Promise\<number[]>
A
Annie_wang 已提交
1584

A
Annie_wang 已提交
1585
Reads multiple pages (4 bytes per page). This API uses a promise to return the result.
A
Annie_wang 已提交
1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | ------------------------------ |
| pageIndex | number | Yes  | Indexes of the pages to read.|

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
1601
| Promise\<number[]> | Promise used to return the data read.|
A
Annie_wang 已提交
1602 1603 1604 1605 1606 1607 1608

**Example**

```js

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

A
Annie_wang 已提交
1609 1610 1611 1612 1613 1614 1615 1616
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareUltralight' correctly.
let pageIndex = 1; // change it to be correct index.
mifareUltralight.readMultiplePages(pageIndex)
    .then((data) => {
        console.log("mifareUltralight readMultiplePages data: " + data);
    }).catch((err)=> {
        console.log("mifareUltralight readMultiplePages err: " + err);
    });
A
Annie_wang 已提交
1617 1618 1619 1620
```

### MifareUltralightTag.readMultiplePages<sup>9+</sup>

A
Annie_wang 已提交
1621
readMultiplePages(pageIndex: number, callback: AsyncCallback\<number[]>): void
A
Annie_wang 已提交
1622

A
Annie_wang 已提交
1623
Reads multiple pages (4 bytes per page). This API uses an asynchronous callback to return the result.
A
Annie_wang 已提交
1624 1625 1626 1627 1628 1629 1630 1631 1632 1633

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| pageIndex | number | Yes  | Indexes of the pages to read.|
A
Annie_wang 已提交
1634
| callback | AsyncCallback\<number[]> | Yes  | Callback invoked to return the result.|
A
Annie_wang 已提交
1635 1636 1637 1638 1639 1640

**Example**

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

A
Annie_wang 已提交
1641 1642 1643 1644 1645 1646 1647 1648 1649
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareUltralight' correctly.
let pageIndex = 1; // change it to be correct index.
mifareUltralight.readMultiplePages(pageIndex, (err, data)=> {
    if (err) {
        console.log("mifareUltralight readMultiplePages err: " + err);
    } else {
        console.log("mifareUltralight readMultiplePages data: " + data);
    }
});
A
Annie_wang 已提交
1650 1651 1652 1653
```

### MifareUltralightTag.writeSinglePages<sup>9+</sup>

A
Annie_wang 已提交
1654
writeSinglePages(pageIndex: number, data: number[]): Promise\<number>
A
Annie_wang 已提交
1655

A
Annie_wang 已提交
1656
Writes a page of data. This API uses a promise to return the result.
A
Annie_wang 已提交
1657 1658 1659 1660 1661 1662 1663 1664 1665 1666

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
| pageIndex | number | Yes  | Index of the page.|
A
Annie_wang 已提交
1667
| data | number[] | Yes  | Data to write.|
A
Annie_wang 已提交
1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| Promise\<number> | Promise used to return the result. If **0** is returned, the operation is successful. If the operation fails, an error code is returned.|

**Example**

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

A
Annie_wang 已提交
1680 1681 1682 1683 1684 1685 1686 1687 1688
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareUltralight' correctly.
let pageIndex = 1; // change it to be correct index.
let data = [0x01, 0x02, ...]; // change it to be correct raw data.
mifareUltralight.writeSinglePages(pageIndex, data)
    .then((data) => {
        console.log("mifareUltralight writeSinglePages data: " + data);
    }).catch((err)=> {
        console.log("mifareUltralight writeSinglePages err: " + err);
    });
A
Annie_wang 已提交
1689 1690 1691 1692
```

### MifareUltralightTag.writeSinglePages<sup>9+</sup>

A
Annie_wang 已提交
1693
writeSinglePages(pageIndex: number, data: number[], callback: AsyncCallback\<number>): void
A
Annie_wang 已提交
1694

A
Annie_wang 已提交
1695
Writes a page of data. This API uses an asynchronous callback to return the result.
A
Annie_wang 已提交
1696 1697 1698 1699 1700 1701 1702 1703 1704 1705

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                    |
| -------- | ----------------------- | ---- | ------------------------ |
| pageIndex | number | Yes  | Index of the page.|
A
Annie_wang 已提交
1706
| data | number[] | Yes  | Data to write.|
A
Annie_wang 已提交
1707 1708 1709 1710 1711 1712 1713
| callback|AsyncCallback\<number> |Yes| Callback invoked to return the result.|

**Example**

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

A
Annie_wang 已提交
1714 1715 1716 1717 1718 1719 1720 1721 1722 1723
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareUltralight' correctly.
let pageIndex = 1; // change it to be correct index.
let data = [0x01, 0x02, ...]; // change it to be correct raw data.
mifareUltralight.writeSinglePages(pageIndex, data, (err, data)=> {
    if (err) {
        console.log("mifareUltralight writeSinglePages err: " + err);
    } else {
        console.log("mifareUltralight writeSinglePages data: " + data);
    }
});
A
Annie_wang 已提交
1724 1725 1726 1727 1728 1729
```

### MifareUltralightTag.getType<sup>9+</sup>

getType(): MifareUltralightType

A
Annie_wang 已提交
1730
Obtains the MIFARE Ultralight tag type, in bytes. For details, see [MifareUltralightType](js-apis-nfcTag.md#mifareultralighttype9).
A
Annie_wang 已提交
1731 1732 1733 1734 1735 1736 1737 1738 1739

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
A
Annie_wang 已提交
1740
| MifareUltralightType | MIFARE Ultralight tag type obtained. For details, see [MifareUltralightType](js-apis-nfcTag.md#mifareultralighttype9).|
A
Annie_wang 已提交
1741 1742 1743 1744 1745 1746

**Example**

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

A
Annie_wang 已提交
1747 1748 1749
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'mifareUltralight' correctly.
let getType = mifareClassic.getType();
console.log("mifareUltralight getType: " + getType);
A
Annie_wang 已提交
1750 1751 1752 1753
```

## NdefFormatableTag<sup>9+</sup>

A
Annie_wang 已提交
1754
Provides APIs for operating NDEF formattable tags. This class inherits from **TagSession**.
A
Annie_wang 已提交
1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773

**TagSession** is the base class of all NFC tag technologies. It provides common interfaces for establishing connections and transferring data. For more details, see [TagSession](js-apis-tagSession.md).

The following describes the unique interfaces of **NdefFormatableTag**.

### NdefFormatableTag.format<sup>9+</sup>

format(message: [NdefMessage](#ndefmessage9)): Promise\<number>

Formats this tag as an NDEF tag, and writes an NDEF message to the tag. This API uses a promise to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
A
Annie_wang 已提交
1774
| message | [NdefMessage](#ndefmessage9) | Yes  | NDEF message to write when the formatting is successful. If this parameter is **null**, the tag is formatted only (no data will be written).|
A
Annie_wang 已提交
1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| Promise\<number> | Promise used to return the result. If **0** is returned, the operation is successful. If the operation fails, an error code is returned.|

**Example**

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

A
Annie_wang 已提交
1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndef' correctly.
let data = [0x01, 0x02, ...]; // change it to be correct raw data.
let ndefmessage = ndef.createNdefMessage(data);

// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndefFormatable' correctly.
ndefFormatable.format(ndefmessage, (err, data)=> {
    if (err) {
        console.log("ndefFormatable format err: " + err);
    } else {
        console.log("ndefFormatable format data: " + data);
    }
});
A
Annie_wang 已提交
1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814
```

### NdefFormatableTag.format<sup>9+</sup>

format(message: [NdefMessage](#ndefmessage9), callback: AsyncCallback\<number>): void

Formats this tag as an NDEF tag, and writes an NDEF message to the tag. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
A
Annie_wang 已提交
1815 1816 1817 1818 1819 1820 1821 1822
| message | [NdefMessage](#ndefmessage9) | Yes  | NDEF message to write when the formatting is successful. If this parameter is **null**, the tag is formatted only (no data will be written).|

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| callback: AsyncCallback\<number> | Callback invoked to return the result.|

A
Annie_wang 已提交
1823 1824 1825 1826 1827 1828

**Example**

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

A
Annie_wang 已提交
1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndef' correctly.
let data = [0x01, 0x02, ...]; // change it to be correct raw data.
let ndefmessage = ndef.createNdefMessage(data);

// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndefFormatable' correctly.
ndefFormatable.format(ndefmessage, (err, data)=> {
    if (err) {
        console.log("ndefFormatable format err: " + err);
    } else {
        console.log("ndefFormatable format data: " + data);
    }
});
A
Annie_wang 已提交
1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856
```

### NdefFormatableTag.formatReadOnly<sup>9+</sup>

formatReadOnly(message: [NdefMessage](#ndefmessage9)): Promise\<number>

Formats this tag as an NDEF tag, writes an NDEF message to the NDEF tag, and then sets the tag to read-only. This API uses a promise to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
A
Annie_wang 已提交
1857
| message | [NdefMessage](#ndefmessage9) | Yes  | NDEF message to write when the formatting is successful. If this parameter is **null**, the tag is formatted only (no data will be written).|
A
Annie_wang 已提交
1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| Promise\<number> | Promise used to return the result. If **0** is returned, the operation is successful. If the operation fails, an error code is returned.|

**Example**

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

A
Annie_wang 已提交
1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndef' correctly.
let data = [0x01, 0x02, ...]; // change it to be correct raw data.
let ndefmessage = ndef.createNdefMessage(data);

// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndefFormatable' correctly.
ndefFormatable.formatReadOnly(ndefmessage, (err, data)=> {
    if (err) {
        console.log("ndefFormatable formatReadOnly err: " + err);
    } else {
        console.log("ndefFormatable formatReadOnly data: " + data);
    }
});
A
Annie_wang 已提交
1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897
```

### NdefFormatableTag.formatReadOnly<sup>9+</sup>

formatReadOnly(message: [NdefMessage](#ndefmessage9), callback: AsyncCallback\<number>): void

Formats this tag as an NDEF tag, writes an NDEF message to the NDEF tag, and then sets the tag to read-only. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.NFC_TAG

**System capability**: SystemCapability.Communication.NFC

**Parameters**

| Name  | Type                   | Mandatory| Description                                  |
| -------- | ----------------------- | ---- | -------------------------------------- |
A
Annie_wang 已提交
1898 1899 1900 1901 1902 1903 1904 1905
| message | [NdefMessage](#ndefmessage9) | Yes  | NDEF message to write when the formatting is successful. If this parameter is **null**, the tag is formatted only (no data will be written).|

**Return value**

| **Type**| **Description**                            |
| ------------------ | --------------------------|
| callback: AsyncCallback\<number> | Callback invoked to return the result.|

A
Annie_wang 已提交
1906 1907 1908 1909 1910 1911

**Example**

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

A
Annie_wang 已提交
1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923
// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndef' correctly.
let data = [0x01, 0x02, ...]; // change it to be correct raw data.
let ndefmessage = ndef.createNdefMessage(data);

// Check whether 'tag.TagInfo' at 'js-apis-nfcTag' has obtained the 'ndefFormatable' correctly.
ndefFormatable.formatReadOnly(ndefmessage, (err, data)=> {
    if (err) {
        console.log("ndefFormatable formatReadOnly err: " + err);
    } else {
        console.log("ndefFormatable formatReadOnly data: " + data);
    }
});
A
Annie_wang 已提交
1924
```