ExternalDocs class abstract

Allows referencing an external resource for extended documentation. https://swagger.io/specification/#external-documentation-object

Available extensions
Annotations
  • @freezed

Constructors

ExternalDocs({String? description, required String url})
const
factory
ExternalDocs.fromJson(Map<String, dynamic> json)
factory

Properties

copyWith → $ExternalDocsCopyWith<ExternalDocs>
Create a copy of ExternalDocs with the given fields replaced by the non-null parameter values.
no setterinherited
description → String?
A description of the target documentation.
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
url → String
The URL for the target documentation. This must be in the form of a URL.
no setterinherited

Methods

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

Available on ExternalDocs, provided by the ExternalDocsPatterns extension

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

Available on ExternalDocs, provided by the ExternalDocsPatterns extension

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

Available on ExternalDocs, provided by the ExternalDocsPatterns extension

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

Available on ExternalDocs, provided by the ExternalDocsPatterns 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 ExternalDocs to a JSON map.
inherited
toString() → String
A string representation of this object.
inherited
when<TResult extends Object?>(TResult $default(String? description, String url)) → TResult

Available on ExternalDocs, provided by the ExternalDocsPatterns extension

A switch-like method, using callbacks.
whenOrNull<TResult extends Object?>(TResult? $default(String? description, String url)?) → TResult?

Available on ExternalDocs, provided by the ExternalDocsPatterns extension

A variant of when that fallback to returning null

Operators

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