DialogFragmentNavigatorDestinationBuilder


@NavDestinationDsl
class DialogFragmentNavigatorDestinationBuilder : NavDestinationBuilder


DSL for constructing a new DialogFragmentNavigator.Destination

Summary

Public constructors

DialogFragmentNavigatorDestinationBuilder(
    navigator: DialogFragmentNavigator,
    id: @IdRes Int,
    fragmentClass: KClass<DialogFragment>
)

This function is deprecated. Use routes to build your DialogFragmentNavigatorDestination instead

DialogFragmentNavigatorDestinationBuilder(
    navigator: DialogFragmentNavigator,
    route: String,
    fragmentClass: KClass<DialogFragment>
)

DSL for constructing a new DialogFragmentNavigator.Destination

DialogFragmentNavigatorDestinationBuilder(
    navigator: DialogFragmentNavigator,
    route: KClass<Any>,
    typeMap: Map<KTypeNavType<*>>,
    fragmentClass: KClass<DialogFragment>
)

DSL for constructing a new DialogFragmentNavigator.Destination

Public functions

open DialogFragmentNavigator.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 DialogFragmentNavigator.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<DialogFragmentNavigator.Destination>

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

String?

The destination's unique route.

Public constructors

DialogFragmentNavigatorDestinationBuilder

Added in 2.1.0
DialogFragmentNavigatorDestinationBuilder(
    navigator: DialogFragmentNavigator,
    id: @IdRes Int,
    fragmentClass: KClass<DialogFragment>
)

DSL for constructing a new DialogFragmentNavigator.Destination

Parameters
navigator: DialogFragmentNavigator

navigator used to create the destination

id: @IdRes Int

the destination's unique id

fragmentClass: KClass<DialogFragment>

the class name of the DialogFragment to show when you navigate to this destination

DialogFragmentNavigatorDestinationBuilder

DialogFragmentNavigatorDestinationBuilder(
    navigator: DialogFragmentNavigator,
    route: String,
    fragmentClass: KClass<DialogFragment>
)

DSL for constructing a new DialogFragmentNavigator.Destination

Parameters
navigator: DialogFragmentNavigator

navigator used to create the destination

route: String

the destination's unique route. This sets the route on the newly constructed NavDestination. This can be any valid non-empty String.

fragmentClass: KClass<DialogFragment>

the class name of the DialogFragment to show when you navigate to this destination

DialogFragmentNavigatorDestinationBuilder

DialogFragmentNavigatorDestinationBuilder(
    navigator: DialogFragmentNavigator,
    route: KClass<Any>,
    typeMap: Map<KTypeNavType<*>>,
    fragmentClass: KClass<DialogFragment>
)

DSL for constructing a new DialogFragmentNavigator.Destination

Parameters
navigator: DialogFragmentNavigator

navigator used to create the destination

route: KClass<Any>

the destination's unique route from a KClass. This sets the route on the newly constructed NavDestination.

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.

fragmentClass: KClass<DialogFragment>

the class name of the DialogFragment to show when you navigate to this destination

Public functions

build

Added in 2.1.0
open fun build(): DialogFragmentNavigator.Destination

Build the NavDestination by calling Navigator.createDestination.