external/com.stripe.stripeterminal.external.models/Reader

Reader

@Serializable(with = ReaderSerializer::class)

class Reader @JvmOverloads constructor(val deviceType: DeviceType = DeviceType.UNKNOWN, locationRaw: ExpandableLocation? = null, var locationStatus: LocationStatus = UNKNOWN, id: String? = null, val isSimulated: Boolean = false, val networkStatus: Reader.NetworkStatus? = null, rawSerialNumber: String? = null, val label: String? = null, deviceSwVersion: String? = null, val baseUrl: String? = null, val ipAddress: String? = null, val livemode: Boolean? = null, val bluetoothDevice: BluetoothDevice? = null, val usbDevice: UsbDevice? = null, location: Location? = null, readerInfoBatteryLevel: Float? = null, readerInfoConfigVersion: String? = null, var settingsVersion: String? = null, readerInfoFirmwareVersion: String? = null, readerInfoHardwareVersion: String? = null, val pinKeyProfileId: String? = null, val macKeyProfileId: String? = null, val trackKeyProfileId: String? = null, val emvKeyProfileId: String? = null, readerInfoPinKeysetId: String? = null, val macKeysetId: String? = null, val trackKeysetId: String? = null, val emvKeysetId: String? = null, val serial: String? = null, isDebug: Boolean? = false, val rawReaderData: Map<String, String>? = null, val isCharging: Boolean? = null, isDevKit: Boolean = false, val firmwareId: String? = null, val coinCellBatteryVoltage: Float? = null, val isUsbConnected: Boolean? = null) : Serializable

The Reader is a representation of a physical reader device.

Use of this SDK is subject to the Stripe Terminal Terms: https://stripe.com/terminal/legal

Constructors

Reader

@JvmOverloads

constructor(deviceType: DeviceType = DeviceType.UNKNOWN, locationRaw: ExpandableLocation? = null, locationStatus: LocationStatus = UNKNOWN, id: String? = null, isSimulated: Boolean = false, networkStatus: Reader.NetworkStatus? = null, rawSerialNumber: String? = null, label: String? = null, deviceSwVersion: String? = null, baseUrl: String? = null, ipAddress: String? = null, livemode: Boolean? = null, bluetoothDevice: BluetoothDevice? = null, usbDevice: UsbDevice? = null, location: Location? = null, readerInfoBatteryLevel: Float? = null, readerInfoConfigVersion: String? = null, settingsVersion: String? = null, readerInfoFirmwareVersion: String? = null, readerInfoHardwareVersion: String? = null, pinKeyProfileId: String? = null, macKeyProfileId: String? = null, trackKeyProfileId: String? = null, emvKeyProfileId: String? = null, readerInfoPinKeysetId: String? = null, macKeysetId: String? = null, trackKeysetId: String? = null, emvKeysetId: String? = null, serial: String? = null, isDebug: Boolean? = false, rawReaderData: Map<String, String>? = null, isCharging: Boolean? = null, isDevKit: Boolean = false, firmwareId: String? = null, coinCellBatteryVoltage: Float? = null, isUsbConnected: Boolean? = null)

Types

Companion

object Companion

NetworkStatus

@Serializable

enum NetworkStatus : Enum<Reader.NetworkStatus>

Contains possible states for the network connectivity status of the reader

Properties

availableUpdate

@Transient

var availableUpdate: ReaderSoftwareUpdate?

If, during connection to the reader, a ReaderSoftwareUpdate is found that is not yet required, it will be stored in this field for future installation. When Terminal.installAvailableUpdate is called, this is the update that will be installed.

baseUrl

val baseUrl: String? = null

The base url for this reader (Only set for internet connected readers)

batteryLevel

@Transient

var batteryLevel: Float?

Get the current battery level as a boxed float in the range 0, 1. If the reader does not have a battery, or the battery level is unknown, this will return null.

bluetoothDevice

@Transient

val bluetoothDevice: BluetoothDevice? = null

Raw bluetooth device information (Only set for bluetooth connected readers)

bootloaderVersion

@Transient

val bootloaderVersion: String? = null

coinCellBatteryVoltage

@Transient

val coinCellBatteryVoltage: Float? = null

configVersion

@Transient