AFCore/com.advantahealth.api/AFCoreExperimentalApi

AFCoreExperimentalApi

@RequiresOptIn(level = RequiresOptIn.Level.WARNING, message = "This AFCore API is experimental and may change or be removed without notice. Do not depend on it in production code yet.")

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

annotation class AFCoreExperimentalApi

Marks an AFCore API as experimental — the surface is intentionally exposed to gather feedback and validate the design, but it is not ready for production use and may change in incompatible ways (or be removed entirely) in a future release without a major-version bump.

Callers must explicitly opt in:

@OptIn(AFCoreExperimentalApi::class)
fun signIn() {
    AFCore.authentication().authenticateWithTokens(...)
}

Swift / Objective-C consumers do not see a compile-time gate (Kotlin's opt-in mechanism is a Kotlin-compiler feature), so the experimental status is communicated through KDoc / generated documentation on the iOS side. Treat the same warning as binding regardless of the consuming language.