Option 2: Add Mobile SDK Setup Code Manually

Prerequisites

1. Create an Xcode Swift Project
2. Add Mobile SDK Libraries to Your Project
3. Configure Your Project’s Build Settings

Add or Edit Info.plist

Mobile SDK uses the project’s main Info.plist file to set the default Salesforce login host. In Xcode 12.4, the app wizard creates the Info.plist file for you. In Xcode 13, the app wizard for the SwiftUI interface doesn’t create the file, but you can copy one from a Mobile SDK template app.

Xcode 12.4

1. In the Project Navigator, control-click MyMobileSDKApp | MyMobileSDKApp | Info.plist and select Open As | Source Code.
2. Add the following key-value pair to the top-level dictionary:
   1<key>SFDCOAuthLoginHost</key>
   2<string>login.salesforce.com</string>

Xcode 13

Copy the Info.plist file to your project from the iOS Native Swift template. When the file is in place, adjust your Project Settings as follows:

1. In your Project settings, select Build Phases.
2. Under Copy Bundle Resources, select Info.plist, if it’s present, and click Remove Items (-).
3. In Build Settings, search for “Info.plist File”.
4. Set Generate Info.plist File to No.
5. Set Info.plist File to the file’s path in your project (for example, “MyMobileSDKApp/Info.plist”.)

   

Add bootconfig.plist

Add a main.swift File

Mobile SDK requires its own UIApplication-based object, SFApplication, to monitor user event notifications. This class must be instantiated when iOS first initializes the main application object. To use this class instead of the default UIApplication class, you add a custom main.swift file to your project. You can then call the UIApplicationMain constructor with custom arguments.

1. In your project, control-click MyMobileSDKApp | MyMobileSDKApp and select New File.
2. Select Swift File, name it “main.swift”, and then click Create. Xcode creates a file with one line:
   1import Foundation

3. Import SalesforceSDKCore.
   1import Foundation
   2import SalesforceSDKCore

4. Create an instance of UIApplicationMain, passing in
   • “SFApplication” for the principalClassName argument
   • “AppDelegate” for the delegateClassName argument
   1UIApplicationMain(
   2    CommandLine.argc,
   3    CommandLine.unsafeArgv,
   4    NSStringFromClass(SFApplication.self), //principalClassName
   5    NSStringFromClass(AppDelegate.self)    //delegateClassName
   6)

See UIApplicationMain(_:_:_:_:) in the Apple Developer documentation.

Customize or Create the AppDelegate Class

Add an InitialViewController Class

To access Salesforce data, your app’s users must authenticate with a Salesforce org. Salesforce sends a login screen to your app to collect the user’s credentials and then returns OAuth tokens to your app.

Customize or Create the SceneDelegate Class

In the scene lifecycle, specific junctures are ideal for each of these AuthHelper calls. For example, register the block that handles user changes only one time, when the scene is first initialized. Also, call AuthHelper.loginIfRequired(_:_:) whenever the scene comes to the foreground. If the current user remains logged in, Mobile SDK merely executes your completion block.

At app startup, you set InitialViewController as the first root view controller. This view hosts the Salesforce login screen and, after a successful login, is replaced by your app’s root view controller. At runtime, if the current user logs out, you dismiss the current root view controller and replace it with InitialViewController. In both cases, after a new user logs in, you dismiss InitialViewController and set your app’s first view as the root view controller.

Xcode 12.4 and Xcode 13:

