APIParameter class Null safety

Describes a single operation parameter.

A unique parameter is defined by a combination of a name and location.

Inheritance
Implementers

Constructors

APIParameter(String? name, APIParameterLocation? location, {String? description, APISchemaObject? schema, Map<String, APIMediaType?>? content, String? style, bool? isRequired, bool? deprecated, bool? allowEmptyValue, bool? explode, bool? allowReserved})
APIParameter.cookie(String? name, {String? description, APISchemaObject? schema, Map<String, APIMediaType?>? content, String? style, bool? isRequired, bool? deprecated, bool? allowEmptyValue, bool? explode, bool? allowReserved})
APIParameter.empty()
APIParameter.header(String? name, {String? description, APISchemaObject? schema, Map<String, APIMediaType?>? content, String? style, bool? isRequired, bool? deprecated, bool? allowEmptyValue, bool? explode, bool? allowReserved})
APIParameter.path(String? name)
APIParameter.query(String? name, {String? description, APISchemaObject? schema, Map<String, APIMediaType?>? content, String? style, bool? isRequired, bool? deprecated, bool? allowEmptyValue, bool? explode, bool? allowReserved})

Properties

allowEmptyValue bool?
read / write
allowReserved bool?
Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. [...]
read / write
castMap Map<String, Cast>?
read-only, inherited
content Map<String, APIMediaType?>?
A map containing the representations for the parameter. [...]
read / write
deprecated bool?
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
read / write
description String?
A brief description of the parameter. [...]
read / write
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
extensions Map<String, dynamic>
read / write, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
isRequired bool?
Determines whether this parameter is mandatory. [...]
read / write
location APIParameterLocation?
The location of the parameter. [...]
read / write
name String?
The name of the parameter. [...]
read / write
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
style String?
Describes how the parameter value will be serialized depending on the type of the parameter value. [...]
read / write

Methods

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
A string representation of this object. [...]
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited