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

BotConfiguration

Kotlin 使用方法:

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

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

Java 使用方法:

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

actual open class BotConfiguration

Bot 配置. 用于 BotFactory.newBot

Kotlin 使用方法:

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

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

Java 使用方法:

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

actual open class BotConfiguration

Bot 配置. 用于 BotFactory.newBot

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

expect constructor()

constructor()

Types

Companion

expect object Companion

actual object Companion

ConfigurationDsl

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

@DslMarker

expect annotation class ConfigurationDsl

标注一个配置 DSL 函数

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

@DslMarker

actual annotation class ConfigurationDsl

标注一个配置 DSL 函数

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

@DslMarker

actual annotation class ConfigurationDsl

标注一个配置 DSL 函数

ContactListCache

expect class ContactListCache

联系人信息缓存配置

actual class ContactListCache

联系人信息缓存配置

actual class ContactListCache

联系人信息缓存配置

HeartbeatStrategy

expect enum HeartbeatStrategy : Enum<BotConfiguration.HeartbeatStrategy>

心跳策略.

actual enum HeartbeatStrategy : Enum<BotConfiguration.HeartbeatStrategy>

心跳策略.

actual enum HeartbeatStrategy : Enum<BotConfiguration.HeartbeatStrategy>

心跳策略.

MiraiProtocol

expect enum MiraiProtocol : Enum<BotConfiguration.MiraiProtocol>

actual enum MiraiProtocol : Enum<BotConfiguration.MiraiProtocol>

Functions

autoReconnectOnForceOffline

expect fun autoReconnectOnForceOffline()

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

actual fun autoReconnectOnForceOffline()

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

actual fun autoReconnectOnForceOffline()

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

contactListCache

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

配置 ContactListCache

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

配置 ContactListCache

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

配置 ContactListCache

copy

expect fun copy(): BotConfiguration

actual fun copy(): BotConfiguration

disableAccountSecretes

expect fun disableAccountSecretes()

禁止保存 account.secrets.

actual fun disableAccountSecretes()

禁止保存 account.secrets.

actual fun disableAccountSecretes()

禁止保存 account.secrets.

disableContactCache

expect fun disableContactCache()

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

actual fun disableContactCache()

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

actual fun disableContactCache()

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

enableContactCache

expect fun enableContactCache()

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

actual fun enableContactCache()

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

actual fun enableContactCache()

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

fileBasedDeviceInfo

@JvmOverloads

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

使用文件存储设备信息.

@JvmOverloads

actual fun fileBasedDeviceInfo(filepath: String)

使用文件存储设备信息.

actual fun fileBasedDeviceInfo(filepath: String)

使用文件存储设备信息.

inheritCoroutineContext

expect inline suspend fun inheritCoroutineContext()

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

actual inline suspend fun inheritCoroutineContext()

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

actual inline suspend fun inheritCoroutineContext()

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

loadDeviceInfoJson

expect fun loadDeviceInfoJson(json: String)

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

actual fun loadDeviceInfoJson(json: String)

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

actual fun loadDeviceInfoJson(json: String)

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

noBotLog

expect fun noBotLog()

不显示 Bot 日志. 不推荐.

actual fun noBotLog()

不显示 Bot 日志. 不推荐.

actual fun noBotLog()

不显示 Bot 日志. 不推荐.

noNetworkLog

expect fun noNetworkLog()

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

actual fun noNetworkLog()

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

actual fun noNetworkLog()

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

randomDeviceInfo

expect fun randomDeviceInfo()

使用随机设备信息.

actual fun randomDeviceInfo()

使用随机设备信息.

actual fun randomDeviceInfo()

使用随机设备信息.

redirectBotLogToDirectory

@JvmOverloads

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

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

redirectBotLogToFile

@JvmOverloads

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

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

redirectNetworkLogToDirectory

@JvmOverloads

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

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

redirectNetworkLogToFile

@JvmOverloads

fun redirectNetworkLogToFile(file: File = File("mirai.log"), identity: (bot: Bot) -> String = { "Net ${it.id}" })

重定向网络日志到指定文件. 默认文件路径为 "$workingDir/mirai.log". 日志将会逐行追加到此文件. 若文件不存在将会自动创建 (File.createNewFile)

Properties

autoReconnectOnForceOffline

expect var autoReconnectOnForceOffline: Boolean

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

actual var autoReconnectOnForceOffline: Boolean

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

actual var autoReconnectOnForceOffline: Boolean

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

botLoggerSupplier

expect var botLoggerSupplier: (Bot) -> MiraiLogger

日志记录器

actual var botLoggerSupplier: (Bot) -> MiraiLogger

日志记录器

actual var botLoggerSupplier: (Bot) -> MiraiLogger

日志记录器

cacheDir

var cacheDir: File

缓存数据目录, 相对于 workingDir.

var cacheDir: String

缓存数据目录路径. 若 cacheDir 为绝对路径, 将解析该绝对路径, 否则作为相对于 workingDir 的路径解析. 例如, cache 将会解析为 $workingDir/cache, 而 /Users/Chisato/Desktop/bot/cache 指代绝对路径, 将解析为绝对路径.