QGBot

interface QGBot : Bot(source)

一个 QQ频道Bot 的 simbot组件实现接口, 是一个具有功能的 QQ频道组件Bot。

AppID 与 用户ID

QGBotid 是用于连接服务器的 appId 而并非系统用户ID。 如果希望获取bot的 用户ID, 至少执行过一次 QGBot.start 后通过 userId 获取, 或者通过 me 实时查询。

Note: QGBot仅由内部实现,对外不稳定

Author

ForteScarlet

Inheritors

Functions

Link copied to clipboard
Link copied to clipboard
abstract suspend override fun cancel(reason: Throwable?): Boolean
Link copied to clipboard
Link copied to clipboard
open fun cancelBlocking(reason: Throwable?): Boolean
Link copied to clipboard
abstract suspend fun category(channelId: ID): QGChannelCategory?

直接获取指定ID的子频道分类。

Link copied to clipboard
abstract suspend fun channel(channelId: ID): QGChannel?

直接获取指定ID的子频道。

Link copied to clipboard
open suspend override fun contact(id: ID): Contact?

Deprecated: QQ频道BOT不存在'联系人'列表,始终得到 null

Link copied to clipboard
open suspend override fun contactCount(): Int

Deprecated: QQ频道BOT不存在'联系人'列表,始终得到 0

Link copied to clipboard
open fun delay(duration: JavaDuration, runnable: Runnable): DelayableCompletableFuture<Void?>
open fun delay(millis: Long, runnable: Runnable): DelayableCompletableFuture<Void?>
open fun delay(time: Long, timeUnit: TimeUnit, runnable: Runnable): DelayableCompletableFuture<Void?>
Link copied to clipboard
open fun <V> delayAndCompute(millis: Long, supplier: Supplier<V>): DelayableCompletableFuture<V>
open fun <V> delayAndCompute(time: Long, timeUnit: TimeUnit, supplier: Supplier<V>): DelayableCompletableFuture<V>
Link copied to clipboard
open fun getContact(id: ID): Contact?
Link copied to clipboard
Link copied to clipboard
open fun getGroup(id: ID): Group?
Link copied to clipboard
Link copied to clipboard
open fun getGuild(id: ID): Guild?
Link copied to clipboard
Link copied to clipboard
open suspend override fun group(id: ID): Group?

QQ频道BOT不存在'联系人'列表

Link copied to clipboard
open suspend override fun groupCount(): Int

Deprecated: QQ频道BOT没有'群'概念

Link copied to clipboard
abstract suspend override fun guild(id: ID): QGGuild?

根据ID尝试获取一个指定的guild。

Link copied to clipboard
open suspend override fun guildCount(): Int

QQ频道数量。QQ频道不支持获取频道服务器数量,始终得到 -1

Link copied to clipboard
open override fun invokeOnCompletion(handler: CompletionHandler)
Link copied to clipboard
abstract infix override fun isMe(id: ID): Boolean

QQ机器人有两个可能的唯一标识:作为bot的 app id 以及在系统中作为用户的 user id.

Link copied to clipboard
abstract suspend override fun join()
Link copied to clipboard
open fun joinBlocking()
Link copied to clipboard
open suspend fun me(): User

通过API实时查询当前bot对应的用户信息。

abstract suspend fun me(withCache: Boolean): User

获取当前bot对应的用户信息。

Link copied to clipboard
inline suspend fun <R> QGBot.request(api: QQGuildApi<R>): R

直接通过bot进行请求。

Link copied to clipboard

直接通过bot进行请求。

Link copied to clipboard

直接通过bot进行请求。

Link copied to clipboard
inline suspend fun QGBot.requestRaw(api: QQGuildApi<*>): String

直接通过bot进行请求。

Link copied to clipboard

直接通过bot进行请求。

Link copied to clipboard

直接通过bot进行请求。

Link copied to clipboard
open suspend override fun resolveImage(id: ID): Image<*>

暂时无法直接解析“id”图片

Link copied to clipboard
Link copied to clipboard
open fun resolveImageBlocking(id: ID): Image<*>
Link copied to clipboard
abstract suspend fun sendTo(channelId: ID, text: String): QGMessageReceipt
abstract suspend fun sendTo(channelId: ID, message: Message): QGMessageReceipt
abstract suspend fun sendTo(channelId: ID, message: MessageContent): QGMessageReceipt

直接向目标子频道发送消息。

Link copied to clipboard
abstract suspend override fun start(): Boolean

启动当前bot, 并且初始化此bot的信息。

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun waiting()

Properties

Link copied to clipboard
abstract override val avatar: String

bot的头像

Link copied to clipboard
open override val bot: QGBot

得到自己。

Link copied to clipboard
open val category: Category?
Link copied to clipboard
abstract override val component: QQGuildComponent

QQ频道的 组件 对象实例。

Link copied to clipboard
open val contactCount: Int
Link copied to clipboard
Link copied to clipboard
open override val contacts: Items<Contact>

Deprecated: QQ频道BOT不存在'联系人'列表,始终得到 emptyItems

Link copied to clipboard
abstract override val coroutineContext: CoroutineContext
Link copied to clipboard
abstract override val eventProcessor: EventProcessor

bot所属的事件处理器。

Link copied to clipboard
open val groupCount: Int
Link copied to clipboard
Link copied to clipboard
open override val groups: Items<Group>

Deprecated: QQ频道BOT没有'群'概念

Link copied to clipboard
open val guildCount: Int
Link copied to clipboard
Link copied to clipboard
abstract override val guilds: Items<QGGuild>

获取当前bot所在的频道服务器列表。

Link copied to clipboard
open override val id: ID

当前bot的 appId

Link copied to clipboard
open override val isActive: Boolean
Link copied to clipboard
abstract override val isCancelled: Boolean
Link copied to clipboard
open override val isContactsSupported: Boolean

Deprecated: QQ频道BOT不存在'联系人'列表,始终得到 false

Link copied to clipboard
open override val isGroupsSupported: Boolean

Deprecated: QQ频道BOT没有'群'概念

Link copied to clipboard
open override val isGuildsSupported: Boolean

是否支持QQ频道相关API,如 guilds。始终得到 true

Link copied to clipboard
abstract override val isStarted: Boolean
Link copied to clipboard
abstract override val logger: Logger
Link copied to clipboard
abstract override val manager: BaseQQGuildBotManager

bot所属的bot管理器

Link copied to clipboard
abstract val source: Bot

在QQ频道标准库中的原始Bot类型。

Link copied to clipboard
abstract val userId: ID

得到当前bot的用户ID。

Link copied to clipboard
abstract override val username: String

bot的用户名