jonz94
Sim
@jonz94/capacitor-sim
Capacitor plugin to get information from device's sim cards.
Install
npm install @jonz94/capacitor-sim
npx cap syncAndroid
Variables
This plugin will use the following project variables (defined in your app's variables.gradle file):
androidxCoreKTXVersionversion ofandroidx.core:core-ktx(default:1.10.0)kotlin_versionversion oforg.jetbrains.kotlin:kotlin-stdlib(default:1.8.20)
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
<docgen-index> </docgen-index> <docgen-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
| Prop | Type |
|---|---|
simCards |
SimCard[] |
SimCard
| Prop | Type | Description | Since |
|---|---|---|---|
number |
string |
Android only: Phone number. | 1.0.0 |
allowsVOIP |
boolean |
iOS only: If this carrier allows VOIP calls to be made on its network. | 1.0.0 |
carrierName |
string |
The name of the cellular service provider. | 1.0.0 |
isoCountryCode |
string |
Country code for the cellular service provider, represented as an ISO 3166-1 country code string. | 1.0.0 |
mobileCountryCode |
string |
Mobile country code (MCC) for the cellular service provider, in its numeric representation. | 1.0.0 |
mobileNetworkCode |
string |
Mobile network code (MNC) for the cellular service provider, in its numeric representation. | 1.0.0 |
PermissionStatus
| Prop | Type |
|---|---|
readSimCard |
PermissionState |
Type Aliases
PermissionState
'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'
Changelog
See CHANGELOG.md.
License
See LICENSE.