OloPaySDK/com.olo.olopay.controls/PaymentCardCvvView

PaymentCardCvvView

class PaymentCardCvvView @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null) : ConstraintLayout

Convenience view for collecting CVV details from a user

Important:

User-entered CVV details are intentionally restricted for PCI compliance

Styling/Branding

This class can be styled in the following ways:

Override general-purpose resource values
Set styles programmatically

Override general-purpose resource values

Overriding general-purpose resource values is the easiest way to control the look/feel of the views in the Olo Pay SDK. Changing these values (listed below) will apply to not just PaymentCardCvvView, but also PaymentCardDetailsSingleLineView and PaymentCardDetailsMultiLineView. To override the resources, simply define resources in your app with the same names listed below

Color Resources

olopay_edittext_textcolor
olopay_errortext_textcolor

Set styles programmatically

A number of methods exist that allow you to style PaymentCardCvvView. Methods exist for changing the background style (color, border, radius, etc), the text colors, error text colors, hint text colors, font, and font size.

Constructors

PaymentCardCvvView

@JvmOverloads

constructor(context: Context, attrs: AttributeSet? = null)

Creates a new instance of PaymentCardCvvView

Properties

cvvInputListener

var cvvInputListener: CvvInputListener?

Set this to receive callbacks about card input events for this control

cvvTokenParams

val cvvTokenParams: ICvvTokenParams?

Get an ICvvTokenParams instance that can be used to create an ICvvUpdateToken instance. If the field is not valid this will return null.

displayErrors

var displayErrors: Boolean

Whether or not to display built-in error messages

fieldState

val fieldState: ICardFieldState

Provides a snapshot of the current state of the field

isValid

val isValid: Boolean

Whether or not the input field contains a valid CVV value

Functions

clear

fun clear()

Clears the text field in this control

dismissKeyboard

fun dismissKeyboard()

Dismisses the keyboard, if visible, and removes focus from the input field in this control

getErrorMessage

fun getErrorMessage(ignoreUneditedFieldErrors: Boolean): String

Get the error message that would be displayed if isValid is false. Note that isValid having a value of false does not necessarily mean there will be an error message (see ignoreUneditedFieldErrors param)

hasErrorMessage

fun hasErrorMessage(ignoreUneditedFieldErrors: Boolean = true): Boolean

Check if there is an error message to be displayed.

requestFocus

fun requestFocus(showKeyboard: Boolean)

Moves focus to the input field

setCursorColor

@RequiresApi(value = 29)

fun setCursorColor(color: Int)

@RequiresApi(value = 29)

fun setCursorColor(colorHex: String)

Sets the color for the cursor, selection handles, and text selection highlight

setCvvBackgroundStyle

fun setCvvBackgroundStyle(backgroundColor: Int? = null, borderColor: Int? = null, borderWidthPx: Float? = null, borderRadiusPx: Float? = null)

@RequiresApi(value = 27)

fun setCvvBackgroundStyle(backgroundColorHex: String? = null, borderColorHex: String? = null, borderWidthPx: Float? = null, borderRadiusPx: Float? = null)

Sets background styles for this view.

setCvvPadding