Getting Started

インストール

AI-Assisted セットアップを使用してプラグインをインストールできます。AI ツールに Capgo スキルを追加するには、以下のコマンドを使用してください。

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

次に、以下のプロンプトを使用してください:

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

Manual Setup を好む場合は、以下のコマンドを実行してプラットフォーム固有の指示に従ってプラグインをインストールしてください:

bun add @capgo/capacitor-sim
bunx cap sync

インポート

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

API の概要

getSimCards

SIMカードから情報を取得します。

SIMカードの詳細をすべて取得します。 デュアルSIM端末では、両方のSIMカードの情報を取得します。 Androidでは、READ_PHONE_STATE権限が必要です。

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

SIMカード情報へのアクセス許可を確認します。

SIMカードデータを読み取るためのアプリの許可を確認します。 Androidでは、READ_PHONE_STATE権限を確認します。 iOSでは、許可状態は常に許可されています。 Webでは、許可状態は常に拒否されます。

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

SIMカード情報へのアクセス許可を求めます。

ユーザーにSIMカードデータを読み取るための許可を求めます。 Androidでは、READ_PHONE_STATE許可を求めます。 iOSでは、許可状態は常に許可されています。 Webでは、許可状態は常に拒否されます。

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

型参照

GetSimCardsResult

__CAPGO_KEEP_0__で返される結果

export interface GetSimCardsResult {
  simCards: SimCard[];
}

PermissionStatus

許可のチェックまたは要求の結果

export interface PermissionStatus {
  readSimCard: PermissionState;
}

SimCard

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

真実の源

このページはプラグインから生成されています。 src/definitions.ts. upstream の public API が変更された場合に再度 Sync を実行してください。

Getting Started から続けてください。

Capacitor を使用している場合 Getting Started ダッシュボードと API の作業を計画するには、Capacitor を接続してください。 Using @capgo/capacitor-sim Capacitor のネイティブ機能の実装については、Using @capgo/capacitor-sim を参照してください。 API Overview API の実装詳細については、API Overview を参照してください。 Introduction 導入の実装詳細について API キー API キーに関する実装詳細、 デバイス デバイスに関する実装詳細について