Getting Started

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrem AI-Tool hinzu, indem Sie die folgende Befehlszeile verwenden:

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

Verwenden Sie dann die folgende Anfrage:

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 untenstehenden plattform-spezifischen Anweisungen befolgen:

bun add @capgo/capacitor-sim
bunx cap sync

Importieren

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

API-Übersicht

getSimCards

Informationen vom Geräts Sim-Karten abrufen.

Zieht Details über alle auf dem Gerät installierten Sim-Karten ab. Bei Dual-Sim-Geräten liefert die Funktion Informationen für beide Sim-Karten. Berechtigung READ_PHONE_STATE auf Android erforderlich.

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üft, ob die App die Berechtigung zur Lesung von Sim-Karten-Daten besitzt. Auf Android wird die Berechtigung READ_PHONE_STATE überprüft. Auf iOS ist der Status immer gewährt. Auf Web ist der Status immer verweigert.

Zwischenablage

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

Fordert den Benutzer auf, die Berechtigung zur Lesung von Sim-Karten-Daten zu gewähren. Auf Android wird die Berechtigung READ_PHONE_STATE angefordert. Auf iOS ist der Status immer gewährt, ohne dass der Benutzer aufgefordert wird. Auf Web bleibt der Status verweigert.

__CAPGO_KEEP_0__ Übersicht

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

Typenreferenz

GetSimCardsResult

Ergibt durch .

export interface GetSimCardsResult {
  simCards: SimCard[];
}

PermissionStatus

Ergibt Ergebnis einer Berechtigungsprü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 wird aus dem Plugin generiert src/definitions.tsRe-run die Synchronisierung, wenn die öffentliche API upstream geändert wird.

Weiter von Getting Started

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