kjwt-core/co.touchlab.kjwt.annotations

Package-level declarations

Types

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

@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "API marked with this annotation should be used only when you know what you are doing. Avoid usage of such declarations as much as possible. They are provided mostly for backward compatibility with older services that require them.")

annotation class DelicateKJWTApi

APIs annotated as delicate KJWT API are not meant for typical client usage; no guarantees about binary nor source compatibility are provided, and incorrect usage may lead to security vulnerabilities or undefined behaviour. Avoid the usage of these APIs in client code unless you fully understand the implications.

ExperimentalKJWTApi

@RequiresOptIn(level = RequiresOptIn.Level.WARNING, message = "This API is an experimental API and is likely to change before becoming stable")

annotation class ExperimentalKJWTApi

APIs annotated as experimental KJWT API are subject to change at any time, with no binary nor source compatibility guarantees. Behavior might change at any time.

InternalKJWTApi

@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "This API is internal and not intended to be used by external applications. It may be changed in the future without notice.")

annotation class InternalKJWTApi

APIs annotated as internal KJWT API are not meant for usage in client code; there are no guarantees about binary nor source compatibility, and the behavior can change at any time. Avoid the usage of these APIs in client code!