メインコンテンツへスキップ
@capgo/capacitor-nfc デバイス API オープンソース

NFC Capacitor プラグイン

iOS と Android の Capacitor アプリ向けネイティブ NFC タグ検出・読み取り・書き込み

インストール

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 アプリをダウンロードして、QR code をスキャンしてください。

NFCプラグインのプレビュー用QR code

@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 の使い方 ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-nfc @capgo/capacitor-nfc の実装の詳細については、 スタートガイド スタートガイドの実装詳細については、 API の概要 「API の概要」の実装の詳細については、 はじめに はじめにの実装詳細、および API キー API Keys の実装詳細については、

よくある質問

NFC プラグイン FAQ

Capacitor アプリに NFC プラグインをインストールするにはどうすればよいですか?

"bun add @capgo/capacitor-nfc" (または "npm install @capgo/capacitor-nfc") を実行し、次に "bunx cap sync" を実行して、iOS および Android プロジェクトにネイティブの code を反映させます。その後、アプリの code で "@capgo/capacitor-nfc" からインポートしてください。

@capgo/capacitor-nfc は React、Vue、Angular で動作しますか?

はい。NFC は Capacitor パッケージであるため、Ionic、React、Vue、Angular、Svelte、およびプレーンな JavaScript を含む、Capacitor 内で動作するあらゆる Web フレームワークで使用可能です。

@capgo/capacitor-nfc はどの Capacitor バージョンをサポートしていますか?

Capgo プラグインは Capacitor のメジャーバージョンに合わせています。使用している Capacitor のメジャーバージョンに一致するプラグインのメジャーバージョンを使ってください (例: Capacitor 8 ならプラグイン v8)。GitHub の README にある互換性テーブルに、メンテナンス中のバージョンが記載されています。

@capgo/capacitor-nfc は無料のオープンソースですか?

はい。code のソースコードは GitHub の https://github.com/Cap-go/capacitor-nfc/ で公開されており、npm から無料でインストールできます。バグ報告やプルリクエストもお待ちしています。

App Store の審査を通さずに、NFC を使用している code をアップデートすることはできますか?

プラグインのインストールやアップグレードはネイティブの code を変更するため、新しいストアビルドが必要です。その後は、プラグインを呼び出す JavaScript、HTML、CSS の変更を Capgo Live Updates で即座に配信できます。

アプリの審査を待たずに NFC の変更をリリース

プラグインをストア用ビルドに組み込めば、Capgo live updates で JavaScript、HTML、CSS の変更を数分でユーザーに配信できます

Capgo から始める