SDK Configuration

During initialization, you can configure the SDK using the options listed in the table below. If not specified, the SDK will use default values.

Platform Guides

iOS - Automatic Initialization

Configuration Options

Feature	Key	Data Type	Default Value
Screen Name Auto Capture (UIKit)	ScreenAutoCaptureUIKit	Boolean	YES
Screen Name Auto Capture (SwiftUI)	ScreenAutoCaptureSwiftUI	Boolean	YES

warning

Without Screen Name Auto Capture, your development teams will need to manually code every screen change event for the SDK.

info

With Screen Name Auto Capture, method swizzling is used on UIViewController for viewDidAppear and viewDidDisappear methods.

Apply Configuration

Add entries to the Qualtrics dictionary in Info.plist using the corresponding keys and data types.

iOS - Manual Initialization

Configuration Options

Feature	Key	Data Type	Default Value
Screen Name Auto Capture (UIKit)	screenAutoCaptureUIKit	Bool	true
Screen Name Auto Capture (SwiftUI)	screenAutoCaptureSwiftUI	Bool	true

warning

Without Screen Name Auto Capture, your development teams will need to manually code every screen change event for the SDK.

info

With Screen Name Auto Capture, method swizzling is used on UIViewController for viewDidAppear and viewDidDisappear methods.

Apply Configuration

Create a QualtricsConfiguration object and pass it to the initialization call.

import QualtricsExperience

let configuration = QualtricsConfiguration(
    screenAutoCaptureUIKit: true,
    screenAutoCaptureSwiftUI: true
)

Qualtrics.initialize(sdkKey: "YOUR_SDK_KEY", configuration)

Android - Automatic Initialization

Configuration Options

Feature	Key	Data Type	Default Value
Screen Name Auto Capture (Activities)	qualtrics_screen_auto_capture_activities	bool	true
Screen Name Auto Capture (Fragments)	qualtrics_screen_auto_capture_fragments	bool	true
Screen Name Auto Capture (Navigation API)	qualtrics_screen_auto_capture_navigation_api	bool	true
Screen Name Auto Capture (Jetpack Compose)	qualtrics_screen_auto_capture_compose	bool	true

info

Jetpack Compose: After enabling it, call Qualtrics.captureComposeNavigation(navController) with your NavController to track screen changes (see SDK Setup – Collect Screen Names).

warning

Without Screen Name Auto Capture, your development teams will need to manually code every screen change event for the SDK.

Apply Configuration

Add entries to the qualtrics_config.xml file using the corresponding keys and data types.

<?xml version="1.0" encoding="utf-8"?>
<resources>
   <string name="qualtrics_sdk_key">YOUR_SDK_KEY</string>
   <bool name="qualtrics_screen_auto_capture_activities">true</bool>
   <bool name="qualtrics_screen_auto_capture_fragments">true</bool>
   <bool name="qualtrics_screen_auto_capture_navigation_api">true</bool>
   <bool name="qualtrics_screen_auto_capture_compose">true</bool>
</resources>

Android - Manual Initialization

Configuration Options

Feature	Key	Data Type	Default Value
Screen Name Auto Capture (Activities)	screenAutoCaptureActivities	Boolean	true
Screen Name Auto Capture (Fragments)	screenAutoCaptureFragments	Boolean	true
Screen Name Auto Capture (Navigation API)	screenAutoCaptureNavigationApi	Boolean	true
Screen Name Auto Capture (Jetpack Compose)	screenAutoCaptureCompose	Boolean	true

info

Jetpack Compose: After enabling it, call Qualtrics.captureComposeNavigation(navController) with your NavController to track screen changes (see SDK Setup – Collect Screen Names).

warning

Without Screen Name Auto Capture, your development teams will need to manually code every screen change event for the SDK.

Apply Configuration

Create a QualtricsConfiguration object and pass it to the initialization call.

val configuration = QualtricsConfiguration(
    screenAutoCaptureActivities = true,
    screenAutoCaptureFragments = true,
    screenAutoCaptureNavigationApi = true,
    screenAutoCaptureCompose = true
)

Qualtrics.initialize("YOUR_SDK_KEY", activity, configuration)

React Native

info

The React Native SDK does not expose configuration options at this time. Screen Name Auto Capture is controlled by calling enableScreenAutoCapture with your navigation ref (see SDK Setup). No other configuration is needed.

warning

Button Auto Capture is not supported for React Native. To report button taps in a React Native app, use the manual reportButtonTap method instead (see Manual Button Taps).