Table of Contents

Class UserNoticeEntity

Namespace
Tharga.Team.MongoDB
Assembly
Tharga.Team.MongoDB.dll

A raised notice occurrence and where its distribution stands.

public record UserNoticeEntity : EntityBase, ISupportInitialize, IEquatable<PersistableEntityBase>, IEntity<ObjectId>, IEquatable<EntityBase<ObjectId>>, IEquatable<EntityBase>, IEquatable<UserNoticeEntity>
Inheritance
PersistableEntityBase
EntityBase<ObjectId>
EntityBase
UserNoticeEntity
Implements
IEquatable<PersistableEntityBase>
IEntity<ObjectId>
IEquatable<EntityBase<ObjectId>>
IEquatable<EntityBase>
Inherited Members
EntityBase.ToString()
EntityBase.GetHashCode()
EntityBase.Equals(EntityBase<ObjectId>)
EntityBase.Equals(EntityBase)
EntityBase.<Clone>$()
EntityBase.EqualityContract
EntityBase<ObjectId>.Equals(PersistableEntityBase)
EntityBase<ObjectId>.Id
PersistableEntityBase.NeedsCleaning()
PersistableEntityBase.BeginInit()
PersistableEntityBase.EndInit()
PersistableEntityBase.CatchAll

Properties

Attempts

How many times it has been claimed.

public int Attempts { get; init; }

Property Value

int

ClaimedBy

Who holds it, while an instance does.

[BsonIgnoreIfNull]
public string ClaimedBy { get; init; }

Property Value

string

ClaimedUntil

When the holder's lease runs out, in UTC.

[BsonIgnoreIfNull]
public DateTime? ClaimedUntil { get; init; }

Property Value

DateTime?

CompletedAt

When it was distributed or given up, in UTC; the retention period runs from here.

[BsonIgnoreIfNull]
public DateTime? CompletedAt { get; init; }

Property Value

DateTime?

Discriminator

What tells occurrences about the same thing apart, or null.

[BsonIgnoreIfNull]
public string Discriminator { get; init; }

Property Value

string

LinkPath

The site path of the thing, or null.

[BsonIgnoreIfNull]
public string LinkPath { get; init; }

Property Value

string

NextAttemptAt

When it is next due, in UTC.

public DateTime NextAttemptAt { get; init; }

Property Value

DateTime

NoticeKey

The notice's key.

public required string NoticeKey { get; init; }

Property Value

string

RaisedAt

When it was raised, in UTC.

public DateTime RaisedAt { get; init; }

Property Value

DateTime

Reason

Why it was given up, or why the last attempt did not succeed.

[BsonIgnoreIfNull]
public string Reason { get; init; }

Property Value

string

RecipientCount

How many users it was given to.

public int RecipientCount { get; init; }

Property Value

int

Recipients

The users the raiser named.

public string[] Recipients { get; init; }

Property Value

string[]

Status

Where its distribution stands, stored by name.

[BsonRepresentation(BsonType.String)]
public UserNoticeStatus Status { get; init; }

Property Value

UserNoticeStatus

SubjectId

The id of the thing it is about.

public required string SubjectId { get; init; }

Property Value

string

SubjectText

How the thing is named to a reader, or null.

[BsonIgnoreIfNull]
public string SubjectText { get; init; }

Property Value

string

TeamKey

The team the occurrence belongs to.

public required string TeamKey { get; init; }

Property Value

string

Values

The placeholder values, by name.

public Dictionary<string, string> Values { get; init; }

Property Value

Dictionary<string, string>