@busfor/react-native-sms-verification-api
TypeScript icon, indicating that this package has built-in type declarations

1.1.3 • Public • Published

react-native-sms-verification-api

npm npm (tag)

Verify your users by SMS without making them deal with verification code.


Versions

1.0.x 1.1.x+
Android support libraries AndroidX

Getting started

  1. Install package $ yarn add react-native-sms-verification-api

  2. Add Kotlin gradle plugin

buildscript {
	ext {
		...
		kotlinVersion = '1.3.50'
	}
	...
	dependencies {
		...
		classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:${project.ext.kotlinVersion}"
	}
}

Linking

>= 0.60

Autolinking will just do the job.

< 0.60

Mostly automatic installation

$ react-native link @busfor/react-native-sms-verification-api

Manual installation

Android

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

Usage

import SmsVerificationApi from "react-native-sms-verification-api";

SmsVerificationApi.requestPhoneNumber()
  .then(phone => Alert.alert("SmsVerificationApi.requestPhoneNumber", phone))
  .catch(reason => console.log(reason));

SmsVerificationApi.startSmsRetriever();

SmsVerificationApi.addSmsListener(event => {
  Alert.alert("SmsVerificationApi.smsRetriever", event.message);
});

SmsVerificationApi.removeSmsListener();

Readme

Keywords

Package Sidebar

Install

npm i @busfor/react-native-sms-verification-api

Weekly Downloads

1

Version

1.1.3

License

MIT

Unpacked Size

10 MB

Total Files

22

Last publish

Collaborators

  • i.sokolovskii
  • sorokin0andrey