public static final class

DynamicLink.IosParameters.Builder

extends Object
java.lang.Object
   ↳ com.google.firebase.dynamiclinks.DynamicLink.IosParameters.Builder

Class Overview

Builder for iOS parameters.

Summary

Public Constructors
DynamicLink.IosParameters.Builder(String bundleId)
Create iOS parameters builder.
Public Methods
DynamicLink.IosParameters build()
Build Bundle for use with setIosParameters(IosParameters).
DynamicLink.IosParameters.Builder setAppStoreId(String appStoreId)
Sets the App Store ID, used to send users to the App Store when the app isn't installed.
DynamicLink.IosParameters.Builder setCustomScheme(String customScheme)
Sets the app's custom URL scheme, if defined to be something other than your app's parameters ID.
DynamicLink.IosParameters.Builder setFallbackUrl(Uri fallbackUrl)
Sets the link to open when the app isn't installed.
DynamicLink.IosParameters.Builder setIpadBundleId(String bundleId)
Sets the parameters ID of the iOS app to use on iPads to open the link.
DynamicLink.IosParameters.Builder setIpadFallbackUrl(Uri fallbackUrl)
Sets the link to open on iPads when the app isn't installed.
DynamicLink.IosParameters.Builder setMinimumVersion(String minimumVersion)
Sets the minimum version of your app that can open the link.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public DynamicLink.IosParameters.Builder (String bundleId)

Create iOS parameters builder.

Parameters
bundleId String: The parameters ID of the iOS app to use to open the link. The app must be connected to your project from the Overview page of the Firebase console.

Public Methods

public DynamicLink.IosParameters build ()

Build Bundle for use with setIosParameters(IosParameters).

Returns
DynamicLink.IosParameters

public DynamicLink.IosParameters.Builder setAppStoreId (String appStoreId)

Sets the App Store ID, used to send users to the App Store when the app isn't installed.

Parameters
appStoreId String: The App Store ID.
Returns
DynamicLink.IosParameters.Builder

public DynamicLink.IosParameters.Builder setCustomScheme (String customScheme)

Sets the app's custom URL scheme, if defined to be something other than your app's parameters ID.

Parameters
customScheme String: The app's custom URL scheme.
Returns
DynamicLink.IosParameters.Builder

public DynamicLink.IosParameters.Builder setFallbackUrl (Uri fallbackUrl)

Sets the link to open when the app isn't installed. Specify this to do something other than install your app from the App Store when the app isn't installed, such as open the mobile web version of the content, or display a promotional page for your app.

Parameters
fallbackUrl Uri: The link to open on iOS if the app is not installed.
Returns
DynamicLink.IosParameters.Builder

public DynamicLink.IosParameters.Builder setIpadBundleId (String bundleId)

Sets the parameters ID of the iOS app to use on iPads to open the link. The app must be connected to your project from the Overview page of the Firebase console.

Parameters
bundleId String: The iPad parameters ID of the app.
Returns
DynamicLink.IosParameters.Builder

public DynamicLink.IosParameters.Builder setIpadFallbackUrl (Uri fallbackUrl)

Sets the link to open on iPads when the app isn't installed. Specify this to do something other than install your app from the App Store when the app isn't installed, such as open the web version of the content, or display a promotional page for your app. Overrides the fallback link set by setFallbackUrl(Uri) on iPad.

Parameters
fallbackUrl Uri: The link to open on iPad if the app is not installed.
Returns
DynamicLink.IosParameters.Builder

public DynamicLink.IosParameters.Builder setMinimumVersion (String minimumVersion)

Sets the minimum version of your app that can open the link.

Parameters
minimumVersion String: The minimum version.
Returns
DynamicLink.IosParameters.Builder