MagicLinkPlugin<TContext> class final

Opt-in email magic-link server plugin.

The plugin contributes provider metadata and host-owned route contracts. Durable token replacement and token/user consumption are delegated to the required AuthMagicLinkBackend. Email delivery and host session/cookie issuance happen after those backend commits and are intentionally not part of the database transaction.

Inheritance

• Object
• AuthProvider
• MagicLinkPlugin

Implemented types

• AuthMagicLinkProvider
• AuthServerPlugin<TContext>
• AuthHostEndpointContributor<TContext>
• AuthPersistenceContributor
• AuthClientOperationContributor
• AuthRateLimitContributor
• AuthAuthenticationMethodInventoryContributor
• AuthAuthenticationMethodInventoryBinding

Constructors

MagicLinkPlugin({String id = 'email', String name = 'Email', required AuthMagicLinkSender<TContext> sendMagicLink, Duration tokenExpiry = const Duration(minutes: 15), String tokenGenerator()?})

Properties

authenticationMethodKinds → Set<AuthAuthenticationMethodKind>

no setter, override

authenticationMethodNamespace → String

no setter, override

authenticationMethodStore → Object

no setter, override

backend → AuthMagicLinkBackend

no setter

clientOperations → Iterable<AuthClientOperationDescriptor>

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

hostEndpoints → Iterable<AuthEndpointDescriptor<TContext>>

no setter, override

id → String

Provider identifier used in callback routes.

final, inherited

name → String

Human-readable provider name.

final, inherited

persistenceSchemas → Iterable<AuthPersistenceSchema>

no setter, override

rateLimitOperations → Iterable<AuthRateLimitOperation>

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sendMagicLink → AuthMagicLinkSender<TContext>

final

tokenExpiry → Duration

final

tokenGenerator → String Function()?

final

type → AuthProviderType

Provider category.

final, inherited

Methods

authenticationMethodInventory(AuthStore store) → AuthAuthenticationMethodInventoryContributor

Builds this provider's authoritative usable-method inventory.

override

authenticationMethodsForUser(String userId) → Future<AuthAuthenticationMethodSnapshot>

override

configure(AuthServerPluginContext<TContext> context) → void

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

redacted() → AuthProvider

Creates a provider metadata projection safe for events and audit logs.

inherited

sendVerification(AuthContext context, AuthEmailRequest request) → Future<void>

override

toJson() → Map<String, dynamic>

Summary payload used by /auth/providers.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited