public class ActionCodeSettings extends Object
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.

Nested Class Summary

class ActionCodeSettings.Builder A Builder class for ActionCodeSettings

Inherited Constant Summary

Field Summary

public static final Creator<ActionCodeSettings> CREATOR

Public Method Summary

boolean
canHandleCodeInApp()
Returns whether the out-of-band (OOB) code should be handled by the app.
boolean
getAndroidInstallApp()
Returns the preference for whether to attempt to install the app if it is not yet installed on the device.
String
getAndroidMinimumVersion()
Returns the minimum version of the app required to open an email link for sign-in.
String
getAndroidPackageName()
Returns the package name of the installed Android app.
String
getIOSBundle()
Returns the bundle ID of the installed Apple platforms app.
String
getUrl()
Returns the URL.
static ActionCodeSettings.Builder
newBuilder()
Returns a new instance of ActionCodeSettings.Builder.
void
writeToParcel(Parcel out, int flags)

Inherited Method Summary

Fields

public static final Creator<ActionCodeSettings> CREATOR

Public Methods

public boolean canHandleCodeInApp ()

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

public boolean getAndroidInstallApp ()

Returns the preference for whether to attempt to install the app if it is not yet installed on the device. See ActionCodeSettings.Builder.setAndroidPackageName(String, boolean, String).

public 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 ActionCodeSettings.Builder.setAndroidPackageName(String, boolean, String).

public String getAndroidPackageName ()

Returns the package name of the installed Android app. See ActionCodeSettings.Builder.setAndroidPackageName(String, boolean, String).

public String getIOSBundle ()

Returns the bundle ID of the installed Apple platforms app. See ActionCodeSettings.Builder.setIOSBundleId(String).

public String getUrl ()

public static ActionCodeSettings.Builder newBuilder ()

Returns a new instance of ActionCodeSettings.Builder.

public void writeToParcel (Parcel out, int flags)