Example class abstract

Text

Available extensions

• ExamplePatterns

Annotations

• @freezed

Constructors

Example({String? summary, String? description, dynamic value, String? externalValue, @JsonKey.new(name: '\$ref') @_ExampleRefConverter.new() String? ref})

const

factory

Example.fromJson(Map<String, dynamic> json)

factory

Properties

copyWith → $ExampleCopyWith<Example>

Create a copy of Example with the given fields replaced by the non-null parameter values.

no setter, inherited

description → String?

Long description for the example.

no setter, inherited

externalValue → String?

A URI that points to the literal example.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

ref → String?

Reference to a response defined in Components.examples

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

summary → String?

Short description for the example.

no setter, inherited

value → dynamic

Embedded literal example

no setter, inherited

Methods

dereference({required Map<String, Example>? components}) → Example

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

Available on Example, provided by the ExamplePatterns extension

A switch-like method, using callbacks.

mapOrNull<TResult extends Object?>(TResult? $default(ExampleObject value)?) → TResult?

Available on Example, provided by the ExamplePatterns extension

A variant of map that fallback to returning null.

maybeMap<TResult extends Object?>(TResult $default(ExampleObject value)?, {required TResult orElse()}) → TResult

Available on Example, provided by the ExamplePatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>(TResult $default(String? summary, String? description, dynamic value, String? externalValue, String? ref)?, {required TResult orElse()}) → TResult

Available on Example, provided by the ExamplePatterns 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 Example to a JSON map.

inherited

toString() → String

A string representation of this object.

inherited

when<TResult extends Object?>(TResult $default(String? summary, String? description, dynamic value, String? externalValue, String? ref)) → TResult

Available on Example, provided by the ExamplePatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>(TResult? $default(String? summary, String? description, dynamic value, String? externalValue, String? ref)?) → TResult?

Available on Example, provided by the ExamplePatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool

The equality operator.

inherited