Démarrage

Copiez un prompt de configuration avec les étapes d'installation et le guide Markdown complet pour ce plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-sim`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/sim/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Installer

bun add @capgo/capacitor-sim
bunx cap sync

Importer

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

API Overview

`getSimCards`

Récupère des informations des cartes SIM du dispositif.

Récupère les détails de toutes les cartes SIM installées sur le dispositif. Sur les appareils dual-SIM, renvoie des informations pour les deux cartes SIM. Exige la permission READ_PHONE_STATE sur 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`

Vérifie la permission d'accès aux informations de la carte SIM.

Vérifie si l'application a la permission de lire les données de la carte SIM. Sur Android, vérifie la permission READ_PHONE_STATE. Sur iOS, le statut est toujours accordé. Sur Web, le statut est toujours refusé.

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`

Demande la permission d'accès aux informations de la carte SIM.

Invite l'utilisateur à accorder la permission de lire les données de la carte SIM. Sur Android, demande la permission READ_PHONE_STATE. Sur iOS, le statut est toujours accordé sans invitation. Sur Web, le statut reste refusé.

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

Référence de type

`GetSimCardsResult`

Résultat retourné par .

export interface GetSimCardsResult {
  simCards: SimCard[];
}

`PermissionStatus`

Résultat d'une vérification ou d'une demande de permission.

export interface PermissionStatus {
  readSimCard: PermissionState;
}

`SimCard`

Description d'une carte 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;
}

Source Of Truth

Cette page est générée à partir du plugin’s src/definitions.tsRe-run the sync when the public API changes upstream.