TomGatedSecretStore class abstract interface

Device secrets released only after the OS's own check: Touch ID, Face ID, a fingerprint, Windows Hello, the device passcode. The OS unlock of an app keeps its unlock bundle here (part-os-unlock).

Like TomSecretStore, a handle is an identifier, not a secret. Unlike it, every read may show the OS prompt with a reason text, and availability says what the gate is before an item is written.

Implementers

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

availability() → Future<TomGatedAvailability>
What gates an item on this device now; TomGatedAvailability.none when nothing can.
delete(String handle) → Future<void>
Forgets the secret at handle, if any, without a prompt.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
read(String handle, {required String reason}) → Future<String?>
The secret under handle after the OS check, which shows reason; null when nothing is stored there (no prompt then). Throws TomGatedSecretStoreException when the check fails or is cancelled.
toString() → String
A string representation of this object.
inherited
write(String handle, String secret, {TomGatedLifetime lifetime = TomGatedLifetime.saved, String? reason}) → Future<void>
Stores secret under handle, replacing any current value. A store whose key exists only after the check (Windows Hello) shows the prompt with reason here too. Throws TomGatedSecretStoreException.

Operators

operator ==(Object other) → bool
The equality operator.
inherited