Known direct subclasses
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

abstract class DeepLinkMatcher.Filter<K : Any>

A filter for a deep link, such as a mimeType.

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

Public constructors

Cmn

Public functions

DeepLinkMatcher.MatchResult<T>?

Matches a DeepLinkRequest to a DeepLinkMatcher.

Cmn

Protected functions

abstract DeepLinkMatcher.MatchResult<T>?

Matches a DeepLinkRequest to a DeepLinkMatcher.

Cmn

Public constructors

DeepLinkMatcher

<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

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

Matches a DeepLinkRequest to a DeepLinkMatcher.

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

Parameters
request: DeepLinkRequest

the DeepLinkRequest to match against

Protected functions

matchRequest

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

Matches a DeepLinkRequest to a DeepLinkMatcher.

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

Parameters
request: DeepLinkRequest

the DeepLinkRequest to match against