# DynamicLink.IosParameters.Builder

# DynamicLink.IosParameters.Builder


```
public final class DynamicLink.IosParameters.Builder
```

<br />

*** ** * ** ***

> [!CAUTION]
> **This class is deprecated.**   
>
> Firebase Dynamic Links is deprecated and should not be used in new projects. The service will shut down on August 25, 2025. For more information, see [Dynamic Links deprecation documentation](https://firebase.google.com/support/dynamic-links-faq).

Builder for iOS parameters.

## Summary

| ### Public constructors |
|---|
| `[Builder](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#Builder(java.lang.String))(@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/java/lang/String.html bundleId)` **This method is deprecated.** Firebase Dynamic Links is deprecated and should not be used in new projects. <br /> |

| ### Public methods |
|---|---|
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters` | `[build](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#build())()` **This method is deprecated.** Firebase Dynamic Links is deprecated and should not be used in new projects. <br /> |
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/java/lang/String.html` | `[getAppStoreId](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#getAppStoreId())()` **This method is deprecated.** Firebase Dynamic Links is deprecated and should not be used in new projects. <br /> |
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/java/lang/String.html` | `[getCustomScheme](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#getCustomScheme())()` **This method is deprecated.** Firebase Dynamic Links is deprecated and should not be used in new projects. <br /> |
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/java/lang/String.html` | `[getIpadBundleId](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#getIpadBundleId())()` **This method is deprecated.** Firebase Dynamic Links is deprecated and should not be used in new projects. <br /> |
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/android/net/Uri.html` | `[getIpadFallbackUrl](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#getIpadFallbackUrl())()` **This method is deprecated.** Firebase Dynamic Links is deprecated and should not be used in new projects. <br /> |
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/java/lang/String.html` | `[getMinimumVersion](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#getMinimumVersion())()` **This method is deprecated.** Firebase Dynamic Links is deprecated and should not be used in new projects. <br /> |
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder` | `[setAppStoreId](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#setAppStoreId(java.lang.String))(@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/java/lang/String.html appStoreId)` **This method is deprecated.** Firebase Dynamic Links is deprecated and should not be used in new projects. <br /> |
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder` | `[setCustomScheme](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#setCustomScheme(java.lang.String))(@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/java/lang/String.html customScheme)` **This method is deprecated.** Firebase Dynamic Links is deprecated and should not be used in new projects. <br /> |
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder` | `[setFallbackUrl](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#setFallbackUrl(android.net.Uri))(@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/android/net/Uri.html fallbackUrl)` **This method is deprecated.** Firebase Dynamic Links is deprecated and should not be used in new projects. <br /> |
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder` | `[setIpadBundleId](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#setIpadBundleId(java.lang.String))(@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/java/lang/String.html bundleId)` **This method is deprecated.** Firebase Dynamic Links is deprecated and should not be used in new projects. <br /> |
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder` | `[setIpadFallbackUrl](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#setIpadFallbackUrl(android.net.Uri))(@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/android/net/Uri.html fallbackUrl)` **This method is deprecated.** Firebase Dynamic Links is deprecated and should not be used in new projects. <br /> |
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder` | `[setMinimumVersion](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#setMinimumVersion(java.lang.String))(@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/java/lang/String.html minimumVersion)` **This method is deprecated.** Firebase Dynamic Links is deprecated and should not be used in new projects. <br /> |

## Public constructors

### Builder

```
public [Builder](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#Builder(java.lang.String))(@NonNull String bundleId)
```

> [!CAUTION]
> **This method is deprecated.**   
>
> Firebase Dynamic Links is deprecated and should not be used in new projects. The service will shut down on August 25, 2025. For more information, see [Dynamic Links deprecation documentation](https://firebase.google.com/support/dynamic-links-faq).

Create iOS parameters builder.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/java/lang/String.html 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](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#build())()
```

> [!CAUTION]
> **This method is deprecated.**   
>
> Firebase Dynamic Links is deprecated and should not be used in new projects. The service will shut down on August 25, 2025. For more information, see [Dynamic Links deprecation documentation](https://firebase.google.com/support/dynamic-links-faq).

Build IosParameters for use with `https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.Builder#setIosParameters(com.google.firebase.dynamiclinks.DynamicLink.IosParameters)`.

### getAppStoreId

```
public @NonNull String [getAppStoreId](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#getAppStoreId())()
```

> [!CAUTION]
> **This method is deprecated.**   
>
> Firebase Dynamic Links is deprecated and should not be used in new projects. The service will shut down on August 25, 2025. For more information, see [Dynamic Links deprecation documentation](https://firebase.google.com/support/dynamic-links-faq).d.

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

| Returns |
|---|---|
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/java/lang/String.html` | the App Store ID, used to send users to the App Store when the app isn't installed. |

### getCustomScheme

```
public @NonNull String [getCustomScheme](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#getCustomScheme())()
```

> [!CAUTION]
> **This method is deprecated.**   
>
> Firebase Dynamic Links is deprecated and should not be used in new projects. The service will shut down on August 25, 2025. For more information, see [Dynamic Links deprecation documentation](https://firebase.google.com/support/dynamic-links-faq).

Returns the app's custom URL scheme.

| Returns |
|---|---|
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/java/lang/String.html` | the app's custom URL scheme. |

### getIpadBundleId

```
public @NonNull String [getIpadBundleId](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#getIpadBundleId())()
```

> [!CAUTION]
> **This method is deprecated.**   
>
> Firebase Dynamic Links is deprecated and should not be used in new projects. The service will shut down on August 25, 2025. For more information, see [Dynamic Links deprecation documentation](https://firebase.google.com/support/dynamic-links-faq).

Returns the iPad bundle ID of the app.

| Returns |
|---|---|
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/java/lang/String.html` | the iPad bundle ID of the app. |

### getIpadFallbackUrl

```
public @NonNull Uri [getIpadFallbackUrl](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#getIpadFallbackUrl())()
```

> [!CAUTION]
> **This method is deprecated.**   
>
> Firebase Dynamic Links is deprecated and should not be used in new projects. The service will shut down on August 25, 2025. For more information, see [Dynamic Links deprecation documentation](https://firebase.google.com/support/dynamic-links-faq).

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

| Returns |
|---|---|
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/android/net/Uri.html` | the link to open on iPad if the app is not installed. |

### getMinimumVersion

```
public @NonNull String [getMinimumVersion](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#getMinimumVersion())()
```

> [!CAUTION]
> **This method is deprecated.**   
>
> Firebase Dynamic Links is deprecated and should not be used in new projects. The service will shut down on August 25, 2025. For more information, see [Dynamic Links deprecation documentation](https://firebase.google.com/support/dynamic-links-faq).

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

| Returns |
|---|---|
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/java/lang/String.html` | the minimum version of your app that can open the link. |

### setAppStoreId

```
public @NonNull DynamicLink.IosParameters.Builder [setAppStoreId](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#setAppStoreId(java.lang.String))(@NonNull String appStoreId)
```

> [!CAUTION]
> **This method is deprecated.**   
>
> Firebase Dynamic Links is deprecated and should not be used in new projects. The service will shut down on August 25, 2025. For more information, see [Dynamic Links deprecation documentation](https://firebase.google.com/support/dynamic-links-faq).

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

| Parameters |
|---|---|
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/java/lang/String.html appStoreId` | The App Store ID. |

### setCustomScheme

```
public @NonNull DynamicLink.IosParameters.Builder [setCustomScheme](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#setCustomScheme(java.lang.String))(@NonNull String customScheme)
```

> [!CAUTION]
> **This method is deprecated.**   
>
> Firebase Dynamic Links is deprecated and should not be used in new projects. The service will shut down on August 25, 2025. For more information, see [Dynamic Links deprecation documentation](https://firebase.google.com/support/dynamic-links-faq).

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

| Parameters |
|---|---|
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/java/lang/String.html customScheme` | The app's custom URL scheme. |

### setFallbackUrl

```
public @NonNull DynamicLink.IosParameters.Builder [setFallbackUrl](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#setFallbackUrl(android.net.Uri))(@NonNull Uri fallbackUrl)
```

> [!CAUTION]
> **This method is deprecated.**   
>
> Firebase Dynamic Links is deprecated and should not be used in new projects. The service will shut down on August 25, 2025. For more information, see [Dynamic Links deprecation documentation](https://firebase.google.com/support/dynamic-links-faq).

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 |
|---|---|
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/android/net/Uri.html fallbackUrl` | The link to open on iOS if the app is not installed. |

### setIpadBundleId

```
public @NonNull DynamicLink.IosParameters.Builder [setIpadBundleId](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#setIpadBundleId(java.lang.String))(@NonNull String bundleId)
```

> [!CAUTION]
> **This method is deprecated.**   
>
> Firebase Dynamic Links is deprecated and should not be used in new projects. The service will shut down on August 25, 2025. For more information, see [Dynamic Links deprecation documentation](https://firebase.google.com/support/dynamic-links-faq).

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 |
|---|---|
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/java/lang/String.html bundleId` | The iPad bundle ID of the app. |

### setIpadFallbackUrl

```
public @NonNull DynamicLink.IosParameters.Builder [setIpadFallbackUrl](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#setIpadFallbackUrl(android.net.Uri))(@NonNull Uri fallbackUrl)
```

> [!CAUTION]
> **This method is deprecated.**   
>
> Firebase Dynamic Links is deprecated and should not be used in new projects. The service will shut down on August 25, 2025. For more information, see [Dynamic Links deprecation documentation](https://firebase.google.com/support/dynamic-links-faq).

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 `https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#setFallbackUrl(android.net.Uri)` on iPad.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/android/net/Uri.html fallbackUrl` | The link to open on iPad if the app is not installed. |

### setMinimumVersion

```
public @NonNull DynamicLink.IosParameters.Builder [setMinimumVersion](https://firebase.google.com/docs/reference/android/com/google/firebase/dynamiclinks/DynamicLink.IosParameters.Builder#setMinimumVersion(java.lang.String))(@NonNull String minimumVersion)
```

> [!CAUTION]
> **This method is deprecated.**   
>
> Firebase Dynamic Links is deprecated and should not be used in new projects. The service will shut down on August 25, 2025. For more information, see [Dynamic Links deprecation documentation](https://firebase.google.com/support/dynamic-links-faq).

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

| Parameters |
|---|---|
| `@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/java/lang/String.html minimumVersion` | The minimum version. |