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

Package-level declarations

Types

Link copied to clipboard
data class ElementValidationError(val detail: String)

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

Link copied to clipboard
interface ForageElement<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 ForagePinElement adhere to the ForageElement interface.

Link copied to clipboard
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 a ForagePanElement to call the ForageSDK online-only method to com.joinforage.forage.android.ForageSDK.tokenizeEBTCard, or the ForageTerminalSDK POS method to com.joinforage.forage.android.pos.ForageTerminalSDK.tokenizeCard.

Link copied to clipboard
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 need a ForagePinElement to call the ForageSDK online-only or ForageTerminalSDK POS methods that:

Link copied to clipboard
abstract class ForageVaultElement<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 ForageElement types. You don't need to use or worry about it!

Properties

Link copied to clipboard
val IncompleteEbtPanError: ElementValidationError

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

Link copied to clipboard
val IncompleteEbtPinError: ElementValidationError

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

Link copied to clipboard
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.

Link copied to clipboard
val WrongEbtPinError: ElementValidationError

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