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

@JvmOverloads

expect 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()

使用随机设备信息.

Properties

autoReconnectOnForceOffline

var autoReconnectOnForceOffline: Boolean

在被挤下线时 (BotOfflineEvent.Force) 自动重连. 默认为 false.

botLoggerSupplier

override var botLoggerSupplier: (Bot) -> MiraiLogger

日志记录器

contactListCache

var contactListCache: BotConfiguration.ContactListCache

联系人信息缓存配置. 将会保存在 cacheDir 中 contacts 目录

convertLineSeparator

var convertLineSeparator: Boolean

是否处理接受到的特殊换行符, 默认为 true

deviceInfo

override var deviceInfo: (Bot) -> DeviceInfo?

设备信息覆盖. 在没有手动指定时将会通过日志警告, 并使用随机设备信息.

heartbeatPeriodMillis

var heartbeatPeriodMillis: Long

连接心跳包周期. 过长会导致被服务器断开连接.

heartbeatStrategy

var heartbeatStrategy: BotConfiguration.HeartbeatStrategy

心跳策略.

heartbeatTimeoutMillis

var heartbeatTimeoutMillis: Long

每次心跳时等待结果的时间. 一旦心跳超时, 整个网络服务将会重启 (将消耗约 1s). 除正在进行的任务 (如图片上传) 会被中断外, 事件和插件均不受影响.

highwayUploadCoroutineCount

var highwayUploadCoroutineCount: Int

Highway 通道上传图片, 语音, 文件等资源时的协程数量.

isShowingVerboseEventLog

var isShowingVerboseEventLog: Boolean

是否显示过于冗长的事件日志

loginCacheEnabled

var loginCacheEnabled: Boolean

登录缓存.

loginSolver

var loginSolver: LoginSolver?

验证码处理器

networkLoggerSupplier

override var networkLoggerSupplier: (Bot) -> MiraiLogger

网络层日志构造器

parentCoroutineContext

var parentCoroutineContext: CoroutineContext

父 CoroutineContext. Bot 创建后会使用 SupervisorJob 覆盖其 Job, 但会将这个 Job 作为父 Job

protocol

var protocol: BotConfiguration.MiraiProtocol

使用协议类型

reconnectionRetryTimes

var reconnectionRetryTimes: Int

最多尝试多少次重连

statHeartbeatPeriodMillis

var statHeartbeatPeriodMillis: Long

状态心跳包周期. 过长会导致掉线. 该值会在登录时根据服务器下发的配置自动进行更新.