Quick Start - iOS

iOS Quick Start

Get session recording working in your iOS app in under 5 minutes.

Prerequisites

  • Xcode
  • iOS deployment target 12.0+
  • A UXCam account with an app key

Step 1: Add the Dependency

CocoaPods

Add to your Podfile:

pod 'UXCam'

Then run:

pod install

Swift Package Manager

Add this URL in Xcode: https://github.com/uxcam/uxcam-ios-sdk


Step 2: Initialize UXCam

In your AppDelegate:

import UXCam

func application(_ application: UIApplication,
                 didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

    let config = UXCamConfiguration(appKey: "YOUR_APP_KEY")
    UXCam.optIntoVideoRecordings()
    UXCam.start(with: config)

    return true
}
Objective-C version
#import <UXCam/UXCam.h>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

    UXCamConfiguration *config = [[UXCamConfiguration alloc] initWithAppKey:@"YOUR_APP_KEY"];
    [UXCam optIntoVideoRecordings];
    [UXCam startWithConfiguration:config];

    return YES;
}

Note

Highlights information that users should take into account, even when skimming.

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.

Success

Negative potential consequences of an action.


Step 3: Verify It Works

  1. Run your app on a simulator or device
  2. Navigate through a few screens
  3. Send the app to background
  4. Check your UXCam Dashboard - your session should appear within 30 seconds

Note

Highlights information that users should take into account, even when skimming.

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.

Success

Negative potential consequences of an action.


Next Steps

You're recording sessions! Now customize your integration:


What's Next? ...