Package com.clover.sdk.util

Class AuthTask

java.lang.Object

android.os.AsyncTask<Account,Void,CloverAuth.AuthResult>

com.clover.sdk.util.AuthTask

public class AuthTask
extends AsyncTask<Account,Void,CloverAuth.AuthResult>

Authenticates with the Clover service in the background. Subclasses can override callback methods in order to respond to success or failure.

Nested Class Summary

Nested classes/interfaces inherited from class android.os.AsyncTask

AsyncTask.Status

Field Summary

Fields inherited from class android.os.AsyncTask

SERIAL_EXECUTOR, THREAD_POOL_EXECUTOR

Constructor Summary

Constructors

Constructor	Description
AuthTask(Activity activity)	Create a new AuthTask.

Method Summary

Modifier and Type	Method	Description
protected CloverAuth.AuthResult	doInBackground(Account... accounts)
String	getErrorMessage()	Return the error message that was generated when authentication failed, or null if authentication succeeded.
Exception	getException()	Return the Exception that was thrown when authentication failed, or null if authentication succeeded.
protected void	onAuthCanceled(OperationCanceledException e)	Called on the main thread if OperationCanceledException was thrown during authentication.
protected void	onAuthComplete(boolean success, CloverAuth.AuthResult result)	Called on the main thread after the auth process has completed.
protected void	onAuthenticatorException(AuthenticatorException e)	Called on the main thread if AuthenticatorException was thrown during authentication.
protected void	onIOException(IOException e)	Called on the main thread if IOException was thrown during authentication.
protected void	onPostExecute(CloverAuth.AuthResult result)	Calls callback methods after the authentication attempt completes.

Methods inherited from class android.os.AsyncTask

cancel, execute, execute, executeOnExecutor, get, get, getStatus, isCancelled, onCancelled, onCancelled, onPreExecute, onProgressUpdate, publishProgress

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthTask

public AuthTask(Activity activity)

Create a new AuthTask.

Parameters:

activity - the Activity that initiated authentication with the Clover service.

Method Detail

getException

public Exception getException()

Return the Exception that was thrown when authentication failed, or null if authentication succeeded.

getErrorMessage

public String getErrorMessage()

Return the error message that was generated when authentication failed, or null if authentication succeeded.

doInBackground

protected CloverAuth.AuthResult doInBackground(Account... accounts)

Specified by:

doInBackground in class AsyncTask<Account,Void,CloverAuth.AuthResult>

onPostExecute

protected void onPostExecute(CloverAuth.AuthResult result)

Calls callback methods after the authentication attempt completes. If a subclass overrides this method, it should call the parent implementation. Otherwise the callback methods will not be called.

Overrides:

onPostExecute in class AsyncTask<Account,Void,CloverAuth.AuthResult>

onAuthComplete

protected void onAuthComplete(boolean success,
                              CloverAuth.AuthResult result)

Called on the main thread after the auth process has completed.

Parameters:

success - true if authentication was successful

result - the authentication result, or null if an exception was thrown

onAuthCanceled

protected void onAuthCanceled(OperationCanceledException e)

Called on the main thread if OperationCanceledException was thrown during authentication.

onAuthenticatorException

protected void onAuthenticatorException(AuthenticatorException e)

Called on the main thread if AuthenticatorException was thrown during authentication.

onIOException

protected void onIOException(IOException e)

Called on the main thread if IOException was thrown during authentication.