StitchCoreTwilioService 6.4.0

StitchCoreTwilioService 6.4.0

×

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

StitchCoreTwilioService 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
  • 注意：构建 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' 并单击您的应用程序，访问您的应用程序中的 Stitch。
  4. 从左侧边栏顶部复制您的 Stitch App ID。
  5. 通过转到左侧边栏中的“用户”页面，选择“提供者”选项卡，并启用“允许用户匿名登录”选项来启用匿名认证。

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

  1. 下载并安装 Xcode。

  2. 使用您希望的名字创建一个新应用项目。确保选择了Swift作为编程语言。

  • 注意：iOS 11.0 是最低部署目标。
  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. 要创建如ObjectId之类的BSON文档和BSON值，在一个源文件中导入 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中转到Product，然后Run（或按下 ⌘R）来运行您的应用。
  2. 一旦应用开始运行，请通过转到View，Debug Area，然后Show Debug Area来打开调试区域。
  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初始化客户端

    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")