You can add the Tealeaf SDK 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 12.0 or later. Then uncomment use_frameworks!.
3. In the same Podfile, set pod to either Tealeaf or TealeafDebug, depending on the build you want to use.

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

target 'SwiftUIMindBlowing' do
  use_frameworks!
  pod 'Tealeaf'
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.

pod install

Important notes:

• Sometimes CocoaPods fails to load the latest version. So you may need to pull it using pod update.
• Use the $(inherited) flag in your application target's "Other Linker Settings". This will ensure all the Pods are linked correctly.

Any class that is listed in the bridging header file can be accessed from your Swift classes.

1. Create a bridging header file if your project does not have one. To create a bridging header, go to File > New > File.
2. From the iOS template options, go to Source and select the Header File.
3. Name your file as <ProjectName>/<ProjectName>-Bridging-Header.h and click Create. If Xcode offers to create an Objective-C bridging header file, accept it.
4. Navigate to your project Build Settings > Swift Compiler - General section. Next to Objective-C Bridging Header, add the name/path of your header file. If your file resides in your project's root folder, put the name of the header file there.
   For example: <ProjectName>/<ProjectName>/-Bridging-Header.h or <ProjectName>-Bridging-Header.h.
5. Open the bridging header file and add the following import statements:

📘

Note:

ASIdentifierManager.h is required if you want your application to capture Apple identifier for advertisers (IDFA) data using the Tealeaf AdvertisingId property.

#import <Tealeaf/TLFApplicationHelper.h>
#import <Tealeaf/TLFCustomEvent.h>
#import <Tealeaf/TLFPublicDefinitions.h>
#import <AdSupport/ASIdentifierManager.h>

1. Enable the Tealeaf framework.

   📘

   Note:

   If DynamicConfigurationEnabled in EOCoreBasicConfig.plist is set to NO you do not have to complete this task.

   • For Swift:

     Open the AppDelegate.swift file and add one of the following code to the didFinishLaunchingWithOptions function:
     Option 1:

     Swift

     
     //Tealeaf
     TLFApplicationHelper.sharedInstance().enableTealeafFramework()
     //Tealeaf End
     

     Option 2:
     If you want your application to capture Apple identifier for advertisers (IDFA) data using the Tealeaf AdvertisingId property, add the following code snippet:

     Swift

     
     TLFApplicationHelper.sharedInstance().setCXAAdvertisingId(ASIdentifierManager.shared().advertisingIdentifier.uuidString)
     TLFApplicationHelper.sharedInstance().enableTealeafFramework()
     

   • For Swift UI:
     1. Your application will require an UIApplicationDelegate implementation. To implement the UIApplicationDelegate for your application, you can
        • Open the swift App class file and add the following code.
        or
        • Create a new AppDelegate file with the following code.
     appdelegate.swift

     class AppDelegate: NSObject, UIApplicationDelegate {
     
         func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
     
             // Option 1
             TLFApplicationHelper.sharedInstance().enableTealeafFramework()
             
             // Option 2 - If you want to capture Apple Identifier for advertisders (IDFA) data using Tealeaf
     //        TLFApplicationHelper.sharedInstance().setCXAAdvertisingId(ASIdentifierManager.shared().advertisingIdentifier.uuidString)
     //        TLFApplicationHelper.sharedInstance().enableTealeafFramework()
     
             return true
         }
     
         // MARK: UISceneSession Lifecycle
         func application(_ application: UIApplication, configurationForConnecting connectingSceneSession: UISceneSession, options: UIScene.ConnectionOptions) -> UISceneConfiguration {
             // Called when a new scene session is being created.
             // Use this method to select a configuration to create the new scene with.
             return UISceneConfiguration(name: "Default Configuration", sessionRole: connectingSceneSession.role)
         }
     }
     

     📘

     Note:

     If you want your application to capture Apple identifier for advertisers (IDFA) data using the Tealeaf AdvertisingId property, you must add the following code: TLFApplicationHelper.sharedInstance().setCXAAdvertisingId(ASIdentifierManager.shared().advertisingIdentifier.uuidString)

     In the example code provided, you must comment out Option 1 and uncomment option 2 to enable the code.

     2. You must create a SceneDelegate.swift file if it doesn't already exist for your project and add the following code:
     Swift UI

     import UIKit
     import SwiftUI
     
     class SceneDelegate: UIResponder, UIWindowSceneDelegate {
     
         var window: UIWindow?
     
         func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {
             // Use this method to optionally configure and attach the UIWindow `window` to the provided UIWindowScene `scene`.
             // If using a storyboard, the `window` property will automatically be initialized and attached to the scene.
             // This delegate does not imply the connecting scene or session are new (see `application:configurationForConnectingSceneSession` instead).
             // Use a UIHostingController as window root view controller
             if let windowScene = scene as? UIWindowScene {
                 let window = UIWindow(windowScene: windowScene)
                 window.rootViewController = UIHostingController(rootView: HomeView())
                 self.window = window
                 window.makeKeyAndVisible()
             }
         }
     }
     

     📘

     Note:

     The rootViewController may differ depending on the class names in your project.

     3. Create a Info.plist file if it doesn't already exist for your project as follows:
     
