BeamState class

A state for BeamerDelegate and BeamLocation.

Helps in building the pages and creates an URI.

Constructors

BeamState({List<String> pathBlueprintSegments = const <String>[], Map<String, String> pathParameters = const <String, String>{}, Map<String, String> queryParameters = const <String, String>{}, Map<String, dynamic> data = const <String, dynamic>{}})

BeamState.fromUri(Uri uri, {BeamLocation<BeamState>? beamLocation, Map<String, dynamic> data = const <String, dynamic>{}})

Creates a BeamState from given uri and optional data.

factory

BeamState.fromUriString(String uriString, {BeamLocation<BeamState>? beamLocation, Map<String, dynamic> data = const <String, dynamic>{}})

Creates a BeamState from given uriString and optional data.

factory

Properties

data → Map<String, dynamic>

Custom key/value data for arbitrary use.

final

hashCode → int

The hash code for this object.

no setter, override

pathBlueprintSegments → List<String>

Path segments of the current URI, in the form as it's defined in BeamLocation.pathBlueprints.

final

pathParameters → Map<String, String>

Path parameters from the URI, in the form as it's defined in BeamLocation.pathBlueprints.

final

queryParameters → Map<String, String>

Query parameters of the current URI.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

uri → Uri

Current URI object in the "real form", as it should be shown in browser's URL bar.

no setter

uriBlueprint → Uri

Current URI object in the "blueprint form", as it's defined in BeamLocation.pathBlueprints.

no setter

Methods

configure() → void

Constructs uriBlueprint and uri.

copyForLocation(BeamLocation<BeamState> beamLocation) → BeamState

Copies this with configuration for specific BeamLocation.

copyWith({List<String>? pathBlueprintSegments, Map<String, String>? pathParameters, Map<String, String>? queryParameters, Map<String, dynamic>? data}) → BeamState

Returns a configured copy of this.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

override