Flutter未知功能插件vkdart的潜在用途探索

VkDart 插件概述

VkDart 是一个用于简化与VK API交互的Flutter插件。它提供了对事件的支持，包括Callback API和Longpoll API，并且易于使用，具有模型支持。以下是VkDart的一些关键特性：

• 可靠性：插件功能被单元测试覆盖。
• 支持事件：支持Callback API和Longpoll API。
• 开发中：功能在不断扩展和完善。
• 易于使用：非常容易上手。
• 模型支持：包含事件、附件和对象模型的描述。

更多关于VkDart的信息可以查看官方文档或加入讨论群组。

使用示例

初始化

import 'package:vkdart/vkdart.dart';

void main() async {
  final TOKEN = 'your_access_token';
  final GROUP_ID = 123456;

  final myFetcher = Longpoll(GROUP_ID); // 或者 Webhook (CallbackAPI).
  final vkdart = VkDart(TOKEN, fetcher: myFetcher);

  vkdart.start();
}

使用API

await vkdart.request('groups.getById', {'group_id': 1}); // List<Map<String, dynamic>>

处理事件

VkDart 提供了多种事件处理方式，例如处理消息事件：

vkdart.onMessage().listen((event) {
  print('Received message: ${event.text}');
});

过滤特定类型的消息：

vkdart
    .onMessage()
    .where((event) => event.isNew && event.isChat)
    .listen((event) {
      print('New chat message received');
    });

处理不支持的事件：

vkdart.onUnsupportedEvent().listen((event) {
  print(
    'An unsupported event has arrived!\n'
    'It is necessary to inform the chat https://t.me/vk_dart\n\n'
    'Type of event ${event.eventType}\n'
    'Event Object: ${event.object}',
  );
});

键盘构建

VkDart 包含了一个键盘构建器，用于创建VK消息中的键盘：

import 'package:vkdart/util.dart' show VkDartKeyboard, VkDartKeyboardColor;

final keyboard = VkDartKeyboard(
  oneTime: true,
  inline: false,
);

keyboard.addButtonText('Hello world!', color: VkDartKeyboardColor.primary, payload: {'button': 'text'});
keyboard.addButtonLink('mysite.com', 'My Site');
keyboard.addButtonLocation(payload: {'button': 'location'});
keyboard.addButtonVkPay("action=transfer-to-group&group_id=1&aid=10");
keyboard.addButtonApp(6232540, -157525928, hash: "123", appName: 'LiveWidget');
keyboard.addButtonCallback(
  'Hello world!',
  color: VkDartKeyboard.secondary,
  payload: {'button': 'callback'},
);

keyboard
  ..addButtonText('1 row: Hello world!')
  ..nextRow()
  ..addButtonText('2 row: Hello world!');

// 在发送消息时使用键盘
vkdart.messages.send({
  'peer_id': PEER_ID,
  'message': 'Hello world!',
  'random_id': RANDOM_ID,
  'keyboard': keyboard.toJson(),
});

附件处理

VkDart 支持处理不同类型的附件：

final customAttachment = CustomAttachmentModel({
  'owner_id': 1,
  'id': 2,
}, attachType: 'photo');

print(customAttachment.toString()); // photo1_2

// 将附件字符串转换为模型
CustomAttachment.fromString('photo1_2'); // PhotoAttachmentModel

完整示例Demo

以下是一个完整的示例，展示了如何使用VkDart插件来处理VK消息和事件：

import 'package:vkdart/vkdart.dart';
import 'package:vkdart/util.dart' show VkDartKeyboard, VkDartKeyboardColor;

void main() async {
  final TOKEN = 'your_access_token';
  final GROUP_ID = 123456;

  final myFetcher = Longpoll(GROUP_ID);
  final vkdart = VkDart(TOKEN, fetcher: myFetcher);

  // 处理消息事件
  vkdart.onMessage().listen((event) {
    if (event.isUser) {
      event.sendMessage(message: 'Hello from VkDart!');
    }
  });

  // 处理不支持的事件
  vkdart.onUnsupportedEvent().listen((event) {
    print(
      'An unsupported event has arrived!\n'
      'It is necessary to inform the chat https://t.me/vk_dart\n\n'
      'Type of event ${event.eventType}\n'
      'Event Object: ${event.object}',
    );
  });

  // 构建键盘
  final keyboard = VkDartKeyboard(
    oneTime: true,
    inline: false,
  );

  keyboard.addButtonText('Hello world!', color: VkDartKeyboardColor.primary, payload: {'button': 'text'});
  keyboard.addButtonLink('mysite.com', 'My Site');

  // 发送带键盘的消息
  vkdart.messages.send({
    'peer_id': PEER_ID,
    'message': 'Check out this keyboard!',
    'random_id': RANDOM_ID,
    'keyboard': keyboard.toJson(),
  });

  // 启动VkDart
  await vkdart.start().then((_) => print('Longpoll API started!'));
}

通过上述代码，您可以快速上手并开始使用VkDart插件进行VK API的开发工作。希望这个帖子能帮助您更好地理解和使用VkDart插件！