Response class abstract

A container for the expected responses of an operation.

The container maps a HTTP response code to the expected response.

https://swagger.io/specification/#response-object

Available extensions
Annotations
  • @freezed

Constructors

Response({@Default.new('') String description, Map<String, Header>? headers, Map<String, MediaType>? content, Map<String, Link>? links, @JsonKey.new(name: '\$ref') @_ResponseRefConverter.new() String? ref})
const
factory
Response.fromJson(Map<String, dynamic> json)
factory

Properties

content → Map<String, MediaType>?
A map containing descriptions of potential response payloads.
no setterinherited
copyWith → $ResponseCopyWith<Response>
Create a copy of Response with the given fields replaced by the non-null parameter values.
no setterinherited
description → String
A description of the response
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
headers → Map<String, Header>?
Maps a header name to its definition. RFC7230 states header names are case insensitive.
no setterinherited
A map containing descriptions of potential response payloads.
no setterinherited
ref → String?
Reference to a response defined in Components.responses
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

dereference({required Map<String, Response>? components}) → Response
map<TResult extends Object?>(TResult $default(_Response value)) → TResult

Available on Response, provided by the ResponsePatterns extension

A switch-like method, using callbacks.
mapOrNull<TResult extends Object?>(TResult? $default(_Response value)?) → TResult?

Available on Response, provided by the ResponsePatterns extension

A variant of map that fallback to returning null.
maybeMap<TResult extends Object?>(TResult $default(_Response value)?, {required TResult orElse()}) → TResult

Available on Response, provided by the ResponsePatterns extension

A variant of map that fallback to returning orElse.
maybeWhen<TResult extends Object?>(TResult $default(String description, Map<String, Header>? headers, Map<String, MediaType>? content, Map<String, Link>? links, String? ref)?, {required TResult orElse()}) → TResult

Available on Response, provided by the ResponsePatterns 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 Response to a JSON map.
inherited
toString() → String
A string representation of this object.
inherited
when<TResult extends Object?>(TResult $default(String description, Map<String, Header>? headers, Map<String, MediaType>? content, Map<String, Link>? links, String? ref)) → TResult

Available on Response, provided by the ResponsePatterns extension

A switch-like method, using callbacks.
whenOrNull<TResult extends Object?>(TResult? $default(String description, Map<String, Header>? headers, Map<String, MediaType>? content, Map<String, Link>? links, String? ref)?) → TResult?

Available on Response, provided by the ResponsePatterns extension

A variant of when that fallback to returning null

Operators

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