Lompat ke Konten Utama
@capgo/capacitor-nfc API Perangkat Sumber Terbuka

NFC Plugin Capacitor

Pengenalan, membaca, dan menulis tag NFC native untuk aplikasi Capacitor di iOS dan Android

Install

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

Petunjuk

Bagaimana menggunakan NFC di Capacitor

Test di perangkat

Unduh aplikasi Capgo, kemudian scan kode QR code.

Tautan QR pratinjau code NFC

Menggunakan @capgo/capacitor-nfc

Permukaan publik API untuk plugin NFC Capacitor.

Pasang

bun add @capgo/capacitor-nfc
bunx cap sync

bunx cap sync menggandakan kode native code plugin ke proyek native Anda. Jalankan lagi setelah setiap pembaruan plugin.

Impor

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

Ringkasan API

Metode Deskripsi
startScanning Mengaktifkan pengaturan untuk mendengar tag NFC.
stopScanning Menghentikan sesi pemindaian NFC yang sedang berlangsung.
write Menggunakan rekaman NDEF yang disediakan untuk menulis ke tag NFC terakhir yang ditemukan.
erase Menggunakan rekaman NDEF kosong untuk menghapus tag NFC terakhir yang ditemukan.
makeReadOnly Mengusut agar tag yang ditemukan terakhir menjadi tidak dapat diedit.
share Mengirimkan pesan NDEF ke perangkat lain melalui peer-to-peer (hanya untuk Android).
unshare Menghentikan pengiriman pesan NDEF sebelumnya (hanya untuk Android).
getStatus Mengembalikan status adapter NFC saat ini.
showSettings Membuka halaman pengaturan sistem di mana pengguna dapat mengaktifkan NFC.
isSupported Mengecek apakah perangkat memiliki dukungan perangkat keras NFC.

Contoh

startScanning()

Mengaktifkan pengaturan untuk mendengarkan tag NFC.

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

await CapacitorNfc.startScanning();

stopScanning()

Menghentikan sesi pemindaian NFC yang sedang berlangsung.

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

await CapacitorNfc.stopScanning();

write()

Mengirimkan rekaman NDEF yang diberikan ke tag terakhir yang ditemukan.

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

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

erase()

Mengusir tag terakhir yang ditemukan dengan menulis pesan NDEF kosong.

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

await CapacitorNfc.erase();

makeReadOnly()

Mengubah tag terakhir yang ditemukan menjadi tidak dapat diedit.

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

await CapacitorNfc.makeReadOnly();

share()

Mengirimkan pesan NDEF ke perangkat lain melalui peer-to-peer (hanya Android).

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

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

Daftar di atas menampilkan 10 metode inti. Bantuan listener dan versi, serta kontrak lengkap dari setiap metode, dapat dilihat di repository GitHub.

Dengarkan event

addListener mengembalikan sebuah handle. Panggil handle.remove() ketika layar diunmount.

Referensi lengkap

Teruskan dari Menggunakan @capgo/capacitor-nfc

Menggunakan @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-nfc Menggunakan @capgo/capacitor-nfc Untuk merencanakan dashboard dan operasional API, hubungkannya untuk detail implementasi di @capgo/capacitor-nfc, untuk detail implementasi di @capgo/capacitor-nfc, Mulai Menggunakan untuk detail implementasi di Getting Started, API reference untuk detail implementasi di API Ringkasan, Pendahuluan untuk detail implementasi di Pendahuluan, dan API Kunci untuk detail implementasi di API Kunci.

FAQ

Pertanyaan NFC plugin

Bagaimana cara menginstal plugin NFC di aplikasi Capacitor?

Jalankan "bun add @capgo/capacitor-nfc" (atau "npm install @capgo/capacitor-nfc"), kemudian jalankan "bunx cap sync" agar projek iOS dan Android dapat menangkap native code. Import dari "@capgo/capacitor-nfc" di aplikasi code.

Apakah @capgo/capacitor-nfc dapat digunakan dengan React, Vue, dan Angular?

Iya. Plugin NFC adalah paket Capacitor, sehingga dapat digunakan dengan framework web apa pun yang berjalan di dalam Capacitor, termasuk Ionic, React, Vue, Angular, Svelte, dan JavaScript biasa.

Versi Capacitor mana yang didukung oleh @capgo/capacitor-nfc?

Plugin Capgo mengikuti versi mayor Capacitor: gunakan versi plugin mayor yang sesuai dengan versi mayor Capacitor (misalnya plugin v8 dengan Capacitor 8). Tabel kompatibilitas di README GitHub menyebutkan versi yang masih dipelihara.

Apakah @capgo/capacitor-nfc gratis dan terbuka sumber?

Ya. Sumber code ini terbuka di GitHub di https://github.com/Cap-go/capacitor-nfc/ dan paket ini gratis untuk diinstal dari npm.

Apakah saya bisa memperbarui code yang menggunakan NFC tanpa melalui tinjauan App Store?

Menginstal atau mengupgrade plugin ini mengubah native code, sehingga memerlukan build toko yang baru. Setelah itu, perubahan JavaScript, HTML, dan CSS yang memanggil plugin ini bisa dikirimkan langsung dengan Capgo live updates.

Kirim perubahan NFC tanpa menunggu tinjauan aplikasi.

Setelah plugin masuk ke dalam toko aplikasi Anda, Capgo pembaruan hidup mengirimkan perubahan JavaScript, HTML, dan CSS Anda ke pengguna dalam menit.

Mulai dengan Capgo.