跳过主要内容
@capgo/capacitor-NFC 设备API 开源

NFC Capacitor插件

原生NFC标签发现、读取和写入,适用于CapacitoriOS和Android应用

安装

bun add @capgo/capacitor-nfc bunx cap sync
npm、pnpm或yarn
  • npm install @capgo/capacitor-nfc
  • pnpm add @capgo/capacitor-nfc
  • yarn add @capgo/capacitor-nfc

指南

如何使用Capacitor中的NFC

在设备上测试

下载Capgo应用,扫描以下二维码code

NFC插件预览二维码code

使用@capgo/capacitor-nfc

公共API面板用于CapacitorNFC插件。

安装

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()

通过对等连接(仅限Android)共享一个NDEF消息。

import { CapacitorNfc } from '@capgo/capacitor-nfc';

await CapacitorNfc.share({
  records: [
    {
      tnf: 1,
      type: [1],
      id: [1],
      payload: [1],
    },
  ],
});

上表列出了10个核心方法。监听器和版本辅助函数,以及每个方法的完整契约,均在__CAPGO_KEEP_0__仓库中文档化。 GitHub 仓库.

监听事件

addListener 返回句柄。调用 handle.remove() 屏幕卸载时调用。

完整参考

继续使用 @capgo/capacitor-nfc

继续使用 @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-nfc 使用@capgo/capacitor-nfc 使用 @API/__CAPGO_KEEP_1__-nfc 以规划仪表板和 capgo 操作,连接它与 @capgo/capacitor-nfc 为 @capgo/capacitor-nfc 的实现细节 开始使用 为开始使用的实现细节 API 介绍 为API 介绍的实现细节 介绍 为介绍的实现细节, 和 API 密钥 为API 密钥的实现细节

常见问题

NFC插件常见问题

如何在Capacitor应用中安装NFC插件?

运行"bun add @capgo/capacitor-nfc" (或 "npm install @capgo/capacitor-nfc"),然后运行"bunx cap sync"以使iOS和Android项目捕获本机code。从"@capgo/capacitor-nfc"中导入它,然后在应用code中使用。

是否@capgo/capacitor-nfc与React、Vue和Angular兼容?

是的。NFC是一个Capacitor包,因此它可以与任何运行在Capacitor内的Web框架一起工作,包括Ionic、React、Vue、Angular、Svelte和纯JavaScript。

哪个Capacitor版本支持@capgo/capacitor-nfc?

Capgo插件遵循Capacitor的主要版本:使用与Capacitor主要版本匹配的插件主要版本(例如,插件v8与Capacitor 8)。在GitHub README中列出的兼容性表格列出了维护的版本。

是否@capgo/capacitor-nfc是免费和开源的?

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-nfc/ and the package is free to install from npm. Bug reports and pull requests are welcome.

是否可以在App Store审查时更新使用NFC的code?

安装或升级插件会更改本机code,因此需要新的商店构建。之后,JavaScript、HTML和CSS更改,调用插件的更改,可以立即与Capgo实时更新一起发布。

不必等待应用程序审查就可以将NFC更改推送到商店

一旦插件在您的商店构建中,Capgo实时更新将推送您的JavaScript、HTML和CSS更改到用户中,仅需几分钟

开始使用 Capgo