# DeepLinkMatcher.MatchResult

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/DeepLinkMatcher.kt+class:androidx.navigation3.runtime.deeplink.DeepLinkMatcher.MatchResult) Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/navigation3#1.2.0) Common/AllAndroid/JVM
- Cmn

  ```
  open class DeepLinkMatcher.MatchResult<T : Any> : Comparable<DeepLinkMatcher.MatchResult<T>>
  ```
Known direct subclasses [UriMatchResult](https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/UriMatchResult), [WrappedMatchResult](https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/WrappedMatchResult)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/UriMatchResult` | The class that is returned when a `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/UriDeepLinkMatcher` matches with a `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest` |
| `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/WrappedMatchResult` | A `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkMatcher.MatchResult` implementation that wraps another MatchResult. |

Known indirect subclasses [BackStackMatchResult](https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/BackStackMatchResult)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/BackStackMatchResult` | Result returned when a `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/BackStackMatcher` successfully matches a `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest`. |

*** ** * ** ***

The class that is returned when a `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkMatcher` matches with a `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkRequest`

## Summary

| ### Public constructors |
|---|---|
| `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html> https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkMatcher.MatchResult#MatchResult(kotlin.Any)(key: T)` | Cmn |

| ### Public functions |
|---|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkMatcher.MatchResult#compareTo(androidx.navigation3.runtime.deeplink.DeepLinkMatcher.MatchResult)(other: https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkMatcher.MatchResult<T>)` Compares this `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkMatcher.MatchResult` to `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkMatcher.MatchResult#compareTo(androidx.navigation3.runtime.deeplink.DeepLinkMatcher.MatchResult)` and returns an Int result. | Cmn |

| ### Public properties |
|---|---|---|
| `T` | `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkMatcher.MatchResult#key()` the navigation key representing the deep link target | Cmn |

## Public constructors

### MatchResult

Cmn

```
<T : Any> MatchResult(key: T)
```

| Parameters |
|---|---|
| `key: T` | the navigation key representing the deep link target |

## Public functions

### compareTo

Cmn

```
open operator fun compareTo(other: DeepLinkMatcher.MatchResult<T>): Int
```

Compares this `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkMatcher.MatchResult` to `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/deeplink/DeepLinkMatcher.MatchResult#compareTo(androidx.navigation3.runtime.deeplink.DeepLinkMatcher.MatchResult)` and returns an Int result.

Returns zero if this result is equal to the other result, a negative number if it's less than the other, or a positive number if it's greater than the other.

## Public properties

### key

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

```
val key: T
```

the navigation key representing the deep link target