Package-level declarations
The public API: com.alirezaiyan.passki.Passkeys, results and errors, capabilities, signals and the setup doctor.
The public API: com.alirezaiyan.passki.Passkeys, results and errors, capabilities, signals and the setup doctor.
The public API: com.alirezaiyan.passki.Passkeys, results and errors, capabilities, signals and the setup doctor.
The public API: com.alirezaiyan.passki.Passkeys, results and errors, capabilities, signals and the setup doctor.
The public API: com.alirezaiyan.passki.Passkeys, results and errors, capabilities, signals and the setup doctor.
Types
One diagnosed item of a DoctorReport.
Result of PasskeyDoctor.run: one DoctorCheck per diagnosed item, in the order they ran.
Outcome of a DoctorCheck.
Marks declarations shared between PassKi modules. Not part of the stable API.
Whether a new passkey must have large-blob storage (PasskeyExtensions.withLargeBlob).
Result of Passkeys.signIn. Send json to the server. Instances are created by PassKi; the constructor is internal API so fields can be added without breaking binaries.
What this device/OS supports. Instances are created by PassKi; the constructor is internal API so fields can be added without breaking binaries.
Diagnoses passkey setup for a relying party on this device: platform support, app configuration and the well-known association files (assetlinks.json on Android, apple-app-site-association on iOS).
Diagnoses passkey setup for a relying party on this device: platform support, app configuration and the well-known association files (assetlinks.json on Android, apple-app-site-association on iOS).
Diagnoses passkey setup for a relying party on this device: platform support, app configuration and the well-known association files (assetlinks.json on Android, apple-app-site-association on iOS).
Diagnoses passkey setup for a relying party on this device: platform support, app configuration and the well-known association files (assetlinks.json on Android, apple-app-site-association on iOS).
Diagnoses passkey setup for a relying party on this device: platform support, app configuration and the well-known association files (assetlinks.json on Android, apple-app-site-association on iOS).
Every way a passkey operation can fail, across all platforms. fixHint is non-null when a developer can fix the cause (configuration, options). checkId names the setup check from the PassKi check catalog that covers the cause, the same ID PasskeyDoctor, ./gradlew passkiCheck and the web verifier report, and docsUrl links its docs page.
The kind of a PasskeyError, from PasskeyError.category.
Thrown by getOrThrow. The message includes PasskeyError.fixHint and PasskeyError.docsUrl when there are ones.
Adds typed WebAuthn extensions to the options JSON your server produced, before you pass it to Passkeys.register or Passkeys.signIn. Read the outputs from PasskeyRegistration / PasskeyAssertion.
Result of Passkeys.register. Send json to the server. Instances are created by PassKi; the constructor is internal API so fields can be added without breaking binaries.
Outcome of a passkey operation: either Success with a value or Failure with a typed PasskeyError.
Tells credential providers about server-side changes (WebAuthn Signal API). Requires PasskeyCapabilities.signals.
Manual initialisation for apps that disabled androidx.startup.
Receives PassKi's log entries. tag is always PassKi; message never contains challenges, user handles, options or response JSON, passwords, PRF outputs or large-blob data, and credential IDs are shortened. throwable is the platform error behind a PasskeyError.Unknown, if there is one.
How much PassKi logs; each level includes the ones above it.
Outputs of the WebAuthn prf extension (PasskeyExtensions.withPrf): one 32-byte result per salt.
What a PasskeySignals call did.
What the user picked in Passkeys.signInOrPassword.
How Passkeys.signIn presents itself.
Properties
True for PasskeyResult.Failure.
True for PasskeyResult.Success.
Functions
Returns the error on failure, or null on success.
Returns the value on success, or throws a PasskeyException carrying the error.
Transforms the value on success; failures pass through unchanged.
Transforms the error on failure, e.g. into another PasskeyError; successes pass through unchanged.
Runs action with the error if this is a PasskeyResult.Failure; returns this result unchanged.
Runs action with the value if this is a PasskeyResult.Success; returns this result unchanged.
The same outcome as a kotlin.Result; a failure holds a PasskeyException whose error is the original error. For code built around Result (e.g. runCatching chains).