DynamicIncludeGraphNavigator.DynamicIncludeNavGraph

public final class DynamicIncludeGraphNavigator.DynamicIncludeNavGraph extends NavDestination

java.lang.Object
   ↳ androidx.navigation.NavDestination
     ↳ androidx.navigation.dynamicfeatures.DynamicIncludeGraphNavigator.DynamicIncludeNavGraph

The graph for dynamic-include.

This class contains information to navigate to a DynamicNavGraph which is contained within a dynamic feature module.

Summary

Public methods
boolean
equals(Object other)
final String

The graph's package.
final String

Resource name of the graph.
final String

Name of the module containing the included graph, if set.
int
void

Called when inflating a destination from a resource.
final void
setGraphPackage(String graphPackage)

The graph's package.
final void
setGraphResourceName(String graphResourceName)

Resource name of the graph.
final void
setModuleName(String moduleName)

Name of the module containing the included graph, if set.

Inherited methods
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.
@NonNull String

Public methods

equals

public boolean equals(Object other)

getGraphPackage

Added in 2.3.0
public final String getGraphPackage()

The graph's package.

getGraphResourceName

Added in 2.3.0
public final String getGraphResourceName()

Resource name of the graph.

getModuleName

Added in 2.3.0
public final String getModuleName()

Name of the module containing the included graph, if set.

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

setGraphPackage

Added in 2.3.0
public final void setGraphPackage(String graphPackage)

The graph's package.

setGraphResourceName

Added in 2.3.0
public final void setGraphResourceName(String graphResourceName)

Resource name of the graph.

setModuleName

Added in 2.3.0
public final void setModuleName(String moduleName)

Name of the module containing the included graph, if set.