API reference

Class DiscordIngressSignatureValidationResult

Namespace

DisCatSharp.Hosting.AspNetCore.Ingress.Security

Assembly

DisCatSharp.Hosting.AspNetCore.dll

Represents the outcome of an ingress signature validation attempt.

public sealed class DiscordIngressSignatureValidationResult

Inheritance

object

DiscordIngressSignatureValidationResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

NotValidated indicates that no registered validator claimed the request. This is distinct from Invalid, which indicates a validator did claim the request and rejected it.

Properties

FailureReason

Gets a human-readable failure reason when validation failed.

Status

Gets the validation outcome.

ValidatorName

Gets the validator name that produced the result when one is available.

Methods

Invalid(string, string?)

Creates a failed validation result.

NotValidated(string?)

Creates a result that indicates no validator evaluated the request.

Valid(string)

Creates a successful validation result.