kord-extensions/dev.kordex.core.annotations

Package-level declarations

Types

@RequiresOptIn(message = "This function will always result in a public interaction response, even if used within an ephemeral interaction.", level = RequiresOptIn.Level.WARNING)

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class AlwaysPublicResponse

Marks a function that always results in public interaction responses.

BotBuilderDSL

@DslMarker

annotation class BotBuilderDSL

Marks a class or function that's part of the bot builder DSLs.

DoNotChain

@RequiresOptIn(message = "This function will cause an immediate REST call. If you want to do more than one operation here, you should use `.edit { }` instead as that will result in a single REST call for all operations - instead of a separate REST call for each operation.", level = RequiresOptIn.Level.WARNING)

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class DoNotChain

Marks a class or function that's part of the bot builder DSLs.

ExtensionDSL

@DslMarker

annotation class ExtensionDSL

Marks a class or function that's part of the extension DSLs.

InternalAPI

@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "This API is internal and should not be used, as it could be removed or changed without notice.An alternative API may be available - read the KDoc comment for this element to check. In IntelliJ IDEA, you may jump to the definition by holding CTRL and clicking on the element.")

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

annotation class InternalAPI

NotTranslated

@RequiresOptIn(level = RequiresOptIn.Level.WARNING, message = "A String or Strings provided here will not be translated. If you intended to translate, please switch to using Key objects.")

annotation class NotTranslated

UnexpectedFunctionBehaviour

@RequiresOptIn(message = "Calling or overriding this function may result in unexpected behaviour. Please ensure you read its documentation comment before continuing.", level = RequiresOptIn.Level.WARNING)

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class UnexpectedFunctionBehaviour

Marks a function that may result in unexpected behaviour, and ask the developer to check the docs.