BotCommands-typesafe-messages-core/dev.freya02.botcommands.typesafe.messages.api.annotations

Package-level declarations

Types

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

annotation class ExperimentalTypesafeMessagesApi

Opt-in marker annotation for the type-safe (localized) messages APIs that are considered experimental and are not subject to compatibility guarantees: The behavior of such API may be changed or the API may be removed completely in any further release.

LocalizedContent

@ExperimentalTypesafeMessagesApi

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class LocalizedContent(val templateKey: String)

Annotates a method as a message supplier.

MessageSourceFactory

@Component

@ExperimentalTypesafeMessagesApi

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

annotation class MessageSourceFactory(val bundleName: String, val discordLocales: Array<DiscordLocale> = [], val locales: Array<String> = [], val ignoreEmptyLocales: Boolean = false)

Mandatory annotation for interfaces extending IMessageSourceFactory.

PreferLocale

@ExperimentalTypesafeMessagesApi

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

annotation class PreferLocale(val preference: LocalePreference)

Allows changing the default locale with another preferred locale, the available locales will depend on how the message source was created.