1.0.0 • Published 1 year ago

ns-sim-info v1.0.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
1 year ago

ns-sim-info

This plugin is forked from nativescript-sim-info. This plugin uses @nativescript/plugin-seed. The plugin will not request phone number in Android in order to reduce requested permissions. manager.getLine1Number requires permissions for SMS and phone numbers in Android, which are difficult to grant in play store. iOS does not provide phone numbers.

ns plugin add ns-sim-info

Usage

    import { SimInfo } from "ns-sim-info";

    load(): void {
        const simInfo = new SimInfo();
        simInfo.getData()
            .then((simData) => {
                console.log(simData)
            }).catch((error) => {
                console.error(error);
            });
    }

Android Output

Single Sim

[
    {
        "isoCountryCode": "at",
        "simOperator": "23XXX",
        "carrierName": "A1",
        "callState": null,
        "dataActivity": null,
        "phoneType": 1,
        "simState": 5,
        "isNetworkRoaming": true,
        "mcc": 232,
        "mnc": 1,
        "phoneNumber": "",
        "deviceSoftwareVersion": "01",
        "simSerialNumber": "894301561923869XXXX",
        "subscriberId": "23201163022XXXX",
        "isDefaultSim": true,
        "networkType": 13,
        "deviceImei": "35404611160XXXX",
        "deviceMeid": "",
        "subscriptionId": 1
    }
]

Dual Sim

[
    {
        "isoCountryCode": "at",
        "simOperator": "23XXX",
        "carrierName": "spusu",
        "callState": null,
        "dataActivity": 4,
        "phoneType": 1,
        "simState": 5,
        "isNetworkRoaming": true,
        "mcc": 232,
        "mnc": 17,
        "phoneNumber": "",
        "deviceSoftwareVersion": "00",
        "simSerialNumber": "894317008000176XXXX",
        "subscriberId": "23217004025XXXX",
        "isDefaultSim": true,
        "networkType": 13,
        "deviceImei": "86760103133XXXX",
        "deviceMeid": "9900111506XXXX",
        "subscriptionId": 1
    },
    {
        "isoCountryCode": "at",
        "carrierName": "A1",
        "isNetworkRoaming": true,
        "phoneNumber": "",
        "mcc": 232,
        "mnc": 1,
        "subscriptionId": 4,
        "simSerialNumber": "894301561520280XXXX",
        "isDefaultSim": false
    }
]

The plugin will request more or less permission items depending on the Android version. If any of the permissions are rejected by the user, an object will be returned as a rejected promise.

{
    "android.permission.READ_PHONE_STATE": false,
}

iOS Output

Single Sim

[
    {
        "mnc": "232",
        "isoCountryCode": "at",
        "carrierName": "A1",
        "allowsVOIP": true,
        "mcc": "1"
    }
]

API

PropertyPlatformAndroid VersioniOS VersionTypeDescription
isoCountryCodecommon11stringReturns the ISO-3166 country code equivalent for the SIM provider's country code.
carrierNamecommon11stringReturns the MCC+MNC (mobile country code + mobile network code) of the provider of the SIM. 5 or 6 decimal digits.
mcccommon11string - number - nullReturns the mobile country code (MCC).
mnccommon11string - number - nullReturns the mobile network code (MNC).
simOperatorandroid1-stringReturns the Service Provider Name (SPN).
callStateandroid1-number - nullReturns the state of all calls on the device.
dataActivityandroid1-number - nullReturns a constant indicating the type of activity on a data connection (cellular).
phoneTypeandroid1-number - nullReturns a constant indicating the device phone type.
simStateandroid1-number - nullReturns a constant indicating the state of the default SIM card.
isNetworkRoamingandroid1-boolean - nullReturns true if the device is considered roaming on the current network, for GSM purposes.
phoneNumberandroid--stringReturns the phone number string for line 1, for example, the MSISDN for a GSM phone. Returns null or "" if it is unavailable.
deviceSoftwareVersionandroid1-stringReturns the software version number for the device, for example, the IMEI/SV for GSM phones.
simSerialNumberandroid1-stringReturns the serial number of the SIM, if applicable.
subscriberIdandroid1-stringReturns the unique subscriber ID, for example, the IMSI for a GSM phone.
subscriptionIdandroid5.1 (Api: 22)-number - nullReturns the subscription.
simSerialNumberandroid5.1 (Api: 22)-stringReturns SIM unique serial number (ICCID).
networkTypeandroid7 (Api: 24)-number - nullReturns a constant indicating the radio technology (network type) currently in use on the device for data transmission.
deviceImeiandroid8 (Api: 26)-stringreturns IMEI for GSM.
isDefaultSimandroid--boolean - nullReturns true if the sim is considered the default.
allowsVOIPios-1boolean - nullIndicates if the carrier allows making VoIP calls on its network.

Android

Dual-Sim Support

From Api Level 22, A.K.A LOLLIPOP_MR1 or Android 5.1, there is support for dual sim. I would like to point out that there is a difference in number of information attributes between what Android considers the default subscription (TelephonyManager) and the subscriptions (SubscriptionManager).

iOS

Dual-Sim Support

From iOS 12 on, Apple supports dual sim. The available information attributes are the same for the default and secondary sim.

Phone Number

Apple does not allow the access to the phone number under any circumstance. More information on this topic can be found under the point 2.5.2 of the guidelines.

Testing phones

  • Mi 9
  • iPhone 5s

Acknowledgements

nativescript-sim-info

License

Apache License Version 2.0