RNSelligent 4.1.0

RNSelligent 4.1.0

Maintained by Selligent Marketing Cloud.



  • By
  • name

SelligentMobileSDK-ReactNative (selligent-react-native)

This module provides an API for the usage of the Selligent Mobile SDKs in React Native.

SelligentMobileSDK-ReactNative Integration

This module supports the following SDK and tools:

IMPORTANT This module doesn't currently support REACT NATIVE'S NEW ARCHITECTURE! The following library contains React native modules, that are tailored to and can only be used in React Native's legacy architecture, that will be deprecated in the future when the new architecture will be stable.

SDK Version
Android SDK 4.3.0
iOS SDK 3.6.1
ReactNative 0.71.8
Expo SDK 48

Installation

Please refer to our SDK full documentation for a step-by-step guide on how to use the SDK, after installation.

  1. Install the module

    npm install @selligent-marketing-cloud/selligent-react-native --save
  2. Create a selligent.json file (name is case sensitive) in the root of the React Native project with the following content:

    {
      "url": "someMobilePushUrl",
      "clientId": "someClientId",
      "privateKey": "somePrivateKey",
      "fullyQualifiedNotificationActivityClassName": "com.some.project.MainActivity",
      "delayedPushAction": true
    }

Check all the options that can be used in our SDK full documentation

Android Specific Installation

IMPORTANT: Since version 2.6.0 of this module we require your app to use the Android Gradle Plugin version 4.2.0 or higher in order to build on Android. This is the default Android Gradle Plugin version since React Native version 0.64.0 but can be manually increased in older versions of React Native.

Attention for Huawei developers!

In order to use this module on Huawei devices (without Goggle Play services), you should add the following dependencies in the build.gradle files of the Android project in your React Native project:

In your Android project's root build.gradle file:

buildscript {
 repositories {
  maven { url 'https://developer.huawei.com/repo/' }
 }
 dependencies {
  classpath 'com.huawei.agconnect:agcp:1.6.0.300'
 }
}

allProjects: {
  repositories: {
    maven { url 'https://developer.huawei.com/repo/' }
  }
}

In your app module's build.gradle file:

apply plugin: 'com.huawei.agconnect'

dependencies {
  api 'com.huawei.hms:base:6.2.0.300'
  api 'com.huawei.hms:push:6.1.0.300'
  api 'com.huawei.hms:maps:6.2.0.301'
}
Without autolinking (RN 0.59 and below)
  1. Create a Google application following the section native documentation, and place the google-services.json file in the ./android/app folder.

  2. Add the following lines at the end of the android/settings.gradle file:

    include ':selligent-react-native'
    project(':selligent-react-native').projectDir = new File(rootProject.projectDir, '../node_modules/@selligent-marketing-cloud/selligent-react-native/android')
  3. Add the following in the android/build.gradle file, and make sure that the Gradle version in android/gradle/wrapper/gradle-wrapper.properties is >= 6.7.1:

    // android/build.gradle
    
    buildscript {
        dependencies {
            // Make sure your Gradle plugin version is >= 4.2.0
            classpath("com.android.tools.build:gradle:4.2.0")
            // Add the following:
            classpath 'com.google.gms:google-services:4.3.3'
        }
    }
     // android/gradle/wrapper/gradle-wrapper.properties
     distributionUrl=https\://services.gradle.org/distributions/gradle-6.7.1-all.zip
  4. Add the following in the android/app/build.gradle file:

    dependencies {
        // Add the following:
        compile project(path: ':selligent-react-native')
    }
    // Add the following:
    apply plugin: 'com.google.gms.google-services'
  5. Add the following in the android/app/src/../MainApplication.java file:

    // Add the following import statements:
    import com.selligent.RNSelligent;
    import com.selligent.RNSelligentPackage;
    
    public class MainApplication extends Application implements ReactApplication {
    
        private final ReactNativeHost mReactNativeHost = new ReactNativeHost(this) {
             @Override
             protected List<ReactPackage> getPackages() {
    
                 List<ReactPackage> packages = new PackageList(this).getPackages();
                 // Add the following:
                 packages.add(new RNSelligentPackage());
                 return packages;
             }
        };
    
        @Override
        public void onCreate() {
            super.onCreate();
    
            // Add the following:
            RNSelligent.configure(this);
        }
    }
With autolinking (RN 0.60 and above)
  1. Create a Google application following the section Creating a Google application of the Android - Using the SDK pdf, and place the google-services.json file in the ./android/app folder.

  2. Add the following in the android/build.gradle file, and make sure that the Gradle version in android/gradle/wrapper/gradle-wrapper.properties is >= 6.7.1:

    // android/build.gradle 
    
    buildscript {
        dependencies {
            // Add the following:
            classpath 'com.google.gms:google-services:4.3.3'
        }
    }
  3. Add the following in the android/app/build.gradle file (at the bottom):

    // Add the following:
    apply plugin: 'com.google.gms.google-services'
  4. Add the following in the android/app/src/../MainApplication.java file:

    // Add the following import statements:
    import com.selligent.RNSelligent;
    import com.selligent.RNSelligentPackage;
    
    public class MainApplication extends Application implements ReactApplication {
        @Override
        public void onCreate() {
            super.onCreate();
    
            // Add the following:
            RNSelligent.configure(this);
        }
    }

iOS Specific installation

Without autolinking (RN 0.59 and below)
  1. Copy the node_modules/@selligent-marketing-cloud/selligent-react-native/ios folder to the Xcode project. Drop it under the Libraries Folder. This will link the module to the iOS project.

  2. Drag and drop the selligent.json you created from the root folder to the Xcode project inside the Copy Bundle Resources in Build phases of your target:

    Do not check the "copy if needed" option to make sure you only have to manage one selligent.json file

  3. Add the native iOS SDK dependency in your Podfile: s.dependency "SelligentMobileSDK/Framework", "3.6.1" or download it manually from here and drag and drop it into you Xcode project.

  4. Execute pod install in the /ios folder

  5. From now on, open the .xcworkspace file to make changes in Xcode

  6. Bootstrap the SDK in the application:didFinishLaunchingWithOptions: of the AppDelegate.mm

    @import RNSelligentMobileSDK;
    
    // You can alternatively specify a different file name (without the extension) from where to load the Selligent configs (defaults to 'selligent')
    // if (!launchOptions) {
    //    launchOptions = [NSMutableDictionary new];
    // }
    // [launchOptions setValue:@"alternativeFileName" forKey:@"RN_SELLIGENT_JSON"];
    
    [RNSelligent configureWithLaunchOptions:launchOptions];
With autolinking (RN 0.60 and above)
  1. Drag and drop the selligent.json you created from the root folder to the Xcode project inside the Copy Bundle Resources in Build phases of your target:

    Do not check the "copy if needed" option to make sure you only have to manage one selligent.json file

  2. Execute pod install in the /ios folder

  3. Import & bootstrap the SDK in the application:didFinishLaunchingWithOptions: of the AppDelegate.m (put it at the end of the method)

    @import RNSelligentMobileSDK;
    // OR
    // #import <RNSelligentMobileSDK/RNSelligentMobileSDK-Swift.h>
    
    // At the end of application:didFinishLaunchingWithOptions:
    [RNSelligent configureWithLaunchOptions:launchOptions];