Add analytics to PDF components in Swift for iOS

1
//
2
//  Copyright © 2015-2025 PSPDFKit GmbH. All rights reserved.
3
//
4
//  The Nutrient sample applications are licensed with a modified BSD license.
5
//  Please see License for details. This notice may not be removed from this file.
6
//
7

8
import PSPDFKit
9
import PSPDFKitUI
10

11
// Extending the type with custom events.
12
extension PDFAnalytics.EventName {
13
    static var catalogAnalyticsExampleOpen = PDFAnalytics.EventName(rawValue: "catalog_analytics_example_open")
14
    static var catalogAnalyticsExampleExit = PDFAnalytics.EventName(rawValue: "catalog_analytics_example_exit")
15
}
16

17
class AnalyticsClientExample: Example, PDFViewControllerDelegate {
18

19
    class CustomAnalyticsClient: PDFAnalyticsClient {
20
        func logEvent(_ event: PDFAnalytics.EventName, attributes: [String: Any]?) {
21
            print("\(event) \(String(describing: attributes))")
22
        }
23
    }
24

25
    let analyticsClient = CustomAnalyticsClient()
26

27
    override init() {
28
        super.init()
29

30
        title = "Analytics Client"
31
        contentDescription = "Example implementation of PDFAnalyticsClient that logs events to console."
32
        category = .analyticsClient
33
        priority = .max // this places the example at the bottom of the list, obviously ;)
34
    }
35

36
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController {
37
        let document = AssetLoader.document(for: .welcome)
38

39
        let analytics = SDK.shared.analytics
40

41
        analytics.add(analyticsClient)
42
        analytics.enabled = true
43

44
        let controller = PDFViewController(document: document)
45
        controller.delegate = self
46

47
        // sending custom events
48
        analytics.logEvent(.catalogAnalyticsExampleOpen)
49

50
        return controller
51
    }
52

53
    func pdfViewControllerDidDismiss(_ pdfController: PDFViewController) {
54
        let analytics = SDK.shared.analytics
55

56
        // sending custom events
57
        analytics.logEvent(.catalogAnalyticsExampleExit)
58

59
        analytics.remove(analyticsClient)
60
        analytics.enabled = false
61
    }
62
}