NumberEight SDK for React Native

Official documentation: Getting Started - React Native

Using this plugin

You will first need to generate a developer key to authenticate with.

To install the plugin, run

$ yarn add @numbereight/react-native-numbereight
OR
$ npm install --save @numbereight/react-native-numbereight

Quick Start

import NumberEight, { ConsentOptions } from '@numbereight/react-native-numbereight';

React.useEffect(() => {
  NumberEight.start("REPLACE_WITH_API_KEY", ConsentOptions.withConsentToAll())
    .then(() => {
      console.log('NumberEight started successfully');
    })
    .catch((err) => {
      console.error('Error during NumberEight start', err);
    });
}, []);

Native repositories

You must make sure to add the NumberEight repository to your Android project:

Android (android/app/build.gradle)

repositories {
    maven {
        url('https://repo.numbereight.ai/artifactory/gradle-release-local')
    }
}

Plugin structure

This helper plugin is built using create-react-native-library to make a Turbo Module. This connects the NumberEight Android and iOS SDKs to a TypeScript wrapper.

The command used to bootstrap the project can be found in ./assemble_command.sh should the project need to be regenerated.

The interface can be found in src/, the Android implementations in android/ and the iOS implementation in ios/.

After changing the API in src/, it's necessary to re-run yarn to generate new interface definitions.

The example folder contains a sample project that can be built to test the API.

Running the provided example project

If you don't yet have a React Native project, you can use the provided example as follows (you must have yarn installed):

1. Setup:

# Initialize
yarn

# (iOS only) Install Cocoapods - you may also need to run `pod repo update`
yarn example pod-install

# Put your API key in a .env file inside the example/ directory
echo 'API_KEY=<insert key>' >> example/.env

2. Run Server:

yarn example start

3. Run App:

yarn example android
# or
yarn example ios

Platform-specific instructions

For further information, such as permissions handling and background services, refer to the platform-specific documentation on the official site:

• React Native
• Android
• iOS

Maintainers

• Chris Watts
• M. Ansar Butt