Getting Started

Installazione

Puoi utilizzare la nostra configurazione assistita dall'IA per installare il plugin. Aggiungi le Capgo competenze al tuo strumento di AI utilizzando il seguente comando:

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

Poi utilizza la seguente richiesta:

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

Se preferisci la configurazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche del dispositivo qui sotto:

bun add @capgo/capacitor-sim
bunx cap sync

Importa

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

API Panoramica

getSimCards

Recupera informazioni dai cartelli 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 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

Verifica il permesso di accesso alle informazioni della SIM.

Controlla se l'app ha il permesso di leggere i dati della SIM. Su Android, controlla la richiesta di permesso READ_PHONE_STATE. Su iOS, lo stato è sempre concesso. Su Web, lo stato è sempre negato.

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

Richiedi il permesso di accesso alle informazioni della SIM.

Sollecita l'utente a concedere il permesso di leggere i dati della SIM. Su Android, richiede il permesso 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 Sim.requestPermissions();
if (status.readSimCard === 'granted') {
  // Now you can call getSimCards()
  const simCards = await Sim.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 della 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;
}

Fonte di Verità

Questa pagina è generata dal plugin’s src/definitions.tsRieccere l'aggiornamento quando le informazioni pubbliche API cambiano in alto.

Keep going from Getting Started

Se stai utilizzando Getting Started per pianificare dashboard e operazioni di API, connettilo con Utilizza @capgo/capacitor-sim per la capacità nativa in Utilizza @capgo/capacitor-sim, Panoramica di API per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli di implementazione in Introduzione, Chiavi di API per i dettagli di implementazione in Chiavi di API, Dispositivi per i dettagli di implementazione in Dispositivi.