mirai-core-api/net.mamoe.mirai

Package-level declarations

Types

@NotStableForInheritance

interface Bot : CoroutineScope, ContactOrBot, UserOrBot

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

interface BotFactory

构造 Bot 的工厂. 这是 Bot 唯一的构造方式.

@NotStableForInheritance

interface IMirai : LowLevelApiAccessor

Mirai API 接口. 是 Mirai API 与 Mirai 协议实现对接的接口.

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR])

annotation class LowLevelApi

标示这个 API 是低级的 API.

LowLevelApiAccessor

@NotStableForInheritance

interface LowLevelApiAccessor

IMirai 协议层低级 API.

Functions

inline suspend fun <B : Bot> B.alsoLogin(): B

登录, 返回 this

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

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

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

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

inline suspend fun IMirai.recallMessage(bot: Bot, message: MessageChain)

撤回这条消息.

Properties

@get:JvmName(name = "getInstance")

val Mirai: IMirai

IMirai 实例.

val Bot.supervisorJob: CompletableJob

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