Stitch

Join the chat at https://gitter.im/mongodb/stitch iOS Swift 4.0 Apache 2.0 License Cocoapods compatible

Creating a new app with the iOS SDK

Set up an application on Stitch

  1. Go to https://stitch.mongodb.com/ and log in
  2. Create a new app with your desired name
  3. Take note of the app’s client App ID by going to Clients under Platform in the side pane
  4. Go to Authentication under Control in the side pane and enable Allow users to log in anonymously

Set up a project in XCode using Stitch

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

CocoaPods 1.1.0+ is required to build Stitch iOS 0.2.0+.

To integrate the iOS SDK into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '11.0'
use_frameworks!

target '<Your Target Name>' do
    pod 'StitchCore', '~> 1.0.0'
    # optional: for accessing a mongodb client
    pod 'MongoDBService', '~> 1.0.0'
    # optional: for using mongodb's ExtendedJson
    pod 'ExtendedJson', '~> 1.0.0'
end

Then, run the following command:

$ pod install

Manually

If you prefer not to use any of the aforementioned dependency managers, you can integrate the iOS SDK into your project manually.

Embedded Framework

  • Open up Terminal, cd into your top-level project directory, and run the following command if your project is not initialized as a git repository:
  $ git init
  • Add the iOS SDK as a git submodule by running the following command:
  $ git submodule add https://github.com/10gen/stitch-ios-sdk.git
  • Open the new stitch-ios-sdk folder, and drag the StitchCore.xcodeproj into the Project Navigator of your application’s Xcode project.

    It should appear nested underneath your application’s blue project icon. Whether it is above or below all the other Xcode groups does not matter.

  • Select the StitchCore.xcodeproj in the Project Navigator and verify the deployment target matches that of your application target.

  • Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the Targets heading in the sidebar.

  • In the tab bar at the top of that window, open the General panel.

  • Click on the + button under the Embedded Binaries section.

  • You will see two different StitchCore.xcodeproj folders each with two different versions of the StitchCore.framework nested inside a Products folder.

    It does not matter which Products folder you choose from, but it does matter whether you choose the top or bottom StitchCore.framework.

  • Select the top StitchCore.framework for iOS and the bottom one for OS X.

  • For adding the other modules, MongoDBService, ExtendedJson, or StitchGCM, follow the same process above but with the respective .xcodeproj files.

  • And that’s it!

The StitchCore.framework is automagically added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.


Using the SDK

Logging In

  • To initialize our connection to Stitch, go to your AppDelegate and within your application:didFinishLoadingWithOptions method, add the following line and replace your-app-id with the app ID you took note of when setting up the application in Stitch:

    let client = StitchClient(appId: "your-app-id")
    
  • This will only instantiate a client but will not make any outgoing connection to Stitch

  • Since

    Since we enabled anonymous log in, let’s log in with it; add the following after your new client:

    client.fetchAuthProviders().then { (authProviderInfo: AuthProviderInfo) in
            if (authProviderInfo.anonymousAuthProviderInfo != nil) {
                return client.anonymousAuth()
            } else {
                print("no anonymous provider")
            }
        }.then { (userId: String) in
            print("logged in anonymously as user \(userId)")
        }.catch { error in
            print("failed to log in anonymously: \(error)")
        }
    
  • Now run your app in XCode by going to product, Run (or hitting ⌘R).

  • Once the app is running, open up the Debug Area by going to View, Debug Area, Show Debug Area.

  • You should see log messages like:

    logging in anonymously                                                      
    logged in anonymously as user 58c5d6ebb9ede022a3d75050
    
  • Running a Pipeline

    1. Once logged in, running a pipeline happens via the client’s executePipeline method
    2. To avoid nesting our tasks any further, after logging in we should call some init method that will use the client. We will also place the client as a member of our AppDelegate:

      let client = StitchClient(appId: "your-app-id")
      
      func initializeClient() {
          var literalArgs: [String: ExtendedJsonRepresentable] = [:]
          literalArgs["items"] = BsonArray(array: ["Hello"])
          self.client.executePipeline(pipeline: Pipeline(action: "literal", args: literalArgs)).response(completionHandler: { (result) in
              if let value = result.value {
              if let strings = value as? BsonArray {
                  print("number of results: \(strings.count)")
                  strings.forEach { string in print(string) }
              }
              }
          })
      }
      
    3. Call initalizeClient() after logging in and run your app. You should see a messages like:

      number of results: 1
      Hello world!
      

    Set up Push Notifications (GCM)

    Set up a GCM provider
    1. Create a Firebase Project
    2. Click Add Firebase to your iOS app
    3. Skip downloading the config file
    4. Skip adding the Firebase SDK
    5. Click the gear next to overview in your Firebase project and go to Project Settings
    6. Go to Cloud Messaging and take note of your Legacy server key and Sender ID
    7. In Stitch go to the Notifications section and enter in your API Key (legacy server key) and Sender ID
    Receive Push Notifications in iOS
    1. Currently, StitchGCM needs to be added as a submodule.

    2. To create a GCM Push Provider by asking Stitch, you must use the getPushProviders method and ensure a GCM provider exists:

    self.stitchClient.getPushProviders().response { (result: StitchResult<AvailablePushProviders>) in
        if let gcm = result.value?.gcm {
            let listener = MyGCMListener(gcmClient: StitchGCMPushClient(stitchClient: self.stitchClient, info: gcm))
    
        StitchGCMContext.sharedInstance().application(application,
                                  didFinishLaunchingWithOptions: launchOptions,
                                  gcmSenderID: "<YOUR-GCM-SENDER-ID>",
                                  stitchGCMDelegate: listener)
        }
    }
    
    1. To begin listening for notifications, set your StitchGCMDelegate to the StitchGCMContext:
    class MyGCMDelegate: StitchGCMDelegate {
        let gcmClient: StitchGCMPushClient
    
        init(gcmClient: StitchGCMPushClient) {
            self.gcmClient = gcmClient
        }
    
        func didFailToRegister(error: Error) {
    
        }
    
        func didReceiveToken(registrationToken: String) {
    
        }
    
        func didReceiveRemoteNotification(application: UIApplication, 
                          pushMessage: PushMessage,
                          handler: ((UIBackgroundFetchResult) -> Void)? 
    
        }
    }
    
    1. To register for push notifications, use the registerToken method on your StitchClient:
    func didReceiveToken(registrationToken: String) {
        gcmClient.registerToken(token: registrationToken)
    }