Package com.firebase.ui.auth.data.model
Class FlowParameters
- java.lang.Object
-
- com.firebase.ui.auth.data.model.FlowParameters
-
- All Implemented Interfaces:
Parcelable
public class FlowParameters extends Object implements 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
Parcelable.ClassLoaderCreator<T extends Object>, Parcelable.Creator<T extends Object>
-
-
Field Summary
Fields Modifier and Type Field Description boolean
alwaysShowProviderChoice
String
appName
AuthMethodPickerLayout
authMethodPickerLayout
static Parcelable.Creator<FlowParameters>
CREATOR
AuthUI.IdpConfig
defaultProvider
String
emailLink
boolean
enableAnonymousUpgrade
boolean
enableCredentials
boolean
enableHints
boolean
lockOrientation
int
logoId
com.google.firebase.auth.ActionCodeSettings
passwordResetSettings
String
privacyPolicyUrl
List<AuthUI.IdpConfig>
providers
String
termsOfServiceUrl
int
themeId
-
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
-
-
Constructor Summary
Constructors Constructor Description FlowParameters(String appName, List<AuthUI.IdpConfig> providers, AuthUI.IdpConfig defaultProvider, int themeId, int logoId, String termsOfServiceUrl, String privacyPolicyUrl, boolean enableCredentials, boolean enableHints, boolean enableAnonymousUpgrade, boolean alwaysShowProviderChoice, boolean lockOrientation, String emailLink, com.google.firebase.auth.ActionCodeSettings passwordResetSettings, AuthMethodPickerLayout authMethodPickerLayout)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
describeContents()
static FlowParameters
fromIntent(Intent intent)
Extract FlowParameters from an Intent.AuthUI.IdpConfig
getDefaultOrFirstProvider()
boolean
isAnonymousUpgradeEnabled()
boolean
isPlayServicesRequired()
boolean
isPrivacyPolicyUrlProvided()
boolean
isProviderEnabled(String provider)
boolean
isSingleProviderFlow()
boolean
isTermsOfServiceUrlProvided()
boolean
shouldShowProviderChoice()
void
writeToParcel(Parcel dest, int flags)
-
-
-
Field Detail
-
CREATOR
public static final Parcelable.Creator<FlowParameters> CREATOR
-
appName
@NonNull public final String appName
-
providers
@NonNull public final 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 String termsOfServiceUrl
-
privacyPolicyUrl
@Nullable public final String privacyPolicyUrl
-
emailLink
@Nullable public 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 String appName, @NonNull List<AuthUI.IdpConfig> providers, @Nullable AuthUI.IdpConfig defaultProvider, @StyleRes int themeId, @DrawableRes int logoId, @Nullable String termsOfServiceUrl, @Nullable String privacyPolicyUrl, boolean enableCredentials, boolean enableHints, boolean enableAnonymousUpgrade, boolean alwaysShowProviderChoice, boolean lockOrientation, @Nullable String emailLink, @Nullable com.google.firebase.auth.ActionCodeSettings passwordResetSettings, @Nullable AuthMethodPickerLayout authMethodPickerLayout)
-
-
Method Detail
-
fromIntent
public static FlowParameters fromIntent(Intent intent)
Extract FlowParameters from an Intent.
-
writeToParcel
public void writeToParcel(Parcel dest, int flags)
- Specified by:
writeToParcel
in interfaceParcelable
-
describeContents
public int describeContents()
- Specified by:
describeContents
in interfaceParcelable
-
isSingleProviderFlow
public boolean isSingleProviderFlow()
-
isTermsOfServiceUrlProvided
public boolean isTermsOfServiceUrlProvided()
-
isPrivacyPolicyUrlProvided
public boolean isPrivacyPolicyUrlProvided()
-
isAnonymousUpgradeEnabled
public boolean isAnonymousUpgradeEnabled()
-
isPlayServicesRequired
public boolean isPlayServicesRequired()
-
isProviderEnabled
public boolean isProviderEnabled(String provider)
-
shouldShowProviderChoice
public boolean shouldShowProviderChoice()
-
getDefaultOrFirstProvider
public AuthUI.IdpConfig getDefaultOrFirstProvider()
-
-