FragmentNavigator.Destination


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

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

Called when inflating a destination from a resource.

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)

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.

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

Called when inflating a destination from a resource.

Parameters
context: Context

local context performing inflation

attrs: AttributeSet

attrs to parse during inflation

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

toString

open fun toString(): String

Public properties

className

Added in 1.0.0
val classNameString

The Fragment's class name associated with this destination

Throws
kotlin.IllegalStateException

when no Fragment class was set.