swift-pocket

Pocket API 的 Swift 库。

用法

在使用 API 之前，你需要获取一个 consumer key。你可以通过创建一个新的 Pocket 实例并传入你的 consumer key 来开始使用该软件包

let pocket = Pocket(consumerKey: "...")

授权

该实例需要通过用户账户进行身份验证。这通过浏览器中用户的同意来完成。

  1. 获取一个请求令牌，稍后你可以使用它来获取你的访问令牌。
  2. 监听你提供的重定向 URL，以留意用户何时已授予授权。
  3. 引导用户访问授权 URL。
  4. 你可以获取你的访问令牌。
// (1)
let requestToken = try await pocket.obtainRequestToken(forRedirectingTo: redirectUrl)
// (2)
// Listen on your redirectUrl, e.g. "https://:44444/callback" using a local webserver
// (3)
let authorizationUrl = pocket.buildAuthorizationUrl(for: requestToken, redirectingTo: redirectUrl)
// (4)
let accessToken = try await pocket.obtainAccessToken(for: requestToken)

使用该实例，你可以对 API 调用操作。

保存访问令牌以供将来使用

你可以从 accessToken 属性中检索访问令牌。使用它来保存和恢复令牌以供将来使用。

向队列添加项目

let parameters = Pocket.AddParameters(url: url)
// add parameters by configuring the AddParameters object
try await pocket.add(item: parameters)

从队列中检索项目

let parameters = Pocket.RetrieveParameters()
// change filter options by configuring the RetrieveParameters object
let items = try await pocket.retrieve(with: parameters)

从队列中归档项目

let itemId = 123
try await pocket.archive(itemIds: [itemId])

安装

使用 Swift Package Manager，将此行添加到你的 Package.swift 文件中作为依赖项

    .package(url: "https://github.com/sgade/swift-pocket", from: "1.0.0"),

许可证

请参阅 LICENSE 文件。