开始获取

安装

bun add @capgo/capacitor-sim
bunx cap sync

导入

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

API 介绍

getSimCards

获取设备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

SIM卡信息读取结果。

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重新同步公共API时，请重新运行上游的同步。

从开始就继续

如果您正在使用 入门 为了规划仪表板和API操作，连接它 使用@capgo/capacitor-sim 在使用@capgo/capacitor-sim中 API概述 在API概述中 介绍 在介绍中 API密钥 在API密钥中 设备 设备详细信息的实现细节。