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

Reader

@JsonClass(generateAdapter = true)

class Reader @JvmOverloads constructor(deviceType: DeviceType, @Json(name = "location") locationRaw: ExpandableLocation?, locationStatus: LocationStatus, id: String?, readerInfo: ReaderInfo?, isSimulated: Boolean, @Json(name = "status") networkStatus: Reader.NetworkStatus?, @Json(name = "serialNumber") rawSerialNumber: String?, label: String?, deviceSwVersion: String?, baseUrl: String?, ipAddress: String?, livemode: Boolean?, device: BluetoothDevice?, bluetoothDevice: BluetoothDevice?, usbDevice: UsbDevice?, location: Location?)

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

fun Reader(deviceType: DeviceType = DeviceType.UNKNOWN, @Json(name = "location") locationRaw: ExpandableLocation? = null, locationStatus: LocationStatus = UNKNOWN, id: String? = null, readerInfo: ReaderInfo? = null, isSimulated: Boolean = false, @Json(name = "status") networkStatus: Reader.NetworkStatus? = null, @Json(name = "serialNumber") rawSerialNumber: String? = null, label: String? = null, deviceSwVersion: String? = null, baseUrl: String? = null, ipAddress: String? = null, livemode: Boolean? = null, device: BluetoothDevice? = null, bluetoothDevice: BluetoothDevice? = null, usbDevice: UsbDevice? = null, location: Location? = null)

Types

object Companion

enum NetworkStatus : Enum<Reader.NetworkStatus>

Contains possible states for the network connectivity status of the reader

Functions

fun activate(readerId: String?, location: Location?, canonicalReaderVersion: Long? = null)

setAvailableUpdate

fun setAvailableUpdate(targetKey: String?, targetConfig: String?, targetFirmware: String?)

fun toDeviceInfo(): DeviceInfo

fun update(update: ReaderSoftwareUpdate)

Properties

availableUpdate

var availableUpdate: ReaderSoftwareUpdate? = null

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.

val baseUrl: String? = null

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

val 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

val bluetoothDevice: BluetoothDevice? = null

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

bootloaderVersion

val bootloaderVersion: String? = null

canonicalReaderVersion

var canonicalReaderVersion: Long? = null

var configVersion: String?

~~val~~ ~~device~~: BluetoothDevice? = ~~null~~

see bluetoothDevice

val deviceType: DeviceType

Get the DeviceType of this reader

emvKeyProfileId

val emvKeyProfileId: String?

firmwareVersion

var firmwareVersion: String?

hardwareVersion

val hardwareVersion: String?

var id: String?

An identifier for the reader

val ipAddress: String? = null

The ip address of this reader. (Only set for internet connected readers)

val isSimulated: Boolean = false

Return whether this reader is simulated

val label: String? = null

A custom label that may be given to a reader for easier identification. (Only set for internet connected readers)

val livemode: Boolean? = null

Whether this reader is in livemode

var location: Location?

Get the Location this reader is registered to, if any

var locationStatus: LocationStatus

Get the LocationStatus of this reader, to know what can be expected in the registeredLocation field

macKeyProfileId

val macKeyProfileId: String?

val networkStatus: Reader.NetworkStatus? = null

The networking status of the reader: either offline or online. Note that (Only set for internet connected readers)

pinKeyProfileId

val pinKeyProfileId: String?

var pinKeysetId: String?

val rawReaderData: Map<String, String>?

registeredLocation

~~val~~ ~~registeredLocation~~: Location?

val serialNumber: String?

Get the serial number of this reader

settingsVersion

var settingsVersion: String? = null

softwareVersion

var softwareVersion: String

Get the current software version on the reader, expressed as a string

trackKeyProfileId

val trackKeyProfileId: String?

val usbDevice: UsbDevice? = null

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