使用 @capgo/capacitor-nfc
Capacitor NFC 插件的公开 API 界面。
安装
bun add @capgo/capacitor-nfc
bunx cap sync
bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。
导入
import { CapacitorNfc } from '@capgo/capacitor-nfc';
API 概览
| 方法 | 描述 |
|---|---|
startScanning |
开始监听 NFC 标签。 |
stopScanning |
停止正在进行的 NFC 扫描会话。 |
write |
将提供的 NDEF 记录写入最近发现的标签。 |
erase |
尝试通过写入空 NDEF 消息擦除最近发现的标签。 |
makeReadOnly |
尝试将最近发现的标签设为只读。 |
share |
通过点对点方式与另一台设备共享 NDEF 消息（仅限 Android）。 |
unshare |
停止共享之前提供的 NDEF 消息（仅限 Android）。 |
getStatus |
返回当前 NFC 适配器状态。 |
showSettings |
打开系统设置页面，用户可以在其中启用 NFC。 |
isSupported |
检查设备是否支持 NFC 硬件。 |
示例
startScanning()
开始监听 NFC 标签。
import { CapacitorNfc } from '@capgo/capacitor-nfc';
await CapacitorNfc.startScanning();
stopScanning()
停止正在进行的 NFC 扫描会话。
import { CapacitorNfc } from '@capgo/capacitor-nfc';
await CapacitorNfc.stopScanning();
write()
将提供的 NDEF 记录写入最近发现的标签。
import { CapacitorNfc } from '@capgo/capacitor-nfc';
await CapacitorNfc.write({
records: [
{
tnf: 1,
type: [1],
id: [1],
payload: [1],
},
],
});
erase()
尝试通过写入空 NDEF 消息擦除最近发现的标签。
import { CapacitorNfc } from '@capgo/capacitor-nfc';
await CapacitorNfc.erase();
makeReadOnly()
尝试将最近发现的标签设为只读。
import { CapacitorNfc } from '@capgo/capacitor-nfc';
await CapacitorNfc.makeReadOnly();
share()
通过点对点方式与另一台设备共享 NDEF 消息（仅限 Android）。
import { CapacitorNfc } from '@capgo/capacitor-nfc';
await CapacitorNfc.share({
records: [
{
tnf: 1,
type: [1],
id: [1],
payload: [1],
},
],
});
上表列出了 10 个核心方法。监听器、版本辅助函数以及每个方法的完整接口定义，请参阅 GitHub 仓库.
监听事件
addListener 会返回一个句柄。调用 handle.remove() 当屏幕卸载时。
完整参考文档
继续阅读 使用 @capgo/capacitor-nfc
如果你正在使用 使用 @capgo/capacitor-nfc 要规划 dashboard 和 API 操作，请将其连接到 @capgo/capacitor-nfc 了解 @capgo/capacitor-nfc 中的实现细节， 快速入门 有关“入门指南”中的实现细节， API 概览 关于 API Overview 中的实现细节， 简介 关于简介中的实现细节，以及 API 密钥 关于 API Keys 中的实现细节。