com.firebase.ui.auth

Class AuthUI

java.lang.Object

com.firebase.ui.auth.AuthUI

public class AuthUI
extends java.lang.Object

The entry point to the AuthUI authentication flow, and related utility methods. If your application uses the default FirebaseApp instance, an AuthUI instance can be retrieved simply by calling AuthUI.getInstance(). If an alternative app instance is in use, call AuthUI.getInstance(app instead, passing the appropriate app instance.

Sign-in

If a user is not currently signed in (as can be determined by checking auth.getCurrentUser() != null, where auth is the FirebaseAuth associated with your FirebaseApp) then the sign-in process can be started by creating a sign-in intent using AuthUI.SignInIntentBuilder. A builder instance can be retrieved by calling createSignInIntentBuilder().

The builder provides the following customization options for the authentication flow implemented by this library:

• The set of authentication methods desired can be specified.
• The terms of service URL for your app can be specified, which is included as a link in the small-print of the account creation step for new users. If no terms of service URL is provided, the associated small-print is omitted.
• A custom theme can specified for the flow, which is applied to all the activities in the flow for consistent customization of colors and typography.

Sign-in examples

If no customization is required, and only email authentication is required, the sign-in flow can be started as follows:

 
 startActivityForResult(
     AuthUI.getInstance().createSignInIntentBuilder().build(),
     RC_SIGN_IN);
 
 

If Google Sign-in and Facebook Sign-in are also required, then this can be replaced with:

 
 startActivityForResult(
     AuthUI.getInstance()
         .createSignInIntentBuilder()
         .setProviders(AuthUI.EMAIL_PROVIDER, AuthUI.GOOGLE_PROVIDER, AuthUI.FACEBOOK_PROVIDER)
         .build(),
     RC_SIGN_IN);
 
 

Finally, if a terms of service URL and a custom theme are required:

 
 startActivityForResult(
     AuthUI.getInstance()
         .createSignInIntentBuilder()
         .setProviders(...)
         .setTosUrl("https://superapp.example.com/terms-of-service.html")
         .setTheme(R.style.SuperAppTheme)
         .build(),
     RC_SIGN_IN);
 
 

Handling the Sign-in response

The authentication flow provides only two response codes: RESULT_OK if a user is signed in, and RESULT_CANCELLED if sign in failed. No further information on failure is provided as it is not typically useful; the only recourse for most apps if sign in fails is to ask the user to sign in again later, or proceed with an anonymous account if supported.

 {@code

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AuthUI.SignInIntentBuilder Builder for the intent to start the user authentication flow.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMAIL_PROVIDER Provider identifier for email and password credentials, for use with AuthUI.SignInIntentBuilder.setProviders(java.lang.String...).
static java.lang.String	FACEBOOK_PROVIDER Provider identifier for Facebook, for use with AuthUI.SignInIntentBuilder.setProviders(java.lang.String...).
static java.lang.String	GOOGLE_PROVIDER Provider identifier for Google, for use with AuthUI.SignInIntentBuilder.setProviders(java.lang.String...).
static int	NO_LOGO Default value for logo resource, omits the logo from the AuthMethodPickerActivity
static java.util.Set<java.lang.String>	SUPPORTED_PROVIDERS The set of authentication providers supported in Firebase Auth UI.

Method Summary

Modifier and Type	Method and Description
AuthUI.SignInIntentBuilder	createSignInIntentBuilder() Starts the process of creating a sign in intent, with the mandatory application context parameter.
static int	getDefaultTheme() Default theme used by AuthUI.SignInIntentBuilder.setTheme(int) if no theme customization is required.
static AuthUI	getInstance() Retrieves the AuthUI instance associated with the default app, as returned by FirebaseApp.getInstance().
static AuthUI	getInstance(FirebaseApp app) Retrieves the AuthUI instance associated the the specified app.
<any>	signOut(android.app.Activity activity) Signs the current user out, if one is signed in.

Methods inherited from class java.lang.Object

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

Field Detail

EMAIL_PROVIDER

public static final java.lang.String EMAIL_PROVIDER

Provider identifier for email and password credentials, for use with AuthUI.SignInIntentBuilder.setProviders(java.lang.String...).

See Also:

Constant Field Values

GOOGLE_PROVIDER

public static final java.lang.String GOOGLE_PROVIDER

Provider identifier for Google, for use with AuthUI.SignInIntentBuilder.setProviders(java.lang.String...).

See Also:

Constant Field Values

FACEBOOK_PROVIDER

public static final java.lang.String FACEBOOK_PROVIDER

Provider identifier for Facebook, for use with AuthUI.SignInIntentBuilder.setProviders(java.lang.String...).

See Also:

Constant Field Values

NO_LOGO

public static final int NO_LOGO

Default value for logo resource, omits the logo from the AuthMethodPickerActivity

See Also:

Constant Field Values

SUPPORTED_PROVIDERS

public static final java.util.Set<java.lang.String> SUPPORTED_PROVIDERS

The set of authentication providers supported in Firebase Auth UI.

Method Detail

signOut

public <any> signOut(@NonNull
                     android.app.Activity activity)

Signs the current user out, if one is signed in.

Parameters:

activity - The activity requesting the user be signed out.

Returns:

a task which, upon completion, signals that the user has been signed out (result.isSuccess(), or that the sign-out attempt failed unexpectedly (!result.isSuccess()).

createSignInIntentBuilder

public AuthUI.SignInIntentBuilder createSignInIntentBuilder()

Starts the process of creating a sign in intent, with the mandatory application context parameter.

getInstance

public static AuthUI getInstance()

Retrieves the AuthUI instance associated with the default app, as returned by FirebaseApp.getInstance().

Throws:

java.lang.IllegalStateException - if the default app is not initialized.

getInstance

public static AuthUI getInstance(FirebaseApp app)

Retrieves the AuthUI instance associated the the specified app.

getDefaultTheme

@StyleRes
public static int getDefaultTheme()

Default theme used by AuthUI.SignInIntentBuilder.setTheme(int) if no theme customization is required.