斯托奇AWSService 6.4.0

斯托奇AWSService 6.4.0

×

由 Adam Chelminski、Eric Daniels、Jason Flax 维护。

 
依赖项
斯托奇核心= 6.4.0
斯托奇核心AWSService= 6.4.0
 

斯托奇AWSService 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 的官方 iOS/Swift SDK。

索引

文档

讨论

安装

Xcode/iOS

CocoaPods

CocoaPods 是 Cocoa 项目的依赖管理器。您可以使用以下命令安装它：

$ gem install cocoapods
  • 注意：需要 CocoaPods 1.6.0+ 才能构建 Stitch iOS SDK 5.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'并点击您的应用程序，在 Stitch 中通过 Atlas 访问您的应用程序。
  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功能，请在源文件中导入StitchCore。
  4. 要创建BSON文档和BSON值，如ObjectId，请在源文件中导入MongoSwift。
  5. 要访问通过Stitch远程MongoDB实例，请在源文件中导入StitchRemoteMongoDBService。

使用SDK

初始化SDK

  1. 当您的应用程序初始化时，运行以下代码来初始化Stitch SDK。在您的AppDelegate.swift中的application(_:didFinishLaunchWithOptions)方法是将此初始化步骤放置的最佳位置。请确保导入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函数
    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初始化客户端，每个客户端应用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")