ApiKey class abstract

Available extensions

• ApiKeyPatterns

Annotations

• @freezed

Constructors

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

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?

no setter, inherited

lastRefillAt → DateTime?

no setter, inherited

lastRequest → DateTime?

no setter, inherited

metadata → Map<String, dynamic>?

no setter, inherited

name → String?

no setter, inherited

permissions → String?

no setter, inherited

prefix → String?

no setter, inherited

rateLimitEnabled → bool?

no setter, inherited

rateLimitMax → double?

no setter, inherited

rateLimitTimeWindow → double?

no setter, inherited

refillAmount → double?

no setter, inherited

refillInterval → double?

no setter, inherited

remaining → double?

no setter, inherited

requestCount → double?

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, DateTime? expiresAt, DateTime createdAt, DateTime? updatedAt, DateTime? lastRefillAt, DateTime? lastRequest, Map<String, dynamic>? metadata, double? rateLimitMax, double? rateLimitTimeWindow, double? remaining, double? refillAmount, double? refillInterval, bool? rateLimitEnabled, double? requestCount, String? permissions)?, {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, DateTime? expiresAt, DateTime createdAt, DateTime? updatedAt, DateTime? lastRefillAt, DateTime? lastRequest, Map<String, dynamic>? metadata, double? rateLimitMax, double? rateLimitTimeWindow, double? remaining, double? refillAmount, double? refillInterval, bool? rateLimitEnabled, double? requestCount, String? permissions)) → 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, DateTime? expiresAt, DateTime createdAt, DateTime? updatedAt, DateTime? lastRefillAt, DateTime? lastRequest, Map<String, dynamic>? metadata, double? rateLimitMax, double? rateLimitTimeWindow, double? remaining, double? refillAmount, double? refillInterval, bool? rateLimitEnabled, double? requestCount, String? permissions)?) → 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