FragmentNavigator.Destination

Added in 1.0.0

Kotlin |Java

@NavDestination.ClassType(value = Fragment)
open class FragmentNavigator.Destination : NavDestination

kotlin.Any
↳	androidx.navigation.NavDestination
	↳	androidx.navigation.fragment.FragmentNavigator.Destination

Known direct subclasses

DynamicFragmentNavigator.Destination

Destination for dynamic feature navigator.

NavDestination specific to FragmentNavigator

Construct a new fragment destination. This destination is not valid until you set the Fragment via setClassName.

Summary

Public constructors
`Destination( fragmentNavigator: Navigator<FragmentNavigator.Destination> )`
`Destination(navigatorProvider: NavigatorProvider)` Construct a new fragment destination.

Public functions
`open operator Boolean`	`equals(other: Any?)`
`open Int`	`hashCode()`
`open Unit`	`@CallSuper onInflate(context: Context, attrs: AttributeSet)` Called when inflating a destination from a resource.
`FragmentNavigator.Destination`	`setClassName(className: String)` Set the Fragment class name associated with this destination
`open String`	`toString()`

Public properties
`String`	`className` The Fragment's class name associated with this destination

`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?`	`getAction(id: @IdRes Int)` 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.

`Map<String, NavArgument>`	`arguments` The arguments supported by this destination.
`Int`	`id` The destination's unique ID.
`CharSequence?`	`label` The descriptive label of this destination.
`String`	`navigatorName` The name associated with this destination's `Navigator`.
`NavGraph?`	`parent` Gets the `NavGraph` that contains this destination.
`String?`	`route` The destination's unique route.

Added in 1.0.0

Destination(
    fragmentNavigator: Navigator<FragmentNavigator.Destination>
)

Parameters
`fragmentNavigator: Navigator<FragmentNavigator.Destination>`	The `FragmentNavigator` which this destination will be associated with. Generally retrieved via a `NavController`'s `NavigatorProvider.getNavigator` method.

Added in 1.0.0

Destination(navigatorProvider: NavigatorProvider)

Construct a new fragment destination. This destination is not valid until you set the Fragment via setClassName.

Parameters
`navigatorProvider: NavigatorProvider`	The `NavController` which this destination will be associated with.

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

open fun hashCode(): Int

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

Added in 1.0.0

fun setClassName(className: String): FragmentNavigator.Destination

Set the Fragment class name associated with this destination

Parameters
`className: String`	The class name of the Fragment to show when you navigate to this destination

Returns
`FragmentNavigator.Destination`	this `Destination`

open fun toString(): String

Added in 1.0.0

val className: String

The Fragment's class name associated with this destination

Throws
`kotlin.IllegalStateException`	when no Fragment class was set.