2.0.0 • Published 4 days ago

@jonz94/capacitor-sim v2.0.0

Weekly downloads
-
License
0BSD
Repository
github
Last release
4 days ago

Install

npm install @jonz94/capacitor-sim
npx cap sync

Android

Variables

This plugin will use the following project variables (defined in your app's variables.gradle file):

  • $androidxCoreKTXVersion version of androidx.core:core-ktx (default: 1.9.0)
  • $kotlin_version version of org.jetbrains.kotlin:kotlin-stdlib-jdk7 (default: 1.8.10)

Configuration

No configuration required for this plugin.

Demo

A working example can be found here: jonz94/capacitor-sim-demo

Usage

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

const getSimCards = async () => {
  const { simCards } = await Sim.getSimCards();

  // console.log(simCards);

  return simCards;
}

API

getSimCards()

getSimCards() => Promise<GetSimCardsResult>

Get information from device's sim cards.

Returns: Promise<GetSimCardsResult>

Since: 1.0.0


checkPermissions()

checkPermissions() => Promise<PermissionStatus>

Check permission to get information from device's sim cards.

On iOS the status is always granted.

Returns: Promise<PermissionStatus>

Since: 1.0.0


requestPermissions()

requestPermissions() => Promise<PermissionStatus>

Request permission to get information from device's sim cards.

On iOS the status is always granted.

Returns: Promise<PermissionStatus>

Since: 1.0.0


Interfaces

GetSimCardsResult

PropType
simCardsSimCard[]

SimCard

PropTypeDescriptionSince
numberstringAndroid only: Phone number.1.0.0
allowsVOIPbooleaniOS only: If this carrier allows VOIP calls to be made on its network.1.0.0
carrierNamestringThe name of the cellular service provider.1.0.0
isoCountryCodestringCountry code for the cellular service provider, represented as an ISO 3166-1 country code string.1.0.0
mobileCountryCodestringMobile country code (MCC) for the cellular service provider, in its numeric representation.1.0.0
mobileNetworkCodestringMobile network code (MNC) for the cellular service provider, in its numeric representation.1.0.0

PermissionStatus

PropType
readSimCardPermissionState

Type Aliases

PermissionState

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'

Changelog

See CHANGELOG.md.

License

See LICENSE.

3.0.0-beta.0

4 days ago

2.0.0

1 year ago

1.0.5

1 year ago

1.0.4

1 year ago

2.0.0-beta.2

1 year ago

2.0.0-beta.1

1 year ago

2.0.0-beta.0

1 year ago

2.0.0-beta.3

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

2 years ago

0.1.0

2 years ago

1.0.0

2 years ago

0.0.1

2 years ago