DynamicActivityNavigator.Destination

public final class DynamicActivityNavigator.Destination extends NavDestination, ActivityNavigator.Destination


Destination for DynamicActivityNavigator.

Summary

Public fields

final @Nullable String

The action used to start the Activity, if any

final @NonNull Map<@NonNull String, @NonNull NavArgument>

The arguments supported by this destination.

final @Nullable ComponentName

The explicit ComponentName associated with this destination, if any

final @Nullable Uri

The data URI used to start the Activity, if any

final @Nullable String

The dynamic data URI pattern, if any

final int

The destination's unique ID.

final @Nullable Intent

The Intent associated with this destination.

final @Nullable CharSequence

The descriptive label of this destination.

final @Nullable String

The module name of this Destination's dynamic feature module.

final @NonNull String

The name associated with this destination's Navigator.

final @Nullable NavGraph

Gets the NavGraph that contains this destination.

final @Nullable String

The destination's unique route.

final @Nullable String

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

Public constructors

Create a new Destination with a NavigatorProvider.

Create a new Destination with an ActivityNavigator.Destination.

Public methods

boolean
int
void

Called when inflating a destination from a resource.

Inherited methods

From class ActivityNavigator.Destination
final @NonNull ActivityNavigator.Destination

Sets the action sent when navigating to this destination.

final @NonNull ActivityNavigator.Destination

Set an explicit ComponentName to navigate to.

final @NonNull ActivityNavigator.Destination

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

final @NonNull ActivityNavigator.Destination

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

final @NonNull ActivityNavigator.Destination

Set the Intent to start when navigating to this destination.

final @NonNull ActivityNavigator.Destination

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

@NonNull String
From class NavDestination
final void
addArgument(@NonNull String argumentName, @NonNull NavArgument argument)

Sets an argument type for an argument name

final void

Add a deep link to this destination.

final void
addDeepLink(@NonNull String uriPattern)

Add a deep link to this destination.

final @Nullable NavAction
getAction(@IdRes int id)

Returns the NavAction for the given action ID.

boolean
hasDeepLink(@NonNull 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 .

boolean

Checks the given NavDeepLinkRequest, and determines whether it matches a NavDeepLink added to the destination by a call to addDeepLink.

final void
putAction(@IdRes int actionId, @NonNull NavAction action)

Sets the NavAction destination for an action ID.

final void
putAction(@IdRes int actionId, @IdRes int destId)

Creates a NavAction for the given destId and associates it with the actionId.

final void
removeAction(@IdRes int actionId)

Unsets the NavAction for an action ID.

final void
removeArgument(@NonNull String argumentName)

Unsets the argument type for an argument name.

Public fields

action

@Nullable
public final @Nullable String action

The action used to start the Activity, if any

arguments

@NonNull
public final @NonNull Map<@NonNull String, @NonNull NavArgumentarguments

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 and removeArgument.

Returns
@NonNull Map<@NonNull String, @NonNull NavArgument>

Read-only map of argument names to arguments.

component

@Nullable
public final @Nullable ComponentName component

The explicit ComponentName associated with this destination, if any

data

@Nullable
public final @Nullable Uri data

The data URI used to start the Activity, if any

dataPattern

@Nullable
public final @Nullable String dataPattern

The dynamic data URI pattern, if any

id

@NonNull
public final int id

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

intent

@Nullable
public final @Nullable Intent intent

The Intent associated with this destination.

label

@Nullable
public final @Nullable CharSequence label

The descriptive label of this destination.

moduleName

@Nullable
public final @Nullable String moduleName

The module name of this Destination's dynamic feature module. This has to be the same as defined in the dynamic feature module's AndroidManifest.xml file.

@NonNull
public final @NonNull String navigatorName

The name associated with this destination's Navigator.

parent

@Nullable
public final @Nullable NavGraph parent

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

route

@Nullable
public final @Nullable String route

The destination's unique route. Setting this will also update the id of the destinations so custom destination ids should only be set after setting the route.

Returns
@Nullable String

this destination's route, or null if no route is set

Throws
kotlin.IllegalArgumentException

is the given route is empty

targetPackage

@Nullable
public final @Nullable String targetPackage

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

Public constructors

Destination

public final Destination(@NonNull NavigatorProvider navigatorProvider)

Create a new Destination with a NavigatorProvider.

Destination

public final Destination(
    @NonNull Navigator<@NonNull ActivityNavigator.Destination> activityNavigator
)

Create a new Destination with an ActivityNavigator.Destination.

Parameters
@NonNull Navigator<@NonNull ActivityNavigator.Destination> activityNavigator

The Navigator to use for this Destination.

Public methods

equals

@NonNull
public boolean equals(@Nullable Object other)

hashCode

@NonNull
public int hashCode()

onInflate

@NonNull
public void onInflate(@NonNull Context context, @NonNull AttributeSet attrs)

Called when inflating a destination from a resource.

Parameters
@NonNull Context context

local context performing inflation

@NonNull AttributeSet attrs

attrs to parse during inflation