OrderCloudSwifty

OrderCloudSwifty是一个用Swift编写并与Objective-C兼容的SDK，用于Four51的OrderCloud API。

要求

• iOS 8.0+ / Mac OS X 10.9+ / tvOS 9.0+ / watchOS 2.0+
• Xcode 7.2+

交流

• 如果您需要帮助，请使用Stack Overflow。（请用ordercloud标签）
• 如果您想提问，请使用Stack Overflow。
• 如果您有任何问题或需要帮助，请加入#ordercloudevs频道Slack
• 如果您找到了错误，请开一个问题。
• 如果您有功能请求，请开一个问题。

安装

作为嵌入式框架手动安装

如果不想使用依赖管理器，可以手动安装OrderCloudSwifty。

• 在终端中，转到您的项目目录

$ cd /path/to/my/project

• 如果您在项目目录中没有初始化Git仓库，可以使用

$ git init

• 使用以下命令将OrderCloudSwifty作为 子模块 添加

$ git submodule add https://github.com/OrderCloud/OrderCloudSwifty.git

• 打开OrderCloudSwifty文件夹，将OrderCloudSwifty.xcodeproj拖放到您应用的Xcode项目的Project Navigator中。

• 选择您的项目并编辑您应用的目标配置。在“通用”选项卡下，“通用”部分下添加“嵌入式二进制文件”。

• 选择针对您的平台的目标OrderCloudSwifty。

• 🎉

OrderCloudSwifty.framework会自动作为目标依赖项，链接框架和嵌入框架，这是在模拟器和设备上构建所需的一切。

使用

设置

为了与API交互，您需要提供OrderCloudSwifty的客户端ID。有关如何创建客户端ID的信息请见此处。

• Swift

import OrderCloudSwifty

OrderCloud.setupClientId("my-client-id")

• Objective-C

#import <OrderCloudSwifty.h>

int main() {
  [OrderCloud.setupClientId: "client-id"]
}

身份验证

设置好客户端ID后，您现在可以使用在OrderCloud DevCenter控制台创建的用户账户登录。

• Swift

OrderCloud.Auth.currentUser.authenticate("username", password: "password")

• Objective-C

[OrderCloud.Auth.currentUser authenticate:"username" password:"password"]

您还可以指定用户的范围以及要使用的回调。

OrderCloud.User.currentUser.authenticate("username", password: "password", scope: "scope", completionHandler: { response in
  // Do something with response
})

处理请求响应

大多数调用API的函数都会为您提供定义自己的回调的可能性。这确保了您的应用程序保持异步，特别是在GUI的上下文中。要处理请求的响应，Util.swift文件中提供了默认的回调。以下是一个不错的结构可供使用：

{ response in
  switch response.result {
    case .Success:
      if let value = response.result.value {
        let json = JSON(value)
      }
    case .Failure(let error):
      print("error:", error)
  }
}

{ response in 

}

许可证

OrderCloudSwifty在MIT许可证下可用。有关更多信息，请参阅LICENSE文件。