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<StringList<String>>)
Cmn

Public functions

open operator Int

Compares this matcher with the other for sorting order.

Cmn

Public properties

Map<StringList<String>>

the map of arguments extracted from the DeepLinkRequest

Cmn

Protected properties

Boolean
Cmn

Inherited properties

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

the navigation key representing the deep link target

Cmn

Public constructors

UriMatchResult

<T : Any> UriMatchResult(key: T, arguments: Map<StringList<String>>)
Parameters
key: T

the navigation key representing the deep link target

arguments: Map<StringList<String>>

the map of arguments extracted from the DeepLinkRequest

Public functions

compareTo

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

val argumentsMap<StringList<String>>

the map of arguments extracted from the DeepLinkRequest

Protected properties

isExactPath

protected var isExactPathBoolean