react-native-synerise-sdk
v0.24.2
Published
React Native wrapper for Synerise SDK
Downloads
233
Maintainers
Readme
Synerise React Native SDK (react-native-synerise-sdk) (0.24.2)
About
Synerise SDK wrapper for React Native.
Documentation
Most up-to-date documentation is available at Developer Guide - Mobile SDK.
Requirements
- Access to workspace
- A Profile API Key
- Development environment configured - React Native - Setting up the development environment
Android
- Minimum Android SDK version - 21
- Supported targetSDKVersion - 33
iOS
- Xcode 15 and iOS SDK 17
- iOS 9.0+ minimum deployment target
- Valid architectures: arm64 devices and arm64, x86_64 simulators
Installation
Install module by
npm
:npm install react-native-synerise-sdk --save
If you are using React Native >= 0.60, install native dependencies via CocoaPods from your ios directory:
pod install
Or if you are using React Native < 0.60, link native dependency:
react-native link react-native-synerise-sdk
and then, install from your ios directory:
pod install --repo-update
Import Synerise SDK:
import { Synerise } from 'react-native-synerise-sdk';
iOS
Important: Please note that starting from React Native 0.60, CocoaPods is now the default integration approach for React Native iOS projects.
Add
pod 'react-native-synerise-sdk', :path => '../node_modules/react-native-synerise-sdk'
as a dependency in your ios/Podfile.Your Podfile should now look like this:
target 'YourTarget' do # Pods for your target pod 'React', :path => '../node_modules/react-native/' pod 'React-Core', :path => '../node_modules/react-native/React' # ... other React dependencies # Add react-native-synerise-sdk pod 'react-native-synerise-sdk', :path => '../node_modules/react-native-synerise-sdk' use_native_modules! end
Run
pod install
from your ios directory.
If you prefer linking manually, check React Native - Linking Libraries to link your libraries that contain native code.
Android
Add
implementation 'com.synerise.sdk.react:react-native-synerise-sdk:0.15.0'
as a dependency in your app's build.gradle file.Add
RNSyneriseSdkPackage
to your list your packages in application's main class as shown below:@Override protected List<ReactPackage> getPackages() { @SuppressWarnings("UnnecessaryLocalVariable") List<ReactPackage> packages = new PackageList(this).getPackages(); packages.add(new RNSyneriseSdkPackage(getApplication())); return packages; }
Initialization:
First of all, you need to initialize Synerise React Native SDK and provide Profile API Key
.
To get Profile API Key
, please sign in to your Synerise account and visit https://app.synerise.com/settings/apikeys.
Then, generate new API Key
for Profile
audience.
Synerise.Initializer()
.withClientApiKey('YOUR_PROFILE_API_KEY')
.init()
Changelog
Changelog can be found here.
Author
Synerise, [email protected]. If you need support please feel free to contact us.