# DeepLinkRequest

Artifact: [androidx.navigation3:navigation3-runtime](https://developer.android.com/jetpack/androidx/releases/navigation3) [View Source](https://cs.android.com/search?q=file:androidx/navigation3/runtime/deeplink/DeepLinkRequest.kt+class:androidx.navigation3.runtime.deeplink.DeepLinkRequest) Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/navigation3#1.2.0) Common/AllAndroid/JVM
- Cmn

  ```
  class DeepLinkRequest
  ```

*** ** * ** ***

Represents a requested deep link.

## Summary

| ### Nested types |
|---|
| `object https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest.Companion` |
| `object https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest.Companion.MimeTypeExtrasKey : https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtrasKey<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html>` The `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtrasKey` for the mimeType stored inside the `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtras` returned by `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest#mimeTypeExtra(kotlin.String)`. |

| ### Public companion functions |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtras` | `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest#mimeTypeExtra(kotlin.String)(mimeType: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Returns a `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtras` that stores the provided `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest#mimeTypeExtra(kotlin.String)` with the key `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest.Companion.MimeTypeExtrasKey`. | Cmn |

| ### Public constructors |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest#DeepLinkRequest(androidx.navigation3.runtime.deeplink.DeepLinkUri,androidx.navigation3.runtime.deeplink.RequestExtras)(uri: https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkUri?, extras: https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtras)` | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest#DeepLinkRequest(kotlin.String,androidx.navigation3.runtime.deeplink.RequestExtras)(uri: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, extras: https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtras)` Constructs a `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest` with a string uri. | Cmn |

| ### Public functions |
|---|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest#toString()()` | Cmn |

| ### Public properties |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtras` | `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest#extras()` The `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtras` to provide extra information to the `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest` | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkUri?` | `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest#uri()` The URI for the deep link. | Cmn |

## Public companion functions

### mimeTypeExtra

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

```
fun mimeTypeExtra(mimeType: String): RequestExtras
```

Returns a `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtras` that stores the provided `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest#mimeTypeExtra(kotlin.String)` with the key `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest.Companion.MimeTypeExtrasKey`.

The value can be retrieved via extras\[`https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest.Companion.MimeTypeExtrasKey`\].

## Public constructors

### DeepLinkRequest

Cmn

```
DeepLinkRequest(
    uri: DeepLinkUri? = null,
    extras: RequestExtras = emptyRequestExtras()
)
```

| Parameters |
|---|---|
| `uri: https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkUri? = null` | The URI for the deep link. |
| `extras: https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtras = emptyRequestExtras()` | The `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtras` to provide extra information to the `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest` |

### DeepLinkRequest

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

```
DeepLinkRequest(uri: String, extras: RequestExtras = emptyRequestExtras())
```

Constructs a `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest` with a string uri.

| Parameters |
|---|---|
| `uri: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | the string uri of the requested deep link |
| `extras: https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtras = emptyRequestExtras()` | The `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtras` to provide extra information to the `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest` |

## Public functions

### toString

Cmn

```
open fun toString(): String
```

## Public properties

### extras

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

```
val extras: RequestExtras
```

The `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtras` to provide extra information to the `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest`

### uri

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

```
val uri: DeepLinkUri?
```

The URI for the deep link.