SecurityScheme class abstract

Represents a single security scheme object for OpenAPI 2.0.

Available extensions

• SecuritySchemePatterns

Annotations

• @Freezed.new(copyWith: true, fromJson: true, toJson: true, equal: true)

Constructors

SecurityScheme({required String type, String? description, String? name, @JsonKey.new(name: 'in') ParameterLocation? location, String? scheme, String? bearerFormat, String? flow, String? authorizationUrl, Map<String, String>? scopes})

Creates a SecurityScheme object.

const

factory

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

Creates a SecurityScheme from a JSON object.

factory

Properties

authorizationUrl → String?

The authorization URL to be used for this flow.

no setter, inherited

bearerFormat → String?

A hint to the client to identify the bearer token scheme.

no setter, inherited

copyWith → $SecuritySchemeCopyWith<SecurityScheme>

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

no setter, inherited

description → String?

A short description of the security scheme.

no setter, inherited

flow → String?

The flow used by the OAuth2 security scheme.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

location → ParameterLocation?

The location of the API key.

no setter, inherited

name → String?

The name of the header, query, or cookie parameter to be used.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scheme → String?

The name of the HTTP Authorization scheme to be used in the Authorization header.

no setter, inherited

scopes → Map<String, String>?

The available scopes for the OAuth2 flow.

no setter, inherited

type → String

The type of the security scheme.

no setter, inherited

Methods

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

Available on SecurityScheme, provided by the SecuritySchemePatterns extension

A switch-like method, using callbacks.

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

Available on SecurityScheme, provided by the SecuritySchemePatterns extension

A variant of map that fallback to returning null.

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

Available on SecurityScheme, provided by the SecuritySchemePatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>(TResult $default(String type, String? description, String? name, ParameterLocation? location, String? scheme, String? bearerFormat, String? flow, String? authorizationUrl, Map<String, String>? scopes)?, {required TResult orElse()}) → TResult

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

inherited

toString() → String

A string representation of this object.

inherited

when<TResult extends Object?>(TResult $default(String type, String? description, String? name, ParameterLocation? location, String? scheme, String? bearerFormat, String? flow, String? authorizationUrl, Map<String, String>? scopes)) → TResult

Available on SecurityScheme, provided by the SecuritySchemePatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>(TResult? $default(String type, String? description, String? name, ParameterLocation? location, String? scheme, String? bearerFormat, String? flow, String? authorizationUrl, Map<String, String>? scopes)?) → TResult?

Available on SecurityScheme, provided by the SecuritySchemePatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool

The equality operator.

inherited