Getting Started

Instalar

Puede utilizar nuestra configuración asistida por IA para instalar el plugin. Agregue las Capgo habilidades a su herramienta de IA utilizando el siguiente comando:

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

Usa luego el siguiente prompt:

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

Si prefieres la configuración manual, instala el complemento ejecutando los siguientes comandos y sigue las instrucciones específicas de la plataforma a continuación:

bun add @capgo/capacitor-sim
bunx cap sync

Importar

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

API Resumen

getSimCards

Obtén información de los cartones SIM del dispositivo.

Obtiene detalles sobre todos los tarjetas SIM instaladas en el dispositivo. En dispositivos con dos SIM, devuelve información para ambas tarjetas 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 la tarjeta SIM.

Verifica si la aplicación tiene permiso para leer datos de la tarjeta 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 la tarjeta SIM.

Pide al usuario que conceda permiso para leer datos de la tarjeta 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 la página del plugin’s src/definitions.ts. Re-run la sincronización cuando el público API cambia en la fuente.

Sigue adelante desde Getting Started

Si estás utilizando Getting Started para planificar la consola de dashboard y API operaciones, conecta con Usando @capgo/capacitor-sim para la capacidad nativa en Usando @capgo/capacitor-sim, API Overview para el detalle de implementación en API Overview, __CAPGO_KEEP_0__ para el detalle de implementación en __CAPGO_KEEP_0__, API Claves para el detalle de implementación en API Claves, y Dispositivos para el detalle de implementación en Dispositivos.