Flutter非官方Twitch开放API集成插件unofficial_twitch_open_api的使用

Flutter非官方Twitch开放API集成插件unofficial_twitch_open_api的使用

本插件允许通过最新的Twitch API获取所有数据。

开始使用

为了使API正常工作，你需要在Twitch开发者控制台配置你的应用程序。如果你不知道如何操作，请遵循以下步骤：

1. 访问Twitch开发者控制台。
2. 注册一个新的应用程序，并获取client_id。
3. 配置应用程序以获取访问令牌（bearerToken）。

初始化插件

首先，你需要创建一个TwitchManagerOpenApi实例。可以通过provider或get_it来创建该实例。以下是一个例子：

/// 你可以通过provider或get_it来创建[UnofficialTwitchOpenApi]的实例。
/// 下面是一个示例：
List<SingleChildWidget> _initProvider() {
  String clientId = 'your_secret_client_id'; // 替换为你的client_id

  return [
    Provider<TwitchManagerOpenApi>(
      create: (ctx) => TwitchManagerOpenApi(
        clientId: clientId,
      ),
    ),
  ];
}

然后，你可以使用之前创建的实例来检索所需的子类：

T getInstance<T extends BaseTwitchOpenApi>() {
  final manager = Provider.of<TwitchManagerOpenApi>(context); // 获取当前上下文中的manager

  return manager.of<T>(bearerToken: 'your_secret_token'); // 使用bearerToken获取特定类型的实例
}

最后，使用这个实例。例如：

final channelInfo = getInstance<TwitchChannelInformation>(
  bearerToken: 'your_secret_token', // 替换为你的bearerToken
).getChannelInformation(broadcasterId: 'broadcaster_id'); // 替换为你要查询的broadcasterId

完整示例

下面是一个完整的示例，展示了如何使用该插件来获取频道信息并显示在界面上。

import 'package:flutter/material.dart';
import 'package:unofficial_twitch_open_api/channel_information/model/open_api_channel_information_response.dart';
import 'package:unofficial_twitch_open_api/channel_information/twitch_channel_information.dart';
import 'package:unofficial_twitch_open_api/twitch_manager_open_api.dart';

void main() {
  runApp(const AppExample());
}

class AppExample extends StatelessWidget {
  const AppExample({
    Key? key,
  }) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'unofficial_twitch_open_api Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const OpenApiExampleWidget(),
    );
  }
}

class OpenApiExampleWidget extends StatefulWidget {
  const OpenApiExampleWidget({Key? key}) : super(key: key);

  [@override](/user/override)
  _OpenApiExampleWidgetState createState() => _OpenApiExampleWidgetState();
}

class _OpenApiExampleWidgetState extends State<OpenApiExampleWidget> {
  TwitchManagerOpenApi? manager;
  List<ChannelInformationResult> infoResult = [];

  [@override](/user/override)
  void initState() {
    manager = TwitchManagerOpenApi(
      clientId: 'your_secret_client_id', // 替换为你的client_id
    );
    super.initState();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return SafeArea(
      child: Scaffold(
        body: Column(
          children: [
            ElevatedButton(
              onPressed: () async {
                final channelInfo = manager?.of<TwitchChannelInformation>(
                  bearerToken: 'your_secret_token', // 替换为你的bearerToken
                );

                final responseInfo = await channelInfo?.getChannelInformation(
                  broadcasterId: 'broadcaster_id', // 替换为你要查询的broadcasterId
                );

                setState(() {
                  infoResult = responseInfo?.result?.channelList ?? [];
                });
              },
              child: const Text('Get random info'),
            ),
            const SizedBox(height: 16),
            ListView.separated(
              separatorBuilder: (_, __) => const Divider(),
              itemBuilder: (_, index) => ChannelInfoWidget(
                infoResult[index],
              ),
              shrinkWrap: true,
              itemCount: infoResult.length,
            ),
          ],
        ),
      ),
    );
  }
}

class ChannelInfoWidget extends StatelessWidget {
  final ChannelInformationResult informationChannel;

  const ChannelInfoWidget(
    this.informationChannel, {
    Key? key,
  }) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Column(
      children: [
        Text(informationChannel.title ?? ''), // 显示频道标题
        const SizedBox(height: 2),
        Text(informationChannel.gameName ?? ''), // 显示游戏名称
        const SizedBox(height: 2),
        Text(informationChannel.broadcasterLanguage ?? ''), // 显示语言
      ],
    );
  }
}