-
- All Implemented Interfaces:
-
com.ramcosta.composedestinations.spec.RouteOrDirection,com.ramcosta.composedestinations.spec.TypedNavGraphSpec,com.ramcosta.composedestinations.spec.TypedRoute
public interface TypedNavHostGraphSpec<START_ROUTE_NAV_ARGS extends Object> implements TypedNavGraphSpec<START_ROUTE_NAV_ARGS, START_ROUTE_NAV_ARGS>
Like DirectionNavGraphSpec but used specifically for top level navigation graphs (i.e they have no parent graph) that are meant to pass to com.ramcosta.composedestinations.DestinationsNavHost call.
-
-
Method Summary
Modifier and Type Method Description Directioninvoke(START_ROUTE_NAV_ARGS navArgs)Function to get a Direction you can then pass to com.ramcosta.composedestinations.navigation.DestinationsNavigator or to NavController.navigateTo() to safely navigate to this Destination. abstract NavHostAnimatedDestinationStylegetDefaultTransitions()Like TypedNavGraphSpec.defaultTransitions but not nullable since NavHost level graphs must have animations defined (even if they are defined as "No animations") START_ROUTE_NAV_ARGSgetDefaultStartArgs()abstract DirectiongetDefaultStartDirection()StringgetBaseRoute()abstract TypedRoute<START_ROUTE_NAV_ARGS>getStartRoute()Start Route of this navigation graph. abstract List<TypedDestinationSpec<?>>getDestinations()All destinations which belong to this navigation graph List<TypedNavGraphSpec<?, ?>>getNestedNavGraphs()abstract StringgetRoute()Full route pattern that will be added to the navigation graph. List<NamedNavArgument>getArguments()List<NavDeepLink>getDeepLinks()-
Methods inherited from class com.ramcosta.composedestinations.spec.TypedNavHostGraphSpec
requireGraphArgs, requireGraphArgs, requireGraphArgs -
Methods inherited from class com.ramcosta.composedestinations.spec.TypedNavGraphSpec
argsFrom, argsFrom, argsFrom -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
invoke
Direction invoke(START_ROUTE_NAV_ARGS navArgs)
Function to get a Direction you can then pass to com.ramcosta.composedestinations.navigation.DestinationsNavigator or to NavController.navigateTo() to safely navigate to this Destination.
-
getDefaultTransitions
abstract NavHostAnimatedDestinationStyle getDefaultTransitions()
Like TypedNavGraphSpec.defaultTransitions but not nullable since NavHost level graphs must have animations defined (even if they are defined as "No animations")
-
getDefaultStartArgs
START_ROUTE_NAV_ARGS getDefaultStartArgs()
-
getDefaultStartDirection
abstract Direction getDefaultStartDirection()
-
getBaseRoute
String getBaseRoute()
-
getStartRoute
abstract TypedRoute<START_ROUTE_NAV_ARGS> getStartRoute()
Start Route of this navigation graph.
-
getDestinations
abstract List<TypedDestinationSpec<?>> getDestinations()
All destinations which belong to this navigation graph
-
getNestedNavGraphs
List<TypedNavGraphSpec<?, ?>> getNestedNavGraphs()
-
getRoute
abstract String getRoute()
Full route pattern that will be added to the navigation graph. Navigation arguments are not filled in.
-
getArguments
List<NamedNavArgument> getArguments()
-
getDeepLinks
List<NavDeepLink> getDeepLinks()
-
-
-
-