Flutter插件teledart_app的使用

Flutter插件teledart_app的使用

teledart_app 是一个基于 teledart 构建的 API，旨在简化命令和回调的处理。通过继承自 Command 类或 ComplexCommand 类，可以轻松地创建具有复杂逻辑的命令。

目的

此 API 应用于构建交互式机器人，可以根据用户的输入（命令、纯文本或按钮点击）执行不同的操作。

基本用法

以下是使用 teledart_app 的基本步骤：

1. 创建一个新的命令类，继承自 Command 类。
2. 创建应用类，继承自 TeledartApp 类。
3. 在应用类中注册命令。
4. 运行应用。
5. 测试命令。

步骤1: 创建新的命令类

class ExampleCommand extends Command {
  // 获取命令解析器，此处返回null表示没有参数
  [@override](/user/override)
  ArgParser? getParser() => null;

  // 获取命令名称
  [@override](/user/override)
  String get name => 'example';

  // 处理命令
  [@override](/user/override)
  void run(Message message, TelegramEx telegram) {
    // 发送消息
    telegram.sendMessage(message.chat.id, 'Hello, World!');
  }
}

步骤2: 创建应用类

class ExampleApp extends TeledartApp {
  ExampleApp(String token) : super(token);

  // 注册命令
  [@override](/user/override)
  List<CommandConstructor> get commands => [() => ExampleCommand()];

  // 获取中间件
  [@override](/user/override)
  List<MiddleWareConstructor> get middleware => [];

  // 错误处理
  [@override](/user/override)
  void onError(Object exception, Update data, TelegramEx telegram) {
    print('Hello, Error!');
  }
}

步骤3: 在应用类中注册命令

[@override](/user/override)
List<CommandConstructor> get commands => [() => ExampleCommand()];

步骤4: 运行应用

void main() {
  final app = ExampleApp('bot key here');
  app.run();
}

步骤5: 测试命令

在与机器人的对话中输入 /example，应该会收到回复 Hello, World!。

处理多动作命令

如果需要在一个命令中处理多个动作，可以使用 ComplexCommand 类。

创建一个复杂的命令

class ExampleComplexCommand extends ComplexCommand {
  [@override](/user/override)
  String get name => 'complex';

  // 定义动作映射
  [@override](/user/override)
  Map<String, CmdAction> get actionMap => {
        'first': onFirstButton,
        'second': onSecondButton
      };

  // 如果没有指定动作时的默认处理函数
  [@override](/user/override)
  void onNoAction(Message message, TelegramEx telegram) {
    telegram.sendMessage(message.chat.id, 'onNoAction function',
        reply_markup: InlineKeyboardMarkup(inline_keyboard: [
          [
            InlineKeyboardButton(
                text: 'onFirstButton call', callback_data: buildAction('first'))
          ],
          [
            InlineKeyboardButton(
                text: 'onSecondButton call', callback_data: buildAction('second'))
          ]
        ]));
  }

  // 处理第一个按钮的动作
  void onFirstButton(Message message, TelegramEx telegram) {
    telegram.sendMessage(message.chat.id, 'onFirstButton pressed!');
  }

  // 处理第二个按钮的动作
  void onSecondButton(Message message, TelegramEx telegram) {
    telegram.sendMessage(message.chat.id, 'onSecondButton pressed!');
  }
}

使用命令参数

如果需要使用额外的参数，可以通过 ArgParser 来定义参数，并在动作函数中访问这些参数。

[@override](/user/override)
ArgParser getParser() => super.getParser()..addOption('param1')..addOption('param2');

// 定义新动作
'with-parameters': onButtonWithParameters,

// 实现新动作函数
void onButtonWithParameters(Message message, TelegramEx telegram) {
  final txtParameters = 'param1: ' +
      arguments?['param1'] +
      '\r\n' +
      'param2: ' +
      arguments?['param2'] +
      '\r\n';
  telegram.sendMessage(
      message.chat.id,
      'onButtonWithParameters pressed!\r\n'
              'parameters are:\r\n' +
          txtParameters);
}