swi

SwiftTwitch

👾 The New Twitch API for iOS; wrapped in Swift goodness 👾

Showing:

Popularity

Downloads/wk

0

GitHub Stars

78

Maintenance

Last Commit

1yr ago

Contributors

6

Package

Dependencies

1

License

MIT

Categories

Readme

Version License Platform Discord

THIS IS AN UNOFFICIAL, FAN-MADE WRAPPER. IT IS IN NO WAY ENDORSED BY TWITCH.TV

What is It?

Swift Twitch is a library intended for client-facing applications interaction with the New Twitch API, Helix. This library aims to ease API interaction by returning typed data values to help you finish your application without headaches. For example, after a non-empty Get Videos call, you can do the following:

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

❤️ Pull requests are very welcome ❤️

Available API Calls

You can run the following API calls:

API MethodSwift Function
Get Extension AnalyticsTwitch.Analytics.getExtensionAnalytics
Get Game AnalyticsTwitch.Analytics.getGameAnalytics
Get Bits LeaderboardTwitch.Bits.getBitsLeaderboard
Create ClipTwitch.Clips.createClip
Get ClipsTwitch.Clips.getClips
Get Top GamesTwitch.Games.getTopGames
Get GamesTwitch.Games.getGames
Get StreamsTwitch.Streams.getStreams
Get Streams MetadataTwitch.Streams.getStreamsMetadata
Create Stream MarkerTwitch.Streams.createStreamMarker
Get Stream MarkersTwitch.Streams.getStreamMarkers
Get UsersTwitch.Users.getUsers
Get Users FollowsTwitch.Users.getUsersFollows
Update UserTwitch.Users.updateUser
Get User ExtensionsTwitch.Users.getUserExtensions
Get VideosTwitch.Videos.getVideos

Documentation

New Twitch API (Helix) Documentation

Swift Twitch Documentation

  • If the above link is not working, clone this repo and open docs/index.html

Example Usage

How to check if a user is following another user
import SwiftTwitch

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

        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.")
            }
        }
    }
}

Get Started

I don't have an access token!

In order to use this library, you must first have an application register on the Twitch Developer portal. You can register your application quickly on Twitch's official application creation dashboard. After this step, there are two methods to retrieving API keys.

Manually Retrieve Access Token

To manually retrieve an access token, please utilize this guide by Twitch.

Automatically Retrieve Access Token

If you need an access token generated by the user, you have a few options:

  1. Create a custom OAuth token retriever. This can be done using Web Views to the OAuth token portal.
  2. Use a library to do it for you! There's a few OAuth libraries out there.
    1. OAuthSwift
    2. OAuth2

I have my access token, now what?

Now that you have an access token, you can provide it to the application in the following manner:

TwitchTokenManager.shared.accessToken = "$Your_Token"
TwitchTokenManager.shared.clientID = "$Client_ID_Used_To_Get_Token"

Once this command is run, all of your API calls are now automatically authenticated! Now go make some API calls. :)

I want to embed a Twitch Stream/Clip/Video in my app!

I made a separate library for that! Please see TwitchPlayer!

I still have questions!

For Twitch Swift support, feel free to open up an issue or email me at chris@chrisperkins.me. For API-based support, please visit The Twitch Developer Forums

Installation

  1. Install CocoaPods

  2. Add this repo to your Podfile

    target 'Example' do
        # IMPORTANT: Make sure use_frameworks! is included at the top of the file
        use_frameworks!
    
        pod 'SwiftTwitch'
    end
    
  3. Run pod install in the podfile directory from your terminal

  4. Open up the .xcworkspace that CocoaPods created

  5. Done!

Example Project

To run the example project, clone the repo, and run pod install from the Example directory. After that, open the resulting .xcworkspace file and go nuts!

The example project is a simple Videos browser for a pre-selected user on Twitch. To run the example project properly, you will need an access token. Set this access token in TwitchVideosTableViewController's viewDidLoad method.

Contributing

Thank you so much for wanting to contribute! There are a couple of things you can do if you want to help out the project.

Layout of helpful contributions
  • Helper functions for verbosity

    Examples:

    • getUserWithIDFollowers(_ userId: String) to get the users that are following the user
    • getUserWithIDFollowings(_ userId: String) to get the users that are being followed by the user

    Both of these functions are just wrapped around my pre-existing getUsersFollows method, but they make the code that uses them more explicit.

  • Additional Documentation

    • Some documentation regarding the Helix API in this library is lacking. It would be awesome to have someone go back and double-check the functions as they use the library.
  • Missing functions

  • Anything you think would be nice! I'll most likely agree with the user (you). 😊

License

SwiftTwitch is available under the MIT license. See the LICENSE file for more info.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100