# NavigationEventHistory

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

*** ** * ** ***


```
public final class NavigationEventHistory
```

<br />

*** ** * ** ***

Represents an immutable snapshot of the navigation history stack.

This object tracks the combined navigation stack (`https://developer.android.com/reference/androidx/navigationevent/NavigationEventHistory#mergedHistory()`) from the root to the currently active destination, indicated by `https://developer.android.com/reference/androidx/navigationevent/NavigationEventHistory#(androidx.navigationevent.NavigationEventInfo,kotlin.collections.List,kotlin.collections.List,kotlin.Int)`.

This state is explicitly separate from transition state (which tracks gesture progress). `https://developer.android.com/reference/androidx/navigationevent/NavigationEventHistory` is stable during gestures and only updates when the active handler changes or when the active handler's info (its local stack) is updated.

## Summary

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/navigationevent/NavigationEventHistory#equals(kotlin.Any)(https://developer.android.com/reference/java/lang/Object.html other)` |
| `final int` | `https://developer.android.com/reference/androidx/navigationevent/NavigationEventHistory#getCurrentIndex()()` Index of current in mergedHistory. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigationevent/NavigationEventInfo>` | `https://developer.android.com/reference/androidx/navigationevent/NavigationEventHistory#getMergedHistory()()` Combined stack from root to leaf. |
| `int` | `https://developer.android.com/reference/androidx/navigationevent/NavigationEventHistory#hashCode()()` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/navigationevent/NavigationEventHistory#toString()()` |

## Public methods

### equals

```
public boolean equals(Object other)
```

### getCurrentIndex

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

```
public final int getCurrentIndex()
```

Index of current in mergedHistory.

### getMergedHistory

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

```
public final @NonNull List<@NonNull NavigationEventInfo> getMergedHistory()
```

Combined stack from root to leaf.

### hashCode

```
public int hashCode()
```

### toString

```
public @NonNull String toString()
```