This SDK allows Reclaim Protocol to be triggered from your app, without changing context.

Get an API Key

Setup your project using the Get API Key guide.

Using Expo

Installation

npx expo install @reclaimprotocol/inapp-rn-sdk

Expo users can skip the native configuration changes by adding the Reclaim InApp Config Plugin. To do so merge the following code to the plugins section of your app.json, app.config.js, or app.config.ts file:

{
  // .. other plugin options (removed for brevity)
  "plugins": [
    "expo-router",
    // Add the following in the plugins section:
+   "@reclaimprotocol/inapp-rn-sdk",
    [
      "expo-splash-screen",
      {
        "image": "./assets/images/splash-icon.png",
        "imageWidth": 200,
        "resizeMode": "contain",
        "backgroundColor": "#ffffff"
      }
    ]
    // ... other plugins (removed for brevity)
  ],
  // .. other options (removed for brevity)
}

Note: This module contains custom native code which is NOT supported by Expo Go

If you're using Expo without EAS, run the following commands:

# For iOS
npx expo prebuild
npx expo run:ios

# For Android
npx expo prebuild
npx expo run:android

If you're using Expo with EAS, create a new build:

# For online builds
npx eas-cli build --profile development

# For local builds
npx eas-cli build --profile development --local

Without using Expo

Installation

npm install @reclaimprotocol/inapp-rn-sdk

Alternative: Install from git source

npm install git+https://github.com/reclaimprotocol/reclaim-inapp-reactnative-sdk.git

Setup

Android Setup

Add the following to your android/app/src/main/AndroidManifest.xml file under the <application> tag:

      <activity
        android:name="org.reclaimprotocol.inapp_sdk.ReclaimActivity"
        android:theme="@style/Theme.ReclaimInAppSdk.LaunchTheme"
        android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
        android:hardwareAccelerated="true"
        android:windowSoftInputMode="adjustResize"
        />

add the following to the end of settings.gradle:

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
    String flutterStorageUrl = System.env.FLUTTER_STORAGE_BASE_URL ?: "https://storage.googleapis.com"
    String reclaimStorageUrl = System.env.RECLAIM_STORAGE_BASE_URL ?: "https://reclaim-inapp-sdk.s3.ap-south-1.amazonaws.com/android/repo"
    repositories {
        google()
        mavenCentral()
        maven {
            url "$reclaimStorageUrl"
        }
        maven {
            url "$flutterStorageUrl/download.flutter.io"
        }
    }
}

(Ignore if already added in settings.gradle from above) or alternatively add the following repositories to the relevant repositories block:

String flutterStorageUrl = System.env.FLUTTER_STORAGE_BASE_URL ?: "https://storage.googleapis.com"
String reclaimStorageUrl = System.env.RECLAIM_STORAGE_BASE_URL ?: "https://reclaim-inapp-sdk.s3.ap-south-1.amazonaws.com/android/repo"
// ...
maven {
    url "$reclaimStorageUrl"
}
maven {
    url "$flutterStorageUrl/download.flutter.io"
}

iOS Setup

Make sure to have a platform declaration for your project in your Podfile with version 13.0 or higher.

platform :ios, '13.0' # or platform :ios, min_ios_version_supported

Ignore if you already have this declaration in your Podfile.

Add the following to your Podfile to override SDK dependency:

This step is only required when facing issues with the resolved pod dependency.
You can override the version of dependency when you wish to use a specific version of the SDK.
You can add a declaration in your Podfile to install the SDK from cocoapods, or from a specific git tag, head, commit, or branch.

# Cocoapods is the recommended way to install the SDK.
pod 'ReclaimInAppSdk', '~> 0.6.0'

After adding the dependency, your podfile may look like this:

platform :ios, '13.0'
 
# ... some podfile content (removed for brevity)
 
target 'InappRnSdkExample' do
  config = use_native_modules!
 
  use_react_native!(
    :path => config[:reactNativePath],
    :app_path => "#{Pod::Config.instance.installation_root}/.."
  )
 
  # This is the line that you may need to add in your podfile.
  pod 'ReclaimInAppSdk', '~> 0.6.0'
 
  pre_install do |installer|
    system("cd ../../ && npx bob build --target codegen")
  end
 
  # ... rest of the podfile. (removed for brevity)

Run pod install inside the ios/ directory of your project.

cd ios/
pod install

Fixing performance issues on IOS physical devices

Your app performance will be severely impacted when you run debug executable on a physical device. Fixing this requires a simple change in your Xcode project xcscheme.

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

Installation

Method 1: Update Environment Variables for XCScheme (Recommended)

Method 2: Disable 'Debug executable'

On this page