Inizia a utilizzare

Installazione

bun add @capgo/capacitor-sim
bunx cap sync

Importa

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

API Panoramica

getSimCards

Ottenere informazioni dalle schede SIM del dispositivo.

Recupera dettagli su tutti i cartelli SIM installati sul dispositivo. In dispositivi dual-SIM, restituisce informazioni per entrambi i cartelli SIM. Richiede la permessione READ_PHONE_STATE su Android.

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

const { simCards } = await SimPlugin.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

Controlla la permessione per accedere alle informazioni del cartello SIM.

Controlla se l'app ha la permessione di leggere i dati del cartello SIM. Su Android, controlla la permessione READ_PHONE_STATE. Su iOS, lo stato è sempre concesso. Su Web, lo stato è sempre negato.

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

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

requestPermissions

Richiedi la permessione per accedere alle informazioni del cartello SIM.

Sollecita l'utente a concedere la permessione di leggere i dati del cartello SIM. Su Android, richiede la permessione READ_PHONE_STATE. Su iOS, lo stato è sempre concesso senza sollecitazione. Su Web, lo stato rimane negato.

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

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

Riferimento di tipo

GetSimCardsResult

Risultato restituito da .

export interface GetSimCardsResult {
  simCards: SimCard[];
}

PermissionStatus

Risultato di un controllo o richiesta di autorizzazione.

export interface PermissionStatus {
  readSimCard: PermissionState;
}

SimCard

Descrizione di una scheda 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;
}

Punto di verità

Questa pagina è generata dal plugin’s src/definitions.ts. Riavvia la sincronizzazione quando il pubblico API cambia in alto.

Continua da Inizia con l'installazione

Se stai utilizzando Inizia con l'installazione per pianificare il dashboard e le operazioni di API, connettilo con Utilizza @capgo/capacitor-sim per la capacità nativa in Utilizza @capgo/capacitor-sim, API Overview per i dettagli di implementazione in API Overview, Introduzione per i dettagli di implementazione in Introduzione, API Chiavi per i dettagli di implementazione in API Chiavi, e Dispositivi per i dettagli di implementazione in Dispositivi.