react-native-sim-cards-manager
A new library that merge multiple sim cards libraries into a single one:
Bridges have been adapted, so you will have to adapt your code if you come from one of those libraries.
Bugs fixed and some improvements have been made.
Installation
npm install react-native-sim-cards-manager
Permissions
Android
Minimum API Level is 22
TelephonyManager require Android permission READ_PHONE_STATE:
Add in your Android Manifest:
<uses-permission
android:name="android.permission.READ_PHONE_STATE" />
iOS
This API won't work without eSIM entitlement. You can read more about it here
Minimum API Level is 12 for eSIM methods
Note: At the moment (iOS 14.2) there might a bug in iOS SDK which returns uknown result before eSIM setup completion. More about it here
Usage
Get sim cards
The list can be empty (no simcards detected) or one/many element(s) Two methods are availabe :
Method getSimCards
This handle the permission request and takes an optionnal rationale Parameter
import { SimManager } from 'react-native-sim-cards-manager';
SimCardsManagerModule.getSimCards({
title: 'App Permission',
message: 'Custom message',
buttonNeutral: 'Not now',
buttonNegative: 'Not OK',
buttonPositive: 'OK',
})
.then((array: Array<any>) => {
//
})
.catch((error) => {
//
});
Method getSimCardsNative
This is the method used internally by getSimCards. It does not handle the permission request and leaves the user of this lib.
import { SimManager } from 'react-native-sim-cards-manager';
SimCardsManagerModule.getSimCardsNative()
.then((array: Array<any>) => {
//
})
.catch((error) => {
//
});
Available set of data per platform:
| Platform | iOS | Android |
|---|---|---|
| carrierName |
|
|
| displayName |
|
|
| isoCountryCode |
|
|
| mobileCountryCode |
|
|
| mobileNetworkCode |
|
|
| isNetworkRoaming |
|
|
| isDataRoaming |
|
|
| simSlotIndex |
|
|
| phoneNumber |
|
|
| simSerialNumber |
|
|
| subscriptionId |
|
|
| allowsVOIP |
|
|
Esim is supported
Return true/false is the device support eSim feature
import { SimManager } from 'react-native-sim-cards-manager';
SimCardsManagerModule.isEsimSupported()
.then((isSupported: boolean) => {
//
})
.catch((error) => {
//
});
Setup eSim with an activation code
Entry parameters for the bridge:
| Entry parameters | Mandatory | Description |
|---|---|---|
| address | N/A | The address of the carrier network’s eSIM server |
| confirmationCode | N/A | The provisioning request’s confirmation code, provided by the network operator when initiating an eSIM download |
| iccid | N/A | The provisioning request’s eUICC identifier |
| address | N/A | The provisioning request’s Integrated Circuit Card Identifier |
| matchingId | N/A | The provisioning request’s matching identifier |
| oid | N/A | The provisioning request’s Object Identifier |
Error code that can be returned by the bridge:
| Error code | Description |
|---|---|
| 0 | Feature not available for that OS / device |
| 1 | The device doesn't support a cellular plan |
| 2 | The OS failed to add the new plan |
| 3 (iOS) | The OS has returned an unknow error |
| 3 (Android) | The OS has returned an error or something goes wrong with the Intent/Activity |
import { SimManager } from 'react-native-sim-cards-manager';
SimCardsManagerModule.setupEsim({
confirmationCode,
address: '',
})
.then((isPlanAdded: boolean) => {
//
})
.catch((error) => {
//
});
Changelog
1.0.3
- Fix bug with EMBEDDED_SUBSCRIPTION_RESULT_ERROR #12
1.0.2
- Remove 'deviceID' on Android because it require high privilege
- Adding permission management on Android (READ_PHONE_STATE)
1.0.1
- Android bug fixes
1.0.0
- First stable release
0.9.9
- iOS implementation
- Android implementation
- RN implementation
- Documentation & sample project
Contributing
See the contributing guide to learn how to contribute to the repository and the development workflow.
License
MIT
![[Snyk] Upgrade react-native from 0.69.0 to 0.70.6](https://avatars.githubusercontent.com/u/2726958?v=4)
![[Snyk] Security upgrade react-native from 0.68.2 to 0.69.0](https://avatars.githubusercontent.com/u/19733683?v=4)
| 619/1000 
| 519/1000 
46 Nov 29, 2022
42 Dec 17, 2022
7 Dec 21, 2022
7 May 2, 2022
28 Dec 4, 2022
1 Feb 23, 2022
16 Dec 30, 2022
1 Nov 28, 2022
150 Dec 30, 2022
23 Sep 1, 2022
51 Sep 29, 2022
128 Jan 6, 2023
21 Dec 5, 2022
37 Nov 15, 2022
64 Oct 19, 2022
5 Feb 16, 2022
13 Jul 14, 2022
2 Oct 31, 2022
15.6k Jan 7, 2023