# Device Connect: React Native

The React Native package can be used to integrate mobile apps with Device Connect, so that users can share their data.

# Integration Flow

Assuming the bridge has been setup between your project and device connect as per this section, the following would be the flow in your app:

# Step 1: Requesting Runtime Permissions

It is required to show what all permissions you will be needing from users in app, and then ask them for the permissions. Please refer this section to get the list of permissions the SDK needs. Also in case you want to exclude certain permissions, you can use a remove rule as mentioned in the same article.

# Step 2: Creating the User

After requesting, the createUser method can be called specifying a CUSTOMER_ID (Refer to this section for sample code and response), which represents a unique identifier for the user.

createUser in general acts as a check for API credentials. For the first time when the user doesn't exists, it will create user on FinBox side. The next step will work only if this function returns a success response.

# Step 3: Start Syncing Data

If the createUser response is successful, you can call startPeriodicSync function (Refer this article) which will sync data in period intervals in background.

# Setting up the bridge

1. Install the React SDK from the npm package:

   yarn add react-native-risk-sdk
   

2. Now to auto link this native module to your app, run following command:

   react-native link
   

3. Once the linking is done you need to open Android Studio and add a maven repository url in your project level build.gradle file

   maven {  
       url "s3://risk-manager-android-sdk/artifacts"  
       credentials(AwsCredentials) {  
           accessKey = "<ACCESS_KEY>"
           secretKey = "<SECRET_KEY>"  
       }
   }
   

4. Specify the following in local.properties file:

   AWS_KEY=<ACCESS_KEY>
   AWS_SECRET=<SECRET_KEY>
   FINBOX_RM_VERSION=<DC_SDK_VERSION>
   FINBOX_RM_ARTIFACT=parent-release
   

5. Final change required is in the MainApplication class of your native app.

   @Override  
   protected List<ReactPackage> getPackages() {
       return Arrays.<ReactPackage>asList(
           ....
           new RiskSdkPackage(),
           ...
       );
   }
   

# Handle Permissions

The Runtime permissions needs to handled by the developer when calling the helper methods. Based on the permissions available, the SDK intelligently syncs the alternate data.

Below are the list of Runtime permissions the sdk adds to the application Manifest, if Manifest Merger is enabled:

<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_CALENDAR" />
<uses-permission android:name="android.permission.READ_SMS" />
<uses-permission android:name="android.permission.RECEIVE_SMS" />
<uses-permission android:name="android.permission.READ_CALL_LOG" />
<uses-permission android:name="android.permission.READ_CONTACTS" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.GET_ACCOUNTS" />
<uses-permission
    android:name="android.permission.PACKAGE_USAGE_STATS"
    tools:ignore="ProtectedPermissions" />

To remove the unused permissions, add a remove rule to that permission as shown below:

<uses-permission
    android:name="android.permission.READ_CALL_LOG"
    tools:node="remove" />

In case the Manifest merger is not enabled add the above specified permissions manually.

# Create User Method

Call createUser method using the FinBoxRiskSdk instance to create the user (first time) or check the API credentials for the SDK. It takes CUSTOMER_ID as one of its arguments which is a unique identifier for a user.

The response to this method (success or failure) can be captured using the callback, and on success Start Periodic Sync Method should be called.

import FinBoxRiskSdk from 'react-native-risk-sdk';
//Function to trigger RiskSdk
const callModule = () => {
    FinBoxRiskSdk.createUser(
        "CLIENT_API_KEY",
        "CUSTOMER_ID",
        (errorStatus) => {
	    // Error Callback
            console.log("Error status -> ", errorStatus)
        }, 
        (msg) => {
            // Success Callback, Call the periodic sync once the user has been created
	    console.log("Final message", msg)
	    FinBoxRiskSdk.startPeriodicSync(12) //Start the sync periodically after every 12 hour
	}
    )
}

You can read about the error codes in this section.

# Start Periodic Sync Method

This is to be called only on successful response to createUser method's callback. On calling this the syncs will start for all the data sources configured as per permissions. The method below syncs data in background at regular intervals:

FinBoxRiskSdk.startPeriodicSync(12) //Start the sync periodically after every 12 hour

# Cancel Periodic Syncing

If you have already set up the sync for the user data, you can cancel it any time by following code:

FinBoxRiskSdk.stopPeriodicSync();

# Reset User Data

In case the user data needs to be removed to re-sync the entire data, use the method resetData.

FinBoxRiskSdk.resetData();

# Error Codes

Below table contains the constant name, error code value and the description of error code:

Some error codes can be resolved by validating the implementation and some by retrying the creation of user, while other error codes can only be resolved by contacting FinBox.