Flutter文本解析模式设置插件parse_mode_setter的使用

ParseModeSetter for Televerse

Overview

通过使用ParseModeSetter插件，可以简化你的Televerse机器人开发。ParseModeSetter是一个Transformer插件，它自动化了各种API方法的解析模式设置。这确保了消息格式的一致性，无需每次手动指定解析模式。它简化了你的代码并节省了宝贵的时间。

安装

1. 使用Dart的包管理器将parse_mode_setter包添加到你的项目中：

dart pub add parse_mode_setter

使用

示例

以下是一个代码片段，展示了如何将ParseModeSetter与你的Televerse机器人集成：

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

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

void main(List<String> args) {
  // 将ParseModeSetter附加到bot上，并设置解析模式为HTML。
  bot.use(ParseModeSetter(ParseMode.html));

  bot.command('start', (ctx) async {
    // 在方法中使用HTML格式化文本，无需担心解析模式。
    await ctx.reply(
      "Hello <b>World</b>\n\nThis is a <i>great story of the Detective Rajappan</i>. I hope you've heard of Rajappan. Well, if you haven't, he's a <tg-spoiler>super detective.</tg-spoiler>",
    );
  });

  bot.start();
}

配置

你可以通过以下属性自定义ParseModeSetter类：

• allowedMethods: 允许设置解析模式的API方法列表。默认值为：

  [
    APIMethod.sendMessage,
    APIMethod.copyMessage,
    APIMethod.sendPhoto,
    APIMethod.sendAudio,
    APIMethod.sendDocument,
    APIMethod.sendVideo,
    APIMethod.sendAnimation,
    APIMethod.sendVoice,
    APIMethod.sendPoll,
    APIMethod.editMessageText,
    APIMethod.editMessageCaption,
    APIMethod.answerInlineQuery,
    APIMethod.editMessageMedia,
    APIMethod.sendMediaGroup,
  ],
  

• disallowedMethods: 不允许设置解析模式的API方法列表。默认为空列表。
• setQuestionParseMode: 布尔值，表示是否为投票问题设置解析模式。默认为true。
• setExplanationParseMode: 布尔值，表示是否为投票解释设置解析模式。默认为true。

示例配置

final parseModeSetter = ParseModeSetter(
  ParseMode.markdown,
  allowedMethods: [APIMethod.sendMessage, APIMethod.sendPhoto],
  disallowedMethods: [APIMethod.sendVoice],
  setQuestionParseMode: true,
  setExplanationParseMode: false,
);

bot.use(parseModeSetter);

在这个配置中：

• 解析模式被设置为Markdown用于sendMessage和sendPhoto方法。
• 解析模式明确不设置用于sendVoice方法。
• 解析模式设置用于投票问题但不用于投票解释。

理解解析模式

Telegram Bot API支持基本的消息格式化，包括加粗、斜体、下划线、删除线、隐藏文字、引用块、内联链接和预格式化代码。Telegram客户端会相应地渲染这些样式。你可以在文本中直接指定这些实体或使用Markdown风格或HTML风格的格式化。

贡献

我们非常感谢你对ParseModeSetter的兴趣！如果你发现它很有用，请考虑给仓库点星。如果你有任何问题或建议，欢迎在GitHub上报告或提出。

开始使用Televerse

有关Televerse（本插件使用的Telegram Bot API库）的更多信息，请访问其官方仓库。

感谢使用ParseModeSetter！希望它能简化你的Televerse机器人开发体验。

示例代码

import 'dart:io';

import 'package:parse_mode_setter/parse_mode_setter.dart';
import 'package:televerse/telegram.dart';
import 'package:televerse/televerse.dart';

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

void main(List<String> args) {
  // 附加Parse Mode Setter并传递必要的参数。
  // 这里我们将解析模式设置为HTML。
  bot.use(ParseModeSetter(ParseMode.html));

  bot.command('start', (ctx) async {
    // 现在可以在方法中使用HTML文本，不必担心不传递解析模式
    await ctx.reply(htmlText());
  });

  bot.onInlineQuery((ctx) async {
    final results = InlineQueryResultBuilder().article(
      "test-id",
      "Hello",
      (content) => content.text(htmlText()),
    );
    await ctx.answerInlineQuery(results.build());
  });

  bot.command('group', (ctx) async {
    await ctx.replyWithMediaGroup([
      InputMediaPhoto(
        media: InputFile.fromUrl(
          "https://televerse-space.web.app/example/photo.jpg",
        ),
        caption: htmlText(),
      ),
      InputMediaPhoto(
        media: InputFile.fromUrl(
          "https://televerse-space.web.app/example/photo.jpg",
        ),
      ),
    ]);
  });

  bot.start();
}

String htmlText() {
  return """<b>bold</b>, <strong>bold</strong>
<i>italic</i>, <em>italic</em>
<u>underline</u>, <ins>underline</ins>
<s>strikethrough</s>, <strike>strikethrough</strike>, <del>strikethrough</del>
<span class="tg-spoiler">spoiler</span>, <tg-spoiler>spoiler</tg-spoiler>
<b>bold <i>italic bold <s>italic bold strikethrough <span class="tg-spoiler">italic bold strikethrough spoiler</span></s> <u>underline italic bold</u></i> bold</b>
<a href="http://www.example.com/">inline URL</a>
<a href="tg://user?id=123456789">inline mention of a user</a>
<tg-emoji emoji-id="5368324170671202286">👍</tg-emoji>
<code>inline fixed-width code</code>
<pre>pre-formatted fixed-width code block</pre>
<pre><code class="language-python">pre-formatted fixed-width code block written in the Python programming language</code></pre>
<blockquote>Block quotation started
Block quotation continued
The last line of the block quotation</blockquote>
<blockquote expandable>Expandable block quotation started
Expandable block quotation continued
Expandable block quotation continued
Hidden by default part of the block quotation started
Expandable block quotation continued
The last line of the block quotation</blockquote>""";
}