getAvailability

abstract suspend fun getAvailability(parameters: BiometricsParameters): BiometricsAvailability

Returns the biometric availability status for the current device and user. This is a local-only operation — it does not make a network call.

Kotlin (Android):

StytchConsumer.biometrics.getAvailability(
BiometricsParameters(context = activity, sessionDurationMinutes = 0)
)

iOS:

let params = BiometricsParameters(sessionDurationMinutes: 0)
let availability = try await StytchConsumer.biometrics.getAvailability(params)

React Native:

StytchConsumer.biometrics.getAvailability({ sessionDurationMinutes: 0 })

Return

BiometricsAvailability — one of Available, AlreadyRegistered, or Unavailable.

Parameters

parameters
  • BiometricsParameters (see register for field descriptions).

Throws

if the coroutine is cancelled.