ApiKey class abstract

An API key.

key is the full secret and is returned only when the key is created — it is null on list/get, where only start (a display prefix) is available.

Available extensions

• ApiKeyPatterns

Annotations

• @freezed

Constructors

ApiKey({required String id, String? name, String? start, String? prefix, String? key, String? userId, @Default.new(true) bool enabled, int? remaining, int? refillAmount, int? refillInterval, bool? rateLimitEnabled, int? rateLimitMax, int? rateLimitTimeWindow, int? requestCount, DateTime? lastRequest, DateTime? expiresAt, DateTime? createdAt, DateTime? updatedAt, Map<String, dynamic>? metadata})

const

factory

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

factory

Properties

copyWith → $ApiKeyCopyWith<ApiKey>

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

no setter, inherited

createdAt → DateTime?

no setter, inherited

enabled → bool

no setter, inherited

expiresAt → DateTime?

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id → String

no setter, inherited

key → String?

The full key, present only in the create response.

no setter, inherited

lastRequest → DateTime?

no setter, inherited

metadata → Map<String, dynamic>?

no setter, inherited

name → String?

no setter, inherited

prefix → String?

no setter, inherited

rateLimitEnabled → bool?

no setter, inherited

rateLimitMax → int?

no setter, inherited

rateLimitTimeWindow → int?

no setter, inherited

refillAmount → int?

no setter, inherited

refillInterval → int?

no setter, inherited

remaining → int?

no setter, inherited

requestCount → int?

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

start → String?

no setter, inherited

updatedAt → DateTime?

no setter, inherited

userId → String?

no setter, inherited

Methods

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

Available on ApiKey, provided by the ApiKeyPatterns extension

A switch-like method, using callbacks.

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

Available on ApiKey, provided by the ApiKeyPatterns extension

A variant of map that fallback to returning null.

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

Available on ApiKey, provided by the ApiKeyPatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>(TResult $default(String id, String? name, String? start, String? prefix, String? key, String? userId, bool enabled, int? remaining, int? refillAmount, int? refillInterval, bool? rateLimitEnabled, int? rateLimitMax, int? rateLimitTimeWindow, int? requestCount, DateTime? lastRequest, DateTime? expiresAt, DateTime? createdAt, DateTime? updatedAt, Map<String, dynamic>? metadata)?, {required TResult orElse()}) → TResult

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

inherited

toString() → String

A string representation of this object.

inherited

when<TResult extends Object?>(TResult $default(String id, String? name, String? start, String? prefix, String? key, String? userId, bool enabled, int? remaining, int? refillAmount, int? refillInterval, bool? rateLimitEnabled, int? rateLimitMax, int? rateLimitTimeWindow, int? requestCount, DateTime? lastRequest, DateTime? expiresAt, DateTime? createdAt, DateTime? updatedAt, Map<String, dynamic>? metadata)) → TResult

Available on ApiKey, provided by the ApiKeyPatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>(TResult? $default(String id, String? name, String? start, String? prefix, String? key, String? userId, bool enabled, int? remaining, int? refillAmount, int? refillInterval, bool? rateLimitEnabled, int? rateLimitMax, int? rateLimitTimeWindow, int? requestCount, DateTime? lastRequest, DateTime? expiresAt, DateTime? createdAt, DateTime? updatedAt, Map<String, dynamic>? metadata)?) → TResult?

Available on ApiKey, provided by the ApiKeyPatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool

The equality operator.

inherited