Models API Reference
API documentation for models module
Component
class Component extends EventEmitterProperties
id: number;
api: ComponentAPI;
required: boolean;
deviceType: DeviceType;
pendingCalls: number;
enabled: boolean;
pollingInterval: number;
parent: Component | null;
subcomponents: Component[];
get ready(): boolean;
get pending(): boolean;
get status(): MessageCodes;Methods
stateIsDifferent(msg: PlatformData): booleanupdateState(msg: PlatformData): voidpollUntilReady(
requireOK: boolean = false,
pollingInterval: void = [UNSUPPORTED].pollingInterval
): voidprotected handleMessage(data: PlatformData): voidasync enable(): Promise<PlatformData>async disable(): Promise<PlatformData>async cancel(): Promise<PlatformData>async query(): Promise<PlatformData>async setup(dataObj: DataRecordList): Promise<PlatformData>async send(
dataObj: DataRecordList | ScreenResolution | IlluminationData | BaggageData | CommonUsePaymentMessage | CommonUseBiometricMessage
): Promise<PlatformData>DataReaderComponent
class DataReaderComponent extends ComponentProperties
previousData: string[];Methods
override handleMessage(data: PlatformData): voidasync read(ms: number = 30000): Promise<string[]>BarcodeReader
class BarcodeReader extends DataReaderComponentDocumentReader
class DocumentReader extends DataReaderComponentCardReader
class CardReader extends DataReaderComponentMethods
async enablePayment(yes: boolean): Promise<void>async readPayment(ms: number = 30000): Promise<void>Scale
class Scale extends DataReaderComponentRFID
class RFID extends DataReaderComponentCamera
class Camera extends DataReaderComponentAEASBD
class AEASBD extends ComponentBHS
class BHS extends DataReaderComponentPrinter
class Printer extends ComponentProperties
feeder: Feeder;
dispenser: Dispenser;
logos: object;
pectabs: object;
get mediaPresent(): boolean;Methods
override updateState(msg: PlatformData): voidasync setupITPS(commands: string[]): Promise<PlatformData>async sendITPS(commands: string[]): Promise<PlatformData>async sendITPSCommand(cmd: string): Promise<string>async getEnvironment(): Promise<Record<string, string>>protected async getPairedResponse(cmd: string, n: number = 2): Promise<string[]>BagTagPrinter
class BagTagPrinter extends PrinterProperties
pectabs: object;BoardingPassPrinter
class BoardingPassPrinter extends PrinterProperties
templates: object;Feeder
class Feeder extends ComponentProperties
printer?: Printer;Dispenser
class Dispenser extends ComponentProperties
printer?: Printer;
get mediaPresent(): boolean;Keypad
class Keypad extends ComponentMethods
override handleMessage(message: PlatformData): voidAnnouncement
class Announcement extends ComponentMethods
say(text: string, lang: string = "en-US"): Promise<PlatformData>play(xml: string): Promise<PlatformData>stop(): Promise<PlatformData>pause(): Promise<PlatformData>resume(): Promise<PlatformData>Illumination
class Illumination extends ComponentMethods
override async enable(
duration: number = 0,
color?: string | number[],
blink?: number[]
): Promise<PlatformData>Headset
class Headset extends ComponentBiometric
class Biometric extends ComponentInsertionBelt
class InsertionBelt extends ComponentVerificationBelt
class VerificationBelt extends ComponentParkingBelt
class ParkingBelt extends ComponentPlatformResponseError
class PlatformResponseError extends ErrorProperties
componentID?: number;
componentState: ComponentState | undefined;
requestID: UniqueId;
messageCode: MessageCodes;StateChange
class StateChangeProperties
previous: ApplicationStateCodes;
current: ApplicationStateCodes;