ActionCodeSettings interface

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

Signature:

export interface ActionCodeSettings 

Properties

ActionCodeSettings.android

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

Signature:

android?: {
        installApp?: boolean;
        minimumVersion?: string;
        packageName: string;
    };

ActionCodeSettings.dynamicLinkDomain

When multiple custom dynamic link domains are defined for a project, specify which one to use when the link is to be opened via a specified mobile app (for example, example.page.link).

Signature:

dynamicLinkDomain?: string;

ActionCodeSettings.handleCodeInApp

When set to true, the action code link will be be sent as a Universal Link or Android App Link and will be opened by the app if installed.

In the false case, the code will be sent to the web widget first and then on continue will redirect to the app if installed.

Signature:

handleCodeInApp?: boolean;

ActionCodeSettings.iOS

Sets the iOS bundle ID.

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

App installation is not supported for iOS.

Signature:

iOS?: {
        bundleId: string;
    };

ActionCodeSettings.url

Sets the link continue/state URL.

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

Signature:

url: string;