Giter Club home page Giter Club logo

react-native-carrier-info's Introduction

React Native Carrier Info

npm version npm downloads

React Native module bridge to obtain information about the user’s home cellular service provider.

Makes use of the following native classes:

Version

1.0.0

  • Android support
  • Promosify all APIs
  • RN 0.47 support

API

All APIs are async functions

allowsVOIP (iOS only)

boolean allowsVOIP() - Indicates if the carrier allows VoIP calls to be made on its network.
  • If you configure a device for a carrier and then remove the SIM card, this property retains the Boolean value indicating the carrier’s policy regarding VoIP.
  • Always return true on Android.

carrierName

string carrierName() - The name of the user’s home cellular service provider.
  • This string is provided by the carrier and formatted for presentation to the user. The value does not change if the user is roaming; it always represents the provider with whom the user has an account.
  • If you configure a device for a carrier and then remove the SIM card, this property retains the name of the carrier.
  • The value for this property is 'nil' if the device was never configured for a carrier.

isoCountryCode

string isoCountryCode() - The ISO country code for the user’s cellular service provider.
  • This property uses the ISO 3166-1 country code representation.
  • The value for this property is 'nil' if any of the following apply:
    • The device is in Airplane mode.
    • There is no SIM card in the device.
    • The device is outside of cellular service range.

mobileCountryCode

string mobileCountryCode() - The mobile country code (MCC) for the user’s cellular service provider.
  • MCCs are defined by ITU-T Recommendation E.212, “List of Mobile Country or Geographical Area Codes.”
  • The value for this property is 'nil' if any of the following apply:
    • There is no SIM card in the device.
    • The device is outside of cellular service range.
  • The value may be 'nil' on hardware prior to iPhone 4S when in Airplane mode.

mobileNetworkCode

string mobileNetworkCode() - The mobile network code (MNC) for the user’s cellular service provider.
  • The value for this property is 'nil' if any of the following apply:
    • There is no SIM card in the device.
    • The device is outside of cellular service range.
  • The value may be 'nil' on hardware prior to iPhone 4S when in Airplane mode.

mobileNetworkOperator

string mobileNetworkOperator() - return MCC + MNC, e.g 46697

Getting Started (and running the demo project)

iOS

  1. From inside your project run npm install react-native-carrier-info --save
  2. In XCode, in the project navigator, right click LibrariesAdd Files to [your project's name]
  3. Go to node_modules/react-native-carrier-info/ios and add RNCarrierInfo.xcodeproj
  4. In XCode, in the project navigator, select your project. Add libRNCarrierInfo.a to your project's Build PhasesLink Binary With Libraries
  5. Click RNCarrierInfo.xcodeproj in the project navigator and go the Build Settings tab. Make sure 'All' is toggled on (instead of 'Basic'). Look for Header Search Paths and make sure it contains both $(SRCROOT)/../react-native/React and $(SRCROOT)/../../React - mark both as recursive.
  6. Set up the project to run on your device (iOS simulator does not report cellular provider info)
  7. Run your project (Cmd+R)

Android

  • app/build.gradle
dependencies {
  ...
  compile project(':react-native-carrier-info') <-- add this
  ...

}
  • settings.gradle
include ':react-native-carrier-info'
project(':react-native-carrier-info').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-carrier-info/android')
  • MainApplication.java
...
import com.ianlin.RNCarrierInfo.RNCarrierInfoPackage; <-- add this
...

@Override
protected List<ReactPackage> getPackages() {
  return Arrays.<ReactPackage>asList(
    new MainReactPackage(),
    ...
    new RNCarrierInfoPackage(), <-- add this
    ...
  );
}

Usage Example

import CarrierInfo from 'react-native-carrier-info';

// inside your code where you would like to retrieve carrier info
CarrierInfo.allowsVOIP()
.then((result) => {
  Alert.alert('Allows VoIP', JSON.stringify(result));
});

CarrierInfo.carrierName()
.then((result) => {
  Alert.alert('Carrier Name', result);
});

CarrierInfo.isoCountryCode()
.then((result) => {
  Alert.alert('ISO', result);
});

CarrierInfo.mobileCountryCode()
.then((result) => {
  Alert.alert('MCC', result);
});

CarrierInfo.mobileNetworkCode()
.then((result) => {
  Alert.alert('MNC', result);
});

CarrierInfo.mobileNetworkOperator()
.then((result) => {
  Alert.alert('MCC + MNC', result);
});

There is an example project supplied with the repo in the RNCarrierInfoDemo folder. The sample app needs to be run on a device as the simulator does not report cellular provider info.

Original Author:

anarchicknight

License

ISC License (functionality equivalent to MIT License)

react-native-carrier-info's People

Contributors

acctforgh avatar ianlin avatar matanelgabsi avatar mikehardy avatar nsimonfr avatar richardgill avatar srounce avatar zxcpoiu avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.