Flutter自动聊天动作插件auto_chat_action的使用

概述

AutoChatAction 是一个用于 Televerse 的插件，Televerse 是一个基于 Dart 的 Telegram Bot API 库。该插件会根据调用的方法自动发送聊天动作，如 “正在输入…” 或 “正在上传照片…”。这一功能通过显示正在进行的机器人活动来增强用户体验。

安装

在你的项目中添加 auto_chat_action 包，使用 Dart 的包管理器：

dart pub add auto_chat_action

使用

使用 AutoChatAction 非常简单。首先，创建你的 Televerse 机器人类实例，如下所示：

final bot = Bot(Platform.environment["BOT_TOKEN"]!);

接下来，将 AutoChatAction 插件附加到机器人上。可以使用 Bot.use 方法来实现这一点：

void main() {
  bot.use(AutoChatAction());

  // 其余代码...
}

就是这样！只需一行代码即可完成。

现在，每次调用 sendVideo、sendDocument、sendSticker、sendVoice、sendMessage、sendLocation、sendVideoNote 和 sendPhoto 方法时，相应的聊天动作将自动发送给相应的终端用户。

仅在一个上下文中使用

如果你出于某种原因不希望为每个 API 调用都使用该插件，并且只想在特定上下文中应用它，可以使用 Context.use() 方法而不是 Bot.use() 方法来附加插件：

bot.command('test', (ctx) async {
  ctx.use(AutoChatAction());

  // 其余代码
});

配置

AutoChatAction 类可以通过以下属性进行自定义：

• allowedMethods: 一个允许发送聊天动作的 API 方法列表，默认包括：

  [
    APIMethod.sendVideo, 
    APIMethod.sendDocument, 
    APIMethod.sendSticker, 
    APIMethod.sendVoice, 
    APIMethod.sendMessage, 
    APIMethod.sendLocation, 
    APIMethod.sendVideoNote, 
    APIMethod.sendPhoto, 
  ]
  

• disallowedMethods: 一个不允许发送聊天动作的 API 方法列表，默认为空列表。

• interval: 重复发送聊天动作之间的持续时间，默认为 3 秒。

示例配置

const autoChatAction = AutoChatAction(
  allowedMethods: [APIMethod.sendMessage, APIMethod.sendPhoto],
  disallowedMethods: [APIMethod.sendVoice],
  interval: Duration(seconds: 5),
);

bot.use(autoChatAction);

在这个配置中，只有 sendMessage 和 sendPhoto 方法会自动发送聊天动作。sendVoice 方法被显式禁止，且两次动作之间的间隔设置为 5 秒。

完整示例

import 'dart:io';
import 'package:auto_chat_action/auto_chat_action.dart';
import 'package:televerse/televerse.dart';

final bot = Bot(Platform.environment["BOT_TOKEN"]!);

void main() {
  bot.use(AutoChatAction());

  final keyboard = Keyboard()
      .text("Photo")
      .text("Video")
      .row()
      .text("Voice")
      .text("Document")
      .resized();

  Future<void> startHandler(Context ctx) async {
    await ctx.reply(
      "Hello, choose a type of file from the buttons.",
      replyMarkup: keyboard,
    );
  }

  bot.command('start', startHandler);
  bot.onMessage(startHandler);

  bot.text("Voice", (ctx) async {
    await ctx.replyWithVoice(
      InputFile.fromUrl(getUrl("audio")),
      caption: thanks,
      parseMode: ParseMode.html,
    );
  });

  bot.text("Video", (ctx) async {
    await ctx.replyWithVideo(
      InputFile.fromUrl(getUrl("video")),
      caption: thanks,
      parseMode: ParseMode.html,
    );
  });

  bot.text("Photo", (ctx) async {
    await ctx.replyWithPhoto(
      InputFile.fromUrl(getUrl("photo")),
      caption: thanks,
      parseMode: ParseMode.html,
    );
  });

  bot.text("Document", (ctx) async {
    await ctx.replyWithDocument(
      InputFile.fromUrl(getUrl("document")),
      caption: thanks,
      parseMode: ParseMode.html,
    );
  });

  bot.start();
}

// 全局变量

const base = "https://televerse-space.web.app/";
const fileMap = {
  "video": "example/video.mp4",
  "audio": "example/audio.mp3",
  "document": "example/document.pdf",
  "photo": "example/photo.jpg",
};

const thanks =
    'Credits to <a href="https://file-examples.com/">File Examples</a> for the file.';
// 获取 URL 方法，指向托管的示例文件
String getUrl(String file) {
  return "$base${fileMap[file]}";
}

谢谢

感谢你使用 AutoChatAction！我们希望这个插件能提升你使用 Televerse 开发机器人的体验。如果你遇到任何问题或有建议，请自由地贡献或在 GitHub 仓库中提出问题。