Table of Contents

Interface IForgiveableModerationEntry

Namespace
Uncreated.Warfare.Moderation
Assembly
Uncreated.Warfare.dll
public interface IForgiveableModerationEntry : IDurationModerationEntry, IModerationEntry
Inherited Members

Properties

ForgiveMessage

Why the moderation entry was forgiven.

[JsonPropertyName("forgive_message")]
string? ForgiveMessage { get; set; }

Property Value

string

ForgiveTimestamp

When the moderation entry was forgiven.

[JsonPropertyName("forgive_timestamp_utc")]
DateTimeOffset? ForgiveTimestamp { get; set; }

Property Value

DateTimeOffset?

Forgiven

If the moderation entry was forgiven.

[JsonPropertyName("is_forgiven")]
bool Forgiven { get; set; }

Property Value

bool

ForgivenBy

Who forgave the moderation entry.

[JsonPropertyName("forgiving_actor")]
[JsonConverter(typeof(ActorConverter))]
IModerationActor? ForgivenBy { get; set; }

Property Value

IModerationActor

Methods

IsApplied(bool)

Checks if the punishment is still active.

bool IsApplied(bool considerForgiven)

Parameters

considerForgiven bool

Considers the values of Forgiven and Removed.

Returns

bool

Exceptions

InvalidOperationException

This punishment hasn't been resolved (ResolvedTimestamp is null).

WasAppliedAt(DateTimeOffset, bool)

Checks if the punishment was still active at timestamp.

bool WasAppliedAt(DateTimeOffset timestamp, bool considerForgiven)

Parameters

timestamp DateTimeOffset
considerForgiven bool

Considers the values of Forgiven and Removed.

Returns

bool

Exceptions

InvalidOperationException

This punishment hasn't been resolved (ResolvedTimestamp is null).

Edit this page