The Connect SDK is a library that captures visitors' interactions with mobile applications. You can integrate the library into your native iOS app written in Objective-C and track the findings in the Acoustic Connect interface. For Swift instructions, see Integrate the Connect SDK into a native iOS app (Swift) .

📘

Note

New to Connect? Install our preconfigured sample app and explore the implementation faster.

Requirements

• Acoustic Connect. To use the Connect SDK, your company must have an active Connect subscription. Proper credentials are required for each app. For instructions, see Generate Connect credentials for integration.
• Development environment. Xcode with Command Line Tools.
• Mobile app compatibility. The library can capture user experience data on end users' devices running iOS 15.1 and later. On iPadOS, only single-window applications are fully supported.

Limitations

We offer limited support for iPad apps with a multi-window architecture. The library captures data from such apps and makes it available for analytics, but session replays may not work correctly.

General guidelines

It is important that you assign unique IDs to all UI controls that you want to capture.

Initial setup

• CocoaPods
• Swift Package
• Carthage

You can add the Connect library to your iOS app using the CocoaPods dependency manager. This option requires a recent version of CocoaPods.

Here are steps to follow:

1. If you don't have a Podfile in your Xcode project directory, create one.
2. Open the Podfile in a text editor and make sure the iOS version is 15.1 or later. Then uncomment use_frameworks!.
3. In the same Podfile, set pod to either AcousticConnect or AcousticConnectDebug, depending on the build you want to use.

Ruby

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '15.1'

target 'SwiftUIMindBlowing' do
  use_frameworks!
  pod 'AcousticConnect'
end

4. In a terminal emulator, navigate to your project directory.
5. Install the pods. Make sure the command is completed with no errors. If you get an error, run the same command with the --verbose option and share the error log with our services team.

Shell

pod install

Important notes:

• Sometimes CocoaPods fails to load the latest version. So you may need to pull it using pod update.
• If you get a warning message after running pod install, see our help article Removing CocoaPods warnings during integration.

You can add the Connect iOS library as a Swift Package.

1. In your Xcode project, go to File > Add Package Dependencies.

2. Search for https://github.com/go-acoustic/Connect-SP . For the debug build, replace Connect-SP with ConnectDebug-SP. Never use both versions in the same project.

3. Select the target to add the library to.

You can add the Connect library to your iOS app using the Carthage dependency manager.

1. Create a Cartfile in your Xcode project directory if you don't have one yet.

Shell

touch Cartfile

2. Open the Cartfile in a text editor and add the following lines for the release build. To add the debug build, update the file names: instead of EOCore.json use EOCoreDebug.json, instead of Tealeaf.json use TealeafDebug.json and instead of Connect.json use ConnectDebug.json.

binary "https://raw.githubusercontent.com/go-acoustic/EOCore/master/EOCore.json"
binary "https://raw.githubusercontent.com/go-acoustic/Tealeaf/master/Tealeaf.json"
binary "https://raw.githubusercontent.com/go-acoustic/Connect/master/Connect.json"

🚧

Warning

Never use the release and debug builds together in the same project.

3. From the main project directory, run the command carthage update --use-xcframeworks. Make sure it completes without errors.
4. In a file manager, navigate to /Carthage/Build inside your project directory and select all three bundles.

5. In your Xcode project, select the primary project target. Drag and drop the bundles to Frameworks, Libraries, and Embedded Content. Select Embed & Sign for each bundle.

6. Switch to the Build Phases tab and make sure all three appear under Embed Frameworks. If they don't, you will need to add them as frameworks.

7. Rebuild the project.

Required configuration

There are some required steps to finalize the integration.

1. Open the AppDelegate.m file in your project.
2. Add 2 import statements to the header.

@import Tealeaf;
@import Connect;

3. Add the following code to the didFinishLaunchingWithOptions function. Replace app_key and collector_url with your Connect credentials.

[[TLFApplicationHelper sharedInstance] enableTealeafFramework:@"app_key" withPostMessageUrl:@"collector_url"];

4. If you have installed the debug version, add three variables with the value of 1 to the project scheme: EODebug, CONNECT_DEBUG and TLF_DEBUG.

Important:

• Never use the release and beta builds together in the same project.
• When reporting an issue to our support team, always attach your debug log. It speeds up troubleshooting.

👍

What's next?

Now you can build and run your app.

Related instructions

• iOS SDK privacy manifests
• Connect iOS SDK public API reference