external/com.stripe.stripeterminal.external.models/ReaderSoftwareUpdate

ReaderSoftwareUpdate

class ReaderSoftwareUpdate(val requiredAtMs: Long, val durationEstimate: ReaderSoftwareUpdate.UpdateDurationEstimate, val version: String, val configSpec: ClientVersionSpecPb?, val firmwareSpec: ClientVersionSpecPb?, val keyProfileName: String?, val settingsVersion: String?, val imageRef: ImageRef?, val config: MobileClientConfig?)

ReaderSoftwareUpdate contains information about a potential software update to the reader.

For more information, see the official Stripe docs: Software updates

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

Constructors

ReaderSoftwareUpdate

constructor(requiredAtMs: Long, durationEstimate: ReaderSoftwareUpdate.UpdateDurationEstimate, version: String, configSpec: ClientVersionSpecPb?, firmwareSpec: ClientVersionSpecPb?, keyProfileName: String?, settingsVersion: String?, imageRef: ImageRef?, config: MobileClientConfig?)

Types

UpdateComponent

enum UpdateComponent : Enum<ReaderSoftwareUpdate.UpdateComponent>

UpdateDurationEstimate

enum UpdateDurationEstimate : Enum<ReaderSoftwareUpdate.UpdateDurationEstimate>

The UpdateDurationEstimate enums represents a range of time that this update is expected to take.

Properties

components

val components: Set<ReaderSoftwareUpdate.UpdateComponent>

config

val config: MobileClientConfig?

configSpec

val configSpec: ClientVersionSpecPb?

durationEstimate

val durationEstimate: ReaderSoftwareUpdate.UpdateDurationEstimate

The estimated amount of time an update will take to complete. Note that these times are estimates; actual times may vary depending on your network connection.

firmwareSpec

val firmwareSpec: ClientVersionSpecPb?

hasConfigUpdate

@get:JvmName(name = "hasConfigUpdate")

val hasConfigUpdate: Boolean

Whether this update includes a config update

hasFirmwareUpdate

@get:JvmName(name = "hasFirmwareUpdate")

val hasFirmwareUpdate: Boolean

Whether this update includes a firmware update

hasIncrementalUpdate

@get:JvmName(name = "hasIncrementalUpdate")

val hasIncrementalUpdate: Boolean

Whether this update includes an incremental update (defined as splash screen update, EMV application updates, or settings updates).

hasKeyUpdate

@get:JvmName(name = "hasKeyUpdate")

val hasKeyUpdate: Boolean

Whether this update includes a key update

imageRef

val imageRef: ImageRef?

keyProfileName

val keyProfileName: String?

onlyInstallRequiredUpdates

var onlyInstallRequiredUpdates: Boolean

requiredAtMs

val requiredAtMs: Long

The timestamp in milliseconds at which this update will be required to be installed. If this time is in the past, this update is required before the reader can be used.

settingsVersion

val settingsVersion: String?

version

val version: String

Return the version string for this update