Class AuthenticationStartedEvent

Namespace: Void.Proxy.Api.Events.Authentication
Assembly: Void.Proxy.Api.dll

public record AuthenticationStartedEvent : IScopedEventWithResult<AuthenticationResult>, IScopedEvent, IEventWithResult<AuthenticationResult>, IEvent, IEquatable<AuthenticationStartedEvent>

Inheritance

object ← AuthenticationStartedEvent

Implements

IScopedEventWithResult<AuthenticationResult>, IScopedEvent, IEventWithResult<AuthenticationResult>, IEvent, IEquatable<AuthenticationStartedEvent>

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Constructors

AuthenticationStartedEvent(ILink, IPlayer, AuthenticationSide)

public AuthenticationStartedEvent(ILink Link, IPlayer Player, AuthenticationSide Side)

Parameters

Link ILink

Player IPlayer

Side AuthenticationSide

Properties

Link

public ILink Link { get; init; }

Property Value

ILink

Player

public IPlayer Player { get; init; }

Property Value

IPlayer

Result

Gets or sets the authentication decision produced by listeners for this event.

public AuthenticationResult? Result { get; set; }

Property Value

AuthenticationResult?

Examples

var result = await events.ThrowWithResultAsync(authenticationStartedEvent, cancellationToken)
    ?? AuthenticationResult.NoResult;

Remarks

The event dispatcher returns this property from .

Callers commonly coalesce null to to represent an unresolved state.

See Also

AuthenticationResult.NoResult

Side

public AuthenticationSide Side { get; init; }

Property Value

AuthenticationSide