ActivityNavigatorDestinationBuilder

@NavDestinationDsl
public final class ActivityNavigatorDestinationBuilder extends NavDestinationBuilder

java.lang.Object
   ↳ androidx.navigation.NavDestinationBuilder
     ↳ androidx.navigation.ActivityNavigatorDestinationBuilder

DSL for constructing a new ActivityNavigator.Destination

Summary

Public constructors

This method is deprecated. Use routes to create your ActivityNavigatorDestinationBuilder instead

DSL for constructing a new ActivityNavigator.Destination

Public methods
@NonNull ActivityNavigator.Destination

Build the NavDestination by calling Navigator.createDestination.
final String
final KClass<@NonNull Activity>
final Uri
final String
final String
final void
setAction(String action)
final void
final void
setData(Uri data)
final void
setDataPattern(String dataPattern)
final void
setTargetPackage(String targetPackage)

Inherited methods
From androidx.navigation.NavDestinationBuilder
final void
action(
    int actionId,
    @ExtensionFunctionType @NonNull Function1<@NonNull NavActionBuilder, Unit> actionBuilder
)

This method is deprecated. Building NavDestinations using IDs with the Kotlin DSL has been deprecated in favor of using routes.
final void
argument(
    @NonNull String name,
    @ExtensionFunctionType @NonNull Function1<@NonNull NavArgumentBuilder, Unit> argumentBuilder
)

Add a NavArgument to this destination.
final void

Add a NavArgument to this destination.
final void
<T extends Object> deepLinkSafeArgs(@NonNull String basePath)

Add a deep link to this destination.
final void

Add a deep link to this destination.
final void

Add a deep link to this destination.
final void
deepLink(@NonNull String uriPattern)

Add a deep link to this destination.
final void
<T extends Object> deepLink(
    @NonNull String basePath,
    @ExtensionFunctionType @NonNull Function1<@NonNull NavDeepLinkDslBuilder, Unit> navDeepLink
)

Add a deep link to this destination.
final void
<T extends Object> deepLink(
    @NonNull KClass<@NonNull T> route,
    @NonNull String basePath,
    @ExtensionFunctionType @NonNull Function1<@NonNull NavDeepLinkDslBuilder, Unit> navDeepLink
)

Add a deep link to this destination.
final int

The destination's unique ID.
final CharSequence

The descriptive label of the destination
final @NonNull Navigator<@NonNull ActivityNavigator.Destination>

The navigator the destination that will be used in instantiateDestination to create the destination.
final String

The destination's unique route.
@NonNull ActivityNavigator.Destination

Instantiate a new instance of D that will be passed to build.
final void

The descriptive label of the destination

Public constructors

ActivityNavigatorDestinationBuilder

Added in 1.0.0
public ActivityNavigatorDestinationBuilder(
    @NonNull ActivityNavigator navigator,
    @IdRes int id
)

ActivityNavigatorDestinationBuilder

public ActivityNavigatorDestinationBuilder(
    @NonNull ActivityNavigator navigator,
    @NonNull String route
)

ActivityNavigatorDestinationBuilder

public ActivityNavigatorDestinationBuilder(
    @NonNull ActivityNavigator navigator,
    @NonNull KClass<@NonNull Object> route,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap
)

DSL for constructing a new ActivityNavigator.Destination

Parameters
@NonNull ActivityNavigator navigator

navigator used to create the destination
@NonNull KClass<@NonNull Object> route

the route from a KClass of the destination
@NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap

map of destination arguments' kotlin type KType to its respective custom NavType. May be empty if route does not use custom NavTypes.

Public methods

build

Added in 1.0.0
public @NonNull ActivityNavigator.Destination build()

Build the NavDestination by calling Navigator.createDestination.

getAction

Added in 1.0.0
public final String getAction()

getActivityClass

Added in 1.0.0
public final KClass<@NonNull Activity> getActivityClass()

getData

Added in 1.0.0
public final Uri getData()

getDataPattern

Added in 1.0.0
public final String getDataPattern()

getTargetPackage

Added in 2.1.0
public final String getTargetPackage()

setAction

Added in 1.0.0
public final void setAction(String action)

setActivityClass

Added in 1.0.0
public final void setActivityClass(KClass<@NonNull Activity> activityClass)

setData

Added in 1.0.0
public final void setData(Uri data)

setDataPattern

Added in 1.0.0
public final void setDataPattern(String dataPattern)

setTargetPackage

Added in 2.1.0
public final void setTargetPackage(String targetPackage)