# NavType

Artifact: [androidx.navigation:navigation-common](https://developer.android.com/jetpack/androidx/releases/navigation) [View Source](https://cs.android.com/search?q=file:androidx/navigation/NavType.+class:androidx.navigation.NavType) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/navigation#1.0.0)

*** ** * ** ***

Common/AllAndroid/JVMJavaScript
- Cmn

  ```
  abstract class NavType<T : Any?>
  ```
Known direct subclasses [CollectionNavType](https://developer.android.com/reference/kotlin/androidx/navigation/CollectionNavType), [NavType.ParcelableArrayType](https://developer.android.com/reference/kotlin/androidx/navigation/NavType.ParcelableArrayType), [NavType.ParcelableType](https://developer.android.com/reference/kotlin/androidx/navigation/NavType.ParcelableType), [NavType.SerializableArrayType](https://developer.android.com/reference/kotlin/androidx/navigation/NavType.SerializableArrayType), [NavType.SerializableType](https://developer.android.com/reference/kotlin/androidx/navigation/NavType.SerializableType)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation/CollectionNavType` | A `https://developer.android.com/reference/kotlin/androidx/navigation/NavType` for `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-collection/index.html` such as arrays, lists, maps. |
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType.ParcelableArrayType` | ParcelableArrayType is used for `https://developer.android.com/reference/kotlin/androidx/navigation/NavArgument`s which hold arrays of Parcelables. |
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType.ParcelableType` | ParcelableType is used for passing Parcelables in `https://developer.android.com/reference/kotlin/androidx/navigation/NavArgument`s. |
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType.SerializableArrayType` | SerializableArrayType is used for `https://developer.android.com/reference/kotlin/androidx/navigation/NavArgument`s that hold arrays of Serializables. |
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType.SerializableType` | SerializableType is used for Serializable `https://developer.android.com/reference/kotlin/androidx/navigation/NavArgument`s. |

Known indirect subclasses [NavType.EnumType](https://developer.android.com/reference/kotlin/androidx/navigation/NavType.EnumType)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType.EnumType` | EnumType is used for `https://developer.android.com/reference/kotlin/androidx/navigation/NavArgument`s holding enum values. |

*** ** * ** ***

NavType denotes the type that can be used in a `https://developer.android.com/reference/kotlin/androidx/navigation/NavArgument`.

There are built-in NavTypes for primitive types, such as int, long, boolean, float, and strings, parcelable, and serializable classes (including Enums), as well as arrays of each supported type.

You should only use one of the static NavType instances and subclasses defined in this class.

| Parameters |
|---|---|
| `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?>` | the type of the data that is supported by this NavType |

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/navigation/NavType.EnumType<D : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-enum/index.html<*>> : https://developer.android.com/reference/kotlin/androidx/navigation/NavType.SerializableType<D>` EnumType is used for `https://developer.android.com/reference/kotlin/androidx/navigation/NavArgument`s holding enum values. |
| `class https://developer.android.com/reference/kotlin/androidx/navigation/NavType.ParcelableArrayType<D : https://developer.android.com/reference/android/os/Parcelable.html> : https://developer.android.com/reference/kotlin/androidx/navigation/NavType<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html<D>?>` ParcelableArrayType is used for `https://developer.android.com/reference/kotlin/androidx/navigation/NavArgument`s which hold arrays of Parcelables. |
| `class https://developer.android.com/reference/kotlin/androidx/navigation/NavType.ParcelableType<D : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?> : https://developer.android.com/reference/kotlin/androidx/navigation/NavType<D>` ParcelableType is used for passing Parcelables in `https://developer.android.com/reference/kotlin/androidx/navigation/NavArgument`s. |
| `class https://developer.android.com/reference/kotlin/androidx/navigation/NavType.SerializableArrayType<D : https://developer.android.com/reference/java/io/Serializable.html> : https://developer.android.com/reference/kotlin/androidx/navigation/NavType<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html<D>?>` SerializableArrayType is used for `https://developer.android.com/reference/kotlin/androidx/navigation/NavArgument`s that hold arrays of Serializables. |
| `open class https://developer.android.com/reference/kotlin/androidx/navigation/NavType.SerializableType<D : https://developer.android.com/reference/java/io/Serializable.html> : https://developer.android.com/reference/kotlin/androidx/navigation/NavType<D>` SerializableType is used for Serializable `https://developer.android.com/reference/kotlin/androidx/navigation/NavArgument`s. |

| ### Public companion functions |
|---|---|---|
| `open https://developer.android.com/reference/kotlin/androidx/navigation/NavType<*>` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#fromArgType(kotlin.String,kotlin.String)(type: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?, packageName: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` Parse an argType string into a NavType. | Cmn android |

| ### Public companion properties |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean-array/index.html?>` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#BoolArrayType()` NavType for storing boolean arrays, corresponding with the "boolean\[\]" type in a Navigation XML file. | Cmn android |
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html>?>` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#BoolListType()` NavType for storing list of Booleans. | Cmn android |
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html>` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#BoolType()` NavType for storing boolean values, corresponding with the "boolean" type in a Navigation XML file. | Cmn android |
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float-array/index.html?>` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#FloatArrayType()` NavType for storing float arrays, corresponding with the "float\[\]" type in a Navigation XML file. | Cmn android |
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html>?>` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#FloatListType()` NavType for storing list of Floats. | Cmn android |
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html>` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#FloatType()` NavType for storing float values, corresponding with the "float" type in a Navigation XML file. | Cmn android |
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int-array/index.html?>` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#IntArrayType()` NavType for storing integer arrays, corresponding with the "integer\[\]" type in a Navigation XML file. | Cmn android |
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html>?>` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#IntListType()` NavType for storing list of Ints. | Cmn android |
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html>` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#IntType()` NavType for storing integer values, corresponding with the "integer" type in a Navigation XML file. | Cmn android |
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long-array/index.html?>` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#LongArrayType()` NavType for storing long arrays, corresponding with the "long\[\]" type in a Navigation XML file. | Cmn android |
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html>?>` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#LongListType()` NavType for storing list of Longs. | Cmn android |
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html>` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#LongType()` NavType for storing long values, corresponding with the "long" type in a Navigation XML file. | Cmn android |
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html>` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#ReferenceType()` NavType for storing integer values representing resource ids, corresponding with the "reference" type in a Navigation XML file. | android |
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html>?>` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#StringArrayType()` NavType for storing String arrays, corresponding with the "string\[\]" type in a Navigation XML file. | Cmn android |
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html>?>` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#StringListType()` NavType for storing list of Strings. | Cmn android |
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?>` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#StringType()` NavType for storing String values, corresponding with the "string" type in a Navigation XML file. | Cmn android |

| ### Public constructors |
|---|---|
| `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?> https://developer.android.com/reference/kotlin/androidx/navigation/NavType#NavType(kotlin.Boolean)(isNullableAllowed: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` | Cmn android |

| ### Public functions |
|---|---|---|
| `abstract operator T?` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#get(android.os.Bundle,kotlin.String)(bundle: https://developer.android.com/reference/android/os/Bundle.html, key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Get a value of this type from the `savedState` | android |
| `abstract operator T?` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#get(androidx.savedstate.SavedState,kotlin.String)(bundle: https://developer.android.com/reference/kotlin/androidx/savedstate/SavedState, key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Get a value of this type from the `savedState` | Cmn |
| `abstract T` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#parseValue(kotlin.String)(value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Parse a value of this type from a String. | Cmn android |
| `open T` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#parseValue(kotlin.String,kotlin.Any)(value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, previousValue: T)` Parse a value of this type from a String and then combine that parsed value with the given previousValue of the same type to provide a new value that contains both the new and previous value. | Cmn android |
| `abstract https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#put(android.os.Bundle,kotlin.String,kotlin.Any)(bundle: https://developer.android.com/reference/android/os/Bundle.html, key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, value: T)` Put a value of this type in the `savedState` | android |
| `abstract https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#put(androidx.savedstate.SavedState,kotlin.String,kotlin.Any)(bundle: https://developer.android.com/reference/kotlin/androidx/savedstate/SavedState, key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, value: T)` Put a value of this type in the `savedState` | Cmn |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#serializeAsValue(kotlin.Any)(value: T)` Serialize a value of this NavType into a String. | Cmn android |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#toString()()` | android |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#toString()()` | Cmn |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#valueEquals(kotlin.Any,kotlin.Any)(value: T, other: T)` Compares two values of type `https://developer.android.com/reference/kotlin/androidx/navigation/NavType` and returns true if values are equal. | Cmn android |

| ### Public properties |
|---|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#isNullableAllowed()` Check if an argument with this type can hold a null value. | Cmn android |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#name()` The name of this type. | Cmn android |

## Public companion functions

### fromArgType

Cmn android Added in [2.4.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.4.0)

```
open fun fromArgType(type: String?, packageName: String?): NavType<*>
```

Parse an argType string into a NavType.

| Parameters |
|---|---|
| `type: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | argType string, usually parsed from the Navigation XML file |
| `packageName: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | package name of the R file, used for parsing relative class names starting with a dot. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation/NavType<*>` | a NavType representing the type indicated by the argType string. Defaults to StringType for null. |

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if there is no valid argType |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-runtime-exception/index.html` | if the type class name cannot be found |

## Public companion properties

### BoolArrayType

Cmn android

```
val BoolArrayType: NavType<BooleanArray?>
```

NavType for storing boolean arrays, corresponding with the "boolean\[\]" type in a Navigation XML file.

Null values are supported. Default values in Navigation XML files are not supported.

### BoolListType

Cmn android

```
val BoolListType: NavType<List<Boolean>?>
```

NavType for storing list of Booleans.

Null values are supported. List NavTypes in Navigation XML files are not supported.

### BoolType

Cmn android

```
val BoolType: NavType<Boolean>
```

NavType for storing boolean values, corresponding with the "boolean" type in a Navigation XML file.

Null values are not supported.

### FloatArrayType

Cmn android

```
val FloatArrayType: NavType<FloatArray?>
```

NavType for storing float arrays, corresponding with the "float\[\]" type in a Navigation XML file.

Null values are supported. Default values in Navigation XML files are not supported.

### FloatListType

Cmn android

```
val FloatListType: NavType<List<Float>?>
```

NavType for storing list of Floats.

Null values are supported. List NavTypes in Navigation XML files are not supported.

### FloatType

Cmn android

```
val FloatType: NavType<Float>
```

NavType for storing float values, corresponding with the "float" type in a Navigation XML file.

Null values are not supported.

### IntArrayType

Cmn android

```
val IntArrayType: NavType<IntArray?>
```

NavType for storing integer arrays, corresponding with the "integer\[\]" type in a Navigation XML file.

Null values are supported. Default values in Navigation XML files are not supported.

### IntListType

Cmn android

```
val IntListType: NavType<List<Int>?>
```

NavType for storing list of Ints.

Null values are supported. List NavTypes in Navigation XML files are not supported.

### IntType

Cmn android

```
val IntType: NavType<Int>
```

NavType for storing integer values, corresponding with the "integer" type in a Navigation XML file.

Null values are not supported.

### LongArrayType

Cmn android

```
val LongArrayType: NavType<LongArray?>
```

NavType for storing long arrays, corresponding with the "long\[\]" type in a Navigation XML file.

Null values are supported. Default values in Navigation XML files are not supported.

### LongListType

Cmn android

```
val LongListType: NavType<List<Long>?>
```

NavType for storing list of Longs.

Null values are supported. List NavTypes in Navigation XML files are not supported.

### LongType

Cmn android

```
val LongType: NavType<Long>
```

NavType for storing long values, corresponding with the "long" type in a Navigation XML file.

Null values are not supported. Default values for this type in Navigation XML files must always end with an 'L' suffix, e.g. `app:defaultValue="123L"`.

### ReferenceType

android

```
val ReferenceType: NavType<Int>
```

NavType for storing integer values representing resource ids, corresponding with the "reference" type in a Navigation XML file.

Null values are not supported.

### StringArrayType

Cmn android

```
val StringArrayType: NavType<Array<String>?>
```

NavType for storing String arrays, corresponding with the "string\[\]" type in a Navigation XML file.

Null values are supported. Default values in Navigation XML files are not supported.

### StringListType

Cmn android

```
val StringListType: NavType<List<String>?>
```

NavType for storing list of Strings.

Null values are supported. List NavTypes in Navigation XML files are not supported.

### StringType

Cmn android

```
val StringType: NavType<String?>
```

NavType for storing String values, corresponding with the "string" type in a Navigation XML file.

Null values are supported.

## Public constructors

### NavType

Cmn android

```
<T : Any?> NavType(isNullableAllowed: Boolean)
```

| Parameters |
|---|---|
| `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?>` | the type of the data that is supported by this NavType |
| `isNullableAllowed: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | whether an argument with this type can hold a null value. |

## Public functions

### get

android Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/navigation#1.0.0)

```
abstract operator fun get(bundle: Bundle, key: String): T?
```

Get a value of this type from the `savedState`

| Parameters |
|---|---|
| `bundle: https://developer.android.com/reference/android/os/Bundle.html` | savedState to get value from |
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | savedState key |

| Returns |
|---|---|
| `T?` | value of this type |

### get

Cmn

```
abstract operator fun get(bundle: SavedState, key: String): T?
```

Get a value of this type from the `savedState`

| Parameters |
|---|---|
| `bundle: https://developer.android.com/reference/kotlin/androidx/savedstate/SavedState` | savedState to get value from |
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | savedState key |

| Returns |
|---|---|
| `T?` | value of this type |

### parseValue

Cmn android Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/navigation#1.0.0)

```
abstract fun parseValue(value: String): T
```

Parse a value of this type from a String.

| Parameters |
|---|---|
| `value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | string representation of a value of this type |

| Returns |
|---|---|
| `T` | parsed value of the type represented by this NavType |

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if value cannot be parsed into this type |

### parseValue

Cmn android Added in [2.6.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.6.0)

```
open fun parseValue(value: String, previousValue: T): T
```

Parse a value of this type from a String and then combine that parsed value with the given previousValue of the same type to provide a new value that contains both the new and previous value.

By default, the given value will replace the previousValue.

| Parameters |
|---|---|
| `value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | string representation of a value of this type |
| `previousValue: T` | previously parsed value of this type |

| Returns |
|---|---|
| `T` | combined parsed value of the type represented by this NavType |

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if value cannot be parsed into this type |

### put

android Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/navigation#1.0.0)

```
abstract fun put(bundle: Bundle, key: String, value: T): Unit
```

Put a value of this type in the `savedState`

| Parameters |
|---|---|
| `bundle: https://developer.android.com/reference/android/os/Bundle.html` | savedState to put value in |
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | savedState key |
| `value: T` | value of this type |

### put

Cmn

```
abstract fun put(bundle: SavedState, key: String, value: T): Unit
```

Put a value of this type in the `savedState`

| Parameters |
|---|---|
| `bundle: https://developer.android.com/reference/kotlin/androidx/savedstate/SavedState` | savedState to put value in |
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | savedState key |
| `value: T` | value of this type |

### serializeAsValue

Cmn android Added in [2.6.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.6.0)

```
open fun serializeAsValue(value: T): String
```

Serialize a value of this NavType into a String.

By default it returns value of `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/index.html` or null if value passed in is null.

This method can be override for custom serialization implementation on types such custom NavType classes.

Note: Final output should be encoded with `https://developer.android.com/reference/kotlin/androidx/navigation/NavUriUtils#encode(kotlin.String,kotlin.String)`

| Parameters |
|---|---|
| `value: T` | a value representing this NavType to be serialized into a String |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | encoded and serialized String value of `https://developer.android.com/reference/kotlin/androidx/navigation/NavType#serializeAsValue(kotlin.Any)` |

### toString

android

```
open fun toString(): String
```

### toString

Cmn

```
open fun toString(): String
```

### valueEquals

Cmn android Added in [2.8.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.8.0)

```
open fun valueEquals(value: T, other: T): Boolean
```

Compares two values of type `https://developer.android.com/reference/kotlin/androidx/navigation/NavType` and returns true if values are equal.

| Parameters |
|---|---|
| `value: T` | the first value for comparison |
| `other: T` | the second value for comparison |

## Public properties

### isNullableAllowed

Cmn android Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/navigation#1.0.0)

```
open val isNullableAllowed: Boolean
```

Check if an argument with this type can hold a null value.

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Returns true if this type allows null values, false otherwise. |

### name

Cmn android Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/navigation#1.0.0)

```
open val name: String
```

The name of this type.

This is the same value that is used in Navigation XML `argType` attribute.

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | name of this type |