simbot-component-mirai-core/love.forte.simbot.component.mirai.bot/MiraiBot

MiraiBot

interface MiraiBot : Bot, UserInfo, FriendsContainer(source)

Mirai的Bot OriginalMiraiBot 在 simbot中的整合类型。

当 MiraiBot 被关闭的时候（或者说 originalBot 被关闭的时候）会将自身移出所属的 BotManager. 这一行为是由 MiraiBotManager 所决定的。

在 mirai 中, bot存在"好友"概念，因此 MiraiBot 实现 FriendsContainer, 提供好友相关api。

Author

ForteScarlet

Functions

asFuture

open fun asFuture(): CompletableFuture<Unit>

avatar

@JvmName(name = "getAvatar")

open fun avatar(spec: AvatarSpec): String

获取当前bot的头像链接。

cancel

open suspend override fun cancel(reason: Throwable?): Boolean

cancelAsync

open fun cancelAsync(): CompletableFuture<Boolean>

open fun cancelAsync(reason: Throwable?): CompletableFuture<out Boolean>

cancelBlocking

open fun cancelBlocking(): Boolean

open fun cancelBlocking(reason: Throwable?): Boolean

contact

abstract suspend override fun contact(id: ID): MiraiContact?

尝试获取一个联系人。

contactCount

abstract suspend override fun contactCount(): Int

获取当前bot的所有联系人的数量

delay

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?>

delayAndCompute

open fun <V> delayAndCompute(duration: JavaDuration, supplier: Supplier<V>): DelayableCompletableFuture<V>

open fun <V> delayAndCompute(millis: Long, supplier: Supplier<V>): DelayableCompletableFuture<V>

open fun <V> delayAndCompute(time: Long, timeUnit: TimeUnit, supplier: Supplier<V>): DelayableCompletableFuture<V>

friend

abstract suspend override fun friend(id: ID): MiraiFriend?

获取指定的好友。在mirai中，好友的获取不是挂起的，因此可以安全的使用 getFriend

friendCount

abstract suspend override fun friendCount(): Int

获取当前bot中所有好友的数量

getContact

open fun getContact(id: ID): Contact?

getContactAsync

open fun getContactAsync(id: ID): CompletableFuture<out Contact?>

getFriend

open fun getFriend(id: ID): Friend?

getFriendAsync

open fun getFriendAsync(id: ID): CompletableFuture<out Friend?>

getGroup

open fun getGroup(id: ID): Group?

getGroupAsync

open fun getGroupAsync(id: ID): CompletableFuture<out Group?>

getGuild

open fun getGuild(id: ID): Guild?

getGuildAsync

open fun getGuildAsync(id: ID): CompletableFuture<out Guild?>

group

abstract suspend override fun group(id: ID): MiraiGroup?

获取指定的群. mirai的群组获取没有真正的挂起，因此可以安全的使用 getGroup.

groupCount

abstract suspend override fun groupCount(): Int

获取当前bot中所有群的数量

guild

open suspend override fun ~~guild~~(id: ID): Guild?

mirai中不存在'频道（guild）'概念。

guildCount

open suspend override fun ~~guildCount~~(): Int

mirai中不存在'频道（guild）'概念。

idImage

abstract fun idImage(id: ID, flash: Boolean, builderAction: Image.Builder.() -> Unit = {}): MiraiImage

尝试通过一个 ID 解析得到一个图片对象。当使用 ID的时候，会直接通过mirai的函数 net.mamoe.mirai.message.data.Image 直接通过此ID获取对应图片。此时的 Image 对象是可以序列化的。

invokeOnCompletion

open override fun invokeOnCompletion(handler: CompletionHandler)

isMe

abstract infix fun isMe(id: ID): Boolean

join

open suspend override fun join()

joinBlocking

open fun joinBlocking()

resolveImage

open suspend override fun resolveImage(id: ID): MiraiImage

open fun resolveImage(id: ID, flash: Boolean, builderAction: Image.Builder.() -> Unit = {}): MiraiImage

resolveImageAsync

open fun resolveImageAsync(id: ID): CompletableFuture<out Image<*>>

resolveImageBlocking

open fun resolveImageBlocking(id: ID): Image<*>

sendOnlyImage

abstract fun sendOnlyImage(resource: Resource, flash: Boolean): MiraiSendOnlyImage

通过 resource 构建得到一个可以且仅可用于在mirai组件中进行发送的图片消息对象。

start

abstract suspend override fun start(): Boolean

startAsync

open fun startAsync(): CompletableFuture<out Boolean>

startBlocking

open fun startBlocking(): Boolean

stranger

abstract suspend fun stranger(id: ID): MiraiStranger?

根据唯一标识获取一个陌生人。

waiting

open fun waiting()

Properties

avatar

open override val avatar: String

获取当前bot的头像链接。规格默认为 AvatarSpec.LARGEST

bot

open override val bot: MiraiBot

得到自己。

Inheritors

MiraiGroupBot

MiraiBot

Author

See also

Functions

Properties

Inheritors