Summary: Ctors | Methods | Inherited Methods

ActivityNavigator.Destination

Kotlin |Java

public static class ActivityNavigator.Destination
extends NavDestination

java.lang.Object
↳	androidx.navigation.NavDestination
	↳	androidx.navigation.ActivityNavigator.Destination

NavDestination for activity navigation

Summary

Public constructors
`Destination(NavigatorProvider navigatorProvider)` Construct a new activity destination.
`Destination(Navigator<? extends ActivityNavigator.Destination> activityNavigator)` Construct a new activity destination.

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

Inherited methods

From class


        
          androidx.navigation.NavDestination

`final void`	`addArgument(String argumentName, NavArgument argument)` Sets an argument type for an argument name
`final void`	`addDeepLink(String uriPattern)` Add a deep link to this destination.
`final void`	`addDeepLink(NavDeepLink navDeepLink)` Add a deep link to this destination.
`final NavAction`	`getAction(int id)` Returns the destination ID for a given action.
`final Map<String, NavArgument>`	`getArguments()` Get the arguments supported by this destination.
`final int`	`getId()` Returns the destination's unique ID.
`final CharSequence`	`getLabel()` Gets the descriptive label of this destination.
`final String`	`getNavigatorName()` Returns the name associated with this destination's `Navigator`.
`final NavGraph`	`getParent()` Gets the `NavGraph` that contains this destination.
`boolean`	`hasDeepLink(Uri deepLink)` Checks the given deep link `Uri`, and determines whether it matches a Uri pattern added to the destination by a call to `addDeepLink(String)` .
`boolean`	`hasDeepLink(NavDeepLinkRequest deepLinkRequest)` Checks the given `NavDeepLinkRequest`, and determines whether it matches a `NavDeepLink` added to the destination by a call to `addDeepLink(NavDeepLink)`.
`void`	`onInflate(Context context, AttributeSet attrs)` Called when inflating a destination from a resource.
`static <C> Class<? extends C>`	`parseClassFromName(Context context, String name, Class<? extends C> expectedClassType)` Parse the class associated with this destination from a raw name, generally extracted from the `android:name` attribute added to the destination's XML.
`final void`	`putAction(int actionId, NavAction action)` Sets a destination ID for an action ID.
`final void`	`putAction(int actionId, int destId)` Sets a destination ID for an action ID.
`final void`	`removeAction(int actionId)` Unsets the destination ID for an action ID.
`final void`	`removeArgument(String argumentName)` Unsets the argument type for an argument name.
`final void`	`setId(int id)` Sets the destination's unique ID.
`final void`	`setLabel(CharSequence label)` Sets the descriptive label of this destination.
`String`	`toString()`

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public constructors

public Destination (NavigatorProvider navigatorProvider)

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

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

public Destination (Navigator<? extends ActivityNavigator.Destination> activityNavigator)

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

Parameters
`activityNavigator`	`Navigator`: The `ActivityNavigator` which this destination will be associated with. Generally retrieved via a `NavController`'s `NavigatorProvider.getNavigator(Class)` method.

Public methods

getAction

public final String getAction ()

Get the action used to start the Activity, if any

Returns
`String`

getComponent

public final ComponentName getComponent ()

Get the explicit ComponentName associated with this destination, if any

Returns
`ComponentName`

getData

public final Uri getData ()

Get the data URI used to start the Activity, if any

Returns
`Uri`

getDataPattern

public final String getDataPattern ()

Gets the dynamic data URI pattern, if any

Returns
`String`

getIntent

public final Intent getIntent ()

Gets the Intent associated with this destination.

Returns
`Intent`

getTargetPackage

public final String getTargetPackage ()

Get the explicit application package name associated with this destination, if any

Returns
`String`

onInflate

public void onInflate (Context context, 
                AttributeSet attrs)

Called when inflating a destination from a resource.

Parameters
`context`	`Context`: local context performing inflation
`attrs`	`AttributeSet`: attrs to parse during inflation

setAction

public final ActivityNavigator.Destination setAction (String action)

Sets the action sent when navigating to this destination.

Parameters
`action`	`String`: The action string to use.

Returns
`ActivityNavigator.Destination`	this `ActivityNavigator.Destination`

setComponentName

public final ActivityNavigator.Destination setComponentName (ComponentName name)

Set an explicit ComponentName to navigate to.

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

Returns
`ActivityNavigator.Destination`	this `ActivityNavigator.Destination`

setData

public final ActivityNavigator.Destination setData (Uri data)

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(String), which will take precedence when arguments are present.

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

Returns
`ActivityNavigator.Destination`	this `ActivityNavigator.Destination`

See also:

setDataPattern(String)

setDataPattern

public final ActivityNavigator.Destination setDataPattern (String dataPattern)

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.

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 `ActivityNavigator.Destination`

See also:

setData(Uri)

setIntent

public final ActivityNavigator.Destination setIntent (Intent intent)

Set the Intent to start when navigating to this destination.

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

Returns
`ActivityNavigator.Destination`	this `ActivityNavigator.Destination`

setTargetPackage

public final ActivityNavigator.Destination setTargetPackage (String packageName)

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 `ActivityNavigator.Destination`

toString

public String toString ()

Returns
`String`