mirai-core-api/net.mamoe.mirai.utils/BotConfiguration

BotConfiguration

open class BotConfiguration : AbstractBotConfiguration

部分平台相关配置位于 AbstractBotConfiguration, 例如 fileBasedDeviceInfo.

Kotlin 使用方法:

val bot = BotFactory.newBot(...) {
   // 在这里配置 Bot

   bogLoggerSupplier = { bot -> ... }
   fileBasedDeviceInfo()
   inheritCoroutineContext() // 使用 `coroutineScope` 的 Job 作为父 Job
}

Java 使用方法:

Bot bot = BotFactory.newBot(..., new BotConfiguration() {{
    setBogLoggerSupplier((Bot bot) -> { ... })
    fileBasedDeviceInfo()
    ...
}})

Constructors

BotConfiguration

constructor()

Types

Companion

object Companion

ConfigurationDsl

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

@DslMarker

annotation class ConfigurationDsl

标注一个配置 DSL 函数

ContactListCache

class ContactListCache

联系人信息缓存配置

HeartbeatStrategy

enum HeartbeatStrategy : Enum<BotConfiguration.HeartbeatStrategy>

心跳策略.

MiraiProtocol

enum MiraiProtocol : Enum<BotConfiguration.MiraiProtocol>

Functions

autoReconnectOnForceOffline

fun autoReconnectOnForceOffline()

设置 autoReconnectOnForceOffline 为 true, 即在被挤下线时自动重连.

contactListCache

inline fun contactListCache(action: BotConfiguration.ContactListCache.() -> Unit)

配置 ContactListCache

copy

fun copy(): BotConfiguration

disableAccountSecretes

fun disableAccountSecretes()

禁止保存 account.secrets.

disableContactCache

fun disableContactCache()

禁用好友列表和群成员列表的缓存.

enableContactCache

fun enableContactCache()

启用好友列表和群成员列表的缓存.

fileBasedDeviceInfo

fun fileBasedDeviceInfo(filepath: String = "device.json")

使用文件存储设备信息.

inheritCoroutineContext

inline suspend fun inheritCoroutineContext()

使用当前协程的 coroutineContext 作为 parentCoroutineContext.

loadDeviceInfoJson

fun loadDeviceInfoJson(json: String)

使用特定由 DeviceInfo 序列化产生的 JSON 的设备信息

noBotLog

fun noBotLog()

不显示 Bot 日志. 不推荐.

noNetworkLog

fun noNetworkLog()

不显示网络日志. 不推荐.

randomDeviceInfo

fun randomDeviceInfo()

使用随机设备信息.

redirectBotLogToDirectory

fun redirectBotLogToDirectory(dir: <Error class: unknown class> = File("logs"), retain: Long = 1.weeksToMillis, identity: (bot: Bot) -> String = { "Bot ${it.id}" })

重定向 Bot 日志到指定目录. 若目录不存在将会自动创建 (File.mkdirs)

redirectBotLogToFile

fun redirectBotLogToFile(file: <Error class: unknown class> = File("mirai.log"), identity: (bot: Bot) -> String = { "Bot ${it.id}" })

重定向 Bot 日志到指定文件. 日志将会逐行追加到此文件. 若文件不存在将会自动创建 (File.createNewFile)

redirectNetworkLogToDirectory

fun redirectNetworkLogToDirectory(dir: <Error class: unknown class> = File("logs"), retain: Long = 1.weeksToMillis, identity: (bot: Bot) -> String = { "Net ${it.id}" })

重定向网络日志到指定目录. 若目录不存在将会自动创建 (File.mkdirs) 默认目录路径为 "$workingDir/logs/".

redirectNetworkLogToFile