1. At the top of your project’s SceneDelegate class, be sure that you’ve declared a UIWindow variable:
   1class SceneDelegate: UIResponder, UIWindowSceneDelegate {
   2
   3    var window: UIWindow?

2. At the bottom of the SceneDelegate class body, implement a private function named resetViewState(_:) that takes an escaping closure as its sole parameter. This function dismisses the current root view controller and then executes the given closure:
   1func resetViewState(_ postResetBlock: @escaping () -> ()) {
   2    if let rootViewController = self.window?.rootViewController {
   3        if let _ = rootViewController.presentedViewController {
   4            rootViewController.dismiss(animated: false, 
   5                completion: postResetBlock)
   6            return
   7        }
   8        self.window?.rootViewController = nil
   9    }
   10    postResetBlock()
   11}

3. Implement a private function named setupRootViewController() that launches your app’s custom views. For this simple exercise, you can set the root view to the SwiftUI ContentView provided by the Xcode template.
   1func setupRootViewController() {
   2    self.window?.rootViewController = UIHostingController(rootView: 
   3        ContentView())
   4}

   The Xcode template’s ContentView requires no additional setup or cleanup. For a more elaborate example, see setupRootViewController(_:) in the MobileSyncExplorerSwift template.

   Note

4. In the scene(_:willConnectTo:options:) function, provide code that sets up the window scene. Replace all existing code with the following lines:
   1func scene(_ scene: UIScene, willConnectTo session: UISceneSession, 
   2    options connectionOptions: UIScene.ConnectionOptions) {
   3
   4    guard let windowScene = (scene as? UIWindowScene) else { return }
   5    self.window = UIWindow(frame: windowScene.coordinateSpace.bounds)
   6    self.window?.windowScene = windowScene
   7    
   8
   9}

5. Register a callback block for user change events. Using the private functions you added, provide a closure that resets the view state and then presents your app’s root view.
   1func scene(_ scene: UIScene, willConnectTo session: UISceneSession, 
   2    options connectionOptions: UIScene.ConnectionOptions) {
   3
   4    guard let windowScene = (scene as? UIWindowScene) else { return }
   5    self.window = UIWindow(frame: windowScene.coordinateSpace.bounds)
   6    self.window?.windowScene = windowScene
   7
   8    // Define a response to user change events
   9    AuthHelper.registerBlock(forCurrentUserChangeNotifications: {
   10        self.resetViewState {
   11            self.setupRootViewController()
   12        }
   13    })
   14}

6. Implement a private function named initializeAppViewState() that sets InitialViewController as the root view. Notice that this function first makes sure that the app is on the main UI thread. If the app is on some other thread, it switches to the main thread and calls itself recursively.
   1func initializeAppViewState() {
   2    if (!Thread.isMainThread) {
   3        DispatchQueue.main.async {
   4            self.initializeAppViewState()
   5        }
   6        return
   7    }
   8
   9    self.window?.rootViewController = 
   10        InitialViewController(nibName: nil, bundle: nil)
   11    self.window?.makeKeyAndVisible()
   12}

7. In the sceneWillEnterForeground(_:) listener function:
   1. To set the root view to InitialViewController, call initializeAppViewState().
   2. Call AuthHelper.loginIfRequired(_:) with a closure that sets the root view controller to your app’s main view.
   1func sceneWillEnterForeground(_ scene: UIScene) {
   2    // Called as the scene transitions from the background to the foreground.
   3    // Use this method to undo the changes made on entering the background.
   4    self.initializeAppViewState()
   5    AuthHelper.loginIfRequired {
   6        self.setupRootViewController()
   7    }
   8}

Build Your New Mobile SDK App

1. In Xcode, select Product | Run (⌘R).
2. If the Salesforce login screen appears, you’re done!

Add Push Notification Support

1. To support Salesforce push notifications, add code to register and handle them. You can copy boilerplate implementations of the following methods from the AppDelegate class of the Mobile SDK iOSNativeSwiftTemplate app:
   • registerForRemotePushNotifications()
   • application(_:didRegisterForRemoteNotificationsWithDeviceToken:)—Be sure to uncomment the one line of implementation code!
   • didRegisterForRemoteNotifications(_:)
   • application(_:didFailToRegisterForRemoteNotificationsWithError:)
2. Salesforce uses encryption on notifications, which requires you to implement a decryption extension and then to request authorization through the UNUserNotificationCenter object. See Code Modifications (iOS).

Add Identity Provider Support

Mobile SDK supports configuration of identity provider (IDP) apps. See Identity Provider Apps. If you’ve implemented IDP functionality, you enable it by customizing AppDelegate and SceneDelegate.

1. In your AppDelegate class, add the following boilerplate functions from the AppDelegate class of the Mobile SDK iOSNativeSwiftTemplate app:
   • application(_:open:_:)
   • enableIDPLoginFlowForURL(_:_:)
2. In your SceneDelegate class, add the following functions.
   1func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
   2    if let urlContext = URLContexts.first {
   3        self.enableIDPLoginFlowForURLContext(urlContext, scene: scene)
   4    }
   5}
   6
   7func enableIDPLoginFlowForURLContext(_ urlContext: UIOpenURLContext, 
   8    scene: UIScene) -> Bool {
   9    return UserAccountManager.shared.handleIdentityProviderResponse(
   10        from: urlContext.url, with: [UserAccountManager.IDPSceneKey: 
   11            scene.session.persistentIdentifier])
   12}

Customize the Pre-Login Screen

1import Foundation
2import UIKit
3import SalesforceSDKCore.UIColor_SFColors
4
5class InitialViewController: UIViewController {
6
7    override func viewDidLoad() {
8        super.viewDidLoad()
9        self.view.backgroundColor = UIColor.salesforceSystemBackground
10        let label = UILabel()
11        label.translatesAutoresizingMaskIntoConstraints = false
12        guard let info = Bundle.main.infoDictionary, 
13            let name = info[kCFBundleNameKey as String] else { return }
14        label.font = UIFont.systemFont(ofSize: 29)
15        label.textColor = UIColor.black
16        label.text = name as? String
17        self.view.addSubview(label)
18        label.centerXAnchor.constraint(equalTo: self.view.centerXAnchor).
19            isActive = true
20        label.centerYAnchor.constraint(equalTo: self.view.centerYAnchor).
21            isActive = true
22        // Do any additional setup after loading the view, 
23        // typically from a nib.
24    }
25
26    override func didReceiveMemoryWarning() {
27        super.didReceiveMemoryWarning()
28        // Dispose of any resources that can be recreated.
29    }
30}

Include SmartStore and Mobile Sync Configuration Files

1// Setup store based on config userstore.json
2MobileSyncSDKManager.shared.setupUserStoreFromDefaultConfig()
3// Setup syncs based on config usersyncs.json
4MobileSyncSDKManager.shared.setupUserSyncsFromDefaultConfig()