GrabbaKeyboardAPI Class Reference

Description

Provides control of keyboard wedge functionality in the Grabba Driver.

This class provides configuration and control of the keyboard wedge functionality, exposed via objects of the GrabbaKeyboardListener class and its children.

Keyboard events may optionally be generated (via GrabbaKeyboardListener) in response to the following events:

• Scan of a barcode (GrabbaBarcodeListener data event)
• Swipe of a magnetic stripe (GrabbaMagstripeListener data event)
• Swipe of an MRZ (GrabbaMRZ_Listener data event or validated data event)
• Scan of a proxcard or RFID tag (GrabbaProxcardListener data event)

User interaction with this functionality occurs primarily by enabling or disabling event generation for each of the four supported technologies - see selectTechnologies for details. Additional customisation is provided for the output associated with some technologies, e.g. see setLineDelimiter for customisation of the line ending string.

Note

This is a static class; object construction is unnecessary and consequently disabled. Subclassing is strongly discouraged.

Thread safety: This class is fully thread-safe.

Inheritance diagram for GrabbaKeyboardAPI:

Instance Methods
(void)	- enableInvalidMRZ_Events:
	Set whether MRZ keyboard events should be generated for all swipes, or only valid ICAO 9303 swipes. More...
(void)	- enableLineDelimiterForBarcode:proxcard:
	Set whether the line delimiter should be output at the end of each barcode or proxcard scan. More...
(instancetype _Nullable)	- init
	Not callable (NS_UNAVAILABLE) since this is a static class. More...
(void)	- selectTechnologiesWithBarcode:magstripe:MRZ:proxcard:
	Select which technologies will generate keyboard output events. More...
(void)	- setLineDelimiter:
	Set the line ending delimiter string. More...

Method Documentation

enableInvalidMRZ_Events:()

- (void) enableInvalidMRZ_Events:

(bool)

enable

Set whether MRZ keyboard events should be generated for all swipes, or only valid ICAO 9303 swipes.

By default, if MRZ scanning is enabled, then only MRZ swipes which pass ICAO 9303 validation (i.e. swiped MRZ was read cleanly and is fully conformant with ICAO 9303) will result in keyboard events. This function allows for keyboard events to be enabled even for MRZ swipes that do not pass validation.

Parameters

enable

If true, keyboard events are generated for all MRZ swipes (whether valid or invalid) whenever MRZ keyboard support is enabled; if false, only generate events for valid swipes.

enableLineDelimiterForBarcode:proxcard:()

- (void) enableLineDelimiterForBarcode:		(BOOL)	lineDelimAfterBarcode
proxcard:		(BOOL)	lineDelimAfterProxcard

Set whether the line delimiter should be output at the end of each barcode or proxcard scan.

By default, if barcode and/or proxcard scanning are enabled then a line delimiter will be output at the end of each scan of that type. This function provides for inhibition of those trailing delimiters.

Parameters

lineDelimAfterBarcode	If true, output the delimiter set by setLineDelimiter: (defaulting to an LF character) at the end of each scanned barcode; if false, output no delimiter at that time
lineDelimAfterProxcard	If true, output the delimiter set by setLineDelimiter: (defaulting to an LF character) at the end of each scanned proxcard or RFID tag; if false, output no delimiter at that time

init()

- (instancetype _Nullable) init

Not callable (NS_UNAVAILABLE) since this is a static class.

selectTechnologiesWithBarcode:magstripe:MRZ:proxcard:()

- (void) selectTechnologiesWithBarcode:		(BOOL)	barcodeEnabled
magstripe:		(BOOL)	magstripeEnabled
MRZ:		(BOOL)	MRZ_Enabled
proxcard:		(BOOL)	proxcardEnabled

Select which technologies will generate keyboard output events.

By default, no keyboard output events are sent to active GrabbaKeyboardListener objects from this class. Calling this function allows enabling or disabling of keyboard output events for one or more technologies.

Parameters

barcodeEnabled	If true, output keyboard events for barcode scans; if false, disable them
magstripeEnabled	If true, output keyboard events for magnetic stripe swipes; if false, disable them
MRZ_Enabled	If true, output keyboard events for MRZ swipes; if false, disable them
proxcardEnabled	If true, output keyboard events for proxcard scans; if false, disable them

setLineDelimiter:()

- (void) setLineDelimiter:

(NSString *_Nonnull)

newDelimiter

Set the line ending delimiter string.

This string is always output at the end of each magstripe or MRZ line. It is optionally also output at the end of each barcode or proxcard scan; see enableLineDelimiter for configuration.

Parameters

newDelimiter

New line ending delimiter; default is a line-feed character