Otp verify
npm install react-native-otp-verify___

- Automatic SMS Verification with the SMS Retriever API (Android Only)
- Phone Number Retrieving using the Phone Number Hint API (Android Only)
Automatic SMS Verification with the SMS Retriever API, you can perform SMS-based user verification in your Android app automatically, without requiring the user to manually type verification codes, and without requiring any extra app permissions.
Please read the official documentation for the message structure at this
Google developer guide
$ npm install react-native-otp-verify --saveor
$ yarn add react-native-otp-verify
#### Import the Library
``javascript`
import {
getHash,
startOtpListener,
useOtpVerify,
} from 'react-native-otp-verify';
#### Using Hook
`javascript
// You can use the startListener and stopListener to manually trigger listeners again.
// optionally pass numberOfDigits if you want to extract otp
const { hash, otp, message, timeoutError, stopListener, startListener } = useOtpVerify({numberOfDigits: 4});
`numberOfDigits
#### Properties
| Property | Type | Description |
| ------------- |:-------------:|:-------------:|
| hash | string[] | The hash code for the application which should be added at the end of message.|
| otp | string | OTP retreived from SMS when received. (Must pass ) |
| message | string | SMS message when received. |
| timeoutError | boolean | Flag is set to true when after timeout (5 minutes) Check here |
| startListener | function | Manually starts listener again in case of timeout or any other error |
| stopListener | function | Stops listener for the sms |
#### Using Methods
`javascript
// using methods
useEffect(() => {
getHash().then(hash => {
// use this hash in the message.
}).catch(console.log);
startOtpListener(message => {
// extract the otp using regex e.g. the below regex extracts 4 digit otp from message
const otp = /(\d{4})/g.exec(message)[1];
setOtp(otp);
});
return () => removeListener();
}, []);
`exampleExample
See the example app in folder.$3
Linking the package manually is not required anymore with Autolinking.
1. Open up android/app/src/main/java/[...]/MainActivity.javaimport com.faizal.OtpVerify.OtpVerifyPackage;
- Add to the imports at the top of the filenew OtpVerifyPackage()
- Add to the list returned by the getPackages() methodandroid/settings.gradle
2. Append the following lines to :`
gradle`
include ':react-native-otp-verify'
project(':react-native-otp-verify').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-otp-verify/android')
android/app/build.gradle
3. Insert the following lines inside the dependencies block in :`
gradle`
implementation project(':react-native-otp-verify')
#### Methods
---
#### requestHint: () => Promise
Gets phone number in a frictionless way to show a user’s (SIM-based) phone numbers as a hint. Check here
---
#### startOtpListener(handler:(message:string)=>any):Promise
Start listening for OTP/SMS and adds listener for the handler passed which is called when message is received..
---
#### getOtp():Promise
Start listening for OTP/SMS. Return true if listener starts else throws error.
---
#### getHash():Promise
Gets the hash code for the application which should be added at the end of message.
This is just a one time process.
---
#### addListener(handler:(message:string)=>any):Subscription
Adds a javascript listener to the handler passed which is called when message is received.
---
#### removeListener():void`
Removes all listeners.
---