cordova-plugin-sim

Installation

cordova plugin add cordova-plugin-sim

Supported Platforms

• Android
• iOS
• Windows Phone 7 and 8

Usage

document.addEventListener("deviceready", onDeviceReady, false);

function onDeviceReady() {
  window.plugins.sim.getSimInfo(successCallback, errorCallback);
}

function successCallback(result) {
  console.log(result);
}

function errorCallback(error) {
  console.log(error);
}

// Android only: check permission
function hasReadPermission() {
  window.plugins.sim.hasReadPermission(successCallback, errorCallback);
}

// Android only: request permission
function requestReadPermission() {
  window.plugins.sim.requestReadPermission(successCallback, errorCallback);
}

• carrierName: String - the Service Provider Name (SPN)
• countryCode: String - the ISO country code equivalent for the SIM provider's country code
• mcc: String - the MCC (mobile country code) of the provider of the SIM
• mnc: String - the MNC (mobile network code) of the provider of the SIM

Ionic 2 Usage

import { Sim } from 'ionic-native';

Sim.getSimInfo().then(
  (info) => console.log('Sim info: ', info),
  (err) => console.log('Unable to get sim info: ', err)
);

Sim.hasReadPermission().then(
  (info) => console.log('Has permission:', info)
);

Sim.requestReadPermission().then(
  () => console.log('Permission granted'),
  () => console.log('Permission denied')
);

Android Quirks

Under the hood

• TelephonyManager (since API level 1)
• SubscriptionManager (since API level 22)

Return object

• carrierName: {String} Service Provider Name (SPN)
• countryCode: {String} ISO country code equivalent for the SIM provider's country code
• mcc: {String} MCC (mobile country code) of the provider of the SIM
• mnc: {String} MNC (mobile network code) of the provider of the SIM
• callState: {Number} call state (cellular) on the device
• dataActivity: {Number} type of activity on a data connection (cellular)
• networkType: {Number} the NETWORKTYPExxxx for current data connection
• phoneType: {Number} device phone type. This indicates the type of radio used to transmit voice calls
• simState: {Number} the state of the device SIM card
• isNetworkRoaming: {Boolean} true if the device is considered roaming on the current network, for GSM purposes
• phoneCount: {Number} the number of phones available. Returns 0 if none of voice, sms, data is not supported. Returns 1 for Single standby mode (Single SIM functionality). Returns 2 for Dual standby mode (Dual SIM functionality)
• activeSubscriptionInfoCount: {Number} READ_PHONE_STATE the current number of active subscriptions
• activeSubscriptionInfoCountMax: {Number} READ_PHONE_STATE the maximum number of active subscriptions
• phoneNumber: {String} READ_PHONE_STATE - phone number string for line 1, for example, the MSISDN for a GSM phone ¹
• deviceId: {String} READ_PHONE_STATE the unique device ID, for example, the IMEI for GSM and the MEID or ESN for CDMA phones
• deviceSoftwareVersion: {String} READ_PHONE_STATE the software version number for the device, for example, the IMEI/SV for GSM phones
• simSerialNumber: {String} READ_PHONE_STATE the serial number of the SIM, if applicable
• subscriberId: {String} READ_PHONE_STATE the unique subscriber ID, for example, the IMSI for a GSM phone
• cards: {Array} READ_PHONE_STATE List of SIM cards

Android Emulator results

{
  "carrierName": "Android",
  "countryCode": "us",
  "mcc": "310",
  "mnc": "260",
  "phoneNumber": "15555215554",
  "deviceId": "0000000000000000",
  "simSerialNumber": "89014103211118510720",
  "subscriberId": "310260000000000",
  "callState": 0,
  "dataActivity": 0,
  "networkType": 3,
  "phoneType": 1,
  "simState": 5,
  "isNetworkRoaming": false
}

List of Call State Codes and Meanings

List of Data Activity Codes and Meanings

List of Network Type Codes and Meanings

List of Phone Type Codes and Meanings

List of SIM State Codes and Meanings

// check permission
function hasReadPermission() {
  window.plugins.sim.hasReadPermission(successCallback, errorCallback);
}

// request permission
function requestReadPermission() {
  window.plugins.sim.requestReadPermission(successCallback, errorCallback);
}

Build conflict with phonegap-facebook-plugin

• https://github.com/Telerik-Verified-Plugins/Facebook
• https://github.com/jeduan/cordova-plugin-facebook4

iOS Quirks

• allowsVOIP: Boolean - indicates if the carrier allows VoIP calls to be made on its network

iOS Emulator results

{
  "carrierName": "",
  "countryCode": "",
  "mcc": "",
  "mnc": "",
  "allowsVOIP": false
}

Windows Phone Quirks

• isCellularDataEnabled: Boolean - indicates whether the network is cellular data enabled
• isCellularDataRoamingEnabled: Boolean - indicates whether the network allows data roaming
• isNetworkAvailable: Boolean - indicates whether the network interface is available
• isWiFiEnabled: Boolean - indicates whether the network is Wi-Fi enabled

Author

Peter Bakondy

• https://github.com/pbakondy

LICENSE