ApiKeyPlugin class

Inheritance

• Object
• BasePlugin
• ApiKeyPlugin

Constructors

ApiKeyPlugin()

Properties

dio ↔ Dio

late, final, inherited

fromJsonUser ↔ dynamic Function(Map<String, dynamic> json)

late, final, inherited

getOptions ↔ Future<Options> Function({bool isTokenRequired})

late, final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

tokenStore ↔ TokenStore

late, final, inherited

Methods

create({String? name, int? expiresIn, String? userId, String? prefix, int? remaining, Map<String, dynamic>? metadata, int? refillAmount, int? refillInterval, int? rateLimitTimeWindow, int? rateLimitMax, bool? rateLimitEnabled}) → Future<ApiKey>

Create an API Key

delete({required String keyId}) → Future<SuccessResponse>

Delete an API key

get({required String id}) → Future<ApiKey>

Get an API key with ID

initialize({required Dio dio, required Future<Options> getOptions({bool isTokenRequired}), required TokenStore tokenStore, required dynamic fromJsonUser(Map<String, dynamic> json)}) → void

inherited

list() → Future<List<ApiKey>>

Get all API keys

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

update({required String keyId, String? name, int? expiresIn, String? userId, int? remaining, Map<String, dynamic>? metadata, int? refillAmount, int? refillInterval, int? rateLimitTimeWindow, int? rateLimitMax, bool? rateLimitEnabled}) → Future<ApiKey>

Update an API key

Operators

operator ==(Object other) → bool

The equality operator.

inherited