DynamicGraphNavigator.DynamicNavGraph

public final class DynamicGraphNavigator.DynamicNavGraph extends NavDestination, NavGraph

Object
   ↳ NavDestination
     ↳ NavGraph
       ↳ DynamicGraphNavigator.DynamicNavGraph

The NavGraph for dynamic features.

Summary

Public fields

final @NonNull Map<@NonNull String, @NonNull NavArgument>

The arguments supported by this destination.

final int

The destination's unique ID.

final @Nullable CharSequence

The descriptive label of this destination.

final @Nullable String

The dynamic feature's module name.

final @NonNull String

The name associated with this destination's Navigator.

final @NonNull SparseArrayCompat<@NonNull NavDestination>
final @Nullable NavGraph

Gets the NavGraph that contains this destination.

final int

Resource id of progress destination.

final @Nullable String

The destination's unique route.

final @NonNull String
final int

The starting destination id for this NavGraph.

final @Nullable String

The route for the starting destination for this NavGraph.

Public constructors

DynamicNavGraph(
    @NonNull DynamicGraphNavigator navGraphNavigator,
    @NonNull NavigatorProvider navigatorProvider
)

Public methods

boolean
int
void

Called when inflating a destination from a resource.

Inherited methods

From class Iterable
From class NavDestination
final void
addArgument(@NonNull String argumentName, @NonNull NavArgument argument)

Sets an argument type for an argument name

final void

Add a deep link to this destination.

final void
addDeepLink(@NonNull String uriPattern)

Add a deep link to this destination.

final @Nullable NavAction
getAction(@IdRes int id)

Returns the NavAction for the given action ID.

boolean
hasDeepLink(@NonNull Uri deepLink)

Checks the given deep link Uri, and determines whether it matches a Uri pattern added to the destination by a call to addDeepLink .

boolean

Checks the given NavDeepLinkRequest, and determines whether it matches a NavDeepLink added to the destination by a call to addDeepLink.

final void
putAction(@IdRes int actionId, @NonNull NavAction action)

Sets the NavAction destination for an action ID.

final void
putAction(@IdRes int actionId, @IdRes int destId)

Creates a NavAction for the given destId and associates it with the actionId.

final void
removeAction(@IdRes int actionId)

Unsets the NavAction for an action ID.

final void
removeArgument(@NonNull String argumentName)

Unsets the argument type for an argument name.

From class NavGraph
final void

Add all destinations from another collection to this one.

final void

Adds a destination to this NavGraph.

final void

Adds multiple destinations to this NavGraph.

final void

Adds multiple destinations to this NavGraph.

final void

Clear all destinations from this navigation graph.

final @Nullable NavDestination
findNode(@IdRes int resId)

Finds a destination in the collection by ID.

final @Nullable NavDestination

Finds a destination in the collection by route.

final @IdRes int

This method is deprecated. Use getStartDestinationId instead.

final @NonNull Iterator<@NonNull NavDestination>
final void

Remove a given destination from this NavGraph

final void
setStartDestination(int startDestId)

Sets the starting destination for this NavGraph.

final void

Sets the starting destination for this NavGraph.

@NonNull String

Public fields

arguments

@NonNull
public final @NonNull Map<@NonNull String, @NonNull NavArgumentarguments

The arguments supported by this destination. Returns a read-only map of argument names to NavArgument objects that can be used to check the type, default value and nullability of the argument.

To add and remove arguments for this NavDestination use addArgument and removeArgument.

Returns
@NonNull Map<@NonNull String, @NonNull NavArgument>

Read-only map of argument names to arguments.

id

@NonNull
public final int id

The destination's unique ID. This should be an ID resource generated by the Android resource system.

label

@Nullable
public final @Nullable CharSequence label

The descriptive label of this destination.

moduleName

@Nullable
public final @Nullable String moduleName

The dynamic feature's module name.

@NonNull
public final @NonNull String navigatorName

The name associated with this destination's Navigator.

parent

@Nullable
public final @Nullable NavGraph parent

Gets the NavGraph that contains this destination. This will be set when a destination is added to a NavGraph via NavGraph.addDestination.

progressDestination

@NonNull
public final int progressDestination

Resource id of progress destination. This will be preferred over any default progress destination set by installDefaultProgressDestination.

route

@Nullable
public final @Nullable String route

The destination's unique route. Setting this will also update the id of the destinations so custom destination ids should only be set after setting the route.

Returns
@Nullable String

this destination's route, or null if no route is set

Throws
kotlin.IllegalArgumentException

is the given route is empty

startDestDisplayName

@NonNull
public final @NonNull String startDestDisplayName

startDestinationId

@NonNull
public final int startDestinationId

The starting destination id for this NavGraph. When navigating to the NavGraph, the destination represented by this id is the one the user will initially see.

startDestinationRoute

@Nullable
public final @Nullable String startDestinationRoute

The route for the starting destination for this NavGraph. When navigating to the NavGraph, the destination represented by this route is the one the user will initially see.

Public constructors

DynamicNavGraph

public final DynamicNavGraph(
    @NonNull DynamicGraphNavigator navGraphNavigator,
    @NonNull NavigatorProvider navigatorProvider
)

Public methods

equals

@NonNull
public boolean equals(@Nullable Object other)

hashCode

@NonNull
public int hashCode()

onInflate

@NonNull
public void onInflate(@NonNull Context context, @NonNull AttributeSet attrs)

Called when inflating a destination from a resource.

Parameters
@NonNull Context context

local context performing inflation

@NonNull AttributeSet attrs

attrs to parse during inflation