Installation & initialization

This section describes the installation and initialization of the React Native Software Development Kit and covers installation, initialization, and optional configuration.

Installation

To install the Mapp Intelligence plugin for the React Native application, run the following command in the terminal from the application root directory:

Using npm:

npm install mapp-intelligence-reactnative-plugin --save

Using Yarn:

yarn add mapp-intelligence-reactnative-plugin

For iOS, you also need to install CocoaPods:

pod install

Initialization

After installing the plugin, configure and initialize it at the application start:

import MappIntelligencePlugin, { LogLevel, ExceptionType } from 'mapp-intelligence-reactnative-plugin';

// Required steps
await MappIntelligencePlugin.setAnonymousTracking(false);

await MappIntelligencePlugin.initWithConfiguration(
   [TRACK_IDS],
   TRACK_DOMAIN
);

// Build the configuration
await MappIntelligencePlugin.build();

Optional configuration

You can configure additional settings depending on your requirements:

await MappIntelligencePlugin.setLogLevel(LogLevel.all);
await MappIntelligencePlugin.setBatchSupportEnabled(false);
await MappIntelligencePlugin.setBatchSupportSize(150);
await MappIntelligencePlugin.setRequestInterval(1);
await MappIntelligencePlugin.setRequestPerQueue(300);
await MappIntelligencePlugin.setSendAppVersionInEveryRequest(true);
await MappIntelligencePlugin.setEnableBackgroundSendout(true);
await MappIntelligencePlugin.setExceptionLogLevel(ExceptionType.all);
await MappIntelligencePlugin.setEnableUserMatching(false);

Note

setEnableBackgroundSendout is available on iOS only.

Exception tracking (optional)

To set up a global error handler in a React Native application using the Mapp Intelligence plugin, follow these steps:

Import required function:

import { setGlobalErrorHandler } from 'mapp-intelligence-reactnative-plugin';

Define error handling function (optional):

const showError = (error: Error, isFatal: boolean) => {
  Alert.alert(
    'Unexpected error occurred',
    `Error: ${isFatal ? 'Fatal:' : ''} ${error.name} ${error.message}

    We have reported this to our team! Please close the app and start again!`,
    [
      {
        text: 'Close',
        onPress: () => {
          // Optionally, you can close or restart the app
        },
      },
    ]
  );
};

Set global error handler:

setGlobalErrorHandler((error: Error, isFatal: boolean) => {
  showError(error, isFatal);
});

Register component:

import { Alert, AppRegistry } from 'react-native';
AppRegistry.registerComponent(appName, () => App);

Data format & limits

Mapp Intelligence supports the UTF-8 standard.

• A request may not be larger than 7KB.

• Input is case-sensitive.

Parameters can have the data type text or figure:

• Text parameters: maximum of 255 characters per value.

• Figure parameters: range of decimal(12,2)

  (−9999999999.99 to 9999999999.99)