Getting Started

Installieren

Sie können unser AI-gestütztes Setup verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrem AI-Tool hinzu, indem Sie folgenden Befehl verwenden:

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

Verwenden Sie dann die folgende Anweisung:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die unten angegebenen Plattform-spezifischen Anweisungen befolgen:

bun add @capgo/capacitor-sim
bunx cap sync

Importieren

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

API Übersicht

getSimCards

Ermitteln Sie Informationen von den GerätesIM-Karten.

Ruft Details über alle auf dem Gerät installierten SIM-Karten ab. Bei Dual-SIM-Geräten werden Informationen für beide SIM-Karten zurückgegeben. Benötigt die READ_PHONE_STATE-Berechtigung auf 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

Überprüfen Sie die Berechtigung zum Zugriff auf SIM-Karteninformationen.

Überprüft, ob die App die Berechtigung zum Lesen von SIM-Karten-Daten hat. Auf Android überprüft READ_PHONE_STATE-Berechtigung. Auf iOS ist der Status immer gewährt. Auf Web ist der Status immer abgelehnt.

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

Berechtigung zum Zugriff auf SIM-Karteninformationen anfordern.

Bittet den Benutzer um die Genehmigung zum Lesen von SIM-Karten-Daten. Auf Android wird die READ_PHONE_STATE-Berechtigung angefordert. Auf iOS ist der Status immer gewährt, ohne dass der Benutzer aufgefordert wird. Auf Web bleibt der Status abgelehnt.

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

Typenverweis

GetSimCardsResult

Ergbnis, das durch . zurückgegeben wird.

export interface GetSimCardsResult {
  simCards: SimCard[];
}

PermissionStatus

Ergbnis einer Zugriffsprüfung oder -anfrage.

export interface PermissionStatus {
  readSimCard: PermissionState;
}

SimCard

Eine SIM-Kartenbeschreibung.

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

Quelle der Wahrheit

Diese Seite wurde aus dem Plugin generiert. src/definitions.ts. Wenn sich die öffentliche API im Hintergrund ändert, führen Sie den Sync erneut durch.

Weitergehen von Getting Started

Wenn Sie " Getting Started " zum Planen von Dashboard und API-Operationen verwenden, verbinden Sie es mit Mit @capgo/capacitor-sim für die native Fähigkeit in Mit @capgo/capacitor-sim, API-Übersicht für die Implementierungsdetails in API-Übersicht, Einführung für die Implementierungsdetails in Einführung, API Schlüssel für die Implementierungsdetails in API Schlüssel, und Geräte für die Implementierungsdetails in Geräte.