Clerk Android API/com.clerk.api

Package-level declarations

Types

AuthFlowRegistration

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class AuthFlowRegistration : AutoCloseable

Keeps an SDK-owned authentication flow registered until the owning UI is disposed.

Clerk

object Clerk

Main entrypoint class for the Clerk SDK.

ClerkConfigurationOptions

data class ClerkConfigurationOptions(val enableDebugMode: Boolean = false, val proxyUrl: String? = null, val telemetryEnabled: Boolean = true, val sharedSessionSync: SharedSessionSyncConfig? = null)

Data class for enabling extra functionality on the Clerk SDK.

Constants

object Constants

Consolidated constants used throughout the Clerk SDK

FrameworkIntegrationApi

@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "This API exists for Clerk's own framework integrations (e.g. the Expo SDK) and may change without notice in minor releases. Opt in only if you accept that contract.")

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

annotation class FrameworkIntegrationApi

Marks APIs that exist for Clerk's own framework integrations (for example the Expo SDK).

SharedSessionSyncConfig

class SharedSessionSyncConfig

Enables Clerk authentication-state synchronization between sibling Android apps.

Properties

resetPasswordFactor

val SignIn.resetPasswordFactor: Factor?

Functions

identifyingFirstFactor

fun SignIn.identifyingFirstFactor(strategy: String): Factor?

toOAuthProvidersList

fun Map<String, UserSettings.SocialConfig>.toOAuthProvidersList(): List<OAuthProvider>

Extension function to convert a map of social provider configurations into a list of OAuthProvider objects.