FingerprintInterface Interface Reference

Description

Interface class for Grabba fingerprint reader events.

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

Note that this interface need not be directly implemented; it may be simpler to subclass FingerprintListener 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

FingerprintAPI for related API functions, and FingerprintListener for more detailed descriptions of each event.

Inheritance diagram for FingerprintInterface:

Public Member Functions
void	completionEvent ()
	Callback which is invoked when an asynchronous fingerprint operation completes successfully. More...
void	errorEvent (@NonNull ErrorCode error)
	Callback which is invoked when an asynchronous fingerprint operation fails to complete. More...
void	imageEvent (@NonNull FingerprintImage image)
	Callback which is invoked when fingerprint image data is returned. More...
void	templateEvent (@NonNull FingerprintTemplate templ)
	Callback which is invoked when fingerprint template data is returned. More...
void	userMessageEvent (@NonNull FingerprintUserMessage message)
	Callback which is invoked when there is a user message to display. More...

Member Function Documentation

completionEvent()

void completionEvent

(

)

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

Note

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

Implemented in FingerprintListener.

errorEvent()

void errorEvent

(

@NonNull ErrorCode

error

)

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

Note

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

Parameters

error

Details of the error which was detected

Implemented in FingerprintListener.

imageEvent()

void imageEvent

(

@NonNull FingerprintImage

image

)

Callback which is invoked when fingerprint image data is returned.

Note

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

Parameters

image

Captured fingerprint image data, plus associated metadata

Implemented in FingerprintListener.

templateEvent()

void templateEvent

(

@NonNull FingerprintTemplate

templ

)

Callback which is invoked when fingerprint template data is returned.

Note

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

Parameters

templ

Captured fingerprint template data, plus associated metadata

Implemented in FingerprintListener.

userMessageEvent()

void userMessageEvent

(

@NonNull FingerprintUserMessage

message

)

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

Note

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

Parameters

message

Message which needs to be displayed

Implemented in FingerprintListener.