DeepLinkMatcher

Artifact: androidx.navigation3:navigation3-runtime

View Source

Added in 1.2.0-alpha05

Common/AllAndroid/JVM

• Cmn

  abstract class DeepLinkMatcher<T : Any>

Known direct subclasses

StaticKeyDeepLinkMatcher, UriDeepLinkMatcher

StaticKeyDeepLinkMatcher	A DeepLinkMatcher that matches based on a list of Filter and if all filters match, returns the input key in the MatchResult.
UriDeepLinkMatcher	Represents a deep link that can be deep linked into when matched with a DeepLinkRequest

---

Encompasses the logic to match a navigation key of type T against a DeepLinkRequest.

A navigation key can be associated with more than one DeepLinkMatcher if it supports different forms of deep links.

T The type of the navigation key associated with this deep link.

Summary

Nested types
object DeepLinkMatcher.Companion
fun interface DeepLinkMatcher.Filter A filter for a deep link, such as a mimeType.
open class DeepLinkMatcher.MatchResult<T : Any?> : Comparable The class that is returned when a DeepLinkMatcher matches with a DeepLinkRequest

Public companion functions
DeepLinkMatcher.Filter	mimeTypeFilter(mimeType: String) Creates a DeepLinkMatcher.Filter that filters a DeepLinkRequest with the mimeType defined on the DeepLinkMatcher.	Cmn

Public constructors
<T : Any> DeepLinkMatcher(filters: List<DeepLinkMatcher.Filter>)	Cmn

Public functions
DeepLinkMatcher.MatchResult<T>?	match(request: DeepLinkRequest) Matches a DeepLinkRequest to a DeepLinkMatcher.	Cmn

Protected functions
abstract DeepLinkMatcher.MatchResult<T>?	matchRequest(request: DeepLinkRequest) Matches a DeepLinkRequest to a DeepLinkMatcher.	Cmn

Public companion functions

mimeTypeFilter

Cmn

Added in 1.2.0-alpha05

fun mimeTypeFilter(mimeType: String): DeepLinkMatcher.Filter

Creates a DeepLinkMatcher.Filter that filters a DeepLinkRequest with the mimeType defined on the DeepLinkMatcher. Matching is not case-sensitive.

Parameters
mimeType: String	the action the filter by

Returns
DeepLinkMatcher.Filter	true if the mimeType exactly matches the DeepLinkMatcher's action or if the matcher did not define any actions, false otherwise.

Public constructors

DeepLinkMatcher

Cmn

<T : Any> DeepLinkMatcher(filters: List<DeepLinkMatcher.Filter> = emptyList())

Parameters
filters: List<DeepLinkMatcher.Filter> = emptyList()	an optional list of Filter to apply to the DeepLinkRequest during matching

Public functions

match

Cmn

Added in 1.2.0-alpha05

fun match(request: DeepLinkRequest): DeepLinkMatcher.MatchResult<T>?

Matches a DeepLinkRequest to a DeepLinkMatcher.

The entry point to match a DeepLinkMatcher to a DeepLinkRequest. It iterates through any filters and if all filters returns true, proceeds to call matchRequest to get the final match result.

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

Parameters
request: DeepLinkRequest	the DeepLinkRequest to match against

Protected functions

matchRequest

Cmn

Added in 1.2.0-alpha05

protected abstract fun matchRequest(request: DeepLinkRequest): DeepLinkMatcher.MatchResult<T>?

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