payments-ui-core/com.stripe.android.ui.core.elements

Package-level declarations

Types

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Serializable

data class AddressSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic("billing_details[address]"), val allowedCountryCodes: Set<String> = supportedBillingCountries, val displayFields: Set<DisplayField> = emptySet(), val showLabel: Boolean = true, val type: AddressType = AddressType.Normal()) : FormItemSpec

AffirmHeaderElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class AffirmHeaderElement(val identifier: IdentifierSpec, val controller: Controller? = null) : FormElement

AfterpayClearpayHeaderElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class AfterpayClearpayHeaderElement(val identifier: IdentifierSpec, amount: Amount, val controller: Controller? = null) : FormElement

AuBankAccountNumberConfig

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class AuBankAccountNumberConfig : TextFieldConfig

A text field configuration for an AU bank account number

AuBankAccountNumberSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Serializable

class AuBankAccountNumberSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic( "au_becs_debit[account_number]" )) : FormItemSpec

AuBecsDebitMandateTextElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class AuBecsDebitMandateTextElement(val identifier: IdentifierSpec, val merchantName: String?, val controller: InputController? = null) : FormElement

This is an element that has static text because it takes no user input, it is not outputted from the list of form field values. If the stringResId contains a %s, the first one will be populated in the form with the merchantName parameter.

BsbConfig

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class BsbConfig(banks: List<BecsDebitBanks.Bank>) : TextFieldConfig

A text field configuration for a BSB number, or Bank State Branch Number, a six-digit number used to identify the individual branch of an Australian financial institution

BsbElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class BsbElement(identifierSpec: IdentifierSpec, banks: List<BecsDebitBanks.Bank>, initialValue: String?) : FormElement

BsbSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Serializable

data class BsbSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic( "au_becs_debit[bsb_number]" )) : FormItemSpec

Capitalization

@Serializable

enum Capitalization : Enum<Capitalization>

CardBillingAddressElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class CardBillingAddressElement(identifier: IdentifierSpec, rawValuesMap: Map<IdentifierSpec, String?> = emptyMap(), addressRepository: AddressRepository, countryCodes: Set<String> = emptySet(), countryDropdownFieldController: DropdownFieldController = DropdownFieldController( CountryConfig(countryCodes), rawValuesMap[IdentifierSpec.Country] ), sameAsShippingElement: SameAsShippingElement?, shippingValuesMap: Map<IdentifierSpec, String?>?) : AddressElement

This is a special type of AddressElement that removes fields from the address based on the country. It is only intended to be used with the card payment method.

CardBillingSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Serializable

data class CardBillingSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic("card_billing"), val allowedCountryCodes: Set<String> = supportedBillingCountries) : FormItemSpec

CardDetailsSectionController

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class CardDetailsSectionController(context: Context, initialValues: Map<IdentifierSpec, String?>, viewOnlyFields: Set<IdentifierSpec>) : SectionFieldErrorController

CardDetailsSectionElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class CardDetailsSectionElement(val context: Context, initialValues: Map<IdentifierSpec, String?>, viewOnlyFields: Set<IdentifierSpec>, val identifier: IdentifierSpec, val controller: CardDetailsSectionController = CardDetailsSectionController(context, initialValues, viewOnlyFields)) : FormElement

CardDetailsSectionSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Serializable

data class CardDetailsSectionSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic("card_details")) : FormItemSpec

Section containing card details form

ConfirmResponseStatusSpecs

@Serializable(with = ConfirmResponseStatusSpecsSerializer::class)

sealed class ConfirmResponseStatusSpecs

ConfirmResponseStatusSpecsSerializer

object ConfirmResponseStatusSpecsSerializer : JsonContentPolymorphicSerializer<ConfirmResponseStatusSpecs>

ConfirmStatusSpecAssociation

@Serializable

data class ConfirmStatusSpecAssociation(val requiresPaymentMethod: ConfirmResponseStatusSpecs? = null, val requiresConfirmation: ConfirmResponseStatusSpecs? = null, val requiresAction: ConfirmResponseStatusSpecs? = null, val processing: ConfirmResponseStatusSpecs? = null, val succeeded: ConfirmResponseStatusSpecs? = ConfirmResponseStatusSpecs.FinishedSpec, val canceled: ConfirmResponseStatusSpecs? = null)

CountrySpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable

data class CountrySpec(val apiPath: IdentifierSpec = IdentifierSpec.Country, val allowedCountryCodes: Set<String> = supportedBillingCountries) : FormItemSpec

