DynamicLink.IosParameters.Builder

class DynamicLink.IosParameters.Builder

Builder for iOS parameters.

Summary

Public constructors
`Builder(bundleId: String)` This function is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.

Public constructors

Builder(bundleId: String)

This function is deprecated.

Firebase Dynamic Links is deprecated and should not be used in new projects.

Public functions
`DynamicLink.IosParameters`	`build()` This function is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`String`	`getAppStoreId()` This function is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`String`	`getCustomScheme()` This function is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`String`	`getIpadBundleId()` This function is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`Uri`	`getIpadFallbackUrl()` This function is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`String`	`getMinimumVersion()` This function is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`DynamicLink.IosParameters.Builder`	`setAppStoreId(appStoreId: String)` This function is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`DynamicLink.IosParameters.Builder`	`setCustomScheme(customScheme: String)` This function is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`DynamicLink.IosParameters.Builder`	`setFallbackUrl(fallbackUrl: Uri)` This function is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`DynamicLink.IosParameters.Builder`	`setIpadBundleId(bundleId: String)` This function is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`DynamicLink.IosParameters.Builder`	`setIpadFallbackUrl(fallbackUrl: Uri)` This function is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`DynamicLink.IosParameters.Builder`	`setMinimumVersion(minimumVersion: String)` This function is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.

Public constructors

Builder

Builder(bundleId: String)

Create iOS parameters builder.

Parameters
`bundleId: String`	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 functions

build

fun build(): DynamicLink.IosParameters

Build IosParameters for use with setIosParameters.

getAppStoreId

fun getAppStoreId(): String

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

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

getCustomScheme

fun getCustomScheme(): String

Returns the app's custom URL scheme.

Returns
`String`	the app's custom URL scheme.

getIpadBundleId

fun getIpadBundleId(): String

Returns the iPad bundle ID of the app.

Returns
`String`	the iPad bundle ID of the app.

getIpadFallbackUrl

fun getIpadFallbackUrl(): Uri

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

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

getMinimumVersion

fun getMinimumVersion(): String

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

Returns
`String`	the minimum version of your app that can open the link.

setAppStoreId

fun setAppStoreId(appStoreId: String): DynamicLink.IosParameters.Builder

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.

setCustomScheme

fun setCustomScheme(customScheme: String): DynamicLink.IosParameters.Builder

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

Parameters
`customScheme: String`	The app's custom URL scheme.

setFallbackUrl

fun setFallbackUrl(fallbackUrl: Uri): DynamicLink.IosParameters.Builder

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.

setIpadBundleId

fun setIpadBundleId(bundleId: String): DynamicLink.IosParameters.Builder

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
`bundleId: String`	The iPad bundle ID of the app.

setIpadFallbackUrl

fun setIpadFallbackUrl(fallbackUrl: Uri): DynamicLink.IosParameters.Builder

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
`fallbackUrl: Uri`	The link to open on iPad if the app is not installed.

setMinimumVersion

fun setMinimumVersion(minimumVersion: String): DynamicLink.IosParameters.Builder

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

Parameters
`minimumVersion: String`	The minimum version.