搜索插件、代码仓与 APP 分类

插件详情v0.7.0

twitch_api

一个纯 Dart 编写的包装器,用于通过 OAuth 隐式认证连接到 Twitch.tv。

AndroidiOSWebmacOSWindowsLinux
近 30 天下载
51
喜欢数
21
Pub 分数
150

安装插件

flutter pub add twitch_api

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

一个纯 Dart 包,提供用于通过 OAuth 隐式认证连接到 Twitch.tv API 的包装器。它简化了与 Twitch 服务的集成,使开发者能够认证用户并访问公开数据,如流媒体、频道和用户信息。该包支持多种平台,包括 Android、iOS、Web、macOS、Windows 和 Linux,非常适合跨平台应用。设计上注重易用性,处理了 OAuth 流程的复杂性,同时保持安全性,并与 Twitch 当前的认证标准兼容。

适合场景

  • 集成 Twitch 登录功能
  • 获取实时流数据
  • 访问用户和频道信息
  • 构建基于 Twitch 的社交应用
  • 为主播创建仪表板

主要特点

  • OAuth 隐式认证
  • 跨平台支持
  • 纯 Dart 实现
  • 简单 API 接口
  • 安全的令牌处理

适合对象

  • 需要 Twitch 集成的 Flutter 应用
  • 流监控工具
  • Twitch 社区平台
  • Twitch内容开发工具
  • 跨平台应用程序

使用建议

  • 需要正确的 Twitch 应用注册
  • 仅限 OAuth 隐式流程
  • 取决于 Twitch API 的速率限制
  • 需要仔细处理刷新令牌
  • 不适用于服务器端操作

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

twitch_api

Dart Pub Coverage Status style: lint

A wrapper in pure Dart to connect to Twitch.tv using OAuth implicit authentication.

All the endpoints are implemented as defined in the Twitch API Reference

Getting started

NOTE: This package is in its early stage, please be patient until more methods are implemented or do not hesitate to open a merge request if you added support for an endpoint. Currently I do not have a roadmap of the endpoint I am going to add in priority so do not hesitate to open an issue to make suggestions depending of your needs.

To use this package you will need to register an application on the Twitch developer console to get a client ID.

After registering your application you will need to instantiate the TwitchClient class from the package with your clientId and your redirectUri .

import 'package:twitch_api/twitch_api.dart';

final _twitchClient = TwitchClient(
  clientId: clientId,
  redirectUri: redirectUri,
);

Now that you have initialized the client the last step before using the method will be to manage the first connection with your twitch account and initialize the token you will receive. You can find a complete example of an implementation using the package flutter_webview_plugin.

const clientId = "<YOUR_CLIENT_ID>";
const redirectUri = "<YOUR_REDIRECT_URL>"; // ex: "http://localhost/"

final _twitchClient = TwitchClient(
  clientId: clientId,
  redirectUri: redirectUri,
);

final _flutterWebviewPlugin = FlutterWebviewPlugin();

// First authentication through a webview
Future<TwitchToken> _openConnectionPage({
  List<TwitchApiScope> scopes = const [],
}) {
  // Listen for url changes to detect redirection on our redirectUri.
  _flutterWebviewPlugin.onUrlChanged.listen((url) {
    if (url.startsWith(_twitchClient.redirectUri)) {
      // After you got to your redirectUri you can initialize the token.
      _twitchClient.initializeToken(TwitchToken.fromUrl(url));

      // Close the webview
      _flutterWebviewPlugin.close();
    }
  });

  // When the webview is closed pop the current route.
  _flutterWebviewPlugin.onDestroy.listen((_) => Navigator.pop(context));

  // Get authorization URL for the connection with the webview.
  final _url = _twitchClient.authorizeUri(scopes);

  return Navigator.push(
    context,
    MaterialPageRoute(
      builder: (context) => WebViewPage(_url.toString()),
    ),
  ).then((_) => _twitchClient.twitchHttpClient.validateToken());
}