This is the specification for a country field.

CvcConfig

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class CvcConfig : CardDetailsTextFieldConfig

CvcController

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class CvcController(cvcTextFieldConfig: CvcConfig = CvcConfig(), cardBrandFlow: Flow<CardBrand>, initialValue: String? = null, val showOptionalLabel: Boolean = false) : TextFieldController, SectionFieldErrorController

CvcElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class CvcElement(val _identifier: IdentifierSpec, val controller: CvcController) : SectionSingleFieldElement

DisplayField

@Serializable

enum DisplayField : Enum<DisplayField>

DropdownItemSpec

@Serializable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class DropdownItemSpec(val apiValue: String? = null, val displayText: String = "Other")

DropdownSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Serializable

data class DropdownSpec(val apiPath: IdentifierSpec, val labelTranslationId: TranslationId, val items: List<DropdownItemSpec>) : FormItemSpec

EmailElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

data class EmailElement(val identifier: IdentifierSpec = IdentifierSpec.Email, val initialValue: String? = "", val controller: TextFieldController = SimpleTextFieldController( EmailConfig(), initialValue = initialValue )) : SectionSingleFieldElement

EmailSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable

data class EmailSpec(val apiPath: IdentifierSpec = IdentifierSpec.Email) : FormItemSpec

EmptyFormElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class EmptyFormElement(val identifier: IdentifierSpec = IdentifierSpec.Generic("empty_form"), val controller: Controller? = null) : FormElement

FormItemSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable(with = FormItemSpecSerializer::class)

sealed class FormItemSpec

This is used to define each section in the visual form layout specification

FormItemSpecSerializer

object FormItemSpecSerializer : JsonContentPolymorphicSerializer<FormItemSpec>

IbanConfig

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class IbanConfig : TextFieldConfig

A text field configuration for an IBAN, or International Bank Account Number, as defined in ISO 13616-1.

IbanSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Serializable

data class IbanSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic("sepa_debit[iban]")) : FormItemSpec

KeyboardType

@Serializable

enum KeyboardType : Enum<KeyboardType>

KlarnaCountrySpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Serializable

class KlarnaCountrySpec(val apiPath: IdentifierSpec = IdentifierSpec.Country) : FormItemSpec

This is the specification for a klarna country field

KlarnaHelper

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

object KlarnaHelper

LayoutFormDescriptor

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class LayoutFormDescriptor(val layoutSpec: LayoutSpec?, val showCheckbox: Boolean, val showCheckboxControlledFields: Boolean)

LayoutSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class LayoutSpec(val items: List<FormItemSpec>)

This is a data representation of the layout of UI fields on the screen.

MandateTextElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class MandateTextElement(val identifier: IdentifierSpec, val stringResId: Int, val merchantName: String?, val controller: InputController? = null) : FormElement

MandateTextSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable

data class MandateTextSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic("mandate"), @StringRes val stringResId: Int) : FormItemSpec

Mandate text element spec.

NameSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable

data class NameSpec(val apiPath: IdentifierSpec = IdentifierSpec.Name, val labelTranslationId: TranslationId = TranslationId.AddressName) : FormItemSpec

NextActionSpec

@Serializable

data class NextActionSpec(val confirmResponseStatusSpecs: ConfirmStatusSpecAssociation? = null, val postConfirmHandlingPiStatusSpecs: PostConfirmStatusSpecAssociation? = null)

OTPSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable

object OTPSpec : FormItemSpec

PostConfirmHandlingPiStatusSpecs

@Serializable(with = PostConfirmHandlingPiStatusSpecsSerializer::class)

sealed class PostConfirmHandlingPiStatusSpecs

PostConfirmHandlingPiStatusSpecsSerializer

object PostConfirmHandlingPiStatusSpecsSerializer : JsonContentPolymorphicSerializer<PostConfirmHandlingPiStatusSpecs>

PostConfirmStatusSpecAssociation

@Serializable

data class PostConfirmStatusSpecAssociation(val requiresPaymentMethod: PostConfirmHandlingPiStatusSpecs? = null, val requiresConfirmation: PostConfirmHandlingPiStatusSpecs? = null, val requiresAction: PostConfirmHandlingPiStatusSpecs? = null, val processing: PostConfirmHandlingPiStatusSpecs? = null, val succeeded: PostConfirmHandlingPiStatusSpecs? = null, val canceled: PostConfirmHandlingPiStatusSpecs? = null)

