react-native-walkme-sdk
Getting started
$ npm install react-native-walkme-sdk --save
Mostly automatic installation
$ react-native link react-native-walkme-sdk
Manual installation
iOS
- In XCode, in the project navigator, right click
Libraries
➜ Add Files to [your project's name]
- Go to
node_modules
➜ react-native-walkme-sdk
and add RNWalkMeSdk.xcodeproj
- In XCode, in the project navigator, select your project. Add
libRNWalkMeSdk.a
to your project's Build Phases
➜ Link Binary With Libraries
- Run your project (
Cmd+R
)<
Android
- Open up
android/app/src/main/java/[...]/MainActivity.java
- Add
import com.reactlibrary.RNWalkMeSdkPackage;
to the imports at the top of the file
- Add
new RNWalkMeSdkPackage()
to the list returned by the getPackages()
method
- Append the following lines to
android/settings.gradle
:
include ':react-native-walkme-sdk'
project(':react-native-walkme-sdk').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-walkme-sdk/android')
- Insert the following lines inside the dependencies block in
android/app/build.gradle
:
compile project(':react-native-walkme-sdk')
Usage
import WalkMeSDK from 'react-native-walkme-sdk';
...
/**
* Starts ABBI SDK.
*
* @param appId The Application Id provided by WalkMe
* @param appSecretKey The Application Secret key provided by WalkMe
*
* To get your Application Id and Application Secret key, login to WalkMe console at https://console.mobile.walkme.com
* and click the settings icon near your Application Name. You can find more info here - https://walkme-mobile.zendesk.com/hc
*/
WalkMeSDK.start(appId, appSecretKey)
/**
- Restarts ABBI SDK.
-
- This method can be called only after ABBI start was called first.
- Restart ABBI SDK is allowed if old session is at least 1 minute old
*/
WalkMeSDK.restart()
/**
- Stop ABBI SDK.
-
- This method can be called only after ABBI start was called first.
- Stop abbi SDK is allowed if old session is at least 1 minute old
*/
WalkMeSDK.stop()
/**
- Sends a Goal to ABBI's Backend.
- A Goal is a user action that can be used to target your users.
-
- Usage Example :@
-
- WalkMeSDK.sendGoal("goalName")
- WalkMeSDK.sendGoal("goalName", {"x": 3, "y": "yes", "z": false})
-
- @param goalName the Goal name.
- @param properties the Goal properties, key-value structured (if any).
*/
WalkMeSDK.sendGoal(goalName, properties)
/**
/**
- Sets multiple user attributes
-
- @param attributes the user attributes
-
- @code
- Usage Example:
- WalkMeSDK.setUserAttributes({"x": 3, "y": "yes", "z": false})
*/
WalkMeSDK.setUserAttributes(attributes)
/**
/**
- Sets multiple private user attributes
-
- @param attributes the private user attributes
-
- @code
- Usage Example:
- WalkMeSDK.setPrivateUserAttributes({"x": 3, "y": "yes", "z": false})
*/
WalkMeSDK.setPrivateUserAttributes(attributes)
/**
- Clears all private user attributes
*/
WalkMeSDK.clearPrivateUserAttributes()
/**
- Launches a campaign by trigger key
- Once invoked, the method will show the campaign WITHOUT any of its segments (if defined)
-
- @code
- Usage Example :
- WalkMeSDK.trigger("key", "myApp://home/signup")
*/
WalkMeSDK.trigger(key, deepLink)
/**
- Sets user id
-
- @param userId the user id as NSString
-
- @code
- Usage Example:
- WalkMeSDK.setUserID("someUserID")
*/
WalkMeSDK.setUserID(userId)
/**
/**
/**