StitchCoreFCMService 6.4.0

StitchCoreFCMService 6.4.0

×

由以下人员维护：Jason Flax，Eric Daniels，Adam Chelminski。

StitchCoreFCMService 6.4.0

  • 作者
  • Jason Flax, Adam Chelminski 和 Eric Daniels

iOS Swift 4.0 Apache 2.0 License Cocoapods compatible

MongoDB Stitch iOS/Swift SDK

官方 MongoDB Stitch SDK for iOS/Swift。

目录

文档

讨论

安装

Xcode/iOS

CocoaPods

CocoaPods是一种Cocoa项目的依赖管理工具。您可以使用以下命令进行安装

$ gem install cocoapods
  • 注意：构建Stitch iOS SDK 5.0+需要CocoaPods 1.6.0+。

要使用CocoaPods将iOS SDK集成到Xcode项目中，请在您的Podfile中指定它

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

target '<Your Target Name>' do
    # For core functionality and the Remote MongoDB Service
    pod 'StitchSDK', '= 6.4.0'

    # optional: for using the AWS service
    pod 'StitchSDK/StitchAWSService', '= 6.4.0'
    # optional: for using the Firebase Cloud Messaging service
    pod 'StitchSDK/StitchFCMService', '= 6.4.0'
    # optional: for using the HTTP service
    pod 'StitchSDK/StitchHTTPService', '= 6.4.0'
    # optional: for using the twilio service
    pod 'StitchSDK/StitchTwilioService', '= 6.4.0'
end

然后，运行以下命令

$ pod install

打开由pod install生成的.xcworkspace文件，以自动链接所有必要的Stitch依赖项来访问您的项目。

示例用法

使用SDK创建新的应用程序（iOS）

在Stitch上设置应用程序

  1. 访问https://stitch.mongodb.com/ 登录MongoDB Atlas。
  2. 在项目中创建一个名为您的应用程序的新应用程序。
  3. 通过在左侧面板中单击'Stitch'并单击您的应用程序，通过将鼠标悬停在应用程序上并在Atlas中打开您的Stitch应用程序来访问您的应用程序。
  4. 复制左侧面板顶部的Stitch应用程序ID。
  5. 通过转到左侧面板中的'用户'页面，选择'提供者'标签，并启用"允许用户匿名登录"选项来启用匿名身份验证。

使用Stitch在Xcode/CocoaPods中设置项目

  1. 下载并安装 Xcode。

  2. 创建一个带有您所需名称的新应用程序项目。确保选择了Swift语言。

  • 注意：iOS 11.0是最低的iOS部署目标。
  1. 在命令行中导航到项目目录，然后运行 pod init。
  2. 在生成的 Podfile 中，在您的应用程序目标的依赖项下添加以下行
    pod 'StitchSDK', '= 6.4.0'

请参见表格中您可以添加到Podfile的Stitch服务Pods的可选列表。

  1. 运行 pod install。
  2. 打开生成的 .xcworkspace 文件。您的应用程序项目将配置好所有必要的依赖项，以便与MongoDB Stitch通信。
  3. 要使用基本Stitch功能，在源文件中导入 import StitchCore。
  4. 要创建BSON文档和BSON值（如ObjectId），在源文件中导入 import MongoSwift。
  5. 要通过Stitch访问远程MongoDB实例，在源文件中导入 import StitchRemoteMongoDBService。

使用SDK

初始化SDK

  1. 当您的应用程序初始化后，运行以下代码以初始化Stitch SDK。您 AppDelegate.swift 的 application(_:didFinishLaunchWithOptions) 方法是可以进行此初始化步骤的合适位置。请确保导入 import StitchCore。
    // at the top of the file
    import StitchCore

    // ...

    // in `application(_:didFinishLaunchWithOptions)`
    do {
        _ = try Stitch.initializeDefaultAppClient(
            withClientAppID: "your-client-app-id"
        )
        print("Successfully initialized default Stitch app client!");
    } catch {
        // note: This initialization will only fail if an incomplete configuration is 
        // passed to a client initialization method, or if a client for a particular 
        // app ID is initialized multiple times. See the documentation of the "Stitch" 
        // class for more details.
        print("Failed to initialize MongoDB Stitch iOS SDK: \(error)")
    }
  1. 要获取用于登录和与Stitch通信的客户，使用 Stitch.defaultAppClient。
    // in a view controller's properties, for example
    private lazy var stitchClient = Stitch.defaultAppClient!
登录
  1. 我们启用了匿名登录，所以让我们用它来登录！请将以下代码添加到代码中
let client = Stitch.defaultAppClient!

print("logging in anonymously")
client.auth.login(withCredential: AnonymousCredential()) { result in
      switch result {
      case .success(let user):
          print("logged in anonymous as user \(user.id)")
          DispatchQueue.main.async {
              // update UI accordingly
          }
      case .failure(let error):
          print("Failed to log in: \(error)")
      }
  }
  1. 现在通过Xcode中的产品，运行（或按下⌘R）来运行您的应用程序。
  2. 应用程序运行后，打开调试区域，方法是转到视图，调试区域，显示调试区域。
  3. 您应该看到诸如
logging in anonymously                                                    	
logged in anonymously as user 58c5d6ebb9ede022a3d75050
执行函数
  1. 登录后，您可以使用StitchClient的callFunction()方法执行Stitch Function。
    client.callFunction(
        withName: "echoArg", withArgs: ["Hello world!"], withRequestTimeout: 5.0
    ) { (result: StitchResult<String>) in
        switch result {
        case .success(let stringResult):
            print("String result: \(stringResult)")
        case .failure(let error):
            print("Error retrieving String: \(String(describing: error))")
        }
    }
  1. 如果您已配置Stitch应用程序具有名为"echoArg"的函数，该函数返回其参数，即
// Stitch Function called 'echoArg'
exports = function(arg) {
  return arg;
};

然后您应在Xcode调试区域内看到如下消息

String result: Hello world!
获取不带Stitch.defaultAppClient的StitchAppClient

如果不想使用单个默认初始化的StitchAppClient，可以使用以下方式，为多个应用程序ID初始化客户端。

    do {        
        let client1 = try Stitch.initializeAppClient(withClientAppID: "your-first-client-app-id")
        
        let client2 = try Stitch.initializeAppClient(withClientAppID: "your-second-client-app-id")
    } catch {
        print("Failed to initialize MongoDB Stitch iOS SDK: \(error.localizedDescription)")
    }

您可以在您的应用程序中的任何地方使用返回的客户端

let client1 = try! Stitch.appClient(forAppID: "your-first-client-app-id")
let client2 = try! Stitch.appClient(forAppID: "your-second-client-app-id")