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

Package-level declarations

通用标记性注解定义。

Types

@RequiresOptIn(message = "一个设计为仅供 Java 用户使用的API", level = RequiresOptIn.Level.WARNING)

annotation class Api4J

一个设计为仅供 Java 用户使用的API

@RequiresOptIn(message = "一个设计为仅供 JS 用户使用的API", level = RequiresOptIn.Level.WARNING)

annotation class Api4Js

一个设计为仅供 JS 用户使用的API

@RequiresOptIn(message = "试验性的响应式桥接 API。响应式桥接函数的生成仍是实验性的，它可能会在未来被修改或删除，而不保证任何兼容性。")

实验性的响应式桥接 API。使用编译器插件为 suspend 函数生成返回值为 org.reactivestreams.Publisher 的响应式类型来提供对响应式类型更直接的支持。

@RequiresOptIn(message = "一个尚在试验阶段的API。试验阶段的API可能存在漏洞、缺陷，或实现不稳定，且有可能在未来被修改、删除，且没有兼容性保证。", level = RequiresOptIn.Level.WARNING)

一个尚在试验阶段的API。试验阶段的API可能存在漏洞、缺陷，或实现不稳定，且有可能在未来被修改、删除，且没有兼容性保证。

@RequiresOptIn(message = "一个脆弱的、或者具有复杂的须知、备注、条件的API。这类API通常有很多前提条件以及注意事项，需要谨慎使用。", level = RequiresOptIn.Level.WARNING)

annotation class FragileSimbotAPI

一个脆弱的、或者具有复杂的须知、备注、条件的API。这类API通常有很多前提条件以及注意事项，需要谨慎使用。

@RequiresOptIn(message = "实现了一个应当仅供内部实现的API。虽然超类对外可能稳定，但是不保证第三方实现稳定")

实现了一个应当仅供内部实现的API。虽然超类对外可能稳定，但是不保证第三方实现稳定。通常被使用在 SubclassOptInRequired 中。

@RequiresOptIn(message = "一个仅供 simbot 内部使用的API。它可能会随时变更、删除，且不保证兼容性。", level = RequiresOptIn.Level.WARNING)

一个仅供 simbot 内部使用的API。它可能会随时变更、删除，且不保证兼容性。