mirai-core-api/net.mamoe.mirai

Package net.mamoe.mirai

Types

Bot
Link copied to clipboard
@NotStableForInheritance
interface Bot : CoroutineScope, ContactOrBot, UserOrBot
Content copied to clipboard

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

BotFactory
Link copied to clipboard
interface BotFactory
Content copied to clipboard

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

IMirai
Link copied to clipboard
@NotStableForInheritance
interface IMirai : LowLevelApiAccessor
Content copied to clipboard

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

LowLevelApi
Link copied to clipboard
@MiraiExperimentalApi
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR])
annotation class LowLevelApi
Content copied to clipboard

标示这个 API 是低级的 API.

LowLevelApiAccessor
Link copied to clipboard
@NotStableForInheritance
interface LowLevelApiAccessor
Content copied to clipboard

IMirai 协议层低级 API.

Functions

alsoLogin
Link copied to clipboard
inline suspend fun <B : Bot> B.alsoLogin(): B
Content copied to clipboard

登录, 返回 this

containsFriend
Link copied to clipboard
inline fun Bot.containsFriend(id: Long): Boolean
Content copied to clipboard

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

containsGroup
Link copied to clipboard
inline fun Bot.containsGroup(id: Long): Boolean
Content copied to clipboard

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

recallMessage
Link copied to clipboard
inline suspend fun IMirai.recallMessage(bot: Bot, message: MessageChain)
Content copied to clipboard

撤回这条消息.

Properties

Mirai
Link copied to clipboard
val Mirai: IMirai
Content copied to clipboard

IMirai 实例.

supervisorJob
Link copied to clipboard
val Bot.supervisorJob: CompletableJob
Content copied to clipboard

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