FirebaseAdmin.Auth.ActionCodeSettings

Defines the required continue/state URL with optional Android and iOS settings.

Summary

Used when invoking the email action link generation APIs in FirebaseAuth.

Properties

AndroidInstallApp
bool
Gets or sets a value indicating whether to install the Android app if the device supports it and the app is not already installed.
AndroidMinimumVersion
string
Gets or sets the minimum version for the Android app.
AndroidPackageName
string
Gets or sets the Android package name of the app where the link should be handled if the Android app is installed.
DynamicLinkDomain
string
Gets or sets the dynamic link domain to use for the current link if it is to be opened using Firebase Dynamic Links, as multiple dynamic link domains can be configured per project.
HandleCodeInApp
bool
Gets or sets a value indicating whether to open the link via a mobile app or a browser.
IosBundleId
string
Gets or sets the bundle ID of the iOS app where the link should be handled if the application is already installed on the device.
Url
string
Gets or sets the continue/state URL.

Properties

AndroidInstallApp

bool AndroidInstallApp

Gets or sets a value indicating whether to install the Android app if the device supports it and the app is not already installed.

AndroidMinimumVersion

string AndroidMinimumVersion

Gets or sets the minimum version for the Android app.

If the installed app is an older version, the user is taken to the Play Store to upgrade the app.

AndroidPackageName

string AndroidPackageName

Gets or sets the Android package name of the app where the link should be handled if the Android app is installed.

Must be specified when setting other Android-specific settings.

DynamicLinkDomain

string DynamicLinkDomain

Gets or sets the dynamic link domain to use for the current link if it is to be opened using Firebase Dynamic Links, as multiple dynamic link domains can be configured per project.

This setting provides the ability to explicitly choose one. If none is provided, the oldest domain is used by default.

HandleCodeInApp

bool HandleCodeInApp

Gets or sets a value indicating whether to open the link via a mobile app or a browser.

The default is false. When set to true, the action code link is sent as a Universal Link or an Android App Link and is opened by the app if installed. In the false case, the code is sent to the web widget first and then redirects to the app if installed.

IosBundleId

string IosBundleId

Gets or sets the bundle ID of the iOS app where the link should be handled if the application is already installed on the device.

Url

string Url

Gets or sets the continue/state URL.

This property has different meanings in different contexts.

  • When the link is handled in the web action widgets, this is the deep link in the continueUrl query parameter.
  • When the link is handled in the app directly, this is the continueUrl query parameter in the deep link of the Dynamic Link.
This property is required.