ActionCodeSettings.Builder

class ActionCodeSettings.Builder


A Builder class for ActionCodeSettings. Get an instance of this Builder using newBuilder.

Summary

Public functions

ActionCodeSettings

Builds the ActionCodeSettings that this Builder has constructed.

Boolean

Returns whether the out-of-band (OOB) code should be handled by the app.

String?

Returns the bundle ID of the installed Apple platforms app.

ActionCodeSettings.Builder
setAndroidPackageName(
    androidPackageName: String,
    installIfNotAvailable: Boolean,
    minimumVersion: String?
)

Sets the Android package name and returns the current builder instance.

ActionCodeSettings.Builder

The default is false.

ActionCodeSettings.Builder
setIOSBundleId(iOSBundleId: String?)

To be used if the email link that is sent might be opened on an iOS device.

Public properties

String!
String!

Public functions

build

fun build(): ActionCodeSettings

Builds the ActionCodeSettings that this Builder has constructed.

getHandleCodeInApp

fun getHandleCodeInApp(): Boolean

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

getIOSBundleId

fun getIOSBundleId(): String?

Returns the bundle ID of the installed Apple platforms app. See setIOSBundleId.

setAndroidPackageName

fun setAndroidPackageName(
    androidPackageName: String,
    installIfNotAvailable: Boolean,
    minimumVersion: String?
): ActionCodeSettings.Builder

Sets the Android package name and returns the current builder instance. If installIfNotAvailable is set to true and the link is opened on an android device, it will try to install the app if not already available. Otherwise the web URL is used.

A minimum version string is also available. If the installed app is an older version, the user is taken to the Play Store to upgrade the app.

setHandleCodeInApp

fun setHandleCodeInApp(status: Boolean): ActionCodeSettings.Builder

The default is false. When set to true, the action code link will be sent as a universal link and will be open 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.

setIOSBundleId

fun setIOSBundleId(iOSBundleId: String?): ActionCodeSettings.Builder

To be used if the email link that is sent might be opened on an iOS device.

Sets the iOS bundle Id and returns the current Builder instance.

Public properties

dynamicLinkDomain

var dynamicLinkDomainString!

url

var urlString!