Package net.mamoe.mirai.utils

Types

AbstractExternalResource

abstract class AbstractExternalResource constructor(displayName: String?, cleanup: AbstractExternalResource.ResourceCleanCallback?) : ExternalResource

一个实现了基本方法的外部资源

BotConfiguration

open class BotConfiguration

Bot 配置. 用于 BotFactory.newBot

DeviceInfo

class DeviceInfo(display: ByteArray, product: ByteArray, device: ByteArray, board: ByteArray, brand: ByteArray, model: ByteArray, bootloader: ByteArray, fingerprint: ByteArray, bootId: ByteArray, procVersion: ByteArray, baseBand: ByteArray, version: DeviceInfo.Version, simInfo: ByteArray, osType: ByteArray, macAddress: ByteArray, wifiBSSID: ByteArray, wifiSSID: ByteArray, imsiMd5: ByteArray, imei: String, apn: ByteArray)

DirectoryLogger

class DirectoryLogger constructor(identity: String, directory: <ERROR CLASS>, retain: Long) : SimpleLogger

将日志写入('append')到特定文件夹中的文件. 每日日志独立保存.

ExternalResource

interface ExternalResource

一个不可变的外部资源. 仅包含资源内容, 大小, 文件类型, 校验值而不包含文件名, 文件位置等. 外部资源有可能是一个文件, 也有可能只存在于内存, 或者以任意其他方式实现.

FileCacheStrategy

interface FileCacheStrategy

资源缓存策略.

JavaFriendlyAPI

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FUNCTION, AnnotationTarget.CLASS])

annotation class JavaFriendlyAPI

表明这个 API 是为了让 Java 使用者调用更方便.

LoggerAdapters

object LoggerAdapters

org.slf4j.Logger, org.apache.logging.log4j.Logger 或 java.util.logging.Logger 到 MiraiLogger 的转换器.

LoginSolver

actual abstract class LoginSolver

验证码, 设备锁解决器

expect abstract class LoginSolver

验证码, 设备锁解决器

actual abstract class LoginSolver

验证码, 设备锁解决器

MiraiExperimentalApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.CONSTRUCTOR])

annotation class MiraiExperimentalApi(message: String)

标记这个类, 类型, 函数, 属性, 字段, 或构造器为实验性的 API.

MiraiInternalApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class MiraiInternalApi(message: String)

标记为一个仅供 Mirai 内部使用的 API.

MiraiInternalFile

@Target(allowedTargets = [AnnotationTarget.FILE])

@MiraiInternalApi

annotation class MiraiInternalFile

标记为一个仅供 Mirai 内部使用的 API.

MiraiLogger

interface MiraiLogger

日志记录器.

MiraiLoggerPlatformBase

abstract class MiraiLoggerPlatformBase : MiraiLogger

日志基类. 实现了 follower 的调用传递. 若 Mirai 自带的日志系统无法满足需求, 请继承这个类或 PlatformLogger 并实现其抽象函数.

MiraiLoggerWithSwitch

class MiraiLoggerWithSwitch : MiraiLoggerPlatformBase

带有开关的 Logger. 仅能通过 MiraiLogger.withSwitch 构造

NotStableForInheritance

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FUNCTION])

annotation class NotStableForInheritance(message: String)

标记一个定义在使用上是稳定的 (如果没有特殊说明), 但只应该由 mirai 内部实现.

OverFileSizeMaxException

class OverFileSizeMaxException : IllegalStateException

图片文件过大

PlatformLogger

@MiraiInternalApi

actual open class PlatformLogger : MiraiLoggerPlatformBase

Log 日志实现

@MiraiInternalApi

expect open class PlatformLogger : MiraiLoggerPlatformBase

当前平台的默认的日志记录器.

@MiraiInternalApi

actual open class PlatformLogger : MiraiLoggerPlatformBase

JVM 控制台日志实现

ProgressionCallback

interface ProgressionCallback<in S, in P>

操作进度回调, 可供前端使用, 以提供进度显示.

SilentLogger

object SilentLogger : PlatformLogger

不做任何事情的 logger, keep silent.

SimpleLogger

open class SimpleLogger(identity: String?, logger: (priority: SimpleLogger.LogPriority, message: String?, e: Throwable?) -> Unit) : MiraiLoggerPlatformBase

简易日志记录, 所有类型日志都会被重定向 logger

SingleFileLogger

actual class SingleFileLogger : MiraiLogger

将日志写入('append')到特定文件.

expect class SingleFileLogger : MiraiLogger

将日志写入('append')到特定文件.

actual class SingleFileLogger : PlatformLogger, MiraiLogger

将日志写入('append')到特定文件.

StandardCharImageLoginSolver

class StandardCharImageLoginSolver @JvmOverloads constructor(input: suspend () -> String, loggerSupplier: (bot: Bot) -> MiraiLogger) : LoginSolver

CLI 环境 LoginSolver. 将验证码图片转为字符画并通过 output 输出, input 获取用户输入.

SwingSolver

@MiraiExperimentalApi

object SwingSolver : LoginSolver

Functions

BotConfiguration

inline fun BotConfiguration(block: BotConfiguration.() -> Unit): BotConfiguration

构建一个 BotConfiguration.

debug

inline fun MiraiLogger.debug(message: () -> String?)

inline fun MiraiLogger.debug(message: () -> String?, e: Throwable?)

error

inline fun MiraiLogger.error(message: () -> String?)

inline fun MiraiLogger.error(message: () -> String?, e: Throwable?)

generateDeviceInfoData

fun DeviceInfo.generateDeviceInfoData(): ByteArray

info

inline fun MiraiLogger.info(message: () -> String?)

inline fun MiraiLogger.info(message: () -> String?, e: Throwable?)

runAutoClose

@MiraiExperimentalApi

inline fun <T : ExternalResource, R> T.runAutoClose(action: T.() -> R): R

执行 action, 如果 ExternalResource.isAutoClose, 在执行完成后调用 ExternalResource.close.

useAutoClose

@MiraiExperimentalApi

inline fun <T : ExternalResource, R> T.useAutoClose(action: (T) -> R): R

执行 action, 如果 ExternalResource.isAutoClose, 在执行完成后调用 ExternalResource.close.

verbose

inline fun MiraiLogger.verbose(message: () -> String)

inline fun MiraiLogger.verbose(message: () -> String, e: Throwable?)

warning

inline fun MiraiLogger.warning(message: () -> String?)

inline fun MiraiLogger.warning(message: () -> String?, e: Throwable?)

withAutoClose

@MiraiExperimentalApi

inline fun <T : ExternalResource, R> T.withAutoClose(action: () -> R): R

执行 action, 如果 ExternalResource.isAutoClose, 在执行完成后调用 ExternalResource.close.

withSwitch

fun MiraiLogger.withSwitch(default: Boolean = true): MiraiLoggerWithSwitch

给这个 logger 添加一个开关, 用于控制是否记录 log