此项目现已存档,因为 Public WeTransfer API 不再维护。

WeTransfer-Swift-SDK

一个用于 WeTransfer 公共 API 的 Swift SDK

Build Status License Carthage compatible CocoaPods Compatible Platform

如需您的 API 密钥和更多信息,请访问我们的开发者门户

特性

要求

安装

Carthage

Carthage 是一个去中心化的依赖管理器,它构建您的依赖项并为您提供二进制框架。

您可以使用 Homebrew,使用以下命令安装 Carthage

$ brew update
$ brew install carthage

要使用 Carthage 将 WeTransfer 集成到您的 Xcode 项目中,请在您的 Cartfile 中指定它

github "WeTransfer/WeTransfer-Swift-SDK" ~> 2.0

运行 carthage update 以构建框架,并将构建的 WeTransfer.framework 拖到您的 Xcode 项目中。

Swift Package Manager

Swift Package Manager 是一种用于自动化 Swift 代码分发的工具,并集成到 swift 编译器中。

一旦您设置好 Swift 包,将 WeTransfer SDK 作为依赖项添加到 Package.swiftdependencies 值中就非常简单。

Swift 4

dependencies: [
    .package(url: "https://github.com/Alamofire/WeTransfer-Swift-SDK.git", from: "2.0")
]

注意:运行 swift test 目前不起作用,因为 Swift 包不能在其测试目标中包含资源。

Cocoapods

CocoaPods 是 Cocoa 项目的依赖管理器。

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

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

target '<Your Target Name>' do
    pod 'WeTransfer-Swift-SDK', '>= 2.0'
end

然后,运行以下命令

$ pod install

用法

在 SDK 可以使用 WeTransfer API 执行任何操作之前,需要使用 API 密钥进行身份验证。 您可以在开发者门户创建一个 API 密钥

  1. 配置客户端。使用您的 API 密钥创建配置
let configuration = WeTransfer.Configuration(apiKey: "YOUR_API_KEY")
WeTransfer.configure(with: configuration)
  1. 使用新的传输上传文件。使用一个方法调用 WeTransfer.uploadTransfer,可以创建一个传输并向其中上传文件。 SDK 中的文件由 File 对象表示,但此便捷方法需要一个指向您设备上文件的 URL 数组。 在 stateChanged 闭包中,您会收到有关上传进度或是否已完成或失败等信息的更新
let files = [...]
WeTransfer.uploadTransfer(saying: "Transfer Name", containing: files) { state in
    switch state {
    case .created(let transfer):
        print("Transfer created")
    case .uploading(let progress):
        print("Transfer uploading")
    case .completed(let transfer):
        print("Upload completed")
    case .failed(let error):
        XCTFail("Transfer failed: \(error.localizedDescription)")
    }
}

示例应用

WeTransfer Swift SDK Sample Application

该项目包含一个简洁的示例应用程序,展示了 SDK 的一个可能的用例。 它允许将照片和视频添加到传输中,并显示整个传输的上传进度,之后可以共享 URL。

沟通

我们建议查看贡献指南,以全面了解如何开始,但简而言之:

许可

WeTransfer Swift SDK 在 MIT 许可下可用。 有关更多信息,请参阅 LICENSE 文件。

行为准则

期望在 WeTransfer Swift SDK 项目的代码库、问题跟踪器、聊天室和邮件列表中进行交互的每个人都遵守行为准则