@ohos.connectedTag (有源标签)

本模块提供有源标签的使用，包括初始化有源标签芯片、读取有源标签内容、写入内容到有源标签等。

说明：

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

导入模块

import connectedTag from '@ohos.connectedTag';

connectedTag.init

init(): boolean

初始化有源标签芯片。

需要权限：ohos.permission.NFC_TAG

系统能力：SystemCapability.Communication.ConnectedTag

返回值：

connectedTag.initialize⁹⁺

initialize(): void

初始化有源标签芯片。

需要权限： ohos.permission.NFC_TAG

系统能力： SystemCapability.Communication.ConnectedTag

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

connectedTag.uninit

uninit(): boolean

卸载有源标签芯片资源。

需要权限：ohos.permission.NFC_TAG

系统能力：SystemCapability.Communication.ConnectedTag

返回值：

connectedTag.uninitialize⁹⁺

uninitialize(): void

卸载有源标签芯片资源。

需要权限: ohos.permission.NFC_TAG

系统能力: SystemCapability.Communication.ConnectedTag

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

connectedTag.readNdefTag

readNdefTag(): Promise<string>

读取有源标签内容，使用promise方式作为异步方法。

需要权限：ohos.permission.NFC_TAG

系统能力：SystemCapability.Communication.ConnectedTag

返回值：

示例：

import connectedTag from '@ohos.connectedTag';
import { BusinessError } from '@ohos.base';

connectedTag.readNdefTag().then((data) => {
    console.log("connectedTag readNdefTag Promise data = " + data);
}).catch((err: BusinessError)=> {
    console.log("connectedTag readNdefTag Promise err: " + err);
});

connectedTag.read⁹⁺

read(): Promise<number[]>

读取有源标签内容，使用promise方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

系统能力： SystemCapability.Communication.ConnectedTag

返回值：

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

示例：

import connectedTag from '@ohos.connectedTag';
import { BusinessError } from '@ohos.base';

connectedTag.read().then((data) => {
    console.log("connectedTag read Promise data = " + data);
}).catch((err: BusinessError)=> {
    console.log("connectedTag read Promise err: " + err);
});

connectedTag.readNdefTag

readNdefTag(callback: AsyncCallback<string>): void

读取有源标签内容，使用AsyncCallback方式作为异步方法。

需要权限：ohos.permission.NFC_TAG

系统能力：SystemCapability.Communication.ConnectedTag

参数：

示例：

import connectedTag from '@ohos.connectedTag';

connectedTag.readNdefTag((err, data)=> {
    if (err) {
        console.log("connectedTag readNdefTag AsyncCallback err: " + err);
    } else {
        console.log("connectedTag readNdefTag AsyncCallback data: " + data);
    }
});

connectedTag.read⁹⁺

read(callback: AsyncCallback<number[]>): void

读取有源标签内容，使用AsyncCallback方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

系统能力： SystemCapability.Communication.ConnectedTag

参数：

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

示例：

import connectedTag from '@ohos.connectedTag';

connectedTag.read((err, data)=> {
    if (err) {
        console.log("connectedTag read AsyncCallback err: " + err);
    } else {
        console.log("connectedTag read AsyncCallback data: " + data);
    }
});

connectedTag.writeNdefTag

writeNdefTag(data: string): Promise<void>

写入内容到有源标签，使用promise方式作为异步方法。

需要权限：ohos.permission.NFC_TAG

系统能力：SystemCapability.Communication.ConnectedTag

参数：

返回值：

示例：

import connectedTag from '@ohos.connectedTag';
import { BusinessError } from '@ohos.base';

let rawData = "010203"; // change it tobe correct.
connectedTag.writeNdefTag(rawData).then(() => {
    console.log("connectedTag writeNdefTag Promise success.");
}).catch((err: BusinessError)=> {
    console.log("connectedTag writeNdefTag Promise err: " + err);
});

connectedTag.write⁹⁺

write(data: number[]): Promise<void>

写入内容到有源标签，使用promise方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

系统能力： SystemCapability.Communication.ConnectedTag

参数：

返回值：

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

示例：

import connectedTag from '@ohos.connectedTag';
import { BusinessError } from '@ohos.base';

let rawData = [0x01, 0x02, 0x03]; // change it tobe correct.
connectedTag.write(rawData).then(() => {
    console.log("connectedTag write NdefTag Promise success.");
}).catch((err: BusinessError)=> {
    console.log("connectedTag write NdefTag Promise err: " + err);
});

connectedTag.writeNdefTag

writeNdefTag(data: string, callback: AsyncCallback<void>): void

写入内容到有源标签，使用AsyncCallback方式作为异步方法。

需要权限：ohos.permission.NFC_TAG

系统能力：SystemCapability.Communication.ConnectedTag

参数：

示例：

import connectedTag from '@ohos.connectedTag';

let rawData = "010203"; // change it tobe correct.
connectedTag.writeNdefTag(rawData, (err)=> {
    if (err) {
        console.log("connectedTag writeNdefTag AsyncCallback err: " + err);
    } else {
        console.log("connectedTag writeNdefTag AsyncCallback success.");
    }
});

connectedTag.write⁹⁺

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

写入内容到有源标签，使用AsyncCallback方式作为异步方法。

需要权限： ohos.permission.NFC_TAG

系统能力： SystemCapability.Communication.ConnectedTag

参数：

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

示例：

import connectedTag from '@ohos.connectedTag';

let rawData = [0x01, 0x02, 0x03]; // change it tobe correct.
connectedTag.write(rawData, (err)=> {
    if (err) {
        console.log("connectedTag write NdefTag AsyncCallback err: " + err);
    } else {
        console.log("connectedTag write NdefTag AsyncCallback success.");
    }
});

connectedTag.on('notify')

on(type: "notify", callback: Callback<number>): void

注册NFC场强状态事件。

需要权限：ohos.permission.NFC_TAG

系统能力：SystemCapability.Communication.ConnectedTag

参数：

connectedTag.off('notify')

off(type: "notify", callback?: Callback<number>): void

取消NFC场强状态事件的注册。

需要权限：ohos.permission.NFC_TAG

系统能力：SystemCapability.Communication.ConnectedTag

参数：

示例：

import connectedTag from '@ohos.connectedTag';

// Register event
connectedTag.on("notify", (rfState : number)=> {
  console.log("connectedTag on Callback rfState: " + rfState);
});

let initStatus = connectedTag.init();
console.log("connectedTag init status: " + initStatus);

// Add nfc connecected tag business oprations here...
// connectedTag.writeNdefTag(rawData)
// connectedTag.readNdefTag()

let uninitStatus = connectedTag.uninit();
console.log("connectedTag uninit status: " + uninitStatus);

// Unregister event
connectedTag.off("notify", (rfState : number)=> {
  console.log("connectedTag off Callback rfState: " + rfState);
});

NfcRfType

表示NFC场强状态的枚举。

系统能力：SystemCapability.Communication.ConnectedTag