Code Monkey home page Code Monkey logo

react-native-sms-retriever's Introduction

react-native-sms-retriever

A library used by Housing Apps to read SMS on Android Platform

Getting started

$ npm install @housing/react-native-sms-retriever --save

Mostly automatic installation

$ react-native link @housing/react-native-sms-retriever

Manual installation

Android

  1. Open up android/app/src/main/java/[...]/MainActivity.java
  • Add import com.smsRetriever.reactnative.RNSmsRetrieverPackage; to the imports at the top of the file
  • Add new RNSmsRetrieverPackage() to the list returned by the getPackages() method
  1. Append the following lines to android/settings.gradle:
    include ':@housing/react-native-sms-retriever'
    project(':@housing/react-native-sms-retriever').projectDir = new File(rootProject.projectDir, 	'../node_modules/@housing/react-native-sms-retriever/android')
    
  2. Insert the following lines inside the dependencies block in android/app/build.gradle:
      implementation project(':@housing/react-native-sms-retriever')
    

Usage

import { HintPicker } from '@housing/react-native-sms-retriever';
import { OtpRetrieval } from '@housing/react-native-sms-retriever';

//Usage for hint Picker

async requestHint() {
    try {
      let phoneNumber = await HintPickerModule.requestHint()
      //phoneNumber is the number User selected
      
    } catch (exception) {
      Sentry.captureException(exception)
    }
  }
  
 //Usage for SmsRetriever 
 // The library is wrapped inside a component which is a generic text input.It retrieves and populates the OTP in the text input.
 
 <OtpRetrieval
    onAutoReadComplete={this.onAutoReadComplete}  // callback which returns the retrieved otp back to the app in argument
    refCallback={this.setOTPRef}  // callback which gives the ref of the Generic TextInput in the library.We set the ref to access functions of Generic TextInput
    type="otp"
    autoCorrect={false}
    autoCapitalize="none"
    placeholder={Constants.OTP_PLACEHOLDER}
    errorText={Constants.OTP_ERROR_TEXT}
    position={otpPosition}  // specifies the position of OTP in the text message that user gets while OTP Verification
    onErrorOccured={this.onErrorOccured}  // A callback that gives any error occured during OTP Retrieval.
  />

  // To handle reset, the ref that is set in refCallback must call onResendClicked.
  // Pass onChangeText as props to the library to handle the case when the user enters OTP manually.
  

react-native-sms-retriever's People

Contributors

onkarpandit avatar amandeepsingh06 avatar

Watchers

James Cloos 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.