So you've got your account set up, now let’s make sure your iOS app is equipped with the insights that UXCam can provide. This guide will take you through the first steps of integrating UXCam, sending your first session, and setting up key features. Our goal? A successful integration that sets you up for product-led growth, better usability insights, and happier users.

🚧

Note for SwiftUI developers:

If you're working with SwiftUI, you may add the dedicated SwiftUI SDK instead of the regular iOS one, you can check the initial setup here.

What Does a Successful Integration Look Like?

With a solid integration, you’ll have a complete picture of how users interact with your app. From screen journeys and user behaviors to session replays and user properties, you’ll be able to understand and enhance every aspect of your product’s user experience. Follow along with this quick guide, and you’ll be up and running in no time.

Quick Start: Only a Couple of Lines of Code

Let's get you started with the basics. With just a few lines of code, you'll be on your way to capturing user sessions in your test app.

Adding the Dependencies

Cocoapods

• Add UXCam to your Podfile:

pod 'UXCam', "~> x.x.x"

• Run pod install in the project directory to download dependency.

Swift Package Manager

• If you prefer Swift Package Manager, you can add UXCam using the following URL:

https://github.com/uxcam/uxcam-ios-sdk

Specify the exact version to ensure compatibility (e.g., 3.6.17).

Initialising UXCam

1. Imports:

import UXCam

#import <UXCam/UXCam.h>

2. Configuration

Add the following initialisation to application:didFinishLaunchingWithOptions: in your AppDelegate:

let configuration = UXCamConfiguration(appKey: "YourAppKey")

UXCamConfiguration *configuration = [[UXCamConfiguration alloc] initWithAppKey:@"YourAppKey"];

Replace "YourAppKey" with the app key available on your UXCam dashboard.

3. Then, start the SDK with your configuration object

UXCam.optIntoSchematicRecordings()
UXCam.start(with: configuration)

[UXCam optIntoSchematicRecordings];
[UXCam startWithConfiguration: configuration];

Available Configuration Options:

enableAutomaticScreenNameTagging
Used to disable automatic screen tagging if manual tagging of the screens will be done, default is true

enableAdvancedGestureRecognition
Control the gesture recognizers used by UXCam. Set TRUE to enable the full range of gesture recognizers (the default) or FALSE to limit it to basic gestures.

enableCrashHandling:
Crash handling is enabled by default, to let you capture all the sessions with crashes and see the corresponding crash logs.

👍

As Simple As That!

This will complete the integration process.
Your session will be shown on the dashboard within a few seconds after the app goes in the background.

We recommend that after you've set this up and have reviewed some sessions from your tests, get to the customisation features UXCam offers, let's go to the next steps!

📘

Additional Resources

SDK Updates: Stay up to date with the latest features and improvements.

Tailor for Success: Learn how to use advanced features such as identifying users, tagging sessions, or hiding sensitive views.

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.