ConnectionConfiguration

sealed class ConnectionConfiguration

The ConnectionConfiguration class contains configuration information for connecting to a reader.

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

Types

Link copied to clipboard
class BluetoothConnectionConfiguration(locationId: String, autoReconnectOnUnexpectedDisconnect: Boolean, bluetoothReaderReconnectionListener: ReaderReconnectionListener?) : ConnectionConfiguration

The BluetoothConnectionConfiguration object is used to connect to a bluetooth reader (currently DeviceType.CHIPPER_2X, DeviceType.STRIPE_M2 and DeviceType.WISEPAD_3)

Link copied to clipboard
object Companion
Link copied to clipboard
class EmbeddedConnectionConfiguration(posConnectionType: PosConnectionType?, listener: Any, supportsOfflineMode: Boolean) : ConnectionConfiguration

The EmbeddedConnectionConfiguration object should be used to connect to an embedded reader

Link copied to clipboard
class HandoffConnectionConfiguration : ConnectionConfiguration

The HandoffConnectionConfiguration object should be used to connect to a reader in handoff mode.

Link copied to clipboard
class InternetConnectionConfiguration(failIfInUse: Boolean) : ConnectionConfiguration

The InternetConnectionConfiguration object should be used to connect to an internet reader (currently DeviceType.VERIFONE_P400)

Link copied to clipboard
class LocalMobileConnectionConfiguration(locationId: String) : ConnectionConfiguration

The LocalMobileConnectionConfiguration object should be used to connect to the phone's or tablet's NFC reader.

Link copied to clipboard
interface LocationRegistration
Link copied to clipboard
class UsbConnectionConfiguration(locationId: String, autoReconnectOnUnexpectedDisconnect: Boolean, usbReaderReconnectionListener: ReaderReconnectionListener?) : ConnectionConfiguration

The UsbConnectionConfiguration object is used to connect to a USB reader (currently DeviceType.CHIPPER_2X, DeviceType.STRIPE_M2 and DeviceType.WISEPAD_3)

Properties

Link copied to clipboard
val failIfInUse: Boolean

When failIfInUse is true, an error will be returned when attempting to connect to a reader that is already collecting a payment

Link copied to clipboard
val locationId: String?

The ID of the Location that you want this reader to be registered to.

Link copied to clipboard
Link copied to clipboard
val registerToLocation: String?

Inheritors

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard