有源标签

2024-01-23 16:48 更新

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

说明

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

导入模块


import connectedTag from '@ohos.connectedTag';

connectedTag.init

init(): boolean

初始化有源标签芯片。

需要权限：ohos.permission.NFC_TAG

系统能力：SystemCapability.Communication.ConnectedTag

返回值：

类型	说明
boolean	true:初始化成功， false:初始化失败。

connectedTag.uninit

uninit(): boolean

卸载有源标签芯片资源。

需要权限：ohos.permission.NFC_TAG

系统能力：SystemCapability.Communication.ConnectedTag

返回值：

类型	说明
boolean	true:卸载操作成功， false:卸载操作失败。

connectedTag.readNdefTag

readNdefTag(): Promise<string>

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

需要权限：ohos.permission.NFC_TAG

系统能力：SystemCapability.Communication.ConnectedTag

返回值：

类型	说明
Promise<string>	返回读取有源标签内容。

示例：


import connectedTag from '@ohos.connectedTag';

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

connectedTag.readNdefTag

readNdefTag(callback: AsyncCallback<string>): void

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

需要权限：ohos.permission.NFC_TAG

系统能力：SystemCapability.Communication.ConnectedTag

参数：

参数名	类型	必填	说明
callback	AsyncCallback<string>	是	读取有源标签内容回调函数。

示例：


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.writeNdefTag

writeNdefTag(data: string): Promise<void>

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

需要权限：ohos.permission.NFC_TAG

系统能力：SystemCapability.Communication.ConnectedTag

参数：

参数名	类型	必填	说明
data	string	是	有源标签内容, 长度最大是1024个字节。

返回值：

类型	说明
Promise<void>	无返回值。

示例：


import connectedTag from '@ohos.connectedTag';

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

connectedTag.writeNdefTag

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

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

需要权限：ohos.permission.NFC_TAG

系统能力：SystemCapability.Communication.ConnectedTag

参数：

参数名	类型	必填	说明
data	string	是	有源标签内容, 长度最大是1024个字节。
callback	AsyncCallback<void>	是	读取有源标签内容回调函数。

示例：


import connectedTag from '@ohos.connectedTag';

var 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.on('notify')

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

注册NFC场强状态事件。

需要权限：ohos.permission.NFC_TAG

系统能力：SystemCapability.Communication.ConnectedTag

参数：

参数名	类型	必填	说明
type	string	是	固定填"notify"字符串
callback	Callback<number>	是	状态改变回调函数，返回值参见NfcRfType。

connectedTag.off('notify')

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

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

需要权限：ohos.permission.NFC_TAG

系统能力：SystemCapability.Communication.ConnectedTag

参数：

参数名	类型	必填	说明
type	string	是	固定填"notify"字符串
callback	Callback<number>	否	状态改变回调函数。如果callback不填，将“去注册”该事件关联的所有回调函数。

示例：


import connectedTag from '@ohos.connectedTag';

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

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

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

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

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