NavArgument denotes an argument that is supported by a NavDestination.

A NavArgument has a type and optionally a default value, that are used to read/write it in a SavedState. It can also be nullable if the type supports it.

Summary

Nested types

A builder for constructing NavArgument instances.

Public functions
open operator Boolean
equals(other: Any?)
Cmn
open Int
Cmn
open String
Cmn

Public properties
Any?

The default value of this argument or null if it doesn't have a default value.
Cmn
Boolean

Used to distinguish between a default value of null and an argument without an explicit default value.
Cmn
Boolean

Whether this argument allows passing a null value.
Cmn
NavType<Any?>

The type of this NavArgument.
Cmn

Public functions

equals

Cmn 
open operator fun equals(other: Any?): Boolean

hashCode

Cmn 
open fun hashCode(): Int

toString

Cmn 
open fun toString(): String

Public properties

defaultValue

Cmn
Added in 1.0.0
val defaultValue: Any?

The default value of this argument or null if it doesn't have a default value. Use isDefaultValuePresent to distinguish between null and absence of a value.

Returns
Any?

The default value assigned to this argument.

isDefaultValuePresent

Cmn
Added in 1.0.0
val isDefaultValuePresent: Boolean

Used to distinguish between a default value of null and an argument without an explicit default value.

Returns
Boolean

true if this argument has a default value (even if that value is set to null), false otherwise

isNullable

Cmn
Added in 1.0.0
val isNullable: Boolean

Whether this argument allows passing a null value.

Returns
Boolean

true if null is allowed, false otherwise

type

Cmn
Added in 1.0.0
val type: NavType<Any?>

The type of this NavArgument.

Returns
NavType<Any?>

the NavType object denoting the type that can be help in this argument.