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

Package-level declarations

Types

abstract class AbstractExternalResource @JvmOverloads constructor(displayName: String? = null, cleanup: AbstractExternalResource.ResourceCleanCallback? = null) : ExternalResource

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

BotConfiguration

expect open class BotConfiguration

Bot 配置. 用于 BotFactory.newBot

actual open class BotConfiguration

Bot 配置. 用于 BotFactory.newBot

actual open class BotConfiguration

Bot 配置. 用于 BotFactory.newBot

DeviceInfo

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

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

@Serializable

DeviceVerificationRequests

@NotStableForInheritance

interface DeviceVerificationRequests

属性 sms 为短信验证码验证方式, fallback 为其他验证方式. 两个属性至少有一个不为 null, 在不为 null 时表示支持该验证方式. 可任意选用偏好的验证方式.

DeviceVerificationResult

@NotStableForInheritance

interface DeviceVerificationResult

设备验证的验证结果. 请不要自行实现此接口, 而是通过解决 DeviceVerificationRequests 中的其中一种验证获得.

DirectoryLogger

class DirectoryLogger @JvmOverloads constructor(val identity: String, directory: File = File(identity), retain: Long = 1.weeksToMillis) : SimpleLogger

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

ExternalResource

expect interface ExternalResource : Closeable

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

actual interface ExternalResource : Closeable

FileCacheStrategy

expect interface FileCacheStrategy

资源缓存策略.

actual interface FileCacheStrategy

资源缓存策略.

actual 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 或 JUL 到 MiraiLogger 的转换器.

LoginSolver

abstract class LoginSolver

验证码, 设备锁解决器

MiraiExperimentalApi

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

annotation class MiraiExperimentalApi(val 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(val message: String = "")

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

MiraiInternalFile

@Target(allowedTargets = [AnnotationTarget.FILE])

@MiraiInternalApi

annotation class MiraiInternalFile

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

MiraiLogger

expect interface MiraiLogger

日志记录器.

actual interface MiraiLogger

日志记录器.

actual interface MiraiLogger

日志记录器.

MiraiLoggerPlatformBase

abstract class MiraiLoggerPlatformBase : MiraiLogger

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

MiraiLoggerWithSwitch

class MiraiLoggerWithSwitch : MiraiLoggerPlatformBase

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

NotStableForInheritance

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

annotation class NotStableForInheritance(val message: String = "This declaration is not stable for inheritance.")

标记一个定义在使用上是稳定的 (如果没有特殊说明), 但只应该由 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 控制台日志实现

@MiraiInternalApi

actual open class PlatformLogger : MiraiLoggerPlatformBase, MiraiLogger

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

ProgressionCallback

interface ProgressionCallback<in S, in P>

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

SilentLogger

object SilentLogger : PlatformLogger

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

SimpleLogger

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

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

SingleFileLogger

expect class SingleFileLogger(identity: String, file: File = File("$identity-${getCurrentDate()}.log")) : MiraiLogger

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

actual class SingleFileLogger(identity: String, file: File) : PlatformLogger, MiraiLogger

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

StandardCharImageLoginSolver

class StandardCharImageLoginSolver @JvmOverloads constructor(input: suspend () -> String = { readLine() ?: throw NoStandardInputForCaptchaException() }, loggerSupplier: (bot: Bot) -> MiraiLogger = { it.logger }) : LoginSolver

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

Streamable