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

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 com.joinforage.forage.android.pos.ui.element.ForagePinPad, when the Elements are used with com.joinforage.forage.android.pos.services.ForageTerminalSDK.

Properties

CardExpiredError

val CardExpiredError: ElementValidationError

A type of ElementValidationError that occurs when a customer submits an expiration date in the past.

CardholderNameInvalidError

val CardholderNameInvalidError: ElementValidationError

A type of ElementValidationError that occurs when a customer submits an invalid cardholder name.

CardNumberInvalidError

val CardNumberInvalidError: ElementValidationError

A type of ElementValidationError that occurs when a customer submits an invalid card number.

ExpirationDateInvalidError

val ExpirationDateInvalidError: ElementValidationError

A type of ElementValidationError that occurs when a customer submits an invalid expiration date.

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.

SecurityCodeInvalidError

val SecurityCodeInvalidError: ElementValidationError

A type of ElementValidationError that occurs when a customer submits an invalid security code.

WrongEbtPinError

val WrongEbtPinError: ElementValidationError

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

ZipCodeInvalidError

val ZipCodeInvalidError: ElementValidationError

A type of ElementValidationError that occurs when a customer submits an invalid zip code.