RequestBody class abstract

Describes a single request body.

This class represents a request body definition in an OpenAPI document, including its description, content, and whether it is required.

Available extensions
Annotations
  • @Freezed(copyWith: true, fromJson: true, toJson: true, equal: true)

Constructors

RequestBody.new({String? description, @JsonKey(name: 'required') bool? $required, @Default({}) Map<String, MediaType> content})
Creates a RequestBody object.
const
factory
RequestBody.fromJson(Map<String, dynamic> json)
Creates a RequestBody from a JSON object.
factory

Properties

$required → bool?
Determines if the request body is required.
no setterinherited
content → Map<String, MediaType>
The content of the request body, mapped by media type.
no setterinherited
copyWith → $RequestBodyCopyWith<RequestBody>
Create a copy of RequestBody with the given fields replaced by the non-null parameter values.
no setterinherited
description → String?
A brief description of the request body.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

map<TResult extends Object?>(TResult $default(_RequestBody value)) → TResult

Available on RequestBody, provided by the RequestBodyPatterns extension

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

Available on RequestBody, provided by the RequestBodyPatterns extension

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

Available on RequestBody, provided by the RequestBodyPatterns extension

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

Available on RequestBody, provided by the RequestBodyPatterns 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 RequestBody to a JSON map.
inherited
toString() → String
A string representation of this object.
inherited
when<TResult extends Object?>(TResult $default(String? description, bool? $required, Map<String, MediaType> content)) → TResult

Available on RequestBody, provided by the RequestBodyPatterns extension

A switch-like method, using callbacks.
whenOrNull<TResult extends Object?>(TResult? $default(String? description, bool? $required, Map<String, MediaType> content)?) → TResult?

Available on RequestBody, provided by the RequestBodyPatterns extension

A variant of when that fallback to returning null

Operators

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