DynamicIncludeGraphNavigator.DynamicIncludeNavGraph

class DynamicIncludeGraphNavigator.DynamicIncludeNavGraph : NavDestination


The graph for dynamic-include.

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

Summary

Public functions

open operator Boolean
equals(other: Any?)
open Int
open Unit
onInflate(context: Context, attrs: AttributeSet)

Called when inflating a destination from a resource.

Public properties

String?

The graph's package.

String?

Resource name of the graph.

String?

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

Inherited functions

From androidx.navigation.NavDestination
Unit
addArgument(argumentName: String, argument: NavArgument)

Sets an argument type for an argument name

Unit
addDeepLink(navDeepLink: NavDeepLink)

Add a deep link to this destination.

Unit
addDeepLink(uriPattern: String)

Add a deep link to this destination.

String?
fillInLabel(context: Context, bundle: Bundle?)

Parses a dynamic label containing arguments into a String.

NavAction?

Returns the NavAction for the given action ID.

open Boolean
hasDeepLink(deepLinkRequest: NavDeepLinkRequest)

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

open Boolean
hasDeepLink(deepLink: Uri)

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

Unit
putAction(actionId: @IdRes Int, action: NavAction)

Sets the NavAction destination for an action ID.

Unit
putAction(actionId: @IdRes Int, destId: @IdRes Int)

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

Unit
removeAction(actionId: @IdRes Int)

Unsets the NavAction for an action ID.

Unit
removeArgument(argumentName: String)

Unsets the argument type for an argument name.

open String

Inherited properties

From androidx.navigation.NavDestination
Map<StringNavArgument>

The arguments supported by this destination.

Int

The destination's unique ID.

CharSequence?

The descriptive label of this destination.

String

The name associated with this destination's Navigator.

NavGraph?

Gets the NavGraph that contains this destination.

String?

The destination's unique route.

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

onInflate

open fun onInflate(context: Context, attrs: AttributeSet): Unit

Called when inflating a destination from a resource.

Parameters
context: Context

local context performing inflation

attrs: AttributeSet

attrs to parse during inflation

Public properties

graphPackage

Added in 2.3.0
var graphPackageString?

The graph's package.

graphResourceName

Added in 2.3.0
var graphResourceNameString?

Resource name of the graph.

moduleName

Added in 2.3.0
var moduleNameString?

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