State

sealed class State

The reader's state. MAGSTRIPE readers are always Ready.

Inheritors

Types

Link copied to clipboard

The reader is connected, but not yet ready for use. It should become ready soon, typically within a minute.

Link copied to clipboard

This reader is unusable; contact support for resolution, but hardware replacement is likely.

Link copied to clipboard

The reader is unavailable, but known. This represents a reader that has been paired via Bluetooth, but is not currently connected (typically because it is off or asleep or out of range).

Link copied to clipboard
data class FailedToConnect(val reason: ReaderInfo.DeniedReason? = null) : ReaderInfo.State

Connection to the reader failed.

Link copied to clipboard

The reader is available for use. Note that it is possible for a Ready cardreader to also be receiving a firmware update: this occurs for "non-blocking" firmware updates, and the update will be applied when the reader is next not in use after the firmwarePercent reaches 100%.

Link copied to clipboard

The reader is getting a blocking update, and cannot be used until that completes.