Quickstart guide

Requirements

• Xcode 16.0 or later (latest stable version available on the App Store).
• Swift 5.9 or later.
• The minimum deployment target should be 15.0.
• Recommended: An SSH key configured locally and registered with GitHub.

Integration

The DevRev SDK can be integrated using either Swift Package Manager (SPM) or CocoaPods.

Swift Package Manager

To integrate the DevRev SDK into your project using SPM:

1. Open your project in Xcode and go to the Add Package Dependency.
2. Enter the DevRev SDK URL under Enter Package URL:
   • For SSH: git@github.com:devrev/devrev-sdk-ios.git (recommended)
   • For HTTPS: https://github.com/devrev/devrev-sdk-ios
3. In the Build Phases section of your app target, locate the Link Binary With Libraries phase and confirm that DevRevSDK is linked. If not, add it by clicking + and selecting DevRevSDK from the list.

Now you should be able to import and use the DevRev SDK in your project.

CocoaPods

To integrate the DevRev SDK using CocoaPods:

1. Add the following to your Podfile:

   pod 'DevRevSDK', '~> <VERSION>'

2. Run pod install in your project directory.

This will install the DevRev SDK in your project, making it ready for use.

Set up the DevRev SDK

1. Open the DevRev web app at https://app.devrev.ai and go to the Settings page.
2. Under PLuG settings copy the value under Your unique App ID.
3. Configure the DevRev SDK in your app using the obtained credentials.

The SDK becomes ready for use once the configuration API is executed. Remote configuration is fetched from the backend and cached locally. On subsequent launches, you can use the cached configuration to avoid a network round-trip and speed up cold start (see Configuration caching).

DevRev.configure(appID:)

To provide a feature configuration during setup, call the overload that accepts it:

DevRev.configure(appID:featureConfiguration:)

For default behavior, call the simpler overload:

DevRev.configure(appID: "abcdefg12345")

To customize behavior such as frame capture, auto-start recording, configuration caching, or theme preferences, pass a FeatureConfiguration instance:

DevRev.configure(
	appID: "abcdefg12345",
	featureConfiguration: FeatureConfiguration(
		enableFrameCapture: false,
		autoStartRecording: false,
		alwaysUseRemoteConfig: true,
		supportWidgetTheme: .systemDefault
	)
)

Update the feature configuration

You can adjust the feature configuration without reconfiguring the SDK:

DevRev.updateFeatureConfiguration(
	FeatureConfiguration(
		enableFrameCapture: true,
		autoStartRecording: true,
		alwaysUseRemoteConfig: true,
		supportWidgetTheme: .systemDefault
	)
)

Feature configuration reference

FeatureConfiguration controls how the SDK behaves both during initial setup and when calling DevRev.updateFeatureConfiguration(_:).

let configuration = FeatureConfiguration.default

Use the designated initializer to override any combination of options:

let configuration = FeatureConfiguration(
	enableFrameCapture: false,
	autoStartRecording: false,
	alwaysUseRemoteConfig: false,
	supportWidgetTheme: .systemDefault
)

When you only need to toggle frame capture while preserving the current runtime values for other options, use the convenience initializer:

DevRev.updateFeatureConfiguration(
	.init(withShouldEnableFrameCapture: false)
)

When you only need to change the support widget theme, use the convenience initializer that preserves the current values for other options:

DevRev.updateFeatureConfiguration(
	.init(witCustomSupportWidgetTheme: .systemDefault)
)

Configuration caching

When alwaysUseRemoteConfig is false, the SDK uses the last successfully fetched configuration stored on the device. If a cached configuration exists, the SDK skips the remote config request at startup and applies the cached settings (for example, session replay, observability). This reduces cold-start latency and allows the app to work offline with the last known config. The first launch (or after clearing app data) still performs a remote fetch when network is available. Set alwaysUseRemoteConfig: true (the default) to retain the previous behavior of always fetching remote configuration at startup and when the app enters background.

Support widget theme options

SupportWidgetTheme lets you fine-tune the support UI. Start from .systemDefault or provide explicit values:

let customTheme = SupportWidgetTheme(
	prefersSystemTheme: false,
	primaryTextColor: "#1F2933",
	accentColor: "#F97316",
	spacing: [
		"bottom": "20px",
		"side": "16px"
	]
)

1. For UIKit apps, configure the SDK in the AppDelegate.application(_:didFinishLaunchingWithOptions:) method.
2. For SwiftUI apps, depending on your app's architecture, configure the SDK at the app's entry point or initial view.

Use the sample app

A sample app with use cases for both UIKit and SwiftUI has been provided as part of our public repository.

Before you start using the sample app you need to configure it to be used with your Apple Developer team and your DevRev credentials. For your convenience the code is marked with compiler error directives (#error) at the places that need attention.

1. Add your credentials to the relevant AppDelegate.swift of the SwiftUI or UIKit sample.
   • After you have added the credentials, delete or comment out the compiler error lines in the respective files.
2. Configure the code signing for the sample target:
   • Open the project settings (1),
   • Select the appropriate target (2),
   • Go to the Signing & Capabilities section (3), and
   • Select your development team under Team (4).