kotlin.Any
   ↳ androidx.navigation3.runtime.deeplink.DeepLinkMatcher.MatchResult
     ↳ androidx.navigation3.runtime.deeplink.UriMatchResult

The class that is returned when a UriDeepLinkMatcher matches with a DeepLinkRequest

Match Order When comparing two UriMatchResults, the following criteria are used to determine the winner:

  1. MatchResult type: This result wins if the other MatchResult is not a UriMatchResult

  2. Exact Path: A match with an exact path wins over a match with path wildcard or path arguments.

  3. Path Argument Count: A match with more extracted path arguments wins.

  4. Presence of Arguments: A match that contains arguments wins over one that has none.

  5. Total Argument Count: A match with more total arguments (path + query + fragment) wins.

Summary

Public constructors
<T : Any> UriMatchResult(key: T, arguments: Map<String, List<String>>)
Cmn

Public functions
open operator Int

Compares this matcher with the other for sorting order.
Cmn

Public properties
Map<String, List<String>>

the map of arguments extracted from the DeepLinkRequest
Cmn

Protected properties
Boolean

Indicates whether the UriDeepLinkMatcher and DeepLinkRequest match that produced this result was matched on an exact uri path, meaning a path that
Cmn

Inherited properties
From androidx.navigation3.runtime.deeplink.DeepLinkMatcher.MatchResult
T

the navigation key representing the deep link target
Cmn

Public constructors

UriMatchResult

Cmn 
<T : Any> UriMatchResult(
    key: T,
    arguments: Map<String, List<String>> = emptyMap()
)
Parameters
key: T

the navigation key representing the deep link target
arguments: Map<String, List<String>> = emptyMap()

the map of arguments extracted from the DeepLinkRequest

Public functions

compareTo

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

Compares this matcher with the other for sorting order.

Returns:

  • 1 if this result is bigger

  • 0 if they are equal

  • -1 if this result is smaller

Parameters
other: DeepLinkMatcher.MatchResult<T>

the other MatchResult to compare with
See also
UriMatchResult

for matching priority

Public properties

arguments

Cmn
Added in 1.2.0-alpha05
val arguments: Map<String, List<String>>

the map of arguments extracted from the DeepLinkRequest

Protected properties

isExactPath

Cmn
Added in 1.2.0-alpha05
protected var isExactPath: Boolean

Indicates whether the UriDeepLinkMatcher and DeepLinkRequest match that produced this result was matched on an exact uri path, meaning a path that

  1. does not contain any arguments

  2. does not contain any wildcards

True if it is an exact path, false otherwise.