com.auth0.android.provider

Class WebAuthProvider

java.lang.Object

com.auth0.android.provider.WebAuthProvider

public class WebAuthProvider
extends java.lang.Object

OAuth2 Web Authentication Provider. It can use an external browser by sending the Intent.ACTION_VIEW intent or also the WebAuthActivity. This behaviour is changed using WebAuthProvider.Builder.useBrowser(boolean), and defaults to use browser.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebAuthProvider.Builder
static class	WebAuthProvider.LogoutBuilder

Constructor Summary

Constructors

Constructor and Description
WebAuthProvider()

Method Summary

Modifier and Type	Method and Description
static WebAuthProvider.Builder	init(Auth0 account) Deprecated. This method was renamed to reflect an authentication flow. Please use login(Auth0).
static WebAuthProvider.Builder	init(android.content.Context context) Deprecated. This method was renamed to reflect an authentication flow. Please use login(Auth0). You can create an Auth0 instance from a Context using Auth0.Auth0(Context).
static WebAuthProvider.Builder	login(Auth0 account) Initialize the WebAuthProvider instance for authenticating the user using an account.
static WebAuthProvider.LogoutBuilder	logout(Auth0 account) Initialize the WebAuthProvider instance for logging out the user using an account.
static boolean	resume(android.content.Intent intent) Finishes the authentication or log out flow by passing the data received in the activity's onNewIntent() callback.
static boolean	resume(int requestCode, int resultCode, android.content.Intent intent) Deprecated. This method has been deprecated since it only applied to WebView authentication and Google is no longer supporting it. Please use resume(Intent)

Methods inherited from class java.lang.Object

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

Constructor Detail

WebAuthProvider

public WebAuthProvider()

Method Detail

logout

@NonNull
public static WebAuthProvider.LogoutBuilder logout(@NonNull
                                                            Auth0 account)

Initialize the WebAuthProvider instance for logging out the user using an account. Additional settings can be configured in the LogoutBuilder, like changing the scheme of the return to URL.

Parameters:

account - to use for authentication

Returns:

a new Builder instance to customize.

login

@NonNull
public static WebAuthProvider.Builder login(@NonNull
                                                     Auth0 account)

Initialize the WebAuthProvider instance for authenticating the user using an account. Additional settings can be configured in the Builder, like setting the connection name or authentication parameters.

Parameters:

account - to use for authentication

Returns:

a new Builder instance to customize.

init

@NonNull
 @Deprecated
public static WebAuthProvider.Builder init(@NonNull
                                                                 Auth0 account)

Deprecated. This method was renamed to reflect an authentication flow. Please use login(Auth0).

Initialize the WebAuthProvider instance for authenticating the user using an account. Additional settings can be configured in the Builder, like setting the connection name or authentication parameters.

Parameters:

account - to use for authentication

Returns:

a new Builder instance to customize.

init

@NonNull
 @Deprecated
public static WebAuthProvider.Builder init(@NonNull
                                                                 android.content.Context context)

Deprecated. This method was renamed to reflect an authentication flow. Please use login(Auth0). You can create an Auth0 instance from a Context using Auth0.Auth0(Context).

Initialize the WebAuthProvider instance with an Android Context. Additional settings can be configured in the Builder, like setting the connection name or authentication parameters.

Parameters:

context - a valid context.

Returns:

a new Builder instance to customize.

resume

@Deprecated
public static boolean resume(int requestCode,
                                         int resultCode,
                                         @Nullable
                                         android.content.Intent intent)

Deprecated. This method has been deprecated since it only applied to WebView authentication and Google is no longer supporting it. Please use resume(Intent)

Finishes the authentication or log out flow by passing the data received in the activity's onActivityResult() callback. The final result will be delivered to the callback specified when calling start().

This is no longer required to be called, the redirect is handled internally as long as you've correctly setup the intent-filter.

Parameters:

requestCode - the request code received on the onActivityResult() call

resultCode - the result code received on the onActivityResult() call

intent - the data received on the onActivityResult() call

Returns:

true if a result was expected and has a valid format, or false if not. When true is returned a call on the callback is expected.

resume

public static boolean resume(@Nullable
                             android.content.Intent intent)

Finishes the authentication or log out flow by passing the data received in the activity's onNewIntent() callback. The final result will be delivered to the callback specified when calling start().

This is no longer required to be called, the authentication is handled internally as long as you've correctly setup the intent-filter.

Parameters:

intent - the data received on the onNewIntent() call. When null is passed, the authentication will be considered canceled.

Returns:

true if a result was expected and has a valid format, or false if not. When true is returned a call on the callback is expected.