Installation

Note:

• This SDK may not be compatible with React Native Frameworks like Expo.
• To learn more about React Native apps without a framework, refer to the React Native documentation.

Example

• See the Reclaim Example - React Native for a complete example of how to use the SDK in a React Native application.

Get an API Key

Setup your project using the Get API Key guide.

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

1. 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.

2. 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)

3. 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