DynamicLink.IosParameters.Builder

public final class DynamicLink.IosParameters.Builder

Builder for iOS parameters.

Summary

Public constructors

Builder(@NonNullString bundleId)

This method is deprecated.

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

Public methods
`@NonNullDynamicLink.IosParameters`	`build()` This method is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`@NonNullString`	`getAppStoreId()` This method is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`@NonNullString`	`getCustomScheme()` This method is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`@NonNullString`	`getIpadBundleId()` This method is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`@NonNullUri`	`getIpadFallbackUrl()` This method is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`@NonNullString`	`getMinimumVersion()` This method is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`@NonNullDynamicLink.IosParameters.Builder`	`setAppStoreId(@NonNullString appStoreId)` This method is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`@NonNullDynamicLink.IosParameters.Builder`	`setCustomScheme(@NonNullString customScheme)` This method is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`@NonNullDynamicLink.IosParameters.Builder`	`setFallbackUrl(@NonNullUri fallbackUrl)` This method is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`@NonNullDynamicLink.IosParameters.Builder`	`setIpadBundleId(@NonNullString bundleId)` This method is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`@NonNullDynamicLink.IosParameters.Builder`	`setIpadFallbackUrl(@NonNullUri fallbackUrl)` This method is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`@NonNullDynamicLink.IosParameters.Builder`	`setMinimumVersion(@NonNullString minimumVersion)` This method is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.

Public constructors

Builder

public Builder(@NonNullString bundleId)

Create iOS parameters builder.

Parameters
`@NonNullString 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 @NonNullDynamicLink.IosParameters build()

Build IosParameters for use with setIosParameters.

getAppStoreId

public @NonNullString getAppStoreId()

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

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

getCustomScheme

public @NonNullString getCustomScheme()

Returns the app's custom URL scheme.

Returns
`@NonNullString`	the app's custom URL scheme.

getIpadBundleId

public @NonNullString getIpadBundleId()

Returns the iPad bundle ID of the app.

Returns
`@NonNullString`	the iPad bundle ID of the app.

getIpadFallbackUrl

public @NonNullUri getIpadFallbackUrl()

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

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

getMinimumVersion

public @NonNullString getMinimumVersion()

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

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

setAppStoreId

public @NonNullDynamicLink.IosParameters.Builder setAppStoreId(@NonNullString appStoreId)

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

Parameters
`@NonNullString appStoreId`	The App Store ID.

setCustomScheme

public @NonNullDynamicLink.IosParameters.Builder setCustomScheme(@NonNullString customScheme)

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

Parameters
`@NonNullString customScheme`	The app's custom URL scheme.

setFallbackUrl

public @NonNullDynamicLink.IosParameters.Builder setFallbackUrl(@NonNullUri 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
`@NonNullUri fallbackUrl`	The link to open on iOS if the app is not installed.

setIpadBundleId

public @NonNullDynamicLink.IosParameters.Builder setIpadBundleId(@NonNullString 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
`@NonNullString bundleId`	The iPad bundle ID of the app.

setIpadFallbackUrl

public @NonNullDynamicLink.IosParameters.Builder setIpadFallbackUrl(@NonNullUri 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
`@NonNullUri fallbackUrl`	The link to open on iPad if the app is not installed.

setMinimumVersion

public @NonNullDynamicLink.IosParameters.Builder setMinimumVersion(@NonNullString minimumVersion)

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

Parameters
`@NonNullString minimumVersion`	The minimum version.