Configure the SDK for iOS

1import MarketingCloudSDK
2// The SFMCSDK module is included in the dependency packages for the SDK. Don't install it
3// separately or list it in your podfile.
4import SFMCSDK
5import UIKit
6
7@main
8class AppDelegate: UIResponder, UIApplicationDelegate {
9
10  var window: UIWindow?
11
12  // Marketing Cloud SDK configuration
13  let mcAppID = "<your MC appID here>"
14  let mcAccessToken = "<your MC accessToken here>"
15  let mcServerURL = "<your mc serverURL here>"
16  let mcMid = "<your account MID here>"
17
18  // Define features of Marketing Cloud your app uses
19  let mcInboxEnabled = false
20  let mcLocationEnabled = false
21  let mcAnalyticsEnabled = true
22
23  // MarketingCloud SDK: REQUIRED IMPLEMENTATION
24  @discardableResult
25
26  func configureSdk() -> Bool {
27
28    // Enable logging for debugging. Don't use debug level in production apps because the SDK logs
29    // significant data to the console.
30
31    #if DEBUG
32      SFMCSdk.setLogger(logLevel: .debug)
33    #endif
34
35    // Use the `MarketingCloudSdkConfigBuilder` to configure the MarketingCloud SDK.
36    // The builder lets you configure the module parameters at runtime.
37
38    let engagementConfiguration = MarketingCloudSdkConfigBuilder(appId: mcAppID)
39      .setAccessToken(mcAccessToken)
40      .setMarketingCloudServerUrl(URL(string: mcServerURL)!)
41      .setMid(mcMid)
42      .setInboxEnabled(mcInboxEnabled)
43      .setLocationEnabled(mcLocationEnabled)
44      .setAnalyticsEnabled(mcAnalyticsEnabled)
45      .build()
46
47    // Set the completion handler to take action when module initialization completes.
48    // Setting the completion handler is optional.
49
50    let completionHandler: ((_ status: [ModuleInitStatus]) -> Void) = { [weak self] status in
51      DispatchQueue.main.async {
52        self?.handleSDKInitializationCompletion(status: status)
53      }
54    }
55
56    SFMCSdk.initializeSdk(
57      ConfigBuilder().setEngagement(config: engagementConfiguration).build(),
58      completion: completionHandler)
59
60    return true
61  }
62
63  // MARK: - SDK Initialization Completion Handler
64
65  private func handleSDKInitializationCompletion(status: [ModuleInitStatus]) {
66    var allSuccessful = true
67
68    for moduleStatus in status {
69      print(
70        "Module: \(moduleStatus.moduleName.rawValue), Status: \(moduleStatus.initStatus.rawValue)")
71
72      if moduleStatus.initStatus == .success {
73        // Handle successful initialization for each module
74        switch moduleStatus.moduleName {
75        case .engagement:
76          // Handle successful initialization for Marketing Cloud module
77        default:
78          break
79        }
80      } else if moduleStatus.initStatus == .error {
81        allSuccessful = false
82        // Module failed to initialize. Check logs for details.
83      } else if moduleStatus.initStatus == .cancelled {
84        allSuccessful = false
85        // Module initialization was cancelled. For example, reconfiguration was triggered before initialization completed.
86      } else if moduleStatus.initStatus == .timeout {
87        allSuccessful = false
88        // Module failed to initialize due to timeout. Check logs for details.
89      }
90    }
91    if allSuccessful {
92      print("SDK initialization completed successfully")
93    } else {
94      print("SDK initialization completed with errors - check logs above")
95    }
96  }
97
98  func application(
99    _ application: UIApplication,
100    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
101  ) -> Bool {
102    // Override point for customization after application launch.
103    self.configureSdk()
104    return true
105  }
106
107  // Marketing Cloud SDK: OPTIONAL IMPLEMENTATION (if using Data Protection)
108  func applicationProtectedDataDidBecomeAvailable(_ application: UIApplication) {
109    self.configureSdk()
110  }
111}

