ApiKeyClient class

A class exposing functionality for users to manage API keys from the client. It is always scoped to a particular User and can only be accessed via User.apiKeys

Properties

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

Methods

create(String name) → Future<ApiKey>

Creates a new API key with the given name. The value of the returned key must be persisted as this is the only time it is available.

delete(ObjectId objectId) → Future<void>

Deletes a specific API key by id.

disable(ObjectId objectId) → Future<void>

Disables an API key by id.

enable(ObjectId objectId) → Future<void>

Enables an API key by id.

fetch(ObjectId id) → Future<ApiKey?>

Fetches a specific API key by id.

fetchAll() → Future<List<ApiKey>>

Fetches all API keys associated with the user.

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