Latest 0.1.0
Homepage https://github.com/Chris-Perkins/SwiftTwitch
License MIT
Platforms ios 8.0
Dependencies Marshal
Authors

SwiftTwitch

Version
License
Platform

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 Method Swift Function
Get Extension Analytics Twitch.Analytics.getExtensionAnalytics
Get Game Analytics Twitch.Analytics.getGameAnalytics
Get Bits Leaderboard Twitch.Bits.getBitsLeaderboard
Create Clip Twitch.Clips.createClip
Get Clips Twitch.Clips.getClips
Get Top Games Twitch.Games.getTopGames
Get Games Twitch.Games.getGames
Get Streams Twitch.Streams.getStreams
Get Streams Metadata Twitch.Streams.getStreamsMetadata
Create Stream Marker Twitch.Streams.createStreamMarker
Get Stream Markers Twitch.Streams.getStreamMarkers
Get Users Twitch.Users.getUsers
Get Users Follows Twitch.Users.getUsersFollows
Update User Twitch.Users.updateUser
Get User Extensions Twitch.Users.getUserExtensions
Get Videos Twitch.Videos.getVideos

Documentation

New Twitch API (Helix) Documentation

Swift Twitch Documentation

Example Usage

How to check if a user is following another user

“`Swift
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.”)
}
}
}
}

“`

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

I’m in the process of creating an pain-free way to retrieve tokens with a separate library! Feel free to email me at [email protected] and I’ll inform you when the library is public.

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"

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

I still have questions!

For Twitch Swift support, feel free to open up an issue. For API-based support, please visit The Twitch Developer Forums

Example Project

SwiftTwitch

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.

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!

License

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

Latest podspec

{
    "name": "SwiftTwitch",
    "version": "0.1.0",
    "summary": "Wrapper for the New Twitch API written in Swift.",
    "description": "SwiftTwitch allows for accessing the Twitch API is a typed, safe, and readable way. To view a propernusage document of SwiftTwitch, please view the GitHub README available here: https://github.com/[email protected]/SwiftTwitch.git",
    "homepage": "https://github.com/Chris-Perkins/SwiftTwitch",
    "license": {
        "type": "MIT",
        "file": "LICENSE"
    },
    "authors": {
        "[email protected]": "[email protected]"
    },
    "source": {
        "git": "https://github.com/Chris-Perkins/SwiftTwitch.git",
        "tag": "0.1.0"
    },
    "social_media_url": "https://www.linkedin.com/in/chrispperkins/",
    "platforms": {
        "ios": "8.0"
    },
    "source_files": "SwiftTwitch/Classes/**/*",
    "dependencies": {
        "Marshal": [
            "~> 1.2.7"
        ]
    },
    "swift_version": "4.2"
}

Pin It on Pinterest

Share This