此 SDK 让 Pixlee 客户易于将 Pixlee 专辑包含到其原生 iOS 应用中。它包含了一个对 Pixlee 专辑 API 的本地封装以及一些直接使用和可自定义的 UI 元素，以快速开始。

入门

此存储库包含 Pixlee iOS SDK 和一个示例项目，以展示如何使用它。

安装

pixlee-ios-sdk 通过 CocoaPods 提供。要安装它，只需将以下行添加到您的 Podfile 中

pod "pixlee-ios-sdk"

SDK

在访问 Pixlee API 之前，您必须初始化 PXLClient。要设置 API 密钥，请调用 [PXLClient sharedClient] 上的 setApiKey:。然后，您可以使用该单例实例来调用 Pixlee API。

要加载专辑中的照片，您想使用 PXLAlbum 类。通过调用 [PXLAlbum albumWithIdentifier:<ALBUM ID HERE>] 创建一个实例。然后，您可以根据需要设置 sortOptions 和 filterOptions（请参阅头文件以获取更多详细信息），然后调用 loadNextPageOfPhotos: 加载照片。专辑将分页加载其照片，并连续调用 loadNextPageOfPhotos: 将加载每个页面的照片。

此外，您可以使用 PXLAlbumFilterOptions 和 PXLAlbumSortOptions 来控制专辑加载数据的方式。要使用这些，请使用 [PXLAlbumFilterOptions new] 或 [PXLAlbumSortOptions new] 创建一个新实例，设置必要的属性，然后将这些对象设置为您专辑的 filterOptions 和 sortOptions 属性。确保在调用 loadNextPageOfPhotos: 之前设置这些。

专辑从服务器加载照片后，它将实例化 PXLPhoto 对象，这些对象可以用于您的 UI。PXLPhoto 暴露了 Pixlee API 中可用照片的所有数据，并提供了几种根据您需要选择的不同图像大小。

为了帮助您快速开始，我们还构建了一个专辑视图控制器和照片详情视图控制器，可以在您的应用程序中使用和自定义。 PXLAlbumViewController 使用 UICollectionView 来显示专辑中的照片，并包括一个开关来在网格视图和列表视图之间切换。如果需要通过其他方法创建实例，请使用 albumViewControllerWithAlbumId: 创建实例或设置 album 属性。一旦设置了专辑，您就可以调用 loadNextPageOfPhotos 来开始加载过程。专辑视图控制器被设置为在用户滚动时自动加载更多照片页面，从而实现无限滚动效果。

如果用户在 PXLAlbumViewController 中点击照片，我们将展示一个包含 PXLPhotoDetailViewController 的详细信息视图。您也可以通过实例化一个 PXLPhotoDetailViewController 的实例并设置其 photo 属性来自行展示详细信息视图。照片详情视图已配置为显示以下内容：

• 大照片
• 发帖人的用户名
• 显示照片发布时间的戳记
• 照片的平台来源（例如，Instagram）
• 照片的说明（如有）
• 与该照片关联的任何产品（以产品水平列表的形式显示）

示例

要运行示例项目，请先克隆仓库，然后从示例目录中运行 pod install。然后在 PXLAppDelegate.m 中将 PXLClientAPIKey 设置为您的API密钥（可在Pixlee仪表板中获取）。然后在 PXLExampleAlbumViewController.m 中设置您希望显示的专辑ID为 PXLAlbumIdentifier。运行项目后，您应该会看到一个该专辑照片的网格。

许可证

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