APIResponse class

Describes a single response from an API Operation, including design-time, static links to operations based on the response.

Inheritance

Constructors

APIResponse(String description, { Map<String, APIMediaType> content, Map<String, APIHeader> headers })
APIResponse.empty()
APIResponse.schema(String description, APISchemaObject schema, { Iterable<String> contentTypes: const ["application/json"], Map<String, APIHeader> headers })

Properties

content ↔ Map<String, APIMediaType>
A map containing descriptions of potential response payloads. [...]
read / write
description ↔ String
A short description of the response. [...]
read / write
headers ↔ Map<String, APIHeader>
Maps a header name to its definition. [...]
read / write
castMap → Map<String, Cast>
read-only, inherited
extensions ↔ Map<String, dynamic>
read / write, inherited
hashCode → int
The hash code for this object.
read-only, inherited
referenceURI ↔ Uri
read / write, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

addContent(String contentType, APISchemaObject bodyObject) → void
Adds a bodyObject to content for a content-type. [...]
addHeader(String name, APIHeader header) → void
Adds a header to headers for name. [...]
decode(KeyedArchive object) → void
override
encode(KeyedArchive object) → void
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

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