1// The SFMCSDK module is included in the dependency packages for the SDK. Don't install it
2// separately or list it in your podfile.
3import SFMCSDK
4import MarketingCloudSDK
5
6class AppDelegate: UIResponder, UIApplicationDelegate {
7
8  var window: UIWindow?
9
10  // SDK: REQUIRED IMPLEMENTATION
11
12  // The appID, accessToken, and appEndpoint are required configuration values.
13  #if DEBUG
14    let appId = YOUR_DEV_APP_ID
15    let accessToken = YOUR_DEV_ACCESS_TOKEN
16    let appEndpoint = YOUR_DEV_APP_ENDPOINT
17    let mid = YOUR_DEV_MID
18  #else
19    let appId = YOUR_PROD_APP_ID
20    let accessToken = YOUR_PROD_ACCESS_TOKEN
21    let appEndpoint = YOUR_PROD_APP_ENDPOINT
22    let mid = YOUR_PROD_MID
23  #endif
24
25
26  // Define the features your app uses
27  let inbox = false
28  let location = false
29  let analytics = true
30
31  // SDK: REQUIRED IMPLEMENTATION
32  func configureSDK() {
33    // Enable logging for debugging. Don't use debug level in production apps because the SDK logs
34    // a large amount of data to the console.
35    #if DEBUG
36    SFMCSdk.setLogger(logLevel: .debug)
37    #endif
38
39    // Use the Config Builder to configure the module parameters at runtime.
40    let mobilePushConfiguration = PushConfigBuilder(appId: appId)
41      .setAccessToken(accessToken)
42      .setMarketingCloudServerUrl(appEndpoint)
43      .setMid(mid)
44      .setInboxEnabled(inbox)
45      .setLocationEnabled(location)
46      .setAnalyticsEnabled(analytics)
47      .build()
48
49    // Set the completion handler to take action when module initialization completes. The result indicates whether initialization was successful.
50    // Setting the completion handler is optional.
51    let completionHandler: (OperationResult) -> () = { result in
52      if result == .success {
53        // Module is fully configured and ready for use
54      } else if result == .error {
55        // Module failed to initialize. Check logs for details.
56      } else if result == .cancelled {
57        // Module initialization was cancelled. For example, reconfiguration was triggered before initialization completed.
58      } else if result == .timeout {
59        // Module failed to initialize due to timeout. Check logs for details.
60      }
61    }
62
63    // After you create the configuration, initialize the SDK.
64    SFMCSdk.initializeSdk(ConfigBuilder().setPush(config: mobilePushConfiguration, onCompletion: completionHandler).build())
65  }
66
67  // SDK: REQUIRED IMPLEMENTATION
68  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
69    self.configureSDK()
70
71    return true
72  }
73
74  // SDK: OPTIONAL IMPLEMENTATION (if using Data Protection)
75  func applicationProtectedDataDidBecomeAvailable(_ application: UIApplication) {
76    if (SFMCSdk.mp.getStatus() != .operational) {
77      self.configureSFMCSdk()
78    }
79  }
80}

1import MarketingCloudSDK
2
3class AppDelegate: UIResponder, UIApplicationDelegate {
4
5  var window: UIWindow?
6
7  // REQUIRED IMPLEMENTATION
8
9  // The appID, accessToken, and appEndpoint are required configuration values.
10
11  // Use the builder method to configure the SDK.
12  // The builder lets you configure the SDK parameters at runtime.
13  #if DEBUG
14
15  let appID = YOUR_DEV_APP_ID
16  let accessToken = YOUR_DEV_ACCESS_TOKEN
17  let appEndpoint = YOUR_DEV_APP_ENDPOINT
18  let mid = YOUR_DEV_MID
19  #else
20  let appId = YOUR_PROD_APP_ID
21  let accessToken = YOUR_PROD_ACCESS_TOKEN
22  let appEndpoint = YOUR_PROD_APP_ENDPOINT
23  let mid = YOUR_PROD_MID
24  #endif
25
26
27  // Define the features your app uses
28  let inbox = false
29  let location = false
30  let analytics = true
31
32  // REQUIRED IMPLEMENTATION
33  @discardableResult
34  func configureMarketingCloudSDK() -> Bool {
35    // Use the builder method to configure the SDK.
36    // The builder lets you configure the SDK parameters at runtime.
37    let builder = MarketingCloudSDKConfigBuilder()
38      .sfmc_setApplicationId(appID)
39      .sfmc_setAccessToken(accessToken)
40      .sfmc_setMarketingCloudServerUrl(appEndpoint)
41      .sfmc_setMid(mid)
42      .sfmc_setInboxEnabled(inbox as NSNumber)
43      .sfmc_setLocationEnabled(location as NSNumber)
44      .sfmc_setAnalyticsEnabled(analytics as NSNumber)
45      .sfmc_build()!
46
47    var success = false
48
49    // After you create the builder, pass it to the sfmc_configure method.
50    do {
51      try MarketingCloudSDK.sharedInstance().sfmc_configure(with:builder)
52      success = true
53    } catch let error as NSError {
54      // Configuration errors are returned in the NSError parameter. Use them to determine
55      // whether you implemented the SDK correctly.
56
57      let configErrorString = String(format: "MarketingCloudSDK sfmc_configure failed with error = %@", error)
58      print(configErrorString)
59    }
60
61    if success == true {
62      // The SDK is fully configured and ready for use.
63
64      // Enable logging for debugging. Don't use this in production apps because the SDK logs
65      // a large amount of data to the console.
66      #if DEBUG
67      MarketingCloudSDK.sharedInstance().sfmc_setDebugLoggingEnabled(true)
68      #endif
69    }
70
71    return success
72  }
73
74  // REQUIRED IMPLEMENTATION
75  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
76    return self.configureMarketingCloudSDK()
77  }
78
79  // OPTIONAL IMPLEMENTATION (if using Data Protection)
80  func applicationProtectedDataDidBecomeAvailable(_ application: UIApplication) {
81    if(MarketingCloudSDK.sharedInstance().sfmc_isReady() == false)
82    {
83      self.configureMarketingCloudSDK()
84    }
85  }
86}