FragmentNavigator.Destination

@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(navigatorProvider: NavigatorProvider)

Construct a new fragment destination.

Public functions
open operator Boolean
equals(other: Any?)
open Int
open Unit
FragmentNavigator.Destination
setClassName(className: String)

Set the Fragment class name associated with this destination
open String

Public properties
String

The Fragment's class name associated with this destination

Inherited functions
From androidx.navigation.NavDestination
Unit
addArgument(argumentName: String, argument: NavArgument)
Unit
addDeepLink(navDeepLink: NavDeepLink)
Unit
addDeepLink(uriPattern: String)
open Boolean
hasDeepLink(deepLink: NavUri)
open Boolean
hasDeepLink(deepLinkRequest: NavDeepLinkRequest)
Unit
removeArgument(argumentName: String)

Inherited properties
From androidx.navigation.NavDestination
Map<String, NavArgument>
CharSequence?
String
NavGraph?
String?

Public constructors

Destination

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.

Destination

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.

Public functions

equals

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

hashCode

open fun hashCode(): Int

onInflate

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

setClassName

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

toString

open fun toString(): String

Public properties

className

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.