Now you are ready to use the methods implemented in Supported Endpoints section.

Supported Endpoints

Ads
  • [x] Start Commercial
Analytics
  • [x] Get Extension Analytics
  • [x] Get Game Analytics (Documentation in progress)
Bits
  • [x] Get Bits Leaderboard
  • [x] Get Cheermotes
  • [x] Get Extension Transactions
Channels
  • [x] Get Channel Information
  • [x] Modify Channel Information
  • [x] Get Channel Editors
Channel Points
  • [x] Create Custom Rewards
  • [x] Delete Custom Reward
  • [x] Get Custom Reward
  • [x] Get Custom Reward Redemption
  • [x] Update Custom Reward
  • [x] Update Redemption Status
Chat
  • [x] Get Channel Emotes
  • [x] Get Global Emotes
  • [x] Get Emote Sets
  • [x] Get Channel Chat Badges
  • [x] Get Global Chat Badges
  • [x] Get Chat Settings
  • [ ] Update Chat Settings
Clips
  • [x] Create Clip
  • [x] Get Clips
Entitlements
  • [ ] Create Entitlement Grants Upload URL
  • [ ] Get Code Status
  • [ ] Get Drops Entitlements
  • [ ] Redeem Code
Extensions
  • [ ] Get Extension Configuration Segment
  • [ ] Set Extension Configuration Segment
  • [ ] Set Extension Required Configuration
  • [ ] Send Extension PubSub Message
  • [ ] Get Live Channels
  • [ ] Get Extension Secrets
  • [ ] Create Extension Secret
  • [ ] Send Extension Chat Message
  • [ ] Get Extensions
  • [ ] Get Released Extensions
  • [ ] Get Extension Bits Products
  • [ ] Update Extension Bits Product
EventSub
  • [ ] Create EventSub Subscription
  • [ ] Delete EventSub Subscription
  • [ ] Get EventSub Subscriptions
Games
  • [x] Get Top Games
  • [x] Get Games
Hype Train
  • [ ] Get Hype Train Events
Moderation
  • [ ] Check AutoMod Status
  • [ ] Get Banned Events
  • [ ] Get Banned Users
  • [ ] Get Moderators
  • [ ] Get Moderator Events
Polls
  • [ ] Get Polls
  • [ ] Create Poll
  • [ ] End Poll
Predictions
  • [ ] Get Predictions
  • [ ] Create Prediction
  • [ ] End Prediction
Schedule
  • [ ] Get Channel Stream Schedule
  • [ ] Get Channel iCalendar
  • [ ] Update Channel Stream Schedule
  • [ ] Create Channel Stream Schedule Segment
  • [ ] Update Channel Stream Schedule Segment
  • [ ] Delete Channel Stream Schedule Segment
Search
  • [x] Search Categories
  • [x] Search Channels
Streams
  • [ ] Get Stream Key
  • [x] Get Streams
  • [ ] Create Stream Marker
  • [ ] Get Stream Markers
Subscriptions
  • [x] Get Broadcaster Subscriptions
Tags
  • [ ] Get All Stream Tags
  • [ ] Get Stream Tags
  • [ ] Replace Stream Tags
Users
  • [x] Get Users
  • [ ] Update User
  • [x] Get Users Follows
  • [ ] Create User Follows
  • [ ] Delete User Follows
  • [ ] Get User Block List
  • [ ] Block User
  • [ ] Unblock User
  • [ ] Get User Extensions
  • [ ] Get User Active Extensions
  • [ ] Update User Extensions
Videos
  • [ ] Get Videos
  • [ ] Delete Videos
Webhooks
  • [ ] Get Webhook Subscriptions

Contributors

TesteurManiak
Guillaume Roux
matteo0158
LaCremeDoree
LewisHolliday
Lewis Holliday

所属分类

依赖

依赖清单 3 项

源码仓库

使用此插件的项目

暂无相关数据。