bumped to 0.1.0

CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.1.0] - 23/03/2021.
+
+* **Breaking Changes:** `getExtensionAnalytics`, `getGameAnalytics`, `getTopGames`, `searchChannels`, `getStreams` now returns an object of type `TwitchResponse`
+* Added and improved some comments for a better documentation
+
 ## [0.0.4] - 23/03/2021.
 
 * Added methods: `getStreams`, `searchChannels`
@@ -12,11 +17,11 @@
 
 ## [0.0.2] - 09/02/2021.
 
-* Added methods: `getUsers`,  `getGameAnalytics`
+* Added methods: `getUsers`, `getGameAnalytics`
 * Fixed issues with `getExtensionAnalytics` and `getGameAnalytics`
 * Improved comments and example file
 
 ## [0.0.1] - 08/02/2021.
 
-* First releas.
-* Added methods: `startCommercial`,   `getExtensionAnalytics`,  `getGameAnalytics`
+* First release
+* Added methods: `startCommercial`, `getExtensionAnalytics`, `getGameAnalytics`

example/lib/main.dart

@@ -3,8 +3,8 @@ import 'package:flutter/material.dart';
 import 'package:flutter_webview_plugin/flutter_webview_plugin.dart';
 import 'package:twitch_api/twitch_api.dart';
 
-const clientId = "<YOUR_CLIENT_ID>";
-const redirectUri = "http://localhost/";
+const clientId = "n9dgfacl10ivdy8vlr493qjavykdkn";
+const redirectUri = "http://localhost:8080/static.html";
 
 void main() {
   runApp(MyApp());

lib/src/client.dart

@@ -55,7 +55,7 @@ class TwitchClient {
 
   /// Method to initialize the token the first time after connection.
   ///
-  /// `twitchToken`: Token obtained with the first connection.
+  /// [twitchToken]: Token obtained with the first connection.
   void initializeToken(TwitchToken twitchToken) => _accessToken ??= twitchToken;
 
   Future<TwitchToken> validateToken() async {
@@ -156,9 +156,9 @@ class TwitchClient {
   ///
   /// Required scope: `TwitchApiScope.channelEditCommercial`
   ///
-  /// `broadcasterId`: ID of the channel requesting a commercial.
+  /// [broadcasterId]: ID of the channel requesting a commercial.
   ///
-  /// `length`: Desired length of the commercial in seconds. Valid options are
+  /// [length]: Desired length of the commercial in seconds. Valid options are
   /// `30, 60, 90, 120, 150, 180`.
   Future<List<TwitchStartCommercial>> startCommercial(
       String broadcasterId, int length) async {
@@ -179,42 +179,42 @@ class TwitchClient {
   /// (CSV files) for their Extensions. The URL is valid for 5 minutes.
   ///
   /// If you specify a future date, the response will be “Report Not Found For
-  /// Date Range.” If you leave both `startedAt` and `endedAt` blank, the API
+  /// Date Range.” If you leave both [startedAt] and [endedAt] blank, the API
   /// returns the most recent date of data.
   ///
   /// Required scope: `TwitchApiScope.analyticsReadExtensions`
   ///
-  /// `after`: Cursor for forward pagination: tells the server where to start
+  /// [after]: Cursor for forward pagination: tells the server where to start
   /// fetching the next set of results, in a multi-page response. This applies
-  /// only to queries without `extensionId`. If an `extensionId` is specified,
+  /// only to queries without [extensionId]. If an [extensionId] is specified,
   /// it supersedes any cursor/offset combinations. The cursor value specified
   /// here is from the `pagination` response field of a prior query.
   ///
-  /// `endedAt`: Ending date/time for returned reports, in RFC3339 format with
+  /// [endedAt]: Ending date/time for returned reports, in RFC3339 format with
   /// the hours, minutes, and seconds zeroed out and the UTC timezone:
   /// `YYYY-MM-DDT00:00:00Z`. The report covers the entire ending date; e.g., if
   /// `2018-05-01T00:00:00Z` is specified, the report covers up to
   /// `2018-05-01T23:59:59Z`.
-  /// If this is provided, `startedAt` also must be specified. If `endedAt` is
+  /// If this is provided, [startedAt] also must be specified. If [endedAt] is
   /// later than the default end date, the default date is used. Default: 1-2
   /// days before the request was issued (depending on report availability).
   ///
-  /// `extensionId`: Client ID value assigned to the extension when it is
+  /// [extensionId]: Client ID value assigned to the extension when it is
   /// created. If this is specified, the returned URL points to an analytics
   /// report for just the specified extension. If this is not specified, the
   /// response includes multiple URLs (paginated), pointing to separate
   /// analytics reports for each of the authenticated user’s Extensions.
   ///
-  /// `first`: Maximum number of objects to return. Maximum: 100. Default: 20.
+  /// [first]: Maximum number of objects to return. Maximum: 100. Default: 20.
   ///
-  /// `startedAt`: Starting date/time for returned reports, in RFC3339 format
+  /// [startedAt]: Starting date/time for returned reports, in RFC3339 format
   /// with the hours, minutes, and seconds zeroed out and the UTC timezone:
   /// `YYYY-MM-DDT00:00:00Z`. This must be on or after January 31, 2018.
-  /// If this is provided, `endedAt` also must be specified. If `startedAt` is
+  /// If this is provided, [endedAt] also must be specified. If [startedAt] is
   /// earlier than the default start date, the default date is used.
   /// The file contains one row of data per day.
   ///
-  /// `type`: Type of analytics report that is returned. Currently, this field
+  /// [type]: Type of analytics report that is returned. Currently, this field
   /// has no affect on the response as there is only one report type. If
   /// additional types were added, using this field would return only the URL
   /// for the specified report. Limit: 1. Valid values: `"overview_v2"`.

pubspec.yaml

@@ -1,7 +1,7 @@
 name: twitch_api
 description: A wrapper in pure Dart to connect to Twitch.tv using OAuth implicit
   authentication.
-version: 0.0.4
+version: 0.1.0
 homepage: https://github.com/TesteurManiak/twitch_api_flutter
 repository: https://github.com/TesteurManiak/twitch_api_flutter