oskit-kmp/com.outsidesource.oskitkmp.router/RouterDeepLinkTrie

RouterDeepLinkTrie

class RouterDeepLinkTrie(builder: IRouterDeepLinkTrieBuilder.() -> Unit)

A Trie for resolving deep-linked URLs to IRoutes

Example Declaration:

sealed class Route: IRoute {
    data object Home: Route()
    data object StaticDeepLinkTest: Route()
    data class DynamicDeepLinkTest(val dynamicValue: String): Route()

    companion object {
        val deepLinks = Router.buildDeepLinks {
            "/static-deep-link" routesTo { _, _ -> StaticDeepLinkTest }
            "/dynamic-deep-link/:value" routesTo { args, _ -> DynamicDeepLinkTest(args[0]) }
        }
    }
}

Example Usage:

val deepLink = Route.deepLinks.matchRoute(deepLinkUrlFromPlatform)
val router = Router(initialRoute = deepLink ?: Route.Home)

Constructors

RouterDeepLinkTrie

constructor(builder: IRouterDeepLinkTrieBuilder.() -> Unit)

Functions

addDeepLink

fun addDeepLink(pattern: String, mapper: RouterDeepLinkMapper)

Adds a deeplink to the Trie

matchRoute

fun matchRoute(url: String?): IRoute?

Returns an IRoute if the passed in url matches a deep link stored in the trie