Bot

@NotStableForInheritance

interface Bot : CoroutineScope, ContactOrBot, UserOrBot

机器人对象. 一个机器人实例登录一个 QQ 账号. Mirai 为多账号设计, 可同时维护多个机器人.

有关 Bot 生命管理, 请查看 BotConfiguration.inheritCoroutineContext

Types

Companion

object Companion

Functions

open fun close()

关闭这个 Bot. 查看 close 获取更多信息.

abstract fun close(cause: Throwable? = null)

关闭这个 Bot, 立即取消 Bot 的 SupervisorJob, 取消与这个 Bot 相关的所有有协程联系的任务.

closeAndJoin

open suspend fun closeAndJoin(cause: Throwable? = null)

关闭这个 Bot, 停止一切相关活动. 所有引用都会被释放.

getFriend

open fun getFriend(id: Long): Friend?

以对方 QQ 号码获取一个好友对象, 在获取失败时返回 null. 在 id 与 Bot.id 相同时返回 Bot.asFriend.

getFriendOrFail

open fun getFriendOrFail(id: Long): Friend

以对方 QQ 号码获取一个好友对象, 在获取失败时抛出 NoSuchElementException. 在 id 与 Bot.id 相同时返回 Bot.asFriend.

getGroup

open fun getGroup(id: Long): Group?

以群号码获取一个群对象, 在获取失败时返回 null.

getGroupOrFail

open fun getGroupOrFail(id: Long): Group

以群号码获取一个群对象, 在获取失败时抛出 NoSuchElementException.

getStranger

open fun getStranger(id: Long): Stranger?

以对方 QQ 号码获取一个陌生人对象, 在获取失败时返回 null.

getStrangerOrFail

open fun getStrangerOrFail(id: Long): Stranger

以对方 QQ 号码获取一个陌生人对象, 在获取失败时抛出 NoSuchElementException.

join

open suspend fun join()

挂起协程直到 Bot 协程被关闭 (Bot.close). 即使 Bot 离线, 也会等待直到协程关闭.

abstract suspend fun login()

nudge

open override fun nudge(): BotNudge

创建一个 "戳一戳" 消息

Properties

asFriend

abstract val asFriend: Friend

User.id 与 Bot.id 相同的 Friend 实例

asStranger

abstract val asStranger: Stranger

User.id 与 Bot.id 相同的 Stranger 实例

avatarUrl

open val avatarUrl: String

头像下载链接

bot

open override val bot: Bot

返回 this

configuration

abstract val configuration: BotConfiguration

Bot 配置

coroutineContext

abstract val coroutineContext: CoroutineContext

eventChannel

abstract val eventChannel: EventChannel<BotEvent>

来自这个 Bot 的 BotEvent 的事件通道.

friends

abstract val friends: ContactList<Friend>

好友列表. 与服务器同步更新.

groups

abstract val groups: ContactList<Group>

加入的群列表. 与服务器同步更新.

abstract val id: Long

QQ 号或群号.

isOnline

abstract val isOnline: Boolean

当 Bot 在线 (可正常收发消息) 时返回 true.

logger

abstract val logger: MiraiLogger

日志记录器

nick

abstract val nick: String

获取昵称

otherClients

abstract val otherClients: ContactList<OtherClient>

其他设备列表

strangers

abstract val strangers: ContactList<Stranger>

陌生人列表. 与服务器同步更新.

Extensions

buildMessageSource

inline fun Bot.buildMessageSource(kind: MessageSourceKind, block: MessageSourceBuilder.() -> Unit): OfflineMessageSource

使用 DSL 构建一个 OfflineMessageSource. 用法参考 MessageSourceBuilder.

containsFriend

inline fun Bot.containsFriend(id: Long): Boolean

当 Bot 拥有 Friend.id 为 id 的好友时返回 true.

containsGroup

inline fun Bot.containsGroup(id: Long): Boolean

当 Bot 拥有 Group.id 为 id 的群时返回 true.

supervisorJob

val Bot.supervisorJob: CompletableJob

获取 Job 的协程 Job. 此 Job 为一个 SupervisorJob

Bot

See also

Types

Functions

Properties

Extensions