DynamicLink.IosParameters.Builder

public final class DynamicLink.IosParameters.Builder


Builder for iOS parameters.

Summary

Public constructors

Builder(@NonNull String bundleId)

Create iOS parameters builder.

Public methods

@NonNull DynamicLink.IosParameters

Build IosParameters for use with setIosParameters.

@NonNull String
@NonNull String
@NonNull String
@NonNull Uri
@NonNull String
@NonNull DynamicLink.IosParameters.Builder

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

@NonNull DynamicLink.IosParameters.Builder

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

@NonNull DynamicLink.IosParameters.Builder
setFallbackUrl(@NonNull Uri fallbackUrl)

Sets the link to open when the app isn't installed.

@NonNull DynamicLink.IosParameters.Builder

Sets the bundle ID of the iOS app to use on iPads to open the link.

@NonNull DynamicLink.IosParameters.Builder

Sets the link to open on iPads when the app isn't installed.

@NonNull DynamicLink.IosParameters.Builder
setMinimumVersion(@NonNull String minimumVersion)

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

Public constructors

Builder

public Builder(@NonNull String bundleId)

Create iOS parameters builder.

Parameters
@NonNull String bundleId

The bundle 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

build

public @NonNull DynamicLink.IosParameters build()

Build IosParameters for use with setIosParameters.

getAppStoreId

public @NonNull String getAppStoreId()
Returns
@NonNull String

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

getCustomScheme

public @NonNull String getCustomScheme()
Returns
@NonNull String

the app's custom URL scheme.

getIpadBundleId

public @NonNull String getIpadBundleId()
Returns
@NonNull String

the iPad bundle ID of the app.

getIpadFallbackUrl

public @NonNull Uri getIpadFallbackUrl()
Returns
@NonNull Uri

the link to open on iPad if the app is not installed.

getMinimumVersion

public @NonNull String getMinimumVersion()
Returns
@NonNull String

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

setAppStoreId

public @NonNull DynamicLink.IosParameters.Builder setAppStoreId(@NonNull String appStoreId)

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

Parameters
@NonNull String appStoreId

The App Store ID.

setCustomScheme

public @NonNull DynamicLink.IosParameters.Builder setCustomScheme(@NonNull String customScheme)

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

Parameters
@NonNull String customScheme

The app's custom URL scheme.

setFallbackUrl

public @NonNull DynamicLink.IosParameters.Builder setFallbackUrl(@NonNull 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
@NonNull Uri fallbackUrl

The link to open on iOS if the app is not installed.

setIpadBundleId

public @NonNull DynamicLink.IosParameters.Builder setIpadBundleId(@NonNull String bundleId)

Sets the bundle 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
@NonNull String bundleId

The iPad bundle ID of the app.

setIpadFallbackUrl

public @NonNull DynamicLink.IosParameters.Builder setIpadFallbackUrl(@NonNull 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 on iPad.

Parameters
@NonNull Uri fallbackUrl

The link to open on iPad if the app is not installed.

setMinimumVersion

public @NonNull DynamicLink.IosParameters.Builder setMinimumVersion(@NonNull String minimumVersion)

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

Parameters
@NonNull String minimumVersion

The minimum version.