Integration Journey at a Glance

Android SDK · Quickstart

Step 1: Get your App Key

1.1: Find your app key

If you don't already have it, find it in App Settings -> App Key on your UXCam Dashboard.

1.2: Keep it out of source control:

add it to local.properties (already in the default .gitignore) or inject it via your CI, then expose it safely at compile-time and avoid hard-coding secrets in your codebase.

Step 2: Add the SDK Dependency

In your module's build.gradle, add:

repositories {
  maven { url 'https://sdk.uxcam.com/android/' }
}
dependencies {
  implementation 'com.uxcam:uxcam:3.+'
}

Step 3: Start Recording

From your Application Class or Launcher Activity, add the configuration and start the SDK.

import com.uxcam.UXCam
import com.uxcam.datamodel.UXConfig

class MyApp : Application() {
  override fun onCreate() {
    super.onCreate()
    val config = UXConfig.Builder(YOUR_UXCAM_KEY).build()
    UXCam.startWithConfiguration(config)
}

import com.uxcam.UXCam;
import com.uxcam.datamodel.UXConfig;


public class MyApp extends Application { 
@Override
public void onCreate() {
super.onCreate();
UXConfig config = new UXConfig.Builder(YOUR_UXCAM_KEY).build();
UXCam.startWithConfiguration(config);
 }
}

Advanced SDK Configuration

You can control how the SDK is configured via the configuration object you create, the available parameters are below:

Enable Debug Logs?

Set our configuration option .enableIntegrationLogging(bool) as true to see detailed UXCam logs in Logcat. This is useful for verifying your setup and troubleshooting any issues.

Other Configuration Options

• .enableAutomaticScreenNameTagging(bool) True by Default. Set to false if you want to disable automatic screen tagging.
• .occlusions(Arrays.asList(occlusion)) For passing occlusion for screens from the SDK startup, we'll get to that here.
• .enableCrashHandling(bool) True by Default. Set to false if you want to disable crash capture.
• .enableMultiSessionRecord(bool) True by Default. Set to false to stop any session after the first one from being recorded.

Next Steps

You've successfully integrated UXCam and sent some sessions, great job! But there's so much more you can do. Now, let's go further into setting things up.