# DeepLinkRequest.Companion

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.Companion) Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/navigation3#1.2.0) Common/AllAndroid/JVM
- Cmn

  ```
  object DeepLinkRequest.Companion
  ```

*** ** * ** ***

## Summary

| ### Nested types |
|---|
| `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 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 |

| ### Extension functions |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtras` | `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest.Companion.https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest.Companion#(androidx.navigation3.runtime.deeplink.DeepLinkRequest.Companion).actionExtra(kotlin.String)(action: 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/package-summary#(androidx.navigation3.runtime.deeplink.DeepLinkRequest.Companion).actionExtra(kotlin.String)` with the key `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/package-summary#(androidx.navigation3.runtime.deeplink.DeepLinkRequest.Companion).ActionExtrasKey()`. | android |
| `operator https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest` | `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest.Companion.https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest.Companion#(androidx.navigation3.runtime.deeplink.DeepLinkRequest.Companion).invoke(android.content.Intent,androidx.navigation3.runtime.deeplink.RequestExtras)(intent: https://developer.android.com/reference/android/content/Intent.html, extras: https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtras)` Creates a `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest` with an `https://developer.android.com/reference/android/content/Intent.html`. | android |

| ### Extension properties |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtrasKey<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html>` | `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest.Companion.https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest.Companion#(androidx.navigation3.runtime.deeplink.DeepLinkRequest.Companion).ActionExtrasKey()` The `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtrasKey` for the Action 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/package-summary#(androidx.navigation3.runtime.deeplink.DeepLinkRequest.Companion).actionExtra(kotlin.String)`. | android |
| `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtrasKey<https://developer.android.com/reference/android/os/Bundle.html>` | `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest.Companion.https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest.Companion#(androidx.navigation3.runtime.deeplink.DeepLinkRequest.Companion).IntentExtrasKey()` The `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtrasKey` for the `https://developer.android.com/reference/android/content/Intent.html#extras` stored in `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest#extras()` when the Request is created with `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/package-summary#(androidx.navigation3.runtime.deeplink.DeepLinkRequest.Companion).invoke(android.content.Intent,androidx.navigation3.runtime.deeplink.RequestExtras)` factory method. | android |

## Public 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`\].

## Extension functions

### DeepLinkRequest.Companion.actionExtra

android 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.android.kt+function:actionExtra)

```
fun DeepLinkRequest.Companion.actionExtra(action: 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/package-summary#(androidx.navigation3.runtime.deeplink.DeepLinkRequest.Companion).actionExtra(kotlin.String)` with the key `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/package-summary#(androidx.navigation3.runtime.deeplink.DeepLinkRequest.Companion).ActionExtrasKey()`.

The value can be retrieved via extras\[`https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/package-summary#(androidx.navigation3.runtime.deeplink.DeepLinkRequest.Companion).ActionExtrasKey()`\].

### DeepLinkRequest.Companion.invoke

android 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.android.kt+function:invoke)

```
operator fun DeepLinkRequest.Companion.invoke(
    intent: Intent,
    extras: RequestExtras = emptyRequestExtras()
): DeepLinkRequest
```

Creates a `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest` with an `https://developer.android.com/reference/android/content/Intent.html`.

The returned `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest` will be populated with the following data:

1. `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest#uri()` will be `https://developer.android.com/reference/android/content/Intent.html#getData()` if not null

2. `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest#extras()` will contain any non-null information from `https://developer.android.com/reference/android/content/Intent.html#getType()`, `https://developer.android.com/reference/android/content/Intent.html#getAction()`, and `https://developer.android.com/reference/android/content/Intent.html#getExtras()`.

| Parameters |
|---|---|
| `intent: https://developer.android.com/reference/android/content/Intent.html` | The Intent with the metadata to construct a DeepLinkRequest |
| `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` holding key-value pairs of `RequestExtrasKey<T>` to `T` to provide extra information to the `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest`. If `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/package-summary#(androidx.navigation3.runtime.deeplink.DeepLinkRequest.Companion).invoke(android.content.Intent,androidx.navigation3.runtime.deeplink.RequestExtras)` contains an Action stored under `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/package-summary#(androidx.navigation3.runtime.deeplink.DeepLinkRequest.Companion).ActionExtrasKey()` or a MimeType stored under `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest.Companion.MimeTypeExtrasKey`, their values will override any Action or MimeType stored in the `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/package-summary#(androidx.navigation3.runtime.deeplink.DeepLinkRequest.Companion).invoke(android.content.Intent,androidx.navigation3.runtime.deeplink.RequestExtras)`. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest` | a `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest` instance |

## Extension properties

### DeepLinkRequest.Companion.ActionExtrasKey

android 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.android.kt+symbol:ActionExtrasKey)

```
val DeepLinkRequest.Companion.ActionExtrasKey: RequestExtrasKey<String>
```

The `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtrasKey` for the Action 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/package-summary#(androidx.navigation3.runtime.deeplink.DeepLinkRequest.Companion).actionExtra(kotlin.String)`.

### DeepLinkRequest.Companion.IntentExtrasKey

android 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.android.kt+symbol:IntentExtrasKey)

```
val DeepLinkRequest.Companion.IntentExtrasKey: RequestExtrasKey<Bundle>
```

The `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/RequestExtrasKey` for the `https://developer.android.com/reference/android/content/Intent.html#extras` stored in `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest#extras()` when the Request is created with `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/package-summary#(androidx.navigation3.runtime.deeplink.DeepLinkRequest.Companion).invoke(android.content.Intent,androidx.navigation3.runtime.deeplink.RequestExtras)` factory method.

The `https://developer.android.com/reference/android/os/Bundle.html` is stored as a `https://developer.android.com/reference/kotlin/androidx/savedstate/SavedState`.