AFCore/com.advantahealth.api

Package-level declarations

The entry point and SDK-wide types: AFCore, its configuration, session state, logging, realms and errors.

Types

AFCore

actual object AFCore

The AFCore SDK entry point on Android.

actual object AFCore

The AFCore SDK entry point on iOS.

actual object AFCore

The AFCore SDK entry point on watchOS.

AFCoreConfig

class AFCoreConfig(baseUrl: String, clientId: String, clientSecret: String, enableLogging: Boolean, logLevel: AFLogLevel, enableHttpLogging: Boolean, httpLogLevel: AFLogLevel, supportsManualSteps: Boolean, heartbeatEnabled: Boolean?, connectTimeoutMillis: Long, requestTimeoutMillis: Long, socketTimeoutMillis: Long, cacheEnabled: Boolean, cacheTtlMillis: Long, cacheMaxEntries: Int, maxNetworkRetries: Int, tokenRefreshLeadTimeMillis: Long, outboxMaxEntries: Int, outboxMaxAgeMillis: Long, outboxFlushIntervalMillis: Long, smartWalkingSyncIntervalMillis: Long, healthLookbackDays: Int, heartbeatForegroundThrottleMillis: Long, heartbeatBackgroundThrottleMillis: Long, realm: AFRealm?, throwOnReadFailure: Boolean)

Library-stable configuration for AFCore initialization. Not a data class to preserve binary/source compatibility across releases.

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.

AFErrorKind

enum AFErrorKind : Enum<AFErrorKind>

What kind of failure an AFException represents, classified by the SDK the same way on every platform.

AFException

class AFException(val message: String? = null, val isError: Boolean? = null, val detail: String? = null, val data: String? = null, val errors: List<String?>? = null, val httpCode: Int? = null) : Exception

Represents an exception that occurs during an API call.

AFLogLevel

enum AFLogLevel : Enum<AFLogLevel>

Severity threshold for SDK and HTTP logging.

AFLogWriter

fun interface AFLogWriter

Custom log output hook for AFCore's internal logger.

AFRealm

enum AFRealm : Enum<AFRealm>

The Advanta Mobile API platform (realm) your app's members belong to.

SessionState

enum SessionState : Enum<SessionState>

Observable session lifecycle states emitted by AFCore.authentication().sessionState (and the deprecated AFCore.sessionState).