Parameter class abstract

Text

Available extensions
Annotations
  • @Freezed(unionKey: _unionKeyParams)

Constructors

Parameter.cookie({String? name, String? description, bool? required, bool? deprecated, String? style, bool? explode, bool? allowReserved, String? example, required Schema schema, @JsonKey(name: '\$ref') @_ParamRefConverter() String? ref})
Cookie parameter in request
const
factory
Parameter.fromJson(Map<String, dynamic> json)
factory
Parameter.header({String? name, String? description, bool? required, bool? deprecated, String? style, bool? explode, bool? allowReserved, String? example, required Schema schema, @JsonKey(name: '\$ref') @_ParamRefConverter() String? ref})
Header parameter in request
const
factory
Parameter.path({String? name, String? description, bool? deprecated, String? style, bool? explode, bool? allowReserved, String? example, Schema? schema, @JsonKey(name: '\$ref') @_ParamRefConverter() String? ref})
Path parameter in request
const
factory
Parameter.query({String? name, String? description, bool? required, bool? deprecated, String? style, bool? explode, bool? allowReserved, String? example, required Schema schema, @JsonKey(name: '\$ref') @_ParamRefConverter() String? ref})
Query parameter in request
const
factory

Properties

allowReserved → bool?
no setterinherited
copyWith → $ParameterCopyWith<Parameter>
Create a copy of Parameter with the given fields replaced by the non-null parameter values.
no setterinherited
deprecated → bool?
no setterinherited
description → String?
no setterinherited
example → String?
no setterinherited
explode → bool?
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
name → String?
no setterinherited
ref → String?
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schema → Schema?
no setterinherited
style → String?
no setterinherited

Methods

dereference({required Map<String, Parameter>? components}) → Parameter
map<TResult extends Object?>({required TResult cookie(ParameterCookie value), required TResult header(ParameterHeader value), required TResult query(ParameterQuery value), required TResult path(ParameterPath value)}) → TResult

Available on Parameter, provided by the ParameterPatterns extension

A switch-like method, using callbacks.
mapOrNull<TResult extends Object?>({TResult? cookie(ParameterCookie value)?, TResult? header(ParameterHeader value)?, TResult? query(ParameterQuery value)?, TResult? path(ParameterPath value)?}) → TResult?

Available on Parameter, provided by the ParameterPatterns extension

A variant of map that fallback to returning null.
maybeMap<TResult extends Object?>({TResult cookie(ParameterCookie value)?, TResult header(ParameterHeader value)?, TResult query(ParameterQuery value)?, TResult path(ParameterPath value)?, required TResult orElse()}) → TResult

Available on Parameter, provided by the ParameterPatterns extension

A variant of map that fallback to returning orElse.
maybeWhen<TResult extends Object?>({TResult cookie(String? name, String? description, bool? required, bool? deprecated, String? style, bool? explode, bool? allowReserved, String? example, Schema schema, String? ref)?, TResult header(String? name, String? description, bool? required, bool? deprecated, String? style, bool? explode, bool? allowReserved, String? example, Schema schema, String? ref)?, TResult query(String? name, String? description, bool? required, bool? deprecated, String? style, bool? explode, bool? allowReserved, String? example, Schema schema, String? ref)?, TResult path(String? name, String? description, bool? deprecated, String? style, bool? explode, bool? allowReserved, String? example, Schema? schema, String? ref)?, required TResult orElse()}) → TResult

Available on Parameter, provided by the ParameterPatterns extension

A variant of when that fallback to an orElse callback.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Serializes this Parameter to a JSON map.
inherited
toString() → String
A string representation of this object.
inherited
when<TResult extends Object?>({required TResult cookie(String? name, String? description, bool? required, bool? deprecated, String? style, bool? explode, bool? allowReserved, String? example, Schema schema, String? ref), required TResult header(String? name, String? description, bool? required, bool? deprecated, String? style, bool? explode, bool? allowReserved, String? example, Schema schema, String? ref), required TResult query(String? name, String? description, bool? required, bool? deprecated, String? style, bool? explode, bool? allowReserved, String? example, Schema schema, String? ref), required TResult path(String? name, String? description, bool? deprecated, String? style, bool? explode, bool? allowReserved, String? example, Schema? schema, String? ref)}) → TResult

Available on Parameter, provided by the ParameterPatterns extension

A switch-like method, using callbacks.
whenOrNull<TResult extends Object?>({TResult? cookie(String? name, String? description, bool? required, bool? deprecated, String? style, bool? explode, bool? allowReserved, String? example, Schema schema, String? ref)?, TResult? header(String? name, String? description, bool? required, bool? deprecated, String? style, bool? explode, bool? allowReserved, String? example, Schema schema, String? ref)?, TResult? query(String? name, String? description, bool? required, bool? deprecated, String? style, bool? explode, bool? allowReserved, String? example, Schema schema, String? ref)?, TResult? path(String? name, String? description, bool? deprecated, String? style, bool? explode, bool? allowReserved, String? example, Schema? schema, String? ref)?}) → TResult?

Available on Parameter, provided by the ParameterPatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool
The equality operator.
inherited