NavDestination

<init>

NavDestination(@NonNull navigator: Navigator<out NavDestination!>)

NavDestinations should be created via Navigator#createDestination.

This constructor requires that the given Navigator has a Navigator.Name annotation.

<init>

NavDestination(@NonNull navigatorName: String)

NavDestinations should be created via Navigator#createDestination.

addArgument

fun addArgument(
    @NonNull argumentName: String, 
    @NonNull argument: NavArgument
): Unit

Sets an argument type for an argument name

addDeepLink

fun addDeepLink(@NonNull uriPattern: String): Unit

Add a deep link to this destination. Matching Uris sent to NavController#handleDeepLink(Intent) or NavController#navigate(Uri) will trigger navigating to this destination.

In addition to a direct Uri match, the following features are supported:

• Uris without a scheme are assumed as http and https. For example, www.example.com will match http://www.example.com and https://www.example.com.
• Placeholders in the form of {placeholder_name} matches 1 or more characters. The String value of the placeholder will be available in the arguments Bundle with a key of the same name. For example, http://www.example.com/users/{id} will match http://www.example.com/users/4.
• The .* wildcard can be used to match 0 or more characters.

Deep links added in navigation XML files will automatically replace instances of ${applicationId} with the applicationId of your app. Programmatically added deep links should use Context#getPackageName() directly when constructing the uriPattern.

addDeepLink

fun addDeepLink(@NonNull navDeepLink: NavDeepLink): Unit

Add a deep link to this destination. Uris that match the given NavDeepLink uri sent to NavController#handleDeepLink(Intent) or NavController#navigate(NavDeepLinkRequest) will trigger navigating to this destination.

In addition to a direct Uri match, the following features are supported:

• Uris without a scheme are assumed as http and https. For example, www.example.com will match http://www.example.com and https://www.example.com.
• Placeholders in the form of {placeholder_name} matches 1 or more characters. The String value of the placeholder will be available in the arguments Bundle with a key of the same name. For example, http://www.example.com/users/{id} will match http://www.example.com/users/4.
• The .* wildcard can be used to match 0 or more characters.

Custom actions and mimetypes are also supported by NavDeepLink and can be declared in your navigation XML files by adding <app:action="android.intent.action.SOME_ACTION" /> or <app:mimetype="type/subtype" /> as part of your deepLink declaration.

Deep link Uris, actions, and mimetypes added in navigation XML files will automatically replace instances of ${applicationId} with the applicationId of your app. Programmatically added deep links should use Context#getPackageName() directly when constructing the uriPattern.

When matching deep links for calls to NavController#handleDeepLink(Intent) or NavController#navigate(NavDeepLinkRequest) the order of precedence is as follows: the deep link with the most matching arguments will be chosen, followed by the deep link with a matching action, followed by the best matching mimeType (e.i. when matching mimeType image/jpg: image/* > *\/jpg > *\/*).

getAction

@Nullable fun getAction(@IdRes id: Int): NavAction?

Returns the destination ID for a given action. This will recursively check the parent of this destination if the action destination is not found in this destination.

getArguments

@NonNull fun getArguments(): MutableMap<String!, NavArgument!>

Get the arguments supported by this destination. Returns a read-only map of argument names to NavArgument objects that can be used to check the type, default value and nullability of the argument.

To add and remove arguments for this NavDestination use addArgument(String, NavArgument) and removeArgument(String).

getId

@IdRes fun getId(): Int

Returns the destination's unique ID. This should be an ID resource generated by the Android resource system.

getLabel

@Nullable fun getLabel(): CharSequence?

Gets the descriptive label of this destination.

getNavigatorName

@NonNull fun getNavigatorName(): String

Returns the name associated with this destination's Navigator.

getParent

@Nullable fun getParent(): NavGraph?

Gets the NavGraph that contains this destination. This will be set when a destination is added to a NavGraph via NavGraph#addDestination.

hasDeepLink

open fun hasDeepLink(@NonNull deepLink: Uri): Boolean

Checks the given deep link Uri, and determines whether it matches a Uri pattern added to the destination by a call to addDeepLink(String) . It returns true if the deep link is a valid match, and false otherwise.

This should be called prior to NavController#navigate(Uri) to ensure the deep link can be navigated to.

hasDeepLink

open fun hasDeepLink(@NonNull deepLinkRequest: NavDeepLinkRequest): Boolean

Checks the given NavDeepLinkRequest, and determines whether it matches a NavDeepLink added to the destination by a call to addDeepLink(NavDeepLink). It returns true if the request is a valid match, and false otherwise.

This should be called prior to NavController#navigate(NavDeepLinkRequest) to ensure the deep link can be navigated to.

onInflate

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

Called when inflating a destination from a resource.

putAction

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

Sets a destination ID for an action ID.

putAction

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

Sets a destination ID for an action ID.

removeAction

fun removeAction(@IdRes actionId: Int): Unit

Unsets the destination ID for an action ID.

removeArgument

fun removeArgument(@NonNull argumentName: String): Unit

Unsets the argument type for an argument name.

setId

fun setId(@IdRes id: Int): Unit

Sets the destination's unique ID. This should be an ID resource generated by the Android resource system.

setLabel

fun setLabel(@Nullable label: CharSequence?): Unit

Sets the descriptive label of this destination.

toString

@NonNull open fun toString(): String

parseClassFromName

@NonNull protected open static fun <C : Any!> parseClassFromName(
    @NonNull context: Context, 
    @NonNull name: String, 
    @NonNull expectedClassType: Class<out C>
): Class<out C>

Parse the class associated with this destination from a raw name, generally extracted from the android:name attribute added to the destination's XML. This should be the class providing the visual representation of the destination that the user sees after navigating to this destination.

This method does name -> Class caching and should be strongly preferred over doing your own parsing if your Navigator supports the android:name attribute to give consistent behavior across all Navigators.