Skip to content

API 总览 ​

Luolan.QQBot SDK 的 API 分为以下几个层次:

架构分层 ​

┌─────────────────────────────────────────┐
│          QQBotClient(顶层入口)          │
│  快捷方法:Reply, Send, GetGuilds 等     │
├─────────────────────────────────────────┤
│  ┌───────────────┐ ┌─────────────────┐  │
│  │  Controllers  │ │    Events       │  │
│  │  命令路由      │ │   事件分发       │  │
│  └───────────────┘ └─────────────────┘  │
├─────────────────────────────────────────┤
│       QQBotHttpClient(底层 API)        │
│  完整 HTTP API:频道/成员/角色/消息等     │
├─────────────────────────────────────────┤
│       Infrastructure(基础设施)          │
│  TokenManager, WebSocket, RateLimiter   │
└─────────────────────────────────────────┘

核心类一览 ​

类命名空间说明
QQBotClientLuolan.QQBot机器人客户端主类
QQBotClientBuilderLuolan.QQBotBuilder 模式构建器
QQBotClientOptionsLuolan.QQBot配置选项
QQBotControllerLuolan.QQBot.Controllers控制器基类
CommandAttributeLuolan.QQBot.Controllers命令特性标记
ImageResultLuolan.QQBot.Controllers图片返回结果
ControllerManagerLuolan.QQBot.Controllers控制器管理器
QQBotHttpClientLuolan.QQBot.ServicesHTTP API 客户端
TokenManagerLuolan.QQBot.ServicesToken 管理器
QQBotWebSocketClientLuolan.QQBot.ServicesWebSocket 客户端
QQBotApiExceptionLuolan.QQBot.ServicesAPI 异常类
EventDispatcherLuolan.QQBot.Events事件分发器
QQBotWebhookLuolan.QQBot.WebhookWebhook 回调处理器
QQBotWebhookSignatureLuolan.QQBot.WebhookEd25519 签名工具
KeyboardBuilderLuolan.QQBot.Helpers键盘构建器
MarkdownBuilderLuolan.QQBot.HelpersMarkdown 构建器
CommandParserLuolan.QQBot.Helpers命令解析器
RateLimiterLuolan.QQBot.Helpers速率限制器

扩展方法 ​

类命名空间说明
ControllerExtensionsLuolan.QQBot.ExtensionsUseControllers()
MessageExtensionsLuolan.QQBot.ExtensionsSendMarkdownAsync 等
QQBotServiceCollectionExtensionsLuolan.QQBot.ExtensionsAddQQBot()
QQBotHostedServiceExtensionsLuolan.QQBot.ExtensionsAddQQBotHostedService()
HttpClientFactoryExtensionsLuolan.QQBot.ExtensionsAddQQBotWithHttpClientFactory()
WebhookExtensionsLuolan.QQBot.ExtensionsAddQQBotWebhook()(通常无需手动调用)
QQBotWebhookEndpointExtensionsLuolan.QQBot.AspNetCoreMapQQBotWebhook()

使用建议 ​

  • 简单命令 → QQBotController + [Command]
  • 事件处理 → bot.OnXxx 快捷事件 / bot.Events.OnXxx
  • 底层 API → bot.Api.xxx() / QQBotHttpClient
  • 群管理 → bot.Api.GetGroupInfoAsync() / GetGroupMembersAsync() 等
  • ASP.NET Core → AddQQBot() + AddQQBotHostedService()
  • HTTP 回调 → AddQQBotWebhook() + QQBotWebhook.HandleAsync()

基于 MIT 协议发布