NavDestinationBuilder

Kotlin |Java

open class NavDestinationBuilder<out D : NavDestination>

kotlin.Any
↳	androidx.navigation.NavDestinationBuilder

Known Direct Subclasses ActivityNavigatorDestinationBuilder, DialogFragmentNavigatorDestinationBuilder, DynamicActivityNavigatorDestinationBuilder, DynamicFragmentNavigatorDestinationBuilder, DynamicIncludeNavGraphBuilder, FragmentNavigatorDestinationBuilder, NavGraphBuilder ActivityNavigatorDestinationBuilder DSL for constructing a new ActivityNavigator.Destination DialogFragmentNavigatorDestinationBuilder DSL for constructing a new DialogFragmentNavigator.Destination DynamicActivityNavigatorDestinationBuilder DSL for constructing a new DynamicActivityNavigator.Destination DynamicFragmentNavigatorDestinationBuilder DSL for constructing a new DynamicFragmentNavigator.Destination DynamicIncludeNavGraphBuilder DSL for constructing a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph FragmentNavigatorDestinationBuilder DSL for constructing a new FragmentNavigator.Destination NavGraphBuilder DSL for constructing a new NavGraph

Known Indirect Subclasses DynamicNavGraphBuilder DynamicNavGraphBuilder DSL for constructing a new DynamicGraphNavigator.DynamicNavGraph

DSL for constructing a new NavDestination

Summary

Public constructors
<init>(navigator: Navigator<out D>, @IdRes id: Int) DSL for constructing a new NavDestination

Public methods
Unit	action(actionId: Int, actionBuilder: NavActionBuilder.() -> Unit) Adds a new NavAction to the destination
Unit	argument(name: String, argumentBuilder: NavArgumentBuilder.() -> Unit) Add a NavArgument to this destination.
open D	build() Build the NavDestination by calling Navigator.createDestination.
Unit	deepLink(uriPattern: String) Add a deep link to this destination.
Unit	deepLink(navDeepLink: NavDeepLinkDslBuilder.() -> Unit) Add a deep link to this destination.

Properties
Int	id
CharSequence?	label The descriptive label of the destination
Navigator<out D>	navigator

Public constructors

<init>

NavDestinationBuilder(
    navigator: Navigator<out D>, 
    @IdRes id: Int)

DSL for constructing a new NavDestination

Public methods

action

fun action(
    actionId: Int, 
    actionBuilder: NavActionBuilder.() -> Unit
): Unit

Adds a new NavAction to the destination

argument

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

Add a NavArgument to this destination.

build

open fun build(): D

Build the NavDestination by calling Navigator.createDestination.

deepLink

fun deepLink(uriPattern: String): Unit

Add a deep link to this destination.

In addition to a direct Uri match, the following features are supported:

• Uris without a scheme are assumed as http and https. For example, www.example.com will match http://www.example.com and https://www.example.com.
• Placeholders in the form of {placeholder_name} matches 1 or more characters. The String value of the placeholder will be available in the arguments Bundle with a key of the same name. For example, http://www.example.com/users/{id} will match http://www.example.com/users/4.
• The .* wildcard can be used to match 0 or more characters.

Parameters
uriPattern: String	The uri pattern to add as a deep link

See Also

• deepLink

deepLink

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

Add a deep link to this destination.

In addition to a direct Uri match, the following features are supported:

• Uris without a scheme are assumed as http and https. For example, www.example.com will match http://www.example.com and https://www.example.com.
• Placeholders in the form of {placeholder_name} matches 1 or more characters. The String value of the placeholder will be available in the arguments Bundle with a key of the same name. For example, http://www.example.com/users/{id} will match http://www.example.com/users/4.
• The .* wildcard can be used to match 0 or more characters.

Parameters
navDeepLink: NavDeepLinkDslBuilder.() -> Unit	the NavDeepLink to be added to this destination

Properties

id

val id: Int

label

var label: CharSequence?

The descriptive label of the destination

navigator

protected val navigator: Navigator<out D>