Package com.firebase.ui.auth.data.model

Class FlowParameters

java.lang.Object

com.firebase.ui.auth.data.model.FlowParameters

All Implemented Interfaces:

android.os.Parcelable

public class FlowParameters
extends java.lang.Object
implements android.os.Parcelable

Encapsulates the core parameters and data captured during the authentication flow, in a serializable manner, in order to pass data between activities.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T extends java.lang.Object>, android.os.Parcelable.Creator<T extends java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
boolean	alwaysShowProviderChoice
java.lang.String	appName
AuthMethodPickerLayout	authMethodPickerLayout
static android.os.Parcelable.Creator<FlowParameters>	CREATOR
AuthUI.IdpConfig	defaultProvider
java.lang.String	emailLink
boolean	enableAnonymousUpgrade
boolean	enableCredentials
boolean	enableHints
boolean	lockOrientation
int	logoId
com.google.firebase.auth.ActionCodeSettings	passwordResetSettings
java.lang.String	privacyPolicyUrl
java.util.List<AuthUI.IdpConfig>	providers
java.lang.String	termsOfServiceUrl
int	themeId

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor

Description

FlowParameters(java.lang.String appName, java.util.List<AuthUI.IdpConfig> providers, AuthUI.IdpConfig defaultProvider, int themeId, int logoId, java.lang.String termsOfServiceUrl, java.lang.String privacyPolicyUrl, boolean enableCredentials, boolean enableHints, boolean enableAnonymousUpgrade, boolean alwaysShowProviderChoice, boolean lockOrientation, java.lang.String emailLink, com.google.firebase.auth.ActionCodeSettings passwordResetSettings, AuthMethodPickerLayout authMethodPickerLayout)

Method Summary

Modifier and Type	Method	Description
int	describeContents()
static FlowParameters	fromIntent(android.content.Intent intent)	Extract FlowParameters from an Intent.
AuthUI.IdpConfig	getDefaultOrFirstProvider()
boolean	isAnonymousUpgradeEnabled()
boolean	isPrivacyPolicyUrlProvided()
boolean	isSingleProviderFlow()
boolean	isTermsOfServiceUrlProvided()
boolean	shouldShowProviderChoice()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<FlowParameters> CREATOR

appName

@NonNull
public final java.lang.String appName

providers

@NonNull
public final java.util.List<AuthUI.IdpConfig> providers

defaultProvider

@Nullable
public final AuthUI.IdpConfig defaultProvider

themeId

@StyleRes
public final int themeId

logoId

@DrawableRes
public final int logoId

termsOfServiceUrl

@Nullable
public final java.lang.String termsOfServiceUrl

privacyPolicyUrl

@Nullable
public final java.lang.String privacyPolicyUrl

emailLink

@Nullable
public java.lang.String emailLink

passwordResetSettings

@Nullable
public final com.google.firebase.auth.ActionCodeSettings passwordResetSettings

enableCredentials

public final boolean enableCredentials

enableHints

public final boolean enableHints

enableAnonymousUpgrade

public final boolean enableAnonymousUpgrade

alwaysShowProviderChoice

public final boolean alwaysShowProviderChoice

lockOrientation

public final boolean lockOrientation

authMethodPickerLayout

@Nullable
public final AuthMethodPickerLayout authMethodPickerLayout

Constructor Detail

FlowParameters

public FlowParameters(@NonNull
                      java.lang.String appName,
                      @NonNull
                      java.util.List<AuthUI.IdpConfig> providers,
                      @Nullable
                      AuthUI.IdpConfig defaultProvider,
                      @StyleRes
                      int themeId,
                      @DrawableRes
                      int logoId,
                      @Nullable
                      java.lang.String termsOfServiceUrl,
                      @Nullable
                      java.lang.String privacyPolicyUrl,
                      boolean enableCredentials,
                      boolean enableHints,
                      boolean enableAnonymousUpgrade,
                      boolean alwaysShowProviderChoice,
                      boolean lockOrientation,
                      @Nullable
                      java.lang.String emailLink,
                      @Nullable
                      com.google.firebase.auth.ActionCodeSettings passwordResetSettings,
                      @Nullable
                      AuthMethodPickerLayout authMethodPickerLayout)

Method Detail

fromIntent

public static FlowParameters fromIntent(android.content.Intent intent)

Extract FlowParameters from an Intent.

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

isSingleProviderFlow

public boolean isSingleProviderFlow()

isTermsOfServiceUrlProvided

public boolean isTermsOfServiceUrlProvided()

isPrivacyPolicyUrlProvided

public boolean isPrivacyPolicyUrlProvided()

isAnonymousUpgradeEnabled

public boolean isAnonymousUpgradeEnabled()

shouldShowProviderChoice

public boolean shouldShowProviderChoice()

getDefaultOrFirstProvider

public AuthUI.IdpConfig getDefaultOrFirstProvider()