SaveForFutureUseController

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class SaveForFutureUseController(saveForFutureUseInitialValue: Boolean) : InputController

SaveForFutureUseElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class SaveForFutureUseElement(val identifier: IdentifierSpec, val controller: SaveForFutureUseController, val merchantName: String?) : FormElement

This is an element that will make elements (as specified by identifier) hidden when "save for future" use is unchecked

SaveForFutureUseSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable

data class SaveForFutureUseSpec(val apiPath: IdentifierSpec = IdentifierSpec.SaveForFutureUse) : FormItemSpec

This is an element that will make elements (as specified by identifier) hidden when save for future use is unchecked

SimpleDropdownConfig

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class SimpleDropdownConfig(@StringRes val label: Int, items: List<DropdownItemSpec>) : DropdownConfig

SimpleDropdownElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class SimpleDropdownElement(val identifier: IdentifierSpec, val controller: DropdownFieldController) : SectionSingleFieldElement

SimpleTextSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable

data class SimpleTextSpec(val apiPath: IdentifierSpec, @StringRes val label: Int, val capitalization: Capitalization = Capitalization.None, val keyboardType: KeyboardType = KeyboardType.Ascii, val showOptionalLabel: Boolean = false) : FormItemSpec

StaticTextElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class StaticTextElement(val identifier: IdentifierSpec, val stringResId: Int, val controller: InputController? = null) : FormElement

TranslationId

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Serializable

enum TranslationId : Enum<TranslationId>

UpiConfig

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class UpiConfig : TextFieldConfig

UpiElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class UpiElement(val identifier: IdentifierSpec, val controller: InputController = SimpleTextFieldController( textFieldConfig = UpiConfig() )) : SectionSingleFieldElement

UpiSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Serializable

data class UpiSpec(val apiPath: IdentifierSpec = IdentifierSpec.Upi) : FormItemSpec

Functions

AffirmElementUI

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun AffirmElementUI()

AfterpayClearpayElementUI

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun AfterpayClearpayElementUI(enabled: Boolean, element: AfterpayClearpayHeaderElement)

AuBecsDebitMandateElementUI

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun AuBecsDebitMandateElementUI(element: AuBecsDebitMandateTextElement)

BsbElementUI

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun BsbElementUI(enabled: Boolean, element: BsbElement, lastTextFieldIdentifier: IdentifierSpec?)

CardDetailsSectionElementUI

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun CardDetailsSectionElementUI(enabled: Boolean, controller: CardDetailsSectionController, hiddenIdentifiers: Set<IdentifierSpec>, lastTextFieldIdentifier: IdentifierSpec?)

H4Text

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun H4Text(text: String, modifier: Modifier = Modifier)

HyperlinkedText

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun HyperlinkedText(text: String, modifier: Modifier = Modifier, color: Color = Color.Unspecified, style: TextStyle = LocalTextStyle.current)

MandateTextUI

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun MandateTextUI(element: MandateTextElement)

SaveForFutureUseElementUI

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun SaveForFutureUseElementUI(enabled: Boolean, element: SaveForFutureUseElement, modifier: Modifier = Modifier)

SimpleDialogElementUI

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun SimpleDialogElementUI(openDialog: MutableState<Boolean>, titleText: String, messageText: String, confirmText: String, dismissText: String, onConfirmListener: () -> Unit = {}, onDismissListener: () -> Unit = {})

StaticTextElementUI

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun StaticTextElementUI(element: StaticTextElement)

createExpiryDateFormFieldValues

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun createExpiryDateFormFieldValues(entry: FormFieldEntry): Map<IdentifierSpec, FormFieldEntry>

filterNotNullValues

fun <K, V> Map<K, V?>.filterNotNullValues(): Map<K, V>

getNextActionFromSpec

fun getNextActionFromSpec(confirmResponseStatusSpecs: ConfirmResponseStatusSpecs): LuxePostConfirmActionCreator

mapToOutcome

fun mapToOutcome(spec: ConfirmResponseStatusSpecs?): Int?

fun mapToOutcome(spec: PostConfirmHandlingPiStatusSpecs?): Int?

transform

fun NextActionSpec?.transform(): LuxePostConfirmActionRepository.LuxeAction

Properties

SAVE_FOR_FUTURE_CHECKBOX_TEST_TAG

const val SAVE_FOR_FUTURE_CHECKBOX_TEST_TAG: String