DynamicIncludeNavGraphBuilderKt

Added in 2.3.0

public final class DynamicIncludeNavGraphBuilderKt


Summary

Public methods

static final void
includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @IdRes int id,
    @NonNull String moduleName,
    @NonNull String graphResourceName
)

This method is deprecated. Use routes to include your DynamicNavGraph instead

static final void
<T extends Object> includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String moduleName,
    @NonNull String graphResourceName,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap
)

Construct a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph.

static final void
includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String route,
    @NonNull String moduleName,
    @NonNull String graphResourceName
)

Construct a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph.

static final void
includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @IdRes int id,
    @NonNull String moduleName,
    @NonNull String graphResourceName,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicIncludeNavGraphBuilderUnit> builder
)

This method is deprecated. Use routes to include your DynamicNavGraph instead

static final void
<T extends Object> includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String moduleName,
    @NonNull String graphResourceName,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicIncludeNavGraphBuilderUnit> builder
)

Construct a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph.

static final void
includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String route,
    @NonNull String moduleName,
    @NonNull String graphResourceName,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicIncludeNavGraphBuilderUnit> builder
)

Construct a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph.

Public methods

includeDynamic

public static final void includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @IdRes int id,
    @NonNull String moduleName,
    @NonNull String graphResourceName
)

Construct a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph.

Parameters
@IdRes int id

NavGraph id.

@NonNull String moduleName

Dynamic feature module name as defined in the module's AndroidManifest. This must not be an empty string.

@NonNull String graphResourceName

Graph's resource name without the navigation qualifier. This must not be an empty string.

public static final void <T extends Object> includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String moduleName,
    @NonNull String graphResourceName,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap
)

Construct a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph.

Parameters
<T extends Object>

the graph's unique route as a KClass

@NonNull String moduleName

Dynamic feature module name as defined in the module's AndroidManifest. This must not be an empty string.

@NonNull String graphResourceName

Graph's resource name without the navigation qualifier. This must not be an empty string.

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

public static final void includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String route,
    @NonNull String moduleName,
    @NonNull String graphResourceName
)

Construct a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph.

Parameters
@NonNull String route

NavGraph route.

@NonNull String moduleName

Dynamic feature module name as defined in the module's AndroidManifest. This must not be an empty string.

@NonNull String graphResourceName

Graph's resource name without the navigation qualifier. This must not be an empty string.

includeDynamic

public static final void includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @IdRes int id,
    @NonNull String moduleName,
    @NonNull String graphResourceName,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicIncludeNavGraphBuilderUnit> builder
)

Construct a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph.

Parameters
@IdRes int id

NavGraph id.

@NonNull String moduleName

Dynamic feature module name as defined in the module's AndroidManifest. This must not be an empty string.

@NonNull String graphResourceName

Graph's resource name without the navigation qualifier. This must not be an empty string.

@ExtensionFunctionType @NonNull Function1<@NonNull DynamicIncludeNavGraphBuilderUnit> builder

Another builder for chaining.

public static final void <T extends Object> includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String moduleName,
    @NonNull String graphResourceName,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicIncludeNavGraphBuilderUnit> builder
)

Construct a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph.

Parameters
<T extends Object>

the graph's unique route as a KClass

@NonNull String moduleName

Dynamic feature module name as defined in the module's AndroidManifest. This must not be an empty string.

@NonNull String graphResourceName

Graph's resource name without the navigation qualifier. This must not be an empty string.

@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 DynamicIncludeNavGraphBuilderUnit> builder

Another builder for chaining.

public static final void includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String route,
    @NonNull String moduleName,
    @NonNull String graphResourceName,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicIncludeNavGraphBuilderUnit> builder
)

Construct a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph.

Parameters
@NonNull String route

NavGraph route.

@NonNull String moduleName

Dynamic feature module name as defined in the module's AndroidManifest. This must not be an empty string.

@NonNull String graphResourceName

Graph's resource name without the navigation qualifier. This must not be an empty string.

@ExtensionFunctionType @NonNull Function1<@NonNull DynamicIncludeNavGraphBuilderUnit> builder

Another builder for chaining.