Description

User record structure for use with fingerprint reader databases.

This class encapsulates a user ID (used as a database key) and an optional collection of associated data. A record of this type is stored for each enrolment into a fingerprint database.

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 GrabbaFingerprintUserRecord:

Instance Methods
(instancetype _Nullable)	- init
	Initialise a fingerprint user record with null ID and empty contents. More...

(instancetype _Nullable)	- initWithID:data:
	Initialise a fingerprint user record with given contents. More...

Class Methods
(instancetype _Nullable)	+ userRecord
	Allocate and initialise a fingerprint user record with null ID and empty contents. More...

(instancetype _Nullable)	+ userRecordWithID:data:
	Allocate and initialise a fingerprint user record with given contents. More...

Properties
NSData *_Nonnull	userData
	User data for this record. More...

NSString *_Nonnull	userID
	User ID string for this record. More...

Method Documentation

◆ init()

- (instancetype _Nullable) init

Initialise a fingerprint user record with null ID and empty contents.

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

◆ initWithID:data:()

- (instancetype _Nullable) initWithID:	(NSString *_Nonnull)	ID
data:	(NSData *_Nonnull)	data

Initialise a fingerprint user record with given contents.

Parameters

ID	Initial value of the user ID field
data	Initial value of the user data field

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

◆ userRecord()

+ (instancetype _Nullable) userRecord

Allocate and initialise a fingerprint user record with null ID and empty contents.

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

◆ userRecordWithID:data:()

+ (instancetype _Nullable) userRecordWithID:	(NSString *_Nonnull)	ID
data:	(NSData *_Nonnull)	data

Allocate and initialise a fingerprint user record with given contents.

Parameters

ID	Initial value of the user ID field
data	Initial value of the user data field

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

Property Documentation

◆ userData

- (NSData* _Nonnull) userData

readwritenonatomiccopy

User data for this record.

◆ userID

- (NSString* _Nonnull) userID