2. Go to Product > Scheme > Edit scheme. Open Run > Arguments in the dialog screen, and in the Environment Variables section, add the following debug variable TLF_DEBUG, EODebug and set the variable value to 1.
3. Compile your code and run the application.

Set the UIApplication class to track UI control events

The UIApplication class allows the UI control events to be tracked by the SDK.

1. In your Swift application, open the AppDelegate.swift file and comment out the following:
   • For Swift: @UIApplicationMain line.
   • For Swift UI: @main
2. Override the sendAction and sendEvent methods. Create a HelloSwiftApplication.swift file and add the following code to the file:
   Swift

   import Foundation
   import UIKit
   import Tealeaf
   class HelloSwiftApplication:  UIApplication {
       override func sendEvent(_ event: UIEvent) {
           TLFApplicationHelper.sharedInstance().send(event)
           super.sendEvent(event)
       }
   
       override func sendAction(_ action: Selector, to target: Any?, from sender: Any?, for event: UIEvent?) -> Bool {
   
           TLFApplicationHelper.sharedInstance().sendAction(action, to: target, from: sender, for: event)
   
           return super.sendAction(action, to: target, from: sender, for: event)
       }
   }
   

3. Create main.swift file and add the following code:
   Swift

   
   import Foundation
   import UIKit
   UIApplicationMain (CommandLine.argc, CommandLine.unsafeArgv, NSStringFromClass (HelloSwiftApplication.self),
             NSStringFromClass(AppDelegate.self))
    

4. Open the Info.plist file and add the following:

   📘

   Note:

   For Swift UI, you must create the info.plist file as described in an earlier step.

   Swift

   
   Key "Principal Class" with value: "HelloSwiftApplication". 
   

   Auto-log Swift app crashes and exceptions

   You can log Swift app crashes and exceptions when the following debugging and testing functions included in your application are called:

   • func assert(()
   • func assertionFailure(()
   • func precondition(()
   • func preconditionFailure(()
   • func fatalError(()

   To auto-log the swift crash and exception, you must add a swift file with the following lines of code in your Swift application project. The added file will be compiled into your application and globally listen to the function in the Swift application. Then it will log information to Tealeaf and call the original Swift function.

   Swift

   //
   // Copyright (C) 2022 Acoustic, L.P. All rights reserved.
   //
   // NOTICE: This file contains material that is confidential and proprietary to
   // Acoustic, L.P. and/or other developers. No license is granted under any intellectual or
   // industrial property rights of Acoustic, L.P. except as may be provided in an agreement with
   // Acoustic, L.P. Any unauthorized copying or distribution of content from this file is
   // prohibited.
   //
   //  TLFatalErrorUtil.swift
   //  SwiftUIMindBlowing
   //
   //  Created by Omar Hernandez on 11/17/22.
   //
   import Foundation
   import Tealeaf
   
   // overrides Swift global `assert`
   public func assert(_ condition: @autoclosure () -> Bool, _ message: @autoclosure () -> String = String(), file: StaticString = #file, line: UInt = #line) {
       TLFCustomEvent.sharedInstance().logAssertErrorEvent(nil, condition: condition(), message: message(), file: String(describing: file), line: UInt32(line))
       Swift.assert(condition(), message(), file: file, line: line)
   }
   
   // overrides Swift global `assertionFailure`
   public func precondition(_ condition: @autoclosure () -> Bool, _ message: @autoclosure () -> String = String(), file: StaticString = #file, line: UInt = #line) {
       TLFCustomEvent.sharedInstance().logPreconditionErrorEvent(nil, condition: condition(), message: message(), file: String(describing: file), line: UInt32(line))
       Swift.precondition(condition(), message(), file: file, line: line)
   }
   
   // overrides Swift global `assertionFailure`
   @inlinable public func assertionFailure(_ message: @autoclosure () -> String = String(), file: StaticString = #file, line: UInt = #line) {
       TLFCustomEvent.sharedInstance().logAssertionFailureErrorEvent(nil, message: message(), file: String(describing: file), line: UInt32(line))
       Swift.assertionFailure(message(), file: file, line: line)
   }
   
   // overrides Swift global `preconditionFailure`
   public func preconditionFailure(_ message: @autoclosure () -> String = String(), file: StaticString = #file, line: UInt = #line) -> Never {
       TLFCustomEvent.sharedInstance().logPreconditionFailureErrorEvent(nil, message: message(), file: String(describing: file), line: UInt32(line))
       Swift.preconditionFailure(message(), file: file, line: line)
   }
   
   // overrides Swift global `fatalError`
   public func fatalError(_ message: @autoclosure () -> String = String(), file: StaticString = #file, line: UInt = #line) -> Never {
       TLFCustomEvent.sharedInstance().logFatalErrorEvent(nil, message: message(), file: String(describing: file), line: UInt32(line))
       Swift.fatalError(message(), file: file, line: line)
   }
   

   For more information, check out the Sample appwith the Swift file added.

The Tealeaf SDK does screenshots of your app and the screenshots are used for replay.
To enable enhanced replay, go to the Tealeaf.framework/TLFResources.bundle/TealeafLayoutConfig.json file and configure the Autolayout settings as follows:

• Set the screenshot to true
• Set CaptureScreenshotOn value. For example, 2.