navigation/com.freeletics.khonshu.navigation.deeplinks/DeepLinkHandler

DeepLinkHandler

DeepLinkHandler can be used to implement Uri based deep links.

Types

data class Pattern(value: String)

A deep link pattern to be used in DeepLinkHandler.patterns. The pattern is a relative path and should not start with a leading /. Query parameters are not allowed to be included.

Prefix

data class Prefix(value: String)

A url prefix consisting of scheme and host. This is not allowed to have a trailing / or other url elements.

Properties

patterns

abstract val patterns: Set<DeepLinkHandler.Pattern>

Url patterns handled by this deep link. The pattern is not allowed to start with a /. It also can not contain any query parameters which are ignored for the purpose of matching (any query parameter in the actual url will still be passed to deepLink). Placeholders can be added to the pattern with curly braces.

prefixes

open val prefixes: Set<DeepLinkHandler.Prefix>

Prefixes that are used together with the patterns and should contain the scheme and host for the urls to be handled. This is optional and if left empty the defaults of the app are used.

Functions

deepLink

abstract fun deepLink(pathParameters: Map<String, String>, queryParameters: Map<String, String>): DeepLink

Build the DeepLink to the screen.