# NavDeepLinkRequest.Builder

# 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)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/navigation/NavDeepLinkRequest.Builder "View this page in Java")
Common/AllAndroid/JVM
  - Cmn  

  ```
  class NavDeepLinkRequest.Builder
  ```

*** ** * ** ***

A builder for constructing[NavDeepLinkRequest](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest)instances.

## Summary

|                                               ### Public companion functions                                                |
|-----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|
| [NavDeepLinkRequest.Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder) | [fromAction](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder#fromAction(kotlin.String))`(action: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`)` Creates a[NavDeepLinkRequest.Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder)with a set action.         | Cmn |
| [NavDeepLinkRequest.Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder) | [fromMimeType](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder#fromMimeType(kotlin.String))`(mimeType: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`)` Creates a[NavDeepLinkRequest.Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder)with a set mimeType. | Cmn |
| [NavDeepLinkRequest.Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder) | [fromUri](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder#fromUri(androidx.navigation.NavUri))`(uri: `[NavUri](https://developer.android.com/reference/kotlin/androidx/navigation/NavUri)`)` Creates a[NavDeepLinkRequest.Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder)with a set uri.      | Cmn |

|                                                    ### Public functions                                                     |
|-----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|
| [NavDeepLinkRequest](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest)                 | [build](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder#build())`()` Build the[NavDeepLinkRequest](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest)specified by this builder.                                                                                                             | Cmn |
| [NavDeepLinkRequest.Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder) | [setAction](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder#setAction(kotlin.String))`(action: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`)` Set the action for the[NavDeepLinkRequest](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest).         | Cmn |
| [NavDeepLinkRequest.Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder) | [setMimeType](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder#setMimeType(kotlin.String))`(mimeType: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`)` Set the mimeType for the[NavDeepLinkRequest](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest). | Cmn |
| [NavDeepLinkRequest.Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder) | [setUri](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder#setUri(androidx.navigation.NavUri))`(uri: `[NavUri](https://developer.android.com/reference/kotlin/androidx/navigation/NavUri)`)` Set the uri for the[NavDeepLinkRequest](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest).      | Cmn |

## Public companion functions

### fromAction

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

```
fun fromAction(action: String): NavDeepLinkRequest.Builder
```

Creates a[NavDeepLinkRequest.Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder)with a set action.  

|                                         Parameters                                          |
|---------------------------------------------------------------------------------------------|----------------------------------------------|
| `action: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) | the intent action for the NavDeepLinkRequest |

|                                                           Returns                                                           |
|-----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [NavDeepLinkRequest.Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder) | a[Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder)instance |

|                                                             Throws                                                             |
|--------------------------------------------------------------------------------------------------------------------------------|-------------------------|
| [kotlin.IllegalArgumentException](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html) | if the action is empty. |

### fromMimeType

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

```
fun fromMimeType(mimeType: String): NavDeepLinkRequest.Builder
```

Creates a[NavDeepLinkRequest.Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder)with a set mimeType.  

|                                          Parameters                                           |
|-----------------------------------------------------------------------------------------------|-----------------------------------------|
| `mimeType: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) | the mimeType for the NavDeepLinkRequest |

|                                                           Returns                                                           |
|-----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [NavDeepLinkRequest.Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder) | a[Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder)instance |

### fromUri

Cmn  

```
fun fromUri(uri: NavUri): NavDeepLinkRequest.Builder
```

Creates a[NavDeepLinkRequest.Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder)with a set uri.  

|                                         Parameters                                         |
|--------------------------------------------------------------------------------------------|------------------------------------------|
| `uri: `[NavUri](https://developer.android.com/reference/kotlin/androidx/navigation/NavUri) | The uri to add to the NavDeepLinkRequest |

|                                                           Returns                                                           |
|-----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [NavDeepLinkRequest.Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder) | a[Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder)instance |

## Public functions

### build

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

```
fun build(): NavDeepLinkRequest
```

Build the[NavDeepLinkRequest](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest)specified by this builder.  

|                                                   Returns                                                   |
|-------------------------------------------------------------------------------------------------------------|------------------------------------------|
| [NavDeepLinkRequest](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest) | the newly constructed NavDeepLinkRequest |

### setAction

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

```
fun setAction(action: String): NavDeepLinkRequest.Builder
```

Set the action for the[NavDeepLinkRequest](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest).  

|                                         Parameters                                          |
|---------------------------------------------------------------------------------------------|----------------------------------------------|
| `action: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) | the intent action for the NavDeepLinkRequest |

|                                                           Returns                                                           |
|-----------------------------------------------------------------------------------------------------------------------------|---------------|
| [NavDeepLinkRequest.Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder) | This builder. |

|                                                             Throws                                                             |
|--------------------------------------------------------------------------------------------------------------------------------|-------------------------|
| [kotlin.IllegalArgumentException](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html) | if the action is empty. |

### setMimeType

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

```
fun setMimeType(mimeType: String): NavDeepLinkRequest.Builder
```

Set the mimeType for the[NavDeepLinkRequest](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest).  

|                                          Parameters                                           |
|-----------------------------------------------------------------------------------------------|-----------------------------------------|
| `mimeType: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) | the mimeType for the NavDeepLinkRequest |

|                                                           Returns                                                           |
|-----------------------------------------------------------------------------------------------------------------------------|---------------|
| [NavDeepLinkRequest.Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder) | This builder. |

|                                                             Throws                                                             |
|--------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------|
| [kotlin.IllegalArgumentException](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

Cmn  

```
fun setUri(uri: NavUri): NavDeepLinkRequest.Builder
```

Set the uri for the[NavDeepLinkRequest](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest).  

|                                         Parameters                                         |
|--------------------------------------------------------------------------------------------|------------------------------------------|
| `uri: `[NavUri](https://developer.android.com/reference/kotlin/androidx/navigation/NavUri) | The uri to add to the NavDeepLinkRequest |

|                                                           Returns                                                           |
|-----------------------------------------------------------------------------------------------------------------------------|---------------|
| [NavDeepLinkRequest.Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest.Builder) | This builder. |