kotlin.Any
   ↳ androidx.navigation3.runtime.deeplink.DeepLinkMatcher
     ↳ androidx.navigation3.runtime.deeplink.BackStackMatcher

A DeepLinkMatcher that builds a back stack when match succeeds.

Must be created by calling withBackStack on a DeepLinkMatcher. The receiving DeepLinkMatcher will become the nested matcher.

Wraps the provided matcher and matches it with a DeepLinkRequest. When a match succeeds, returns a BackStackMatchResult containing the original DeepLinkMatcher.MatchResult and the back stack built with the back stack builder.

T the type of the navigation key associated with this matcher, must be of type K

K the element type of the back stack List

import androidx.navigation3.runtime.NavKey
import androidx.navigation3.runtime.deeplink.BackStackMatchResult
import androidx.navigation3.runtime.deeplink.DeepLinkMatcher
import androidx.navigation3.runtime.deeplink.DeepLinkRequest
import androidx.navigation3.runtime.deeplink.DeepLinkUri
import androidx.navigation3.runtime.deeplink.UriDeepLinkMatcher
import androidx.navigation3.runtime.deeplink.withBackStack

val matcher =
    UriDeepLinkMatcher(
            uriPattern = DeepLinkUri("https://www.nav3deeplinksample.com/userlist"),
            serializer = serializer<UserListKey>(),
        )
        .withBackStack { matchResult -> listOf(HomeKey, matchResult.key) }

// handling a request
val request = DeepLinkRequest(uri = DeepLinkUri("https://www.nav3deeplinksample.com/userlist/"))
// returns a BackStackMatchResult containing the matched key and the constructed back stack
val matchResult: BackStackMatchResult<UserListKey, NavKey>? = matcher.match(request)
// listOf(HomeKey, UserListKey)
val backStack: List<NavKey>? = matchResult?.backStack
val key: UserListKey? = matchResult?.key
 
import androidx.navigation3.runtime.NavKey
import androidx.navigation3.runtime.deeplink.BackStackMatchResult
import androidx.navigation3.runtime.deeplink.DeepLinkMatcher
import androidx.navigation3.runtime.deeplink.DeepLinkRequest
import androidx.navigation3.runtime.deeplink.DeepLinkUri
import androidx.navigation3.runtime.deeplink.UriDeepLinkMatcher
import androidx.navigation3.runtime.deeplink.withBackStack

val matcher =
    UriDeepLinkMatcher(
            uriPattern = DeepLinkUri("https://www.nav3deeplinksample.com/articles/{id}"),
            serializer = serializer<Article>(),
        )
        .withBackStack { matchResult ->
            val article = matchResult.key
            val parent =
                if (article.id >= 10) ArticleSection("Shipping") else ArticleSection("Returns")
            listOf(parent, article)
        }

// handling a request
val request =
    DeepLinkRequest(uri = DeepLinkUri("https://www.nav3deeplinksample.com/articles/12"))

// returns a BackStackMatchResult containing the Article key and parent key based on article id
val matchResult: BackStackMatchResult<Article, NavKey>? = matcher.match(request)
// listOf(parent, article)
val backStack: List<NavKey>? = matchResult?.backStack
val key: Article? = matchResult?.key

Summary

Protected functions
open BackStackMatchResult<T, K>?

Matches a DeepLinkRequest to a DeepLinkMatcher.
Cmn

Inherited functions
From androidx.navigation3.runtime.deeplink.DeepLinkMatcher
BackStackMatchResult<T, K>?

Matches a DeepLinkRequest to a DeepLinkMatcher.
Cmn

Protected functions

matchRequest

Cmn 
protected open fun matchRequest(request: DeepLinkRequest): BackStackMatchResult<T, K>?

Matches a DeepLinkRequest to a DeepLinkMatcher.

The core function that is called within the matching process after all filters are applied. Subclasses should override this to implement matching logic beyond matching filters.

Returns MatchResult if it is a match, and returns null otherwise.

Parameters
request: DeepLinkRequest

the DeepLinkRequest to match against