<GrabbaFingerprintProtocol> Protocol Reference

Description

Interface for receiving fingerprint reader events.

Objects which implement this protocol may receive callbacks when these events occur, via delegation from a GrabbaFingerprintListener object.

Note that this protocol need not be directly implemented; it may be simpler to subclass GrabbaFingerprintListener and thereby receive the events directly.

Thread safety: This interface is intended to be thread-safe; any classes deriving from it should ensure that the relevant methods are callable from any thread.

See also

GrabbaFingerprintAPI for related API functions

Instance Methods
(void)	- completionEvent
	Callback which is invoked when an asynchronous fingerprint operation completes successfully. More...
(void)	- errorEvent:
	Callback which is invoked when an asynchronous fingerprint operation fails to complete. More...
(void)	- imageEvent:
	Callback which is invoked when fingerprint image data is returned. More...
(void)	- templateEvent:
	Callback which is invoked when fingerprint template data is returned from the reader. More...
(void)	- userMessageEvent:
	Callback which is invoked when there is a user message to display. More...

Method Documentation

completionEvent()

- (void) completionEvent

Callback which is invoked when an asynchronous fingerprint operation completes successfully.

Each asynchronous operation will trigger either this or errorEvent (but not both) immediately prior to termination.

Note

Implementations of this method are required to be thread-safe; no guarantees are made about which thread(s) they will be called from.

errorEvent:()

- (void) errorEvent:

(GrabbaErrorCode *_Nonnull)

error

Callback which is invoked when an asynchronous fingerprint operation fails to complete.

Each asynchronous operation will trigger either this or completionEvent (but not both) immediately prior to termination.

Parameters

error

Details of the error which was detected

Note

Implementations of this method are required to be thread-safe; no guarantees are made about which thread(s) they will be called from.

imageEvent:()

- (void) imageEvent:

(GrabbaFingerprintImage *_Nonnull)

image

Callback which is invoked when fingerprint image data is returned.

Parameters

image

Captured fingerprint image data, plus associated metadata

Note

Implementations of this method are required to be thread-safe; no guarantees are made about which thread(s) they will be called from.

templateEvent:()

- (void) templateEvent:

(GrabbaFingerprintTemplate *_Nonnull)

templ

Callback which is invoked when fingerprint template data is returned from the reader.

Parameters

templ

Captured fingerprint template data, plus associated metadata

Note

Implementations of this method are required to be thread-safe; no guarantees are made about which thread(s) they will be called from.

userMessageEvent:()

- (void) userMessageEvent:

(GrabbaFingerprintUserMessage *_Nonnull)

message

Callback which is invoked when there is a user message to display.

Parameters

message

Message which needs to be displayed

Note

Implementations of this method are required to be thread-safe; no guarantees are made about which thread(s) they will be called from.