simbot-component-onebot-common/love.forte.simbot.component.onebot.common.annotations

Package-level declarations

OneBot 标记性注解。

Types

@Target(allowedTargets = [AnnotationTarget.CONSTRUCTOR])

@RequiresOptIn(message = "这是用作OneBotApi返回值的类型，它应当仅通过序列化器构造。作为数据类，它可能无法保证兼容性，请避免直接构造它。", level = RequiresOptIn.Level.ERROR)

annotation class ApiResultConstructor

标记在作为 OneBotApi 的响应体数据类的构造上，并做出如下警告：这是用作 OneBotApi 返回值的类型，它应当仅通过序列化器构造。作为数据类，它可能无法保证兼容性，请避免直接构造它。

ExperimentalOneBotAPI

@RequiresOptIn(message = "OneBot组件中仍处于实验阶段的API，可能会随时变更、删除", level = RequiresOptIn.Level.ERROR)

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

annotation class ExperimentalOneBotAPI

标记为OneBot组件中仍处于实验阶段的API，可能会随时变更、删除

InternalForInheritanceOneBotBotApi

@Target(allowedTargets = [AnnotationTarget.CLASS])

@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "OneBotBot 及其相关接口是面向 OneBot 组件库内部实现的类型，它可能随时添加更多需要明确实现的抽象 API 而不会确保对继承的安全兼容，因此它不应该由用户随意实现。")

annotation class InternalForInheritanceOneBotBotApi

为 OneBot 组件下 Bot 相关接口类型的实现提供警告信息。

InternalOneBotAPI

@RequiresOptIn(message = "仅用于OneBot组件内部使用的API，可能会随时变更、删除", level = RequiresOptIn.Level.ERROR)

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

annotation class InternalOneBotAPI

标记为仅用于OneBot组件内部使用的API，可能会随时变更、删除

OneBotInternalImplementationsOnly

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

annotation class OneBotInternalImplementationsOnly

一个标记性注解，标记一个类型 (通常是一个抽象类或接口) 或函数应当仅由内部实现，对外实现不稳定且不保证兼容性。

SourceEventConstructor

@Target(allowedTargets = [AnnotationTarget.CONSTRUCTOR])

@RequiresOptIn(message = "这是用作OneBot `Event` 的类型(或与之相关)，它应当仅通过序列化器构造。作为数据类，它可能无法保证兼容性，请避免直接构造它。", level = RequiresOptIn.Level.ERROR)

annotation class SourceEventConstructor

标记在 Event 的某个具体实现数据类的构造上，并做出如下警告：这是用作 Event 的类型(或与之相关)，它应当仅通过序列化器构造。作为数据类，它可能无法保证兼容性，请避免直接构造它。