RecoveryKeyResetStatus

sealed interface RecoveryKeyResetStatus

The pending delayed reset of a user's offline recovery key (docs/recovery-key-reset.md), as returned to a registered device of the user by the signed GET …/last-device-recovery/key/reset, or to the holder of the current recovery key by the recovery-key-signed status query.

Applications must check this themselves (poll it, surface it to the user): the library sends no notification and never completes a reset on its own.

Inheritors

Types

Link copied to clipboard

No reset is pending.

Link copied to clipboard
class Pending(val resetId: RecoveryKeyResetId, val requestedBy: DeviceAddress, val requestedAt: Instant, val eligibleAt: Instant, val recoveryKeyEpoch: Long, recoveryPublicKey: ByteArray) : RecoveryKeyResetStatus

A reset resetId requested by requestedBy at the server time requestedAt is pending. It can be completed from eligibleAt on (server time; nothing happens automatically then) and cancelled until it is completed. It replaces the recovery key recoveryPublicKey (32 bytes, public data) at recoveryKeyEpoch; that key stays authoritative, including for last-device recovery, until completion.