# SavedStateHandleKt

Added in 2.8.0

*** ** * ** ***


```
public final class SavedStateHandleKt
```

<br />

*** ** * ** ***

## Summary

| ### Public methods |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull T` | `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/navigation/SavedStateHandleKt#(androidx.lifecycle.SavedStateHandle).toRoute(kotlin.collections.Map)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/lifecycle/SavedStateHandle receiver, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-type/index.html, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavType<@https://developer.android.com/reference/androidx/annotation/NonNull ?>> typeMap )` Returns route as an object of type `https://developer.android.com/reference/androidx/navigation/package-summary#(androidx.lifecycle.SavedStateHandle).toRoute(kotlin.collections.Map)` |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull T` | `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/navigation/SavedStateHandleKt#(androidx.lifecycle.SavedStateHandle).toRoute(kotlin.reflect.KClass,kotlin.collections.Map)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/lifecycle/SavedStateHandle receiver, @https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-class/index.html<@https://developer.android.com/reference/androidx/annotation/NonNull T> route, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-type/index.html, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavType<@https://developer.android.com/reference/androidx/annotation/NonNull ?>> typeMap )` Returns route as an object of type `https://developer.android.com/reference/androidx/navigation/package-summary#(androidx.lifecycle.SavedStateHandle).toRoute(kotlin.reflect.KClass,kotlin.collections.Map)` |

## Public methods

### toRoute

Artifact: [androidx.navigation:navigation-common](https://developer.android.com/jetpack/androidx/releases/navigation) [View Source](https://cs.android.com/search?q=file:androidx/navigation/SavedStateHandle.kt+function:toRoute)

```
public static final @NonNull T <T extends Object> toRoute(
    @NonNull SavedStateHandle receiver,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap
)
```

Returns route as an object of type `https://developer.android.com/reference/androidx/navigation/package-summary#(androidx.lifecycle.SavedStateHandle).toRoute(kotlin.collections.Map)`

Extrapolates arguments from `https://developer.android.com/reference/androidx/lifecycle/SavedStateHandle` and recreates object `https://developer.android.com/reference/androidx/navigation/package-summary#(androidx.lifecycle.SavedStateHandle).toRoute(kotlin.collections.Map)`

| Parameters |
|---|---|
| `<T extends https://developer.android.com/reference/java/lang/Object.html>` | the entry's `https://developer.android.com/reference/androidx/navigation/NavDestination#route()` as a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-class/index.html` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-type/index.html, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavType<@https://developer.android.com/reference/androidx/annotation/NonNull ?>> typeMap` | A mapping of KType to custom NavType\<\*\> in `https://developer.android.com/reference/androidx/navigation/package-summary#(androidx.lifecycle.SavedStateHandle).toRoute(kotlin.collections.Map)`. May be empty if `https://developer.android.com/reference/androidx/navigation/package-summary#(androidx.lifecycle.SavedStateHandle).toRoute(kotlin.collections.Map)` does not use custom NavTypes. |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull T` | A new instance of this entry's `https://developer.android.com/reference/androidx/navigation/NavDestination#route()` as an object of type `https://developer.android.com/reference/androidx/navigation/package-summary#(androidx.lifecycle.SavedStateHandle).toRoute(kotlin.collections.Map)` |

### toRoute

Artifact: [androidx.navigation:navigation-common](https://developer.android.com/jetpack/androidx/releases/navigation) [View Source](https://cs.android.com/search?q=file:androidx/navigation/SavedStateHandle.kt+function:toRoute) Added in [2.9.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.9.0)

```
public static final @NonNull T <T extends Object> toRoute(
    @NonNull SavedStateHandle receiver,
    @NonNull KClass<@NonNull T> route,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap
)
```

Returns route as an object of type `https://developer.android.com/reference/androidx/navigation/package-summary#(androidx.lifecycle.SavedStateHandle).toRoute(kotlin.reflect.KClass,kotlin.collections.Map)`

Extrapolates arguments from `https://developer.android.com/reference/androidx/lifecycle/SavedStateHandle` and recreates object `https://developer.android.com/reference/androidx/navigation/package-summary#(androidx.lifecycle.SavedStateHandle).toRoute(kotlin.reflect.KClass,kotlin.collections.Map)`

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-class/index.html<@https://developer.android.com/reference/androidx/annotation/NonNull T> route` | the entry's `https://developer.android.com/reference/androidx/navigation/NavDestination#route()` as a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-class/index.html` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-type/index.html, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavType<@https://developer.android.com/reference/androidx/annotation/NonNull ?>> typeMap` | A mapping of KType to custom NavType\<\*\> in `https://developer.android.com/reference/androidx/navigation/package-summary#(androidx.lifecycle.SavedStateHandle).toRoute(kotlin.reflect.KClass,kotlin.collections.Map)`. May be empty if `https://developer.android.com/reference/androidx/navigation/package-summary#(androidx.lifecycle.SavedStateHandle).toRoute(kotlin.reflect.KClass,kotlin.collections.Map)` does not use custom NavTypes. |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull T` | A new instance of this entry's `https://developer.android.com/reference/androidx/navigation/NavDestination#route()` as an object of type `https://developer.android.com/reference/androidx/navigation/package-summary#(androidx.lifecycle.SavedStateHandle).toRoute(kotlin.reflect.KClass,kotlin.collections.Map)` |