ActivityNavigatorDestinationBuilder



DSL for constructing a new ActivityNavigator.Destination

Summary

Public constructors

This function is deprecated. Use routes to create your ActivityNavigatorDestinationBuilder instead

android
ActivityNavigatorDestinationBuilder(
    navigator: ActivityNavigator,
    route: String
)
android
ActivityNavigatorDestinationBuilder(
    navigator: ActivityNavigator,
    route: KClass<Any>,
    typeMap: Map<KTypeNavType<*>>
)

DSL for constructing a new ActivityNavigator.Destination

android

Public functions

open ActivityNavigator.Destination

Build the NavDestination by calling Navigator.createDestination.

android

Public properties

String?
android
KClass<Activity>?
android
Uri?
android
String?
android
String?
android

Inherited functions

From androidx.navigation.NavDestinationBuilder
Unit
action(actionId: Int, actionBuilder: NavActionBuilder.() -> Unit)

This function is deprecated. Building NavDestinations using IDs with the Kotlin DSL has been deprecated in favor of using routes.

android
Unit
argument(name: String, argumentBuilder: NavArgumentBuilder.() -> Unit)

Add a NavArgument to this destination.

android
Unit
argument(name: String, argument: NavArgument)

Add a NavArgument to this destination.

android
inline Unit
<T : Any> deepLink(basePath: String)

Add a deep link to this destination.

android
Unit
deepLink(navDeepLink: NavDeepLinkDslBuilder.() -> Unit)

Add a deep link to this destination.

android
Unit
deepLink(navDeepLink: NavDeepLink)

Add a deep link to this destination.

android
Unit
deepLink(uriPattern: String)

Add a deep link to this destination.

android
inline Unit
<T : Any> deepLink(basePath: String, noinline navDeepLink: NavDeepLinkDslBuilder.() -> Unit)

Add a deep link to this destination.

android
Unit
<T : Any> deepLink(route: KClass<T>, basePath: String, navDeepLink: NavDeepLinkDslBuilder.() -> Unit)

Add a deep link to this destination.

android
open ActivityNavigator.Destination

Instantiate a new instance of D that will be passed to build.

android

Inherited properties

From androidx.navigation.NavDestinationBuilder
Int

The destination's unique ID.

android
CharSequence?

The descriptive label of the destination

android
Navigator<ActivityNavigator.Destination>

The navigator the destination that will be used in instantiateDestination to create the destination.

android
String?

The destination's unique route.

android

Public constructors

ActivityNavigatorDestinationBuilder

ActivityNavigatorDestinationBuilder(
    navigator: ActivityNavigator,
    id: @IdRes Int
)

ActivityNavigatorDestinationBuilder

ActivityNavigatorDestinationBuilder(
    navigator: ActivityNavigator,
    route: String
)

ActivityNavigatorDestinationBuilder

ActivityNavigatorDestinationBuilder(
    navigator: ActivityNavigator,
    route: KClass<Any>,
    typeMap: Map<KTypeNavType<*>>
)

DSL for constructing a new ActivityNavigator.Destination

Parameters
navigator: ActivityNavigator

navigator used to create the destination

route: KClass<Any>

the route from a KClass of the destination

typeMap: Map<KTypeNavType<*>>

map of destination arguments' kotlin type KType to its respective custom NavType. May be empty if route does not use custom NavTypes.

Public functions

build

open fun build(): ActivityNavigator.Destination

Build the NavDestination by calling Navigator.createDestination.

Public properties

action

var actionString?

activityClass

var activityClassKClass<Activity>?

data

var dataUri?

dataPattern

var dataPatternString?

targetPackage

var targetPackageString?