SwiftTwitch 0.1.0

SwiftTwitch 0.1.0

×

由Chris Perkins维护。

SwiftTwitch 0.1.0

Version License Platform

这是一个非官方的粉丝制作的包装器。它以任何方式得到Twitch.TV的认可

是什么？

Swift Twitch是一个库，旨在用于面向客户端的应用程序与新的Twitch API Helix的交互。这个库旨在通过返回类型数据值来简化API交互，帮助您完成应用程序而无需头痛。例如，在执行非空的获取视频调用后，您可以执行以下操作

let firstVideoData: VideoData = getVideosData.videoData.first!
let title: String = firstVideoData.title
let viewCount: Int = firstVideoData.viewCount

❤️非常欢迎pull requests❤️

可用的API调用

您可以运行以下API调用

API方法 Swift函数
获取扩展分析 Twitch.Analytics.getExtensionAnalytics
获取游戏分析 Twitch.Analytics.getGameAnalytics
获取Bits排行榜 Twitch.Bits.getBitsLeaderboard
创建剪辑 Twitch.Clips.createClip
获取剪辑 Twitch.Clips.getClips
获取顶级游戏 Twitch.Games.getTopGames
获取游戏 Twitch.Games.getGames
获取直播 Twitch.Streams.getStreams
获取直播元数据 Twitch.Streams.getStreamsMetadata
创建直播标记 Twitch.Streams.createStreamMarker
获取直播标记 Twitch.Streams.getStreamMarkers
获取用户 Twitch.Users.getUsers
获取用户关注者 Twitch.Users.getUsersFollows
更新用户 Twitch.Users.updateUser
获取用户扩展 Twitch.Users.getUserExtensions
获取视频 Twitch.Videos.getVideos

文档

新Twitch API (Helix) 文档

Swift Twitch 文档

示例用法

如何检查一个用户是否在关注另一个用户 
import SwiftTwitch

class AwesomeClass {
    func spectacularFunction() {
        TwitchTokenManager.shared.accessToken = "$SomeValidToken"

        let user1Id = "1234"
        let user2Id = "5678"
        Twitch.Users.getUsersFollows(followerId: user1Id, followedId: user2Id) { result in 
            switch result {
            case .success(let getUsersFollowsData):
                /* If the total = 1, we know that user1 is following user2 
                   as it is documented in the Twitch API docs. */
                if getUsersFollowsData.total == 1 {
                    print("User \(user1Id) is following user \(user2Id)!")
                } else {
                    print("User \(user1Id) is not following user \(user2Id)")
                }
            case .failure(let data, let response, let error):
                print("The API call failed! Unable to determine relationship.")
            }
        }
    }
}

开始使用

我没有访问令牌！

为了使用这个库，您必须首先在Twitch开发者门户上注册一个应用。您可以在Twitch官方的应用创建控制台中快速注册您的应用https://glass.twitch.tv/console/apps/create。完成此步骤后，有两种方法可以检索API密钥。

手动检索访问令牌

要手动检索访问令牌，请使用Twitch提供的此指南。

自动检索访问令牌

我在努力创建一个使用独立库轻松检索令牌的无痛方式！您可以随时通过电子邮件联系我[email protected]，我会通知您库何时公开。

我有访问令牌了，接下来怎么做？

现在您的访问令牌准备好了，您可以通过以下方式进行提供

TwitchTokenManager.shared.accessToken = "$Your_Token"

运行此命令后，所有的API调用现在都能自动验证！现在去调用一些API。：）

我还有问题！

对于Twitch Swift支持，请随意提交问题。对于基于API的支持，请访问Twitch开发者论坛

示例项目

要运行示例项目，请克隆仓库，然后从示例目录运行pod install。之后，打开生成的.xcworkspace文件，尽情地使用吧！

示例项目是一个简单的用于Twitch预选定用户的视频浏览器。为了正确运行示例项目，您需要一个访问令牌。在TwitchVideosTableViewController的viewDidLoad方法中设置此访问令牌。

安装

  1. 安装CocoaPods

  2. 将此仓库添加到您的Podfile

    target 'Example' do
	# IMPORTANT: Make sure use_frameworks! is included at the top of the file
	use_frameworks!

	pod 'SwiftTwitch'
end

  3. 在终端中从podfile目录运行pod install

  4. 打开CocoaPods创建的.xcworkspace

  5. 完成！

许可协议

SwiftTwitch遵循MIT许可协议。有关更多信息，请参阅LICENSE文件。