Interface IWalletTemplateFieldMapping

The WalletTemplateFieldMapping object contains the configuration for the field mappings on the Apple Wallet layout of the template.

Hierarchy

  • IWalletTemplateFieldMapping

Properties

androidType? changeMessage? currencyCode? dateStyle? defaultValue? ignoresTimeZone? isDefault? isRelative? key label mappedValue? numberStyle? textAlignment? timeStyle?

Properties

Optional androidType

androidType?: "LINK" | "TEXT" | "IMAGE"

Current not used

Optional changeMessage

changeMessage?: string

The changeMessage of the field, this is used to determine the message that is displayed when the field is changed, that is displayed in a push notification.

  • Currently we only recomment using in the currentMessage display.

Optional currencyCode

currencyCode?: string

The currencyCode of the field, this is used to determine the currency code for the field. Current not used

Optional dateStyle

dateStyle?: "PKDateStyleNone" | "PKDateStyleShort" | "PKDateStyleMedium" | "PKDateStyleLong" | "PKDateStyleFull"

The dateStyle of the field, this is used to determine the type of display for a date. Not currently used

Optional defaultValue

defaultValue?: string

The default value is used when no mapped value is set or if the mapped value is found to be undefined. No variable support is provided for default values.

Optional ignoresTimeZone

ignoresTimeZone?: boolean

Current not used

Optional isDefault

isDefault?: boolean

Current not used

Optional isRelative

isRelative?: boolean

Current not used

key

key: string

The field key, this is the key used in the layout to map the field to the template. This must be unique to each field, and should only be applied to a PassData and AndroidPassData record once each.

label

label: string

The field label, this is the label used in the layout to map the field to the template.

Optional mappedValue

mappedValue?: string

The mapped value is used to map the field to a variable in the program. You can either put the path to the card attribute, for example: "person.firstName" or "customMessage" or "passdata.metaData.favoriteColor", or you can replace the variables in other text for example: "{{person.firstName}} {{person.lastName}}" or "Your favorite color is {{passdata.metaData.favoriteColor}}"

Optional numberStyle

numberStyle?: "PKNumberStyleDecimal" | "PKNumberStylePercent" | "PKNumberStyleScientific" | "PKNumberStyleSpellOut"

The numberStyle of the field, this is used to determine the number style for the field. Current not used

Optional textAlignment

textAlignment?: "PKTextAlignmentLeft" | "PKTextAlignmentCenter" | "PKTextAlignmentRight" | "PKTextAlignmentNatural"

The textAlignment of the field, this is used to determine the layout of the text

Optional timeStyle

timeStyle?: "PKDateStyleNone" | "PKDateStyleShort" | "PKDateStyleMedium" | "PKDateStyleLong" | "PKDateStyleFull"

The timeStyle of the field, this is used to determine the type of display for a date. Not currently used

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc