ActionCodeSettings

public classActionCodeSettings implementsParcelable

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 forActionCodeSettings.

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.

@NullableString

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

@NullableString

Returns the package name of the installed Android app.

@NullableString

Returns the bundle ID of the installed Apple platforms app.

@NonNullString

Returns the Firebase Hosting domain used to construct the action code link.

@NonNullString

Returns the URL.

static @NonNullActionCodeSettings.Builder

Returns a new instance ofActionCodeSettings.Builder.

void
writeToParcel(@NonNullParcel out, int flags)

Inherited Constants

Fromandroid.os.Parcelable
static final int
static final int

Inherited methods

Fromandroid.os.Parcelable
abstract int

Constants

CREATOR

public static final Parcelable.Creator<ActionCodeSettings> CREATOR

Public fields

androidInstallApp

public final boolean androidInstallApp

androidMinimumVersion

public final @NullableString androidMinimumVersion

androidPackageName

public final String androidPackageName

linkDomain

public final String linkDomain

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. SeesetHandleCodeInApp.

getAndroidInstallApp

public boolean getAndroidInstallApp()

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

getAndroidMinimumVersion

public @NullableString 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. SeesetAndroidPackageName.

getAndroidPackageName

public @NullableString getAndroidPackageName()

Returns the package name of the installed Android app. SeesetAndroidPackageName.

getIOSBundle

public @NullableString getIOSBundle()

Returns the bundle ID of the installed Apple platforms app. SeesetIOSBundleId.

getLinkDomain

public @NonNullString getLinkDomain()

Returns the Firebase Hosting domain used to construct the action code link.

getUrl

public @NonNullString getUrl()

Returns the URL. SeesetUrl.

newBuilder

public static @NonNullActionCodeSettings.Builder newBuilder()

Returns a new instance ofActionCodeSettings.Builder.

writeToParcel

public void writeToParcel(@NonNullParcel out, int flags)

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-21 UTC.