GrabbaFingerprintUserMessage Class Reference

Description

Encapsulation of fingerprint reader user message data.

Note

All property values are passed by copy; a new copy of the value will be generated each time a property is read.

Thread safety:

• Concurrent accesses to distinct objects: safe
• Concurrent accesses to the same object: unsafe, unless all accesses are read-only (i.e. property reads)

Inheritance diagram for GrabbaFingerprintUserMessage:

Instance Methods
(instancetype _Nullable)	- init
	Initialise an empty (null) user message. More...
(instancetype _Nullable)	- initWithID:count:total:userRecord:
	Initialise with given message ID and parameters. More...

Class Methods
(NSString *_Nonnull)	+ messageForID:
	Obtain the user message associated with a given ID. More...
(instancetype _Nullable)	+ userMessage
	Allocate and initialise an empty (null) user message. More...
(instancetype _Nullable)	+ userMessageWithID:count:total:userRecord:
	Allocate and initialise with given message ID and parameters. More...

Properties
uint8_t	count
	Scan count for enrolment/verification, code quality for images, or progress percentage for image transfer. More...
GrabbaFingerprintUserMessageTypeID	ID
	ID of this message; maps to an associated message string. More...
NSString *_Nonnull	message
	User message associated with the current ID. More...
uint8_t	total
	Total number of scans which will occur for enrolment/verification. More...
GrabbaFingerprintUserRecord *_Nonnull	user
	User record which was matched by a successful identify operation. More...

Method Documentation

init()

- (instancetype _Nullable) init

Initialise an empty (null) user message.

Returns

Pointer to initialised object if initialisation succeeded; nil if it failed

initWithID:count:total:userRecord:()

- (instancetype _Nullable) initWithID:		(GrabbaFingerprintUserMessageTypeID)	ID
count:		(uint8_t)	count
total:		(uint8_t)	total
userRecord:		(GrabbaFingerprintUserRecord *_Nonnull)	userRecord

Initialise with given message ID and parameters.

Parameters

ID	Initial value of the message ID field
count	Initial value of the count field; default is 0
total	Initial value of the total field; default is 0
userRecord	Initial value of the userRecord field; default is an empty user record

Returns

Pointer to initialised object if initialisation succeeded; nil if it failed

messageForID:()

+ (NSString* _Nonnull) messageForID:

(GrabbaFingerprintUserMessageTypeID)

ID

Obtain the user message associated with a given ID.

Parameters

ID	The type of message which is being queried

Returns

String representation of given ID if known; empty string if unknown

userMessage()

+ (instancetype _Nullable) userMessage

Allocate and initialise an empty (null) user message.

Returns

Pointer to initialised object if initialisation succeeded; nil if it failed

userMessageWithID:count:total:userRecord:()

+ (instancetype _Nullable) userMessageWithID:		(GrabbaFingerprintUserMessageTypeID)	ID
count:		(uint8_t)	count
total:		(uint8_t)	total
userRecord:		(GrabbaFingerprintUserRecord *_Nonnull)	userRecord

Allocate and initialise with given message ID and parameters.

Parameters

ID	Initial value of the message ID field
count	Initial value of the count field; default is 0
total	Initial value of the total field; default is 0
userRecord	Initial value of the userRecord field; default is an empty user record

Returns

Pointer to initialised object if initialisation succeeded; nil if it failed

Property Documentation

count

- (uint8_t) count

readwritenonatomicassign

Scan count for enrolment/verification, code quality for images, or progress percentage for image transfer.

Only applicable to the following message types: ImageCodeQuality, ImageProgress, PlaceFingerForAcquisition, PlaceFirstFingerForAcquisition, PlaceSecondFingerForAcquisition.

For all other message types it is set to zero.

ID

- (GrabbaFingerprintUserMessageTypeID) ID

readwritenonatomicassign

ID of this message; maps to an associated message string.

message

- (NSString* _Nonnull) message

readnonatomiccopy

User message associated with the current ID.

This value is not directly writeable; updates should use ID instead

total

- (uint8_t) total

readwritenonatomicassign

Total number of scans which will occur for enrolment/verification.

Only applicable to the following message types: PlaceFingerForAcquisition, PlaceFirstFingerForAcquisition, PlaceSecondFingerForAcquisition.

For all other message types it is set to zero.

user

- (GrabbaFingerprintUserRecord* _Nonnull) user

readwritenonatomicassign

User record which was matched by a successful identify operation.

Only applicable to the MatchSuccessful message type, and only for identify operations.