DestinationParameters class

Base destination parameters.

Extend this class to define your custom parameters class. Use Destination<YourCustomDestinationParameters>() to make a destination aware of your custom parameters.

For custom parameters you also must implement YouCustomDestinationParser<YourCustomDestinationParameters> with toDestinationParameters() ans toMap() methods, like this:

class YourCustomDestinationParser
    extends DestinationParser<YourCustomDestinationParameters> {
  const YourCustomDestinationParser() : super();

  @override
  YourCustomDestinationParameters toDestinationParameters(
      Map<String, String> map) {
      //...
  }

  @override
  Map<String, String> toMap(YourCustomDestinationParameters parameters) {
      //...
  }
}

See also:

Constructors

DestinationParameters([Map<String, String>? map])
Creates a DestinationParameters instance.

Properties

hashCode → int
The hash code for this object.
no setterinherited
map ↔ Map<String, String>
Contains parameter values parsed from the destination's URI.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

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.
inherited

Static Methods

isReservedParameter(String parameterName) → bool
Check if a provided parameter name is reserved

Constants

stateParameterName → const String
Reserved query parameter name.