APIParameter class

Describes a single operation parameter.

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

Inheritance

• Object
• APIObject
• APIParameter

Implementers

• APIHeader

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?

getter/setter pair

allowReserved ↔ bool?

Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding.

getter/setter pair

castMap → Map<String, Cast>?

no setter, inherited

content ↔ Map<String, APIMediaType?>?

A map containing the representations for the parameter.

getter/setter pair

deprecated ↔ bool?

Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.

getter/setter pair

description ↔ String?

A brief description of the parameter.

getter/setter pair

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.

getter/setter pair

extensions ↔ Map<String, dynamic>

getter/setter pair, inherited

hashCode → int

The hash code for this object.

no setter, inherited

isRequired ↔ bool?

Determines whether this parameter is mandatory.

getter/setter pair

location ↔ APIParameterLocation?

The location of the parameter.

getter/setter pair

name ↔ String?

The name of the parameter.

getter/setter pair

referenceURI ↔ Uri?

getter/setter pair, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

schema ↔ APISchemaObject?

The schema defining the type used for the parameter.

getter/setter pair

style ↔ String?

Describes how the parameter value will be serialized depending on the type of the parameter value.

getter/setter pair

Methods

decode(KeyedArchive object) → void

override

encode(KeyedArchive object) → void

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited