@walletpass/pass-js
Version:
Apple Wallet Pass generating and pushing updates from Node.js
40 lines (39 loc) • 1.82 kB
TypeScript
/**
* Class that implements base structure fields setters / getters
*
* @see {@link https://developer.apple.com/library/content/documentation/UserExperience/Reference/PassKit_Bundle/Chapters/LowerLevel.html#//apple_ref/doc/uid/TP40012026-CH3-SW3}
*/
import { ApplePass, PassStyle, TransitType } from '../interfaces';
import { FieldsMap } from './fieldsMap';
import { NFCField } from './nfc-fields';
export declare class PassStructure {
protected fields: Partial<ApplePass>;
constructor(fields?: Partial<ApplePass>);
/**
* Pass type, e.g boardingPass, coupon, etc
*/
get style(): PassStyle | undefined;
set style(v: PassStyle | undefined);
/**
* Required for boarding passes; otherwise not allowed.
* Type of transit.
* Must be one of the following values: PKTransitTypeAir, PKTransitTypeBoat, PKTransitTypeBus, PKTransitTypeGeneric,PKTransitTypeTrain.
*/
get transitType(): TransitType | undefined;
set transitType(v: TransitType | undefined);
/**
* NFC-enabled pass keys support sending reward card information as part of an Apple Pay transaction.
*
* NFC-enabled pass keys are only supported in passes that contain an Enhanced Passbook/NFC certificate.
* For more information, contact merchant support at https://developer.apple.com/contact/passkit/.
* **Only for storeCards with special Apple approval**
*
* @see {@link https://developer.apple.com/library/archive/documentation/UserExperience/Reference/PassKit_Bundle/Chapters/TopLevel.html#//apple_ref/doc/uid/TP40012026-CH2-DontLinkElementID_3}
*/
get nfc(): NFCField;
get headerFields(): FieldsMap;
get auxiliaryFields(): FieldsMap;
get backFields(): FieldsMap;
get primaryFields(): FieldsMap;
get secondaryFields(): FieldsMap;
}