Empezar

Instalar

bun add @capgo/capacitor-sim
bunx cap sync

Importar

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

API Resumen

getSimCards

Obtenga información de los cartones SIM del dispositivo.

Recupera detalles sobre todos los cartones SIM instalados en el dispositivo. En dispositivos con dos cartones SIM, devuelve información para ambos cartones SIM. Requiere permiso READ_PHONE_STATE en 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

Verificar permiso para acceder a información de cartón SIM.

Verifica si la aplicación tiene permiso para leer datos de cartón SIM. En Android, verifica permiso READ_PHONE_STATE. En iOS, el estado siempre está concedido. En Web, el estado siempre está denegado.

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

Solicitar permiso para acceder a información de cartón SIM.

Pide al usuario que conceda permiso para leer datos de cartón SIM. En Android, solicita permiso READ_PHONE_STATE. En iOS, el estado siempre está concedido sin solicitar. En Web, el estado sigue siendo denegado.

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();
}

Referencia de tipos

GetSimCardsResult

Resultado devuelto por .

export interface GetSimCardsResult {
  simCards: SimCard[];
}

PermissionStatus

Resultado de una verificación o solicitud de permiso.

export interface PermissionStatus {
  readSimCard: PermissionState;
}

SimCard

Descripción de una tarjeta 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;
}

Fuente de Verdad

Esta página se genera desde el plugin’s src/definitions.tsRe-ejecutar la sincronización cuando el público API cambie en la fuente.