# NavDeepLink

# NavDeepLink

Artifact:[androidx.navigation:navigation-common](https://developer.android.com/jetpack/androidx/releases/navigation)  
[View Source](https://cs.android.com/search?q=file:androidx/navigation/NavDeepLink.kt+class:androidx.navigation.NavDeepLink)  
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/NavDeepLink "View this page in Java")
Common/AllAndroid/JVM
  - Cmn  

  ```
  class NavDeepLink
  ```

*** ** * ** ***

NavDeepLink encapsulates the parsing and matching of a navigation deep link.

This should be added to a[NavDestination](https://developer.android.com/reference/kotlin/androidx/navigation/NavDestination)using[NavDestination.addDeepLink](https://developer.android.com/reference/kotlin/androidx/navigation/NavDestination#addDeepLink(kotlin.String)).

## Summary

|                                                                                                                    ### Nested types                                                                                                                     |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[NavDeepLink.Builder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLink.Builder) A builder for constructing[NavDeepLink](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLink)instances. |

|                                        ### Public functions                                         |
|-----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|
| `open operator `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [equals](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLink#equals(kotlin.Any))`(other: `[Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)`?)` | Cmn |
| `open `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                  | [hashCode](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLink#hashCode())`()`                                                                                            | Cmn |

|                                ### Public properties                                 |
|--------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|-----|
| [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`?` | [action](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLink#action()) The action from the NavDeepLink.              | Cmn |
| [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`?` | [mimeType](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLink#mimeType()) The mimeType from the NavDeepLink.        | Cmn |
| [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`?` | [uriPattern](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLink#uriPattern()) The uri pattern from the NavDeepLink. | Cmn |

## Public functions

### equals

Cmn  

```
open operator fun equals(other: Any?): Boolean
```  

### hashCode

Cmn  

```
open fun hashCode(): Int
```

## Public properties

### action

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

```
val action: String?
```

The action from the NavDeepLink.  

|                                                 See also                                                 |
|----------------------------------------------------------------------------------------------------------|---|
| [action](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest#action()) |   |

### mimeType

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

```
val mimeType: String?
```

The mimeType from the NavDeepLink.  

|                                                   See also                                                   |
|--------------------------------------------------------------------------------------------------------------|---|
| [mimeType](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest#mimeType()) |   |

### uriPattern

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

```
val uriPattern: String?
```

The uri pattern from the NavDeepLink.  

|                                              See also                                              |
|----------------------------------------------------------------------------------------------------|---|
| [uri](https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkRequest#uri()) |   |