Represents a snapshot of the visible destinations in a navigation container.

This class provides the necessary context for building animations during navigation gestures, like predictive back. It's a simple data holder that feeds into the NavigationEventHistory.

Note: title and url are retrieved from Scene.metadata, which by default only includes the metadata of the last NavEntry in Scene.entries. For example, if a scene renders listOf(entryA, entryB), title and url will be populated only if entryB contains the metadata.

Summary

Public constructors

<T : Any> SceneInfo(scene: Scene<T>)

Binary-compatible constructor for callers compiled against versions without title and url.

Cmn
<T : Any> SceneInfo(scene: Scene<T>, title: String?, url: String?)
Cmn

Public functions

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

Public properties

Scene<T>

The scene whose state is used by the NavigationEvent

Cmn
open String?

The resolved window or destination title associated with scene, or null if unspecified.

Cmn
open String?

The resolved URL or path representation associated with scene, or null if unspecified.

Cmn

Public constructors

SceneInfo

<T : Any> SceneInfo(scene: Scene<T>)

Binary-compatible constructor for callers compiled against versions without title and url.

SceneInfo

<T : Any> SceneInfo(scene: Scene<T>, title: String? = null, url: String? = null)

Public functions

equals

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

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

scene

val scene: Scene<T>

The scene whose state is used by the NavigationEvent

title

open val title: String?

The resolved window or destination title associated with scene, or null if unspecified.

url

open val url: String?

The resolved URL or path representation associated with scene, or null if unspecified.