reaktiv-navigation/io.github.syrou.reaktiv.navigation.link

Package-level declarations

Types

@Serializable

data class AppLinkFiles(val candidates: List<AppLinkPath>, val paths: List<AppLinkPath>, val appleAppSiteAssociation: String? = null, val assetLinks: String? = null, val androidManifestIntentFilter: String?, val androidDeepLinkIntentFilter: String? = null)

AppLinkPath

@Serializable

data class AppLinkPath(val path: String, val pattern: String, val target: String, val screen: String? = null, val params: List<String> = emptyList())

AppLinksConfig

@Serializable

data class AppLinksConfig(val host: String, val basePath: String? = null, val appleAppIds: List<String> = emptyList(), val androidPackage: String? = null, val androidCertFingerprints: List<String> = emptyList(), val androidDynamicPaths: Boolean = true, val paths: Set<String>? = null, val deepLinkScheme: String? = null, val deepLinkHost: String? = null)

LinkAccess

@Serializable

enum LinkAccess : Enum<LinkAccess>

LinkAlias

@Serializable

data class LinkAlias(val pattern: String, val target: String, val params: List<String> = emptyList())

LinkGraph

@Serializable

data class LinkGraph(val id: String, val path: String, val parent: String? = null, val start: LinkStart = LinkStart.None, val guards: List<Int> = emptyList(), val access: LinkAccess = LinkAccess.Linkable)

LinkKind

@Serializable

enum LinkKind : Enum<LinkKind>

LinkOutcome

@Serializable

sealed interface LinkOutcome

LinkRoute

@Serializable

data class LinkRoute(val path: String, val route: String, val graph: String, val screen: String? = null, val kind: LinkKind = LinkKind.Screen, val params: List<String> = emptyList(), val guards: List<Int> = emptyList(), val access: LinkAccess = LinkAccess.Linkable)

LinkStart

@Serializable

sealed interface LinkStart

NavigationLinkMap

@Serializable

data class NavigationLinkMap(val graphs: List<LinkGraph>, val routes: List<LinkRoute>, val aliases: List<LinkAlias> = emptyList(), val webPrefix: String? = null)

Functions

appLinkFiles

fun NavigationLinkMap.appLinkFiles(config: AppLinksConfig): AppLinkFiles

appLinkPaths

fun NavigationLinkMap.appLinkPaths(basePath: String = defaultAppLinkBase()): List<AppLinkPath>