APIHeader class

APIHeader follows the structure of the APIParameter with the following changes:

name MUST NOT be specified, it is given in the corresponding headers map. in MUST NOT be specified, it is implicitly in header. All traits that are affected by the location MUST be applicable to a location of header (for example, style).

Inheritance

Constructors

APIHeader({APISchemaObject schema })
APIHeader.empty()

Properties

allowEmptyValue ↔ bool
read / write, inherited
allowReserved ↔ bool
Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. [...]
read / write, inherited
castMap → Map<String, Cast>
read-only, inherited
content ↔ Map<String, APIMediaType>
A map containing the representations for the parameter. [...]
read / write, inherited
description ↔ String
A brief description of the parameter. [...]
read / write, inherited
explode ↔ bool
When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. [...]
read / write, inherited
extensions ↔ Map<String, dynamic>
read / write, inherited
hashCode → int
The hash code for this object.
read-only, inherited
isDeprecated ↔ bool
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
read / write, inherited
isRequired ↔ bool
Determines whether this parameter is mandatory. [...]
read / write, inherited
location APIParameterLocation
The location of the parameter. [...]
read / write, inherited
name ↔ String
The name of the parameter. [...]
read / write, inherited
referenceURI ↔ Uri
read / write, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited
schema APISchemaObject
The schema defining the type used for the parameter.
read / write, inherited
style ↔ String
Describes how the parameter value will be serialized depending on the type of the parameter value. [...]
read / write, inherited

Methods

encode(KeyedArchive object) → void
override
decode(KeyedArchive object) → void
inherited
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