ActionCodeSettings.Builder

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

Public Method Summary

ActionCodeSettings	build() Builds the `ActionCodeSettings` that this `ActionCodeSettings.Builder` has constructed.
String	getDynamicLinkDomain() Returns the Firebase Dynamic Links domain used to construct the action code link.
boolean	getHandleCodeInApp() Returns whether the out-of-band (OOB) code should be handled by the app.
String	getIOSBundleId() Returns the bundle ID of the installed Apple platforms app.
String	getUrl() Returns the URL, which is used as a state/continueURL in the action code link.
ActionCodeSettings.Builder	setAndroidPackageName(String androidPackageName, boolean installIfNotAvailable, String minimumVersion) Sets the Android package name and returns the current builder instance.
ActionCodeSettings.Builder	setDynamicLinkDomain(String dynamicLinkDomain) Sets the optional FDL domain, overriding the default FDL domain that would be used.
ActionCodeSettings.Builder	setHandleCodeInApp(boolean status) The default is false.
ActionCodeSettings.Builder	setIOSBundleId(String iOSBundleId) To be used if the email link that is sent might be opened on an iOS device.
ActionCodeSettings.Builder	setUrl(String url) Sets the URL, which has different meanings in different contexts.

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Methods

public ActionCodeSettings build ()

Builds the ActionCodeSettings that this ActionCodeSettings.Builder has constructed.

public String getDynamicLinkDomain ()

Returns the Firebase Dynamic Links domain used to construct the action code link.

public boolean getHandleCodeInApp ()

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

public String getIOSBundleId ()

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

public String getUrl ()

Returns the URL, which is used as a state/continueURL in the action code link.

public ActionCodeSettings.Builder setAndroidPackageName (String androidPackageName, boolean installIfNotAvailable, String minimumVersion)

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.

public ActionCodeSettings.Builder setDynamicLinkDomain (String dynamicLinkDomain)

Sets the optional FDL domain, overriding the default FDL domain that would be used. Must be one of the 5 domains configured in the Firebase console.

public ActionCodeSettings.Builder setHandleCodeInApp (boolean status)

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.

public ActionCodeSettings.Builder setIOSBundleId (String iOSBundleId)

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 ActionCodeSettings.Builder instance.

public ActionCodeSettings.Builder setUrl (String url)

Sets the URL, which has different meanings in different contexts. For email actions, this is the state/continue URL. When the app is not installed, this is the web continue URL with any developer provided state appended (the continueURL query parameter). When the app is installed, this is contained in the Firebase dynamic link payload. In the case where the code is sent directly to the app and the app is installed, this is the continueURL query parameter in the dynamic link payload. Otherwise, when the code is handled by the widget itself, it is the payload itself.