React Native wrapper for uxcam.com
Clone or download
Latest commit aa9f9aa Sep 4, 2018

README.md

react-native-ux-cam

npm npm npm CircleCI branch

React Native wrapper for UXCam.

Getting Started

yarn add react-native-ux-cam

iOS with react-native and Cocoapods

Run the following:

react-native link react-native-ux-cam

Then, add the following to your Podfile:

pod "UXCam", "~> 2.5.12"

Then run:

pod install

You're done! 🎉

Android

Run the following:

react-native link react-native-ux-cam

Then add the following to your file android/app/build.gradle (or add the maven url to your existing repositories section):

repositories {
  maven {
    url 'http://sdk.uxcam.com/android'
  }
}

And add this to your file android/app/src/main/AndroidManifest.xml, inside your <application> tag:

<service android:name="com.uxcam.service.HttpPostService"/>

Usage

// Import UXCam.
import UXCam from 'react-native-ux-cam';

// Initialize using your app key.
UXCam.startWithKey(key);

// Tag a screen.
UXCam.tagScreenName('my screen');

// Tag a user.
UXCam.tagUserName('John Doe');

// Add a custom tag with properties.
UXCam.addTag('logged-in', {
  isLoggedIn: true,
  isAwesome: true,
});

// Mark a session as a favorite.
UXCam.markSessionAsFavorite();

// Get the url for the current user. Useful for connecting to other
// analytics services. Note, this method is async and returns a promise.
const currentUserUrl = await UXCam.urlForCurrentUser();

// Get the url for the current session. Note, this method is also async.
const currentSessionUrl = await UXCam.urlForCurrentSession();

// Hide a sensitive screen.
UXCam.occludeSensitiveScreen(true);

// Unhide a sensitive screen.
UXCam.occludeSensitiveScreen(false);

// Stop recording and upload data manually.
UXCam.stopApplicationAndUploadData();

// To start a new recording:
UXCam.restartSession();

If a method is missing from the official SDK, please send a PR!