Class ForbiddenError

Namespace

REslava.Result

Assembly

REslava.Result.dll

Represents an authorization error (HTTP 403 equivalent). Use when the caller is authenticated but lacks permission.

public class ForbiddenError : Reason<ForbiddenError>, IError, IReason

Inheritance

object

Reason

Reason<ForbiddenError>

ForbiddenError

Implements

IError

IReason

Inherited Members

Reason<ForbiddenError>.WithMessage(string)

Reason<ForbiddenError>.WithTag(string, object)

Reason<ForbiddenError>.WithTags(params (string key, object value)[])

Reason<ForbiddenError>.WithTagsFrom(ImmutableDictionary<string, object>)

Reason.Message

Reason.Tags

Reason.ToString()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

ValidationExtensions.EnsureNotNull<TCollection>(TCollection?, string, string?)

TagAccessExtensions.FormatTags(IReason, string)

TagAccessExtensions.GetTagBool(IReason, string, bool)

TagAccessExtensions.GetTagDecimal(IReason, string, decimal)

TagAccessExtensions.GetTagInt(IReason, string, int)

TagAccessExtensions.GetTagKeys(IReason)

TagAccessExtensions.GetTagString(IReason, string, string)

TagAccessExtensions.GetTag<T>(IReason, string, T?)

TagAccessExtensions.GetTags(IReason)

TagAccessExtensions.HasTag(IReason, string)

TagAccessExtensions.RequireTag<T>(IReason, string)

Examples

Result<User>.Fail(new ForbiddenError());
Result<User>.Fail(new ForbiddenError("Admin role required"));
Result<User>.Fail(new ForbiddenError("Delete", "Order"));

Constructors

ForbiddenError()

public ForbiddenError()

ForbiddenError(string)

public ForbiddenError(string message)

Parameters

message string

ForbiddenError(string, string)

public ForbiddenError(string action, string resource)

Parameters

action string

resource string

Methods

CreateNew(string, ImmutableDictionary<string, object>)

Factory method for creating new instances (maintains immutability). Must be implemented by derived classes.

protected override ForbiddenError CreateNew(string message, ImmutableDictionary<string, object> tags)

Parameters

message string

tags ImmutableDictionary<string, object>

Returns

ForbiddenError