Flutter Telegram贴纸导入插件telegram_stickers_import的使用

Flutter Telegram贴纸导入插件telegram_stickers_import的使用

TelegramStickersImport 是一个帮助用户将第三方程序生成的贴纸集导入到 Telegram Messenger 的 Flutter 插件。该插件支持 iOS 和 Android 平台。

请注意，这并不是官方插件！

请阅读完整的文档：Telegram 官方文档

警告：

每次用户导入贴纸时，都会在 Telegram 上创建一个新的贴纸包。不要 使用导入功能来与他人分享你自己制作的贴纸。如果你想要分享你的贴纸，只需上传它们并使用 @stickers 分享你的包链接。例如，这是安装一些 Duck Stickers 的链接。

安装

在 pubspec.yaml 文件中添加 telegram_stickers_import 依赖：

dependencies:
  telegram_stickers_import: ^latest_version

Android

无需特殊安装步骤。

iOS

在 Info.plist 文件中配置 LSApplicationQueriesSchemes 键，添加以下代码片段：

<key>LSApplicationQueriesSchemes</key>
<array>
  <string>tg</string>
</array>

使用

要将一个贴纸集导入 Telegram，首先创建一个贴纸集并导入它：

final stickerSet = StickerSet(
  software: "My app",
  isAnimated: true,
  stickers: stickers,
);

TelegramStickersImport.import(stickerSet);

Android

对于 Android，需要使用 StickerData.android 方法来创建贴纸数据。

要从 Android 导入贴纸，需要构建正确的文件路径。最简单的方法是将必要的文件放入 telegram_stickers_import 文件夹内的缓存目录。

可以通过调用 path_provider 插件的 getTemporaryDirectory() 方法获取缓存文件夹路径。之后，只需将贴纸文件添加到缓存目录内的 telegram_stickers_import 文件夹中。

所有必要的设置都已由插件完成，Telegram 将能够无问题地接收您的贴纸。

如果需要使用其他路径，请务必检查如何正确地在应用程序之间共享文件：Android 文件共享设置

iOS

对于 iOS，需要使用 StickerData.iOS 方法来创建贴纸数据。

要从 iOS 应用程序导入贴纸，只需将贴纸内容写入 Uint8List。

示例代码

以下是完整的示例代码，演示如何在 Flutter 中使用 telegram_stickers_import 插件：

import 'dart:async';
import 'dart:io';

import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:path_provider/path_provider.dart';
import 'package:telegram_stickers_import/sticker.dart';
import 'package:telegram_stickers_import/sticker_data.dart';
import 'package:telegram_stickers_import/sticker_set.dart';
import 'package:telegram_stickers_import/telegram_stickers_import.dart';

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

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

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final _stickerNames = [
    'sticker1.webp',
    'sticker2.webp',
    'sticker3.webp',
    'sticker4.webp',
    'sticker5.webp',
    'sticker6.webp',
    'sticker7.webp',
    'sticker8.webp',
    'sticker9.webp'
  ];
  final _animatedStickerNames = [
    'a_sticker1.tgs',
    'a_sticker2.tgs',
    'a_sticker3.tgs',
    'a_sticker4.tgs',
    'a_sticker5.tgs',
    'a_sticker6.tgs',
    'a_sticker7.tgs',
    'a_sticker8.tgs',
    'a_sticker9.tgs',
  ];

  final Completer _assetsCompleter = Completer();

  [@override](/user/override)
  void initState() {
    super.initState();
    _copyAssets().then((value) => _assetsCompleter.complete());
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: _appBar(),
        body: _body(),
      ),
    );
  }

  AppBar _appBar() {
    return AppBar(title: const Text('Plugin example app'));
  }

  Widget _body() {
    return Center(
      child: Column(
        mainAxisAlignment: MainAxisAlignment.center,
        children: [
          _importButton(),
          const SizedBox(height: 50),
          _importAnimatedButton(),
        ],
      ),
    );
  }

  Widget _importButton() {
    return ElevatedButton(
      onPressed: _onImportPressed,
      child: const Text("Import"),
    );
  }

  Widget _importAnimatedButton() {
    return ElevatedButton(
      onPressed: _onImportAnimatedPressed,
      child: const Text("Import animated"),
    );
  }

  Future<void> _onImportPressed() async {
    debugPrint("On import pressed");
    await _assetsCompleter.future;

    final stickers = [
      Sticker(
        emojis: ["☺️"],
        data: await _stickerData(_stickerNames[0]),
      ),
      Sticker(
        emojis: ["\uD83D\uDE22"],
        data: await _stickerData(_stickerNames[1]),
      ),
      // ... 其他贴纸
      Sticker(
        emojis: ["☺️"],
        data: await _stickerData(_stickerNames[8]),
      ),
    ];

    final set = StickerSet(
      software: "My app",
      isAnimated: false,
      stickers: stickers,
    );

    await TelegramStickersImport.import(set);
  }

  Future<void> _onImportAnimatedPressed() async {
    debugPrint("On import animated pressed");

    final stickers = [
      Sticker(
        emojis: ["☺️"],
        data: await _stickerData(_animatedStickerNames[0]),
      ),
      Sticker(
        emojis: ["\uD83D\uDE22"],
        data: await _stickerData(_animatedStickerNames[1]),
      ),
      // ... 其他贴纸
      Sticker(
        emojis: ["☺️"],
        data: await _stickerData(_animatedStickerNames[8]),
      ),
    ];

    final stickerSet = StickerSet(
      software: "My app",
      isAnimated: true,
      stickers: stickers,
    );

    await TelegramStickersImport.import(stickerSet);
  }

  Future<void> _copyAssets() async {
    if (defaultTargetPlatform == TargetPlatform.android) {
      final directory = await getTemporaryDirectory();
      final names = <String>{};
      names.addAll(_stickerNames);
      names.addAll(_animatedStickerNames);
      for (final name in names) {
        ByteData data = await rootBundle.load("assets/$name");
        List<int> bytes = data.buffer.asUint8List(
          data.offsetInBytes,
          data.lengthInBytes,
        );
        Directory(
          "${directory.path}/${TelegramStickersImport.androidImportFolderName}",
        ).createSync();
        await File(
          "${directory.path}/${TelegramStickersImport.androidImportFolderName}/$name",
        ).writeAsBytes(bytes);
      }
    }
  }

  Future<StickerData> _stickerData(String name) async {
    if (defaultTargetPlatform == TargetPlatform.android) {
      final directory = await getTemporaryDirectory();
      return StickerData.android(
          "${directory.path}/${TelegramStickersImport.androidImportFolderName}/$name");
    } else {
      ByteData data = await rootBundle.load("assets/$name");
      return StickerData.iOS(
        data.buffer.asUint8List(data.offsetInBytes, data.lengthInBytes),
      );
    }
  }
}