はじめに

インストール

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

クリップボードにコピー

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パブリック API がアップストリームで変更された場合に、再度 Sync を実行してください。