ProxcardInterface Interface Reference

Description

Interface class for Grabba proxcard reader events.

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

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

ProxcardAPI for related API functions, and ProxcardListener for more detailed descriptions of each event.

Inheritance diagram for ProxcardInterface:

Public Member Functions
void	dataEvent (@NonNull ProxcardData data)
	Callback which is invoked when a proxcard is successfully scanned. More...
void	errorEvent (@NonNull ErrorCode error)
	Callback which is invoked when a proxcard scan fails. More...
void	startEvent ()
	Callback which is invoked when a proxcard scan is triggered. More...
void	stopEvent ()
	Callback which is invoked when a proxcard scan is stopped, regardless of reason. More...
void	timeoutEvent ()
	Callback which is invoked when proxcard scanning times out. More...

Member Function Documentation

dataEvent()

void dataEvent

(

@NonNull ProxcardData

data

)

Callback which is invoked when a proxcard is successfully scanned.

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

data	Contains the data which was read, along with the ID of the proxcard type which was detected

Implemented in ProxcardListener.

errorEvent()

void errorEvent

(

@NonNull ErrorCode

error

)

Callback which is invoked when a proxcard scan fails.

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

Error code indicating the reasons for the failure

Implemented in ProxcardListener.

startEvent()

void startEvent

(

)

Callback which is invoked when a proxcard scan is triggered.

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 ProxcardListener.

stopEvent()

void stopEvent

(

)

Callback which is invoked when a proxcard scan is stopped, regardless of reason.

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 ProxcardListener.

timeoutEvent()

void timeoutEvent

(

)

Callback which is invoked when proxcard scanning times out.

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 ProxcardListener.