Interface IWalletTemplatePassData

The WalletTemplatePassData object contains the configuration for the Apple Wallet layout of the template.

Hierarchy

  • IWalletTemplatePassData

Properties

associatedStoreIdentifiers? auxiliaryFields? backFields? backgroundColor? barCodes description? expirationDate? foregroundColor? groupingIdentifier? headerFields? images includeLogoText? labelColor? nfcField? passStyle primaryFields? relevantDate? secondaryFields? subheader?

Properties

Optional associatedStoreIdentifiers

associatedStoreIdentifiers?: number[]

Optional auxiliaryFields

auxiliaryFields?: string[]

The auxilary fields for the card. These are used to construct the card layout. You add the key of the field you want to set here in the sequence you want them to be displayed. *This is not used on all card styles.

Optional backFields

backFields?: string[]

The back fields for the card. These are used to construct the card layout. You add the key of the field you want to set here in the sequence you want them to be displayed.

Optional backgroundColor

backgroundColor?: string

The background color of the apple card.

barCodes

barCodes: BarCode[]

If you want to apply barcodes to the card, you can define them here. Typically you only have 1 barcode per card.

Optional description

description?: string

The description of the card.

Optional expirationDate

expirationDate?: string

The expiration date of this card. This card will be moved to the expired section of the device wallet once expired.

Optional foregroundColor

foregroundColor?: string

The text color of the apple card.

Optional groupingIdentifier

groupingIdentifier?: string

The pass grouping identifier used to group multiple cards together on a single device.

Optional headerFields

headerFields?: string[]

The header fields for the card. These are used to construct the card layout. You add the key of the field you want to set here in the sequence you want them to be displayed.

images

images: Image<AppleImageStyles>[]

The images for the card. These are used to construct the card layout. The images styles used are dependant on the passStyle.

Optional includeLogoText

includeLogoText?: boolean

Will show the android header on the card if true.

Optional labelColor

labelColor?: string

The label color of the apple card.

Optional nfcField

nfcField?: NFCField

This will apply an NFC to the card, if NFC is supported by your certificate.

passStyle

passStyle: BambuPassStyles

The pass style can be one of the following:

  • storeCard
  • giftCard
  • eventTicket
  • coupon
  • generic
  • profile

Optional primaryFields

primaryFields?: string[]

The primary fields for the card. These are used to construct the card layout. You add the key of the field you want to set here in the sequence you want them to be displayed. *This is not used on all card styles.

Optional relevantDate

relevantDate?: string

The relevantDate of this card. Applicable to events and coupons, will cause a message to be displayed on the card.

Optional secondaryFields

secondaryFields?: string[]

The secondary fields for the card. These are used to construct the card layout. You add the key of the field you want to set here in the sequence you want them to be displayed.

Optional subheader

subheader?: string

The subtitle of the card.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc