Skip to content

Class AuthenticationFinishedEvent

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

Signals that an authentication attempt for a linked player has completed.

public record AuthenticationFinishedEvent : IScopedEvent, IEvent, IEquatable<AuthenticationFinishedEvent>

Inheritance

objectAuthenticationFinishedEvent

Implements

IScopedEvent, IEvent, IEquatable<AuthenticationFinishedEvent>

Inherited Members

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

Constructors

Signals that an authentication attempt for a linked player has completed.

public AuthenticationFinishedEvent(ILink Link, IPlayer Player, AuthenticationSide Side, AuthenticationResult Result)

Parameters

Link ILink

The active link whose authentication attempt completed.

Player IPlayer

The player that was authenticated.

Side AuthenticationSide

The side that handled authentication.

Result AuthenticationResult

The final authentication outcome.

Properties

The active link whose authentication attempt completed.

public ILink Link { get; init; }

Property Value

ILink

Player

The player that was authenticated.

public IPlayer Player { get; init; }

Property Value

IPlayer

Result

The final authentication outcome.

public AuthenticationResult Result { get; init; }

Property Value

AuthenticationResult

Side

The side that handled authentication.

public AuthenticationSide Side { get; init; }

Property Value

AuthenticationSide