ActionCodeSettings

public class ActionCodeSettings implements Parcelable


Structure that contains the required continue/state URL with optional Android and iOS bundle identifiers. The stateUrl used to initialize this class is the link/deep link/fallback url used while constructing the Firebase dynamic link.

Summary

Nested types

A Builder class for ActionCodeSettings.

Constants

static final Parcelable.Creator<ActionCodeSettings>

Public methods

boolean

Returns whether the out-of-band (OOB) code should be handled by the app.

boolean

Returns the preference for whether to attempt to install the app if it is not yet installed on the device.

@Nullable String

Returns the minimum version of the app required to open an email link for sign-in.

@Nullable String

Returns the package name of the installed Android app.

@Nullable String

Returns the bundle ID of the installed Apple platforms app.

@NonNull String

Returns the URL.

static @NonNull ActionCodeSettings.Builder

Returns a new instance of ActionCodeSettings.Builder.

void
writeToParcel(@NonNull Parcel out, int flags)

Inherited Constants

From android.os.Parcelable
static final int
static final int
static final int
static final int

Inherited methods

From android.os.Parcelable
abstract int
int

Constants

CREATOR

public static final Parcelable.Creator<ActionCodeSettingsCREATOR

Public fields

androidInstallApp

public final boolean androidInstallApp

androidMinimumVersion

public final @Nullable String androidMinimumVersion

androidPackageName

public final String androidPackageName

url

public final String url

Public methods

canHandleCodeInApp

public boolean canHandleCodeInApp()

Returns whether the out-of-band (OOB) code should be handled by the app. See setHandleCodeInApp.

getAndroidInstallApp

public boolean getAndroidInstallApp()

Returns the preference for whether to attempt to install the app if it is not yet installed on the device. See setAndroidPackageName.

getAndroidMinimumVersion

public @Nullable String getAndroidMinimumVersion()

Returns the minimum version of the app required to open an email link for sign-in. If the app version on the device is lower than this version then the user is taken to Google Play Store to upgrade the app. See setAndroidPackageName.

getAndroidPackageName

public @Nullable String getAndroidPackageName()

Returns the package name of the installed Android app. See setAndroidPackageName.

getIOSBundle

public @Nullable String getIOSBundle()

Returns the bundle ID of the installed Apple platforms app. See setIOSBundleId.

getUrl

public @NonNull String getUrl()

Returns the URL. See setUrl.

newBuilder

public static @NonNull ActionCodeSettings.Builder newBuilder()

Returns a new instance of ActionCodeSettings.Builder.

writeToParcel

public void writeToParcel(@NonNull Parcel out, int flags)