DynamicNavGraphBuilderKt

Added in 2.3.0

public final class DynamicNavGraphBuilderKt

Summary

Public methods
static final void
navigation(
    @NonNull DynamicNavGraphBuilder receiver,
    @IdRes int id,
    @IdRes int startDestination,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)

This method is deprecated. Use routes to create your DynamicNavGraph instead
static final void
@ExperimentalSafeArgsApi
<T extends Object> navigation(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull Object startDestination,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)

Construct a nested DynamicGraphNavigator.DynamicNavGraph
static final void
@ExperimentalSafeArgsApi
<T extends Object> navigation(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull KClass<@NonNull ?> startDestination,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)

Construct a nested DynamicGraphNavigator.DynamicNavGraph
static final void
navigation(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String startDestination,
    @NonNull String route,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)

Construct a nested DynamicGraphNavigator.DynamicNavGraph
static final @NonNull NavGraph
navigation(
    @NonNull NavigatorProvider receiver,
    @IdRes int id,
    @IdRes int startDestination,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)

This method is deprecated. Use routes to create your DynamicNavGraph instead
static final @NonNull NavGraph
navigation(
    @NonNull NavigatorProvider receiver,
    @NonNull String startDestination,
    String route,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)

Construct a new DynamicGraphNavigator.DynamicNavGraph
static final @NonNull NavGraph
@ExperimentalSafeArgsApi
navigation(
    @NonNull NavigatorProvider receiver,
    @NonNull Object startDestination,
    KClass<@NonNull ?> route,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)

Construct a new DynamicGraphNavigator.DynamicNavGraph
static final @NonNull NavGraph
@ExperimentalSafeArgsApi
navigation(
    @NonNull NavigatorProvider receiver,
    @NonNull KClass<@NonNull ?> startDestination,
    KClass<@NonNull ?> route,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)

Construct a new DynamicGraphNavigator.DynamicNavGraph

Public methods

navigation

public static final void navigation(
    @NonNull DynamicNavGraphBuilder receiver,
    @IdRes int id,
    @IdRes int startDestination,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)

Construct a nested DynamicGraphNavigator.DynamicNavGraph

Parameters
@IdRes int id

NavGraph id.
@IdRes int startDestination

Id start destination in the graph
@ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder

Another builder for chaining.

navigation

@ExperimentalSafeArgsApi
public static final void <T extends Object> navigation(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull Object startDestination,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)

Construct a nested DynamicGraphNavigator.DynamicNavGraph

Parameters
<T extends Object>

the graph's unique route as a KClass
@NonNull Object startDestination

the starting destination's route from an Object for this NavGraph. The respective NavDestination must be added with route from a KClass in order to match.
@NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap

A mapping of KType to custom NavType<*> in the T. May be empty if T does not use custom NavTypes.
@ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder

Another builder for chaining.

navigation

@ExperimentalSafeArgsApi
public static final void <T extends Object> navigation(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull KClass<@NonNull ?> startDestination,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)

Construct a nested DynamicGraphNavigator.DynamicNavGraph

Parameters
<T extends Object>

the graph's unique route as a KClass
@NonNull KClass<@NonNull ?> startDestination

the starting destination's route from a KClass for this NavGraph. The respective NavDestination must be added with route from a KClass in order to match.
@NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap

A mapping of KType to custom NavType<*> in the T. May be empty if T does not use custom NavTypes.
@ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder

Another builder for chaining.

navigation

public static final void navigation(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String startDestination,
    @NonNull String route,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)

Construct a nested DynamicGraphNavigator.DynamicNavGraph

Parameters
@NonNull String startDestination

route start destination in the graph
@NonNull String route

NavGraph route.
@ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder

Another builder for chaining.

navigation

public static final @NonNull NavGraph navigation(
    @NonNull NavigatorProvider receiver,
    @IdRes int id,
    @IdRes int startDestination,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)

Construct a new DynamicGraphNavigator.DynamicNavGraph

Parameters
@IdRes int id

NavGraph id.
@IdRes int startDestination

Id start destination in the graph
@ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder

Another builder for chaining.

navigation

public static final @NonNull NavGraph navigation(
    @NonNull NavigatorProvider receiver,
    @NonNull String startDestination,
    String route,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)

Construct a new DynamicGraphNavigator.DynamicNavGraph

Parameters
@NonNull String startDestination

route start destination in the graph
String route

NavGraph route.
@ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder

Another builder for chaining.

navigation

@ExperimentalSafeArgsApi
public static final @NonNull NavGraph navigation(
    @NonNull NavigatorProvider receiver,
    @NonNull Object startDestination,
    KClass<@NonNull ?> route,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)

Construct a new DynamicGraphNavigator.DynamicNavGraph

Parameters
@NonNull Object startDestination

the starting destination's route from an Object for this NavGraph. The respective NavDestination must be added with route from a KClass in order to match.
KClass<@NonNull ?> route

the graph's unique route as a KClass
@NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap

A mapping of KType to custom NavType<*> in the route. May be empty if route does not use custom NavTypes.
@ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder

Another builder for chaining.

navigation

@ExperimentalSafeArgsApi
public static final @NonNull NavGraph navigation(
    @NonNull NavigatorProvider receiver,
    @NonNull KClass<@NonNull ?> startDestination,
    KClass<@NonNull ?> route,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)

Construct a new DynamicGraphNavigator.DynamicNavGraph

Parameters
@NonNull KClass<@NonNull ?> startDestination

the starting destination's route from a KClass for this NavGraph. The respective NavDestination must be added with route from a KClass in order to match.
KClass<@NonNull ?> route

the graph's unique route as a KClass
@NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap

A mapping of KType to custom NavType<*> in the route. May be empty if route does not use custom NavTypes.
@ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder

Another builder for chaining.