forage-android/com.joinforage.forage.android.core.ui.element

Package-level declarations

Types

data class ElementValidationError(val detail: String)

A model that represents an error related to an incomplete or incorrect customer input.

interface ForageElement<out T : ElementState>

The interface that defines methods for configuring and interacting with a ForageElement. A ForageElement is a secure, client-side entity that accepts and submits customer input for a transaction. Both ForagePanElement and ForageVaultElement adhere to the ForageElement interface.

ForagePanElement

abstract class ForagePanElement @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = R.attr.foragePanEditTextStyle) : LinearLayout, ForageElement<PanEditTextState> , EditTextElement, DynamicEnvElement

A ForageElement that securely collects a customer's card number. You need an instance of a ForagePanElement to call the method to manually tokenize a card.

ForagePinElement

abstract class ForagePinElement @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = R.attr.foragePanEditTextStyle) : ForageVaultElement<PinEditTextState> , EditTextElement

A ForageElement that securely collects a card PIN. You can use an instance of a ForagePinElement to call the methods that:

ForageVaultElement

abstract class ForageVaultElement<out T : ElementState> @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = R.attr.foragePanEditTextStyle) : LinearLayout, ForageElement<T>

⚠️ Forage developers use this class to manage common attributes across the inheritors. You don't need to use or worry about it!

The parent ForageElement class of ForagePinElement and ForagePinPad, when the Elements are used with ForageTerminalSDK.

Properties

IncompleteEbtPanError

val IncompleteEbtPanError: ElementValidationError

A type of ElementValidationError that occurs when a customer submits an incomplete EBT Card number.

IncompleteEbtPinError

val IncompleteEbtPinError: ElementValidationError

A type of ElementValidationError that occurs when a customer submits an incomplete EBT Card PIN.

InvalidEbtPanError

val InvalidEbtPanError: ElementValidationError

A type of ElementValidationError that occurs when a customer submits an invalid numeric input that fails to meet the expected length constraint.

WrongEbtPinError

val WrongEbtPinError: ElementValidationError

A type of ElementValidationError that occurs when a customer submits an invalid EBT Card PIN.