ActivityNavigator.Destination

Artifact: androidx.navigation:navigation-runtime

View Source

Added in 1.0.0

---

Kotlin |Java

Common/AllAndroid/JVM

• android

  @NavDestination.ClassType(value = Activity)
  open class ActivityNavigator.Destination : NavDestination

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

---

NavDestination for activity navigation

Construct a new activity destination. This destination is not valid until you set the Intent via setIntent or one or more of the other set method.

Summary

Public constructors
Destination(     activityNavigator: Navigator<ActivityNavigator.Destination> )	android
Destination(navigatorProvider: NavigatorProvider) Construct a new activity destination.	android

Public functions
open operator Boolean	equals(other: Any?)	android
open Int	hashCode()	android
open Unit	@CallSuper onInflate(context: Context, attrs: AttributeSet) Called when inflating a destination from a resource.	android
ActivityNavigator.Destination	setAction(action: String?) Sets the action sent when navigating to this destination.	android
ActivityNavigator.Destination	setComponentName(name: ComponentName?) Set an explicit ComponentName to navigate to.	android
ActivityNavigator.Destination	setData(data: Uri?) Sets a static data URI that is sent when navigating to this destination.	android
ActivityNavigator.Destination	setDataPattern(dataPattern: String?) Sets a dynamic data URI pattern that is sent when navigating to this destination.	android
ActivityNavigator.Destination	setIntent(intent: Intent?) Set the Intent to start when navigating to this destination.	android
ActivityNavigator.Destination	setTargetPackage(packageName: String?) Set an explicit application package name that limits the components this destination will navigate to.	android
open String	toString()	android

Public properties
String?	action The action used to start the Activity, if any	android
ComponentName?	component The explicit ComponentName associated with this destination, if any	android
Uri?	data The data URI used to start the Activity, if any	android
String?	dataPattern The dynamic data URI pattern, if any	android
Intent?	intent The Intent associated with this destination.	android
String?	targetPackage The explicit application package name associated with this destination, if any	android

Inherited functions

From androidx.navigation.NavDestination Unit addArgument(argumentName: String, argument: NavArgument) android Unit addDeepLink(navDeepLink: NavDeepLink) android Unit addDeepLink(uriPattern: String) android String? fillInLabel(context: Context, bundle: Bundle?) Parses a dynamic label containing arguments into a String. android NavAction? getAction(id: @IdRes Int) Returns the NavAction for the given action ID. android open Boolean hasDeepLink(deepLinkRequest: NavDeepLinkRequest) android open Boolean hasDeepLink(deepLink: Uri) android Unit putAction(actionId: @IdRes Int, action: NavAction) Sets the NavAction destination for an action ID. android Unit putAction(actionId: @IdRes Int, destId: @IdRes Int) Creates a NavAction for the given destId and associates it with the actionId. android Unit removeAction(actionId: @IdRes Int) Unsets the NavAction for an action ID. android Unit removeArgument(argumentName: String) android

Inherited properties
From androidx.navigation.NavDestination Map<String, NavArgument> arguments android Int id The destination's unique ID. android CharSequence? label android String navigatorName android NavGraph? parent android String? route android

Public constructors

Destination

android

Added in 1.0.0

Destination(
    activityNavigator: Navigator<ActivityNavigator.Destination>
)

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

Destination

android

Added in 1.0.0

Destination(navigatorProvider: NavigatorProvider)

Construct a new activity destination. This destination is not valid until you set the Intent via setIntent or one or more of the other set method.

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

Public functions

equals

android

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

hashCode

android

open fun hashCode(): Int

onInflate

android

@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

setAction

android

Added in 1.0.0

fun setAction(action: String?): ActivityNavigator.Destination

Sets the action sent when navigating to this destination.

Parameters
action: String?	The action string to use.

Returns
ActivityNavigator.Destination	this Destination

setComponentName

android

Added in 1.0.0

fun setComponentName(name: ComponentName?): ActivityNavigator.Destination

Set an explicit ComponentName to navigate to.

Parameters
name: ComponentName?	The component name of the Activity to start.

Returns
ActivityNavigator.Destination	this Destination

setData

android

Added in 1.0.0

fun setData(data: Uri?): ActivityNavigator.Destination

Sets a static data URI that is sent when navigating to this destination.

To use a dynamic URI that changes based on the arguments passed in when navigating, use setDataPattern, which will take precedence when arguments are present.

When inflated from XML, you can use ${applicationId} for string interpolation to automatically use Context.getPackageName.

Parameters
data: Uri?	A static URI that should always be used.

Returns
ActivityNavigator.Destination	this Destination

See also
setDataPattern

setDataPattern

android

Added in 1.0.0

fun setDataPattern(dataPattern: String?): ActivityNavigator.Destination

Sets a dynamic data URI pattern that is sent when navigating to this destination.

If a non-null arguments Bundle is present when navigating, any segments in the form {argName} will be replaced with a URI encoded string from the arguments.

When inflated from XML, you can use ${applicationId} as an argument pattern to automatically use Context.getPackageName.

Parameters
dataPattern: String?	A URI pattern with segments in the form of {argName} that will be replaced with URI encoded versions of the Strings in the arguments Bundle.

Returns
ActivityNavigator.Destination	this Destination

See also
setData

setIntent

android

Added in 1.0.0

fun setIntent(intent: Intent?): ActivityNavigator.Destination

Set the Intent to start when navigating to this destination.

Parameters
intent: Intent?	Intent to associated with this destination.

Returns
ActivityNavigator.Destination	this Destination

setTargetPackage

android

Added in 2.1.0

fun setTargetPackage(packageName: String?): ActivityNavigator.Destination

Set an explicit application package name that limits the components this destination will navigate to.

When inflated from XML, you can use ${applicationId} as the package name to automatically use Context.getPackageName.

Parameters
packageName: String?	packageName to set

Returns
ActivityNavigator.Destination	this Destination

toString

android

open fun toString(): String

Public properties

action

android

Added in 1.0.0

val action: String?

The action used to start the Activity, if any

component

android

Added in 1.0.0

val component: ComponentName?

The explicit ComponentName associated with this destination, if any

data

android

Added in 1.0.0

val data: Uri?

The data URI used to start the Activity, if any

dataPattern

android

Added in 1.0.0

val dataPattern: String?

The dynamic data URI pattern, if any

intent

android

Added in 1.0.0

val intent: Intent?

The Intent associated with this destination.

targetPackage

android

Added in 2.1.0

val targetPackage: String?

The explicit application package name associated with this destination, if any