Destination

Kotlin |Java

open class Destination : NavDestination

kotlin.Any
↳	androidx.navigation.NavDestination
	↳	androidx.navigation.ActivityNavigator.Destination

Known Direct Subclasses

DynamicActivityNavigator.Destination

Destination for DynamicActivityNavigator.

NavDestination for activity navigation

Summary

Public constructors
`<init>(@NonNull navigatorProvider: NavigatorProvider)` Construct a new activity destination.
`<init>(@NonNull activityNavigator: Navigator<out ActivityNavigator.Destination!>)` Construct a new activity destination.

Public methods
String?	`getAction()` Get the action used to start the Activity, if any
ComponentName?	`getComponent()` Get the explicit `ComponentName` associated with this destination, if any
Uri?	`getData()` Get the data URI used to start the Activity, if any
String?	`getDataPattern()` Gets the dynamic data URI pattern, if any
Intent?	`getIntent()` Gets the Intent associated with this destination.
String?	`getTargetPackage()` Get the explicit application package name associated with this destination, if any
open Unit	`onInflate(@NonNull context: Context, @NonNull attrs: AttributeSet)`
ActivityNavigator.Destination	`setAction(@Nullable action: String?)` Sets the action sent when navigating to this destination.
ActivityNavigator.Destination	`setComponentName(@Nullable name: ComponentName?)` Set an explicit `ComponentName` to navigate to.
ActivityNavigator.Destination	`setData(@Nullable data: Uri?)` Sets a static data URI that is sent when navigating to this destination.
ActivityNavigator.Destination	`setDataPattern(@Nullable dataPattern: String?)` Sets a dynamic data URI pattern that is sent when navigating to this destination.
ActivityNavigator.Destination	`setIntent(@Nullable intent: Intent?)` Set the Intent to start when navigating to this destination.
ActivityNavigator.Destination	`setTargetPackage(@Nullable packageName: String?)` Set an explicit application package name that limits the components this destination will navigate to.
open String	`toString()`

Inherited functions

From class NavDestination

Unit

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

Sets an argument type for an argument name

Unit

addDeepLink(@NonNull uriPattern: String)

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.

These Uris can be declared in your navigation XML files by adding one or more <deepLink app:uri="uriPattern" /> elements as a child to your destination.

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.

Unit

addDeepLink(@NonNull navDeepLink: NavDeepLink)

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.

These Uris can be declared in your navigation XML files by adding one or more <deepLink app:uri="uriPattern" /> elements as a child to your destination.

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