@maniac-tech/react-native-expo-read-sms

react-native-expo-read-sms

Reading SMS made simple in React Native on Android

Documentation • Installation • Usage • Example • Methods • License

Installation

Install this in your managed Expo project by running this command:

$ npm install @maniac-tech/react-native-expo-read-sms --save

Usage

• Import the startReadSMS function after installation

  import { startReadSMS } from "@maniac-tech/react-native-expo-read-sms";

• Pass Success and Error callbacks startReadSMS(successCallbackFn, errorCallbackFn)

• Everytime an SMS has been received successCallbackFn will be called with the sms

Example

You may refer to this sample application for how to use the library: GitHub Repo

Methods

Method name	Description	Params	Returns
checkIfHasSMSPermission	Function which checks if the application has READ_SMS and RECEIVE_SMS permissions	-	{ hasReceiveSmsPermission: true/false, hasReadSmsPermission: true/false }
requestReadSMSPermission	Requests READ_SMS and RECEIVE_SMS permission, if missing	-	Returns true if granted, and false otherwise
startReadSMS	Starts listening for incoming messages. Note: SMS Permissions should be present.	callback fn	Return a string with message orginating address, and message body. Example: [[phone], this is a sample message body]

Important Note:

Ensure your app has READ_SMS, and RECEIVE_SMS, failing which you'll receive error on calling the function

Support

Tested on Expo SDK v44, v45 & v47, v48, v49, v50 and Node JS v18

License

MIT

Maintainers

maniac-tech Active maintainer

Credits

• Docusaurus: For helping spin up and manitain the documentation with ease.