CloudFireAuth Docs

Appearance

cloudfire-auth / ActionCodeSettings

Interface: ActionCodeSettings ​

Defined in: types/firebase-admin/action-code-settings.ts:29

This is the interface that defines the required continue/state URL with optional Android and iOS bundle identifiers.

Properties ​

android? ​

optional android: object

Defined in: types/firebase-admin/action-code-settings.ts:70

Defines the Android package name. This will try to open the link in an android app if it is installed. If installApp is passed, it specifies whether to install the Android app if the device supports it and the app is not already installed. If this field is provided without a packageName, an error is thrown explaining that the packageName must be provided in conjunction with this field. If minimumVersion is specified, and an older version of the app is installed, the user is taken to the Play Store to upgrade the app.

installApp? ​

optional installApp: boolean

Whether to install the Android app if the device supports it and the app is not already installed.

minimumVersion? ​

optional minimumVersion: string

The Android minimum version if available. If the installed app is an older version, the user is taken to the GOogle Play Store to upgrade the app.

packageName ​

packageName: string

Defines the required Android package name of the app where the link should be handled if the Android app is installed.

dynamicLinkDomain? ​

optional dynamicLinkDomain: string

Defined in: types/firebase-admin/action-code-settings.ts:95

Defines 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 field provides the ability to explicitly choose configured per project. This fields provides the ability explicitly choose one. If none is provided, the oldest domain is used by default.

Deprecated ​

use linkDomain instead

handleCodeInApp? ​

optional handleCodeInApp: boolean

Defined in: types/firebase-admin/action-code-settings.ts:48

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

iOS? ​

optional iOS: object

Defined in: types/firebase-admin/action-code-settings.ts:53

Defines the iOS bundle ID. This will try to open the link in an iOS app if it is installed.

bundleId ​

bundleId: string

Defines the required iOS bundle ID of the app where the link should be handled if the application is already installed on the device.

linkDomain? ​

optional linkDomain: string

Defined in: types/firebase-admin/action-code-settings.ts:103

Defines the custom Firebase Hosting domain to use when the link is to be opened via a specified mobile app, This is a replacement of Firebase Dynamic Link. If none is provided, a default hosting domain will be used (for example, example.firebaseapp.com)

url ​

url: string

Defined in: types/firebase-admin/action-code-settings.ts:40

Defines the link continue/state URL, which 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.