Panduan Memulai

Instal

Anda bisa menggunakan AI-Assisted Setup untuk menginstal plugin ini. Tambahkan skill Capgo ke tool AI Anda menggunakan perintah berikut:

bunx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Lalu gunakan prompt berikut:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-sim` plugin in my project.

Jika Anda lebih suka Manual Setup, instal plugin dengan menjalankan perintah berikut dan ikuti instruksi khusus platform di bawah ini:

bun add @capgo/capacitor-sim
bunx cap sync

Impor

import { Sim } from '@capgo/capacitor-sim';

Mulai cepat

import { Sim } from '@capgo/capacitor-sim';

const { simCards } = await Sim.getSimCards();
simCards.forEach((sim, index) => {
  console.log(`SIM ${index + 1}:`);
  console.log(`  Carrier: ${sim.carrierName}`);
  console.log(`  Country: ${sim.isoCountryCode}`);
  console.log(`  MCC: ${sim.mobileCountryCode}`);
  console.log(`  MNC: ${sim.mobileNetworkCode}`);
});

Contoh: checkPermissions

import { Sim } from '@capgo/capacitor-sim';

const status = await Sim.checkPermissions();
if (status.readSimCard === 'granted') {
  console.log('Permission granted');
} else {
  console.log('Permission not granted');
}

Contoh: requestPermissions

import { Sim } from '@capgo/capacitor-sim';

const status = await Sim.requestPermissions();
if (status.readSimCard === 'granted') {
  // Now you can call getSimCards()
  const simCards = await Sim.getSimCards();
}

Masalah umum

• Izin: panggil checkPermissions() lalu requestPermissions() saat dibutuhkan.
• Sinkronisasi native: jalankan bunx cap sync setelah upgrade plugin.
• Sumber kebenaran: percaya src/definitions.ts pada repo GitHub.

Ikhtisar API

getSimCards

Dapatkan informasi dari kartu SIM perangkat.

Mengambil detail semua kartu SIM yang terpasang di perangkat. Pada perangkat dual-SIM, akan mengembalikan informasi untuk kedua kartu SIM. Memerlukan izin READ_PHONE_STATE pada Android.

import { Sim } from '@capgo/capacitor-sim';

const { simCards } = await Sim.getSimCards();
simCards.forEach((sim, index) => {
  console.log(`SIM ${index + 1}:`);
  console.log(`  Carrier: ${sim.carrierName}`);
  console.log(`  Country: ${sim.isoCountryCode}`);
  console.log(`  MCC: ${sim.mobileCountryCode}`);
  console.log(`  MNC: ${sim.mobileNetworkCode}`);
});

checkPermissions

Cek izin untuk mengakses informasi kartu SIM.

Memeriksa apakah aplikasi memiliki izin untuk membaca data kartu SIM. Pada Android, memeriksa izin READ_PHONE_STATE. Pada iOS, status selalu granted. Pada Web, status selalu denied.

import { Sim } from '@capgo/capacitor-sim';

const status = await Sim.checkPermissions();
if (status.readSimCard === 'granted') {
  console.log('Permission granted');
} else {
  console.log('Permission not granted');
}

requestPermissions

Minta izin untuk mengakses informasi kartu SIM.

Meminta pengguna untuk memberikan izin membaca data kartu SIM. Pada Android, meminta izin READ_PHONE_STATE. Pada iOS, status selalu granted tanpa prompt. Pada Web, status tetap denied.

import { Sim } from '@capgo/capacitor-sim';

const status = await Sim.requestPermissions();
if (status.readSimCard === 'granted') {
  // Now you can call getSimCards()
  const simCards = await Sim.getSimCards();
}

Referensi Tipe

GetSimCardsResult

Hasil yang dikembalikan oleh .

export interface GetSimCardsResult {
  simCards: SimCard[];
}

PermissionStatus

Hasil dari pengecekan atau permintaan izin.

export interface PermissionStatus {
  readSimCard: PermissionState;
}

SimCard

Deskripsi kartu SIM.

export interface SimCard {
  /**
   * Android only: Phone number for this SIM slot, when available.
   *
   * @since 1.0.0
   */
  number?: string;

  /**
   * Android only: Unique subscription identifier.
   *
   * @since 1.1.0
   */
  subscriptionId?: string;

  /**
   * Android only: Physical SIM slot index for this subscription.
   *
   * @since 1.1.0
   */
  simSlotIndex?: number;

  /**
   * iOS only: Indicates whether the carrier supports VoIP.
   *
   * @since 1.0.0
   */
  allowsVOIP?: boolean;

  /**
   * Display name of the cellular service provider.
   *
   * On iOS 16.4+ the system may return placeholder values such as `--`.
   * See https://github.com/jonz94/capacitor-sim/issues/8 for details.
   *
   * @since 1.0.0
   */
  carrierName: string;

  /**
   * ISO 3166-1 alpha-2 country code of the service provider.
   *
   * On iOS 16.4+ the system may return an empty string or `--`.
   * See https://github.com/jonz94/capacitor-sim/issues/8 for details.
   *
   * @since 1.0.0
   */
  isoCountryCode: string;

  /**
   * Mobile Country Code (MCC) of the service provider.
   *
   * On iOS 16.4+ the system may return placeholder values such as `65535`.
   * See https://github.com/jonz94/capacitor-sim/issues/8 for details.
   *
   * @since 1.0.0
   */
  mobileCountryCode: string;

  /**
   * Mobile Network Code (MNC) of the service provider.
   *
   * On iOS 16.4+ the system may return placeholder values such as `65535`.
   * See https://github.com/jonz94/capacitor-sim/issues/8 for details.
   *
   * @since 1.0.0
   */
  mobileNetworkCode: string;
}

Sumber Kebenaran

Halaman ini dibuat dari plugin src/definitions.ts. Jalankan ulang sync saat API publik berubah di upstream.

Lanjutkan dari Getting Started

Jika Anda menggunakan Panduan Memulai untuk merencanakan operasi dashboard dan API, hubungkan dengan Menggunakan @capgo/capacitor-sim untuk kapabilitas native saat menggunakan @capgo/capacitor-sim, Ikhtisar API untuk detail implementasi di Ringkasan API, Pendahuluan untuk detail implementasi di Pendahuluan, Kunci API untuk detail implementasi di API Keys, dan Perangkat untuk detail implementasi di Perangkat.