Interface IWalletTemplateAndroidPassData

The WalletTemplateAndroidPassData object contains the configuration for the Android Wallet layout of the template.

interface IWalletTemplateAndroidPassData {
    dateTime?: DateTime;
    detailRows?: {
        items: string[];
    }[];
    header: string;
    hexBackgroundColor: string;
    images: Image<AndroidImageStyles>[];
    nfcField?: NFCField;
    rows: {
        items: string[];
    }[];
    seatInfo?: SeatInfo;
    subheader?: string;
    title?: string;
    validTimeInterval?: ValidTimeInterval;
    venue?: Venue;
}

Properties

dateTime?: DateTime

The date time for the card, not applicable for all passStyles.

detailRows?: {
    items: string[];
}[]

The layout for the back of the android card

Type declaration

  • items: string[]

    the items of the row, Android only supports up too 2 items per row.

header: string

The header displayed on the top of the android card.

hexBackgroundColor: string

The background color of the android card.

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

nfcField?: NFCField

The NFC field for the card, not applicable for all passStyles.

rows: {
    items: string[];
}[]

The layout for the front of the android card Currently only support 3 rows of text

Type declaration

  • items: string[]

    the items of the row, Android only supports up too 3 items per row.

seatInfo?: SeatInfo

The seat info for the card, not applicable for all passStyles.

subheader?: string

The subheader displayed on the top of the android card. Not applicable for all card styles.

title?: string

The title displayed on the top of the android card, if not set the organization name is used.

validTimeInterval?: ValidTimeInterval

The time this card is valid for, not applicable for all passStyles.

venue?: Venue

The venue for the card, not applicable for all passStyles.