Getting Started with React Native SDK

React Native is a JavaScript library for building apps on multiple platforms like Android and iOS, by maintaining a single code base.

Castled React Native SDK enables your React Native App to receive push, in-app and inbox notifications originating from the Castled Customer Engagement Platform. It is implemented as a Turbo Native Module with backward compatability. Turbo Native Modules are the next iteration on React Native Modules for apps based on the New Architecture.

​

Installation

To use the SDK, add the library to your project

​

Native Setup

• Android
• iOS

// Top-level build file where you can add configuration options common to all sub-projects/modules.
buildscript {
    repositories {
        // Add google maven repository
        google()
    }
    ...
    dependencies {
        ...
        classpath("com.google.gms:google-services:<plugin-version>")
    }
}

  apply plugin: "com.google.gms.google-services"

<!-- Castled SDK needs this permission to sync user token and campaign events  -->
<uses-permission android:name="android.permission.INTERNET"/>
<!-- Castled SDK will use this permission to decide when to make network calls -->
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

​

Initialization

Next step is to initialize the SDK. Initialization is typically done in App.js.

  import * as React from 'react';
  // Importing SDK modules required for initialization
  import {
    CastledNotifications,
    CastledConfigs,
    CastledLocation,
  } from 'castled-react-native-sdk';

  export default function App() {

    ...

    React.useEffect(() => {
      // Set config
      const configs = new CastledConfigs();
      configs.appId = '<app-id>';
      configs.location = CastledLocation.US;

      // Initialize SDK
      CastledNotifications.initialize(configs);
    }, []);

    ...

    return (
      <>
        ...
      </>
    );
  }

• app-id is a unique key associated with your Castled account. It can be found in the Castled dashboard at Settings > Api Keys.
• location is the region where you have your Castled account.

You can refer to the SDK Configs section for the list of configs available during initialization.

​

User Identification

To identify the user associated with an app instance, use the following method. This is typically invoked immediately after user completes the sign-in flow of your app. user-id is the id that you use internally within your organisation to identify a user.

// User identification
CastledNotifications.setUserId("<user-id>")

​

Secure User Identification

user-token is a unique token per user generated by your app server. This token is usually issued by the app server as a part of user login flow.

// Secure user identification
CastledNotifications.setUserId("<user-id>", "<user-token>")

user-token is a Base64 encoded Hash-based Message Authentication Code (HMAC). Ensure the hash computation happens in your app server so that api-key is not exposed. You can create an api-key in the Setting > API Keys page within your Castled account. Contact Castled support for help with integration.

Find sample server code snippets to generate HMAC for the user-id.

​

User Logout

To remove the user association with a particular app instance. Typically invoked as part of the user sign-out flow within the app. Once invoked, app won’t be able to receive any notifications sent from Castled until the user sign-in to the app again.

// User logout
CastledNotifications.logout()

​

SDK Configs

This section covers the basic configurations available in the CastledConfigs class of the SDK. Use these configs if you want to enable specific messsaging channel or want to override default behavior.