Digital Authentication Framework  6.0.1.37
Public Member Functions | Protected Attributes | List of all members
com.good.daf.app.GeneralProcessParams Class Reference

This is the base class for collecting parameters for a background process. More...

Inheritance diagram for com.good.daf.app.GeneralProcessParams:
com.good.daf.app.ProgressCallback com.good.daf.app.AuthProcessParams com.good.daf.app.ChangeDeviceProcessParams com.good.daf.app.ChangePassphraseProcessParams com.good.daf.app.EnrollProcessParams

Public Member Functions

void setDevice (DADevice dev)
 The DADevice to use in the protocol. More...
 
DADevice getDevice ()
 
void setProgressCallback (ProgressCallback cb)
 Sets the progress callback which will be triggered during the protocol. More...
 
void onStart ()
 Called on the UI thread when the background processing thread is about to start work. More...
 
void onSuccess ()
 Called on the UI thread when the background processing thread completes its work successfully. More...
 
void onError (Exception e)
 Called on the UI thread when the background processing thread fails due to an error. More...
 

Protected Attributes

DADevice device
 
ProgressCallback progressCallback
 

Detailed Description

This is the base class for collecting parameters for a background process.

Member Function Documentation

DADevice com.good.daf.app.GeneralProcessParams.getDevice ( )
Returns
the device to use. null means the native device will be used.
void com.good.daf.app.GeneralProcessParams.onError ( Exception  e)

Called on the UI thread when the background processing thread fails due to an error.

Common such exceptions are: - AccessControlException when a supplied existing passphrase is incorrect - DAFException when a protocol operation fails due to a daf error

You can use this opportunity to classify and identify common errors, and make a decision whether to retry the overall operation, inform the user of the error, or both.

Parameters
ethe exception which caused this error.

Implements com.good.daf.app.ProgressCallback.

void com.good.daf.app.GeneralProcessParams.onStart ( )

Called on the UI thread when the background processing thread is about to start work.

You can use this opportunity to display, for example, a ProgressDialog to ask the user to wait.

Implements com.good.daf.app.ProgressCallback.

void com.good.daf.app.GeneralProcessParams.onSuccess ( )

Called on the UI thread when the background processing thread completes its work successfully.

You can use this opportunity to dismiss any dialog displayed to the user during the process.

Implements com.good.daf.app.ProgressCallback.

void com.good.daf.app.GeneralProcessParams.setDevice ( DADevice  dev)

The DADevice to use in the protocol.

If this is null, a native device is used as obtained from the native DADriver class.

Parameters
devdevice to use, or null to use the native device
void com.good.daf.app.GeneralProcessParams.setProgressCallback ( ProgressCallback  cb)

Sets the progress callback which will be triggered during the protocol.

Parameters
cbprogress callback receiver

The documentation for this class was generated from the following file: