⚠️ Deprecated ⚠️

This repository is deprecated and will no longer be supported for future SDK versions. Please migrate to our newer repository at uxcam-ios-sdk

UXCam iOS SDK

This is the UXCam iOS SDK

To install

[NB: If you are currently using version 3.2.6 or earlier please do a deep clean of your build environment before updating. XCode has exhibited some issues with the change from a .framework packaged library to .xcframework]

Using Cocoapods

Add the following to your Podfile:

pod 'UXCam'

and run pod update and you should be good to go.

NB: Make sure you are using Cocoapods version 1.10.0 or higher - earlier versions don't properly support XCFramworks. pod --version to check.

Using Swift Package Manager

Starting with the 3.3.0 release UXCam for iOS supports installation via Swift Package Manager in Beta status. Please report any problems here.

Using SPM

Follow the instructions here [NB: on Version 12.2 (12B45b) on macOS 10.15.7 (19H15) picking to resolve to a version is crashing XCode. Pick 'main' branch for a working integration.]

Integration

Get your App key from the dashboard at UXCam.com

Objective-C

In your AppDelegate.m file:

#import <UXCam/UXCam.h>

and in your application:didFinishLaunchingWithOptions: method add:

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

Swift

In your AppDelegate.swift file:

import UXCam

and in your func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool function add:

	UXCam.optIntoSchematicRecordings()
	let configuration = UXCamConfiguration(appKey: "YourAppKey")
	UXCam.start(with: configuration)

Developer Documentation

Documentation on using the various API methods can be found here

Acknowledgements

Thanks to:

Anurag Ajwani for a series of excellent articles on building and distributing XCFrameworks.

Boris Bielik for the post on how to get SPM working with binary targets and dependencies.