ActivityNavigatorDestinationBuilder


@NavDestinationDsl
class ActivityNavigatorDestinationBuilder : NavDestinationBuilder


DSL for constructing a new ActivityNavigator.Destination

Summary

Public constructors

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

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

DSL for constructing a new ActivityNavigator.Destination

Public functions

open ActivityNavigator.Destination

Build the NavDestination by calling Navigator.createDestination.

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.

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

Add a NavArgument to this destination.

Unit
argument(name: String, argument: NavArgument)

Add a NavArgument to this destination.

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

Add a deep link to this destination.

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

Add a deep link to this destination.

Unit
deepLink(navDeepLink: NavDeepLink)

Add a deep link to this destination.

Unit
deepLink(uriPattern: String)

Add a deep link to this destination.

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

Add a deep link to this destination.

open ActivityNavigator.Destination

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

Inherited properties

From androidx.navigation.NavDestinationBuilder
Int

The destination's unique ID.

CharSequence?

The descriptive label of the destination

Navigator<ActivityNavigator.Destination>

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

String?

The destination's unique route.

Public constructors

ActivityNavigatorDestinationBuilder

Added in 1.0.0
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

Added in 1.0.0
open fun build(): ActivityNavigator.Destination

Build the NavDestination by calling Navigator.createDestination.

Public properties

action

Added in 1.0.0
var actionString?

activityClass

Added in 1.0.0
var activityClassKClass<Activity>?

data

Added in 1.0.0
var dataUri?

dataPattern

Added in 1.0.0
var dataPatternString?

targetPackage

Added in 2.1.0
var targetPackageString?