DynamicGraphNavigator.DynamicNavGraph


public final class DynamicGraphNavigator.DynamicNavGraph extends NavGraph


The NavGraph for dynamic features.

Summary

Public constructors

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

Public methods

boolean
equals(Object other)
final String

The dynamic feature's module name.

final int

Resource id of progress destination.

int
void

Called when inflating a destination from a resource.

final void
setModuleName(String moduleName)

The dynamic feature's module name.

final void
setProgressDestination(int progressDestination)

Resource id of progress destination.

Inherited methods

From kotlin.collections.Iterable
From androidx.navigation.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 String
fillInLabel(@NonNull Context context, Bundle bundle)

Parses a dynamic label containing arguments into a String.

final NavAction
getAction(@IdRes int id)

Returns the NavAction for the given action ID.

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

The arguments supported by this destination.

final @IdRes int

The destination's unique ID.

final CharSequence

The descriptive label of this destination.

final @NonNull String

The name associated with this destination's Navigator.

final NavGraph

Gets the NavGraph that contains this destination.

final String

The destination's unique route.

boolean

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

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 .

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.

final void
setId(int id)

The destination's unique ID.

final void

The descriptive label of this destination.

final void

The destination's unique route.

From androidx.navigation.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 NavDestination
<T extends Object> findNode()

Finds a destination in the collection by route from KClass.

final NavDestination
findNode(@IdRes int resId)

Finds a destination in the collection by ID.

final NavDestination
<T extends Object> findNode(T route)

Finds a destination in the collection by route from Object.

final NavDestination

Finds a destination in the collection by route.

final @IdRes int

This method is deprecated. Use getStartDestinationId instead.

final @IdRes int

The starting destination id for this NavGraph.

final String

The route for the starting destination for this NavGraph.

final @NonNull Iterator<@NonNull NavDestination>
final void

Remove a given destination from this NavGraph

final void
<T extends Object> setStartDestination()

Sets the starting destination for this NavGraph.

final void
setStartDestination(int startDestId)

Sets the starting destination for this NavGraph.

final void
<T extends Object> setStartDestination(@NonNull T startDestRoute)

Sets the starting destination for this NavGraph.

final void

Sets the starting destination for this NavGraph.

@NonNull String

Public constructors

DynamicNavGraph

Added in 2.3.0
public DynamicNavGraph(
    @NonNull DynamicGraphNavigator navGraphNavigator,
    @NonNull NavigatorProvider navigatorProvider
)

Public methods

equals

public boolean equals(Object other)

getModuleName

Added in 2.3.0
public final String getModuleName()

The dynamic feature's module name.

getProgressDestination

Added in 2.3.0
public final int getProgressDestination()

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

hashCode

public int hashCode()

onInflate

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

setModuleName

Added in 2.3.0
public final void setModuleName(String moduleName)

The dynamic feature's module name.

setProgressDestination

Added in 2.3.0
public final void setProgressDestination(int progressDestination)

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