mobsplit-sdk
v1.0.10
Published
MobSplit SDK for React Native - Track app installs
Downloads
37
Maintainers
Readme
MobSplit SDK for React Native
A simple SDK to track app installs for MobSplit platform.
Installation
Install the SDK and its required dependencies:
npm install mobsplit-sdk @react-native-async-storage/async-storage react-native-device-info
# or
yarn add mobsplit-sdk @react-native-async-storage/async-storage react-native-device-infoFor iOS projects, run:
cd ios && pod installThis is required because React Native's CLI only autolinks native modules listed in your main project's package.json.
Usage
- Import and initialize the SDK in your app's entry point (usually App.js or index.js):
import MobSplitSDK from 'mobsplit-sdk';
// Initialize with your AppKey
MobSplitSDK.initialize('YOUR_APP_KEY');The SDK will automatically track the install and send device information to the MobSplit server. It will only send this information once per installation.
- Getting the Device ID (optional):
You can retrieve the device ID that the SDK uses for tracking:
import MobSplitSDK from 'mobsplit-sdk';
// Initialize the SDK first
const sdk = MobSplitSDK.initialize('YOUR_APP_KEY');
// Get the device ID
try {
const deviceId = await sdk.getDeviceId();
console.log('Device ID:', deviceId);
} catch (error) {
console.error('Failed to get device ID:', error);
}API Methods
initialize(appKey: string): MobSplitSDK
Initializes the SDK with your app key and automatically tracks the install.
getDeviceId(): Promise<string>
Returns the unique device identifier used by the SDK for tracking. This is the same ID sent with install data.
Requirements
- React Native >= 0.60.0
What's Tracked
The SDK sends the following device information:
- Platform (iOS/Android)
- Device model
- OS version
- Bundle ID
- App version
- AppKey
- Device ID (unique identifier - also accessible via
getDeviceId())
License
MIT
