NavDestinationBuilder

public <D extends NavDestination> NavDestinationBuilder(
    @NonNull Navigator<@NonNull D> navigator,
    @IdRes int id
)

DSL for constructing a new NavDestination with a unique id.

This sets the destination's route to null.

public <D extends NavDestination> NavDestinationBuilder(
    @NonNull Navigator<@NonNull D> navigator,
    String route
)

DSL for constructing a new NavDestination with a unique route.

This will also update the id of the destination based on route.

public <D extends NavDestination> NavDestinationBuilder(
    @NonNull Navigator<@NonNull D> navigator,
    KClass<@NonNull ?> route,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap
)

DSL for constructing a new NavDestination with a serializable KClass.

This will also update the id of the destination based on KClass's serializer.

public final void action(
    int actionId,
    @NonNull Function1<@NonNull NavActionBuilder, Unit> actionBuilder
)

Adds a new NavAction to the destination

public final void argument(
    @NonNull String name,
    @NonNull Function1<@NonNull NavArgumentBuilder, Unit> argumentBuilder
)

Add a NavArgument to this destination.

public final void argument(@NonNull String name, @NonNull NavArgument argument)

Add a NavArgument to this destination.

public @NonNull D build()

Build the NavDestination by calling Navigator.createDestination.

public final void deepLink(
    @NonNull Function1<@NonNull NavDeepLinkDslBuilder, Unit> navDeepLink
)

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 SavedState 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.

public final void deepLink(@NonNull NavDeepLink navDeepLink)

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 SavedState 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.

public final void <T extends Object> deepLink(
    @NonNull String basePath,
    @NonNull Function1<@NonNull NavDeepLinkDslBuilder, Unit> navDeepLink
)

Add a deep link to this destination.

The arguments in T are expected to be identical (in name and type) to the arguments in the route from KClass that was used to construct this NavDestinationBuilder.

Extracts deeplink arguments from T and appends it to the basePath. See docs on the safe args version of NavDeepLink.Builder.setUriPattern for the final uriPattern's generation logic.

In addition to a direct Uri match, basePaths 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.

public final void <T extends Object> deepLink(
    @NonNull KClass<@NonNull T> route,
    @NonNull String basePath,
    @NonNull Function1<@NonNull NavDeepLinkDslBuilder, Unit> navDeepLink
)

Add a deep link to this destination.

The arguments in route are expected to be identical (in name and type) to the arguments in the NavDestinationBuilder.route that was used to construct this NavDestinationBuilder.

Extracts deeplink arguments from route and appends it to the basePath. See docs on the safe args version of NavDeepLink.Builder.setUriPattern for the final uriPattern's generation logic.

In addition to a direct Uri match, basePaths 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.

public final void <T extends Object> deepLinkSafeArgs(@NonNull String basePath)

Add a deep link to this destination.

The arguments in T are expected to be identical (in name and type) to the arguments in the route from KClass that was used to construct this NavDestinationBuilder.

Extracts deeplink arguments from T and appends it to the basePath. See docs on the safe args version of NavDeepLink.Builder.setUriPattern for the final uriPattern's generation logic.

In addition to a direct Uri match, basePaths 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.

public final void <T extends Object> deepLinkSafeArgs(@NonNull String uriPattern)

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 SavedState 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.

public final int getId()

The destination's unique ID.

public final CharSequence getLabel()

The descriptive label of the destination

public final String getRoute()

The destination's unique route.

public final void setLabel(CharSequence label)

The descriptive label of the destination

protected final @NonNull Navigator<@NonNull D> getNavigator()

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

protected @NonNull D instantiateDestination()

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

By default, this calls Navigator.createDestination on navigator, but can be overridden to call a custom constructor, etc.