# NavDeepLinkRequest.Builder

Artifact: [androidx.navigation:navigation-common](https://developer.android.com/jetpack/androidx/releases/navigation) [View Source](https://cs.android.com/search?q=file:androidx/navigation/NavDeepLinkRequest.kt+class:androidx.navigation.NavDeepLinkRequest.Builder) Added in [2.3.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.3.0)

*** ** * ** ***


```
public final class NavDeepLinkRequest.Builder
```

<br />

*** ** * ** ***

A builder for constructing `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest` instances.

## Summary

| ### Public methods |
|---|---|
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest` | `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder#build()()` Build the `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest` specified by this builder. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` | `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder#fromAction(kotlin.String)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html action)` Creates a `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` with a set action. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` | `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder#fromMimeType(kotlin.String)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html mimeType)` Creates a `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` with a set mimeType. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` | `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder#fromUri(androidx.navigation.NavUri)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavUri uri)` Creates a `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` with a set uri. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` | `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder#setAction(kotlin.String)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html action)` Set the action for the `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest`. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` | `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder#setMimeType(kotlin.String)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html mimeType)` Set the mimeType for the `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest`. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` | `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder#setUri(androidx.navigation.NavUri)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavUri uri)` Set the uri for the `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest`. |

## Public methods

### build

Added in [2.3.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.3.0)

```
public final @NonNull NavDeepLinkRequest build()
```

Build the `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest` specified by this builder.

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest` | the newly constructed NavDeepLinkRequest |

### fromAction

Added in [2.4.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.4.0)

```
public static final @NonNull NavDeepLinkRequest.Builder fromAction(@NonNull String action)
```

Creates a `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` with a set action.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html action` | the intent action for the NavDeepLinkRequest |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` | a `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` instance |

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if the action is empty. |

### fromMimeType

Added in [2.4.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.4.0)

```
public static final @NonNull NavDeepLinkRequest.Builder fromMimeType(@NonNull String mimeType)
```

Creates a `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` with a set mimeType.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html mimeType` | the mimeType for the NavDeepLinkRequest |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` | a `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` instance |

### fromUri

```
public static final @NonNull NavDeepLinkRequest.Builder fromUri(@NonNull NavUri uri)
```

Creates a `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` with a set uri.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavUri uri` | The uri to add to the NavDeepLinkRequest |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` | a `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` instance |

### setAction

Added in [2.3.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.3.0)

```
public final @NonNull NavDeepLinkRequest.Builder setAction(@NonNull String action)
```

Set the action for the `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest`.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html action` | the intent action for the NavDeepLinkRequest |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` | This builder. |

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if the action is empty. |

### setMimeType

Added in [2.3.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.3.0)

```
public final @NonNull NavDeepLinkRequest.Builder setMimeType(@NonNull String mimeType)
```

Set the mimeType for the `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest`.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html mimeType` | the mimeType for the NavDeepLinkRequest |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` | This builder. |

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if the given mimeType does not match th3e required "type/subtype" format. |

### setUri

```
public final @NonNull NavDeepLinkRequest.Builder setUri(@NonNull NavUri uri)
```

Set the uri for the `https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest`.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavUri uri` | The uri to add to the NavDeepLinkRequest |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder` | This builder. |