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

ReaderSoftwareUpdate

class ReaderSoftwareUpdate(requiredAt: Date, timeEstimate: ReaderSoftwareUpdate.UpdateTimeEstimate, version: String, configSpec: ClientVersionSpecPb?, firmwareSpec: ClientVersionSpecPb?, keyProfileName: String?, settingsVersion: String?, imageRef: ImageRef?, 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

fun ReaderSoftwareUpdate(requiredAt: Date, timeEstimate: ReaderSoftwareUpdate.UpdateTimeEstimate, version: String, configSpec: ClientVersionSpecPb?, firmwareSpec: ClientVersionSpecPb?, keyProfileName: String?, settingsVersion: String?, imageRef: ImageRef?, config: MobileClientConfig?)

Types

UpdateComponent

enum UpdateComponent : Enum<ReaderSoftwareUpdate.UpdateComponent>

UpdateTimeEstimate

enum UpdateTimeEstimate : Enum<ReaderSoftwareUpdate.UpdateTimeEstimate>

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

Properties

val components: EnumSet<ReaderSoftwareUpdate.UpdateComponent>

val config: MobileClientConfig?

val configSpec: ClientVersionSpecPb?

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).

@get:JvmName(name = "hasKeyUpdate")

val hasKeyUpdate: Boolean

Whether this update includes a key update

val imageRef: ImageRef?

val keyProfileName: String?

onlyInstallRequiredUpdates

var onlyInstallRequiredUpdates: Boolean = false

val requiredAt: Date

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

settingsVersion

val settingsVersion: String?

val timeEstimate: ReaderSoftwareUpdate.UpdateTimeEstimate

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

val version: String

Return the version string for this update