vgscollect/com.verygoodsecurity.vgscollect.widget.compose.date/VgsExpiryDateFormat

VgsExpiryDateFormat

Card expiry date format used by com.verygoodsecurity.vgscollect.widget.compose.state.VgsExpiryTextFieldState.

Pick one for inputDateFormat (how the user types) and one for outputDateFormat (how the value is sent to VGS). They can differ — for example, accept MM/yy from the user but submit yyyy/MM.

Inheritors

Types

LongYearMonth

object LongYearMonth : VgsExpiryDateFormat

Four-digit year / two-digit month (e.g. 2027/12).

MonthLongYear

object MonthLongYear : VgsExpiryDateFormat

Two-digit month / four-digit year (e.g. 12/2027).

MonthShortYear

object MonthShortYear : VgsExpiryDateFormat

Two-digit month / two-digit year (e.g. 12/27).

ShortYearMonth

object ShortYearMonth : VgsExpiryDateFormat

Two-digit year / two-digit month (e.g. 27/12).

Properties

dateFormat

val dateFormat: String

underlying SimpleDateFormat pattern.

mask

val mask: String

input mask derived from dateFormat, where each digit is #.

maskCharsCount

val maskCharsCount: Int

Functions

convert

fun convert(text: String, targetFormat: VgsExpiryDateFormat): String?

Reformats text from this format into targetFormat, or null when text cannot be parsed.

format

fun format(date: Date?): String?

Formats date using this format, returning null when date is null or invalid.

parse

fun parse(text: String): Date?

Parses text using this format, returning null when text is invalid.