Table of Contents

Class MutedWord

Namespace
idunno.Bluesky.Actor
Assembly
idunno.Bluesky.dll

Properties for a word that the account owner has muted.

public record MutedWord : IEquatable<MutedWord>

Inheritance

Implements

Inherited Members

Constructors

MutedWord(string?, string, IReadOnlyList<MutedWordTarget>, MutedWordActorTarget, DateTimeOffset?)

Creates a new instance of idunno.Bluesky.Actor.MutedWord.

public MutedWord(string? id, string value, IReadOnlyList<MutedWordTarget> targets, MutedWordActorTarget actorTarget, DateTimeOffset? expiresAt)

Parameters

id string?

An optional identifier for the muted word configuration.

value string

The muted word.

targets IReadOnlyList<MutedWordTarget>

The intended targets of the muted word.

actorTarget MutedWordActorTarget

Groups of users to apply the muted word to.

expiresAt DateTimeOffset?

The date and time at which the muted word will expire and no longer be applied, if any.

Exceptions

ArgumentNullException

Thrown when value or targets is null.

ArgumentOutOfRangeException

Thrown when value is longer than idunno.Bluesky.Maximum.MutedWordLengthInBytes bytes or idunno.Bluesky.Maximum.MutedWordLengthInGraphemes graphemes, when actorTarget is idunno.Bluesky.Actor.MutedWordActorTarget.Unknown, or when targets contains idunno.Bluesky.Actor.MutedWordTarget.Unknown.

MutedWord(MutedWord)

protected MutedWord(MutedWord original)

Parameters

original MutedWord

MutedWord(string?, string, IReadOnlyList<MutedWordTarget>, MutedWordActorTarget, DateTimeOffset?)

Creates a new instance of idunno.Bluesky.Actor.MutedWord.

public MutedWord(string? id, string value, IReadOnlyList<MutedWordTarget> targets, MutedWordActorTarget actorTarget, DateTimeOffset? expiresAt)

Parameters

id string?

An optional identifier for the muted word configuration.

value string

The muted word.

targets IReadOnlyList<MutedWordTarget>

The intended targets of the muted word.

actorTarget MutedWordActorTarget

Groups of users to apply the muted word to.

expiresAt DateTimeOffset?

The date and time at which the muted word will expire and no longer be applied, if any.

Exceptions

ArgumentNullException

Thrown when value or targets is null.

ArgumentOutOfRangeException

Thrown when value is longer than idunno.Bluesky.Maximum.MutedWordLengthInBytes bytes or idunno.Bluesky.Maximum.MutedWordLengthInGraphemes graphemes, when actorTarget is idunno.Bluesky.Actor.MutedWordActorTarget.Unknown, or when targets contains idunno.Bluesky.Actor.MutedWordTarget.Unknown.

MutedWord(MutedWord)

protected MutedWord(MutedWord original)

Parameters

original MutedWord

MutedWord(string?, string, IReadOnlyList<MutedWordTarget>, MutedWordActorTarget, DateTimeOffset?)

Creates a new instance of idunno.Bluesky.Actor.MutedWord.

public MutedWord(string? id, string value, IReadOnlyList<MutedWordTarget> targets, MutedWordActorTarget actorTarget, DateTimeOffset? expiresAt)

Parameters

id string?

An optional identifier for the muted word configuration.

value string

The muted word.

targets IReadOnlyList<MutedWordTarget>

The intended targets of the muted word.

actorTarget MutedWordActorTarget

Groups of users to apply the muted word to.

expiresAt DateTimeOffset?

The date and time at which the muted word will expire and no longer be applied, if any.

Exceptions

ArgumentNullException

Thrown when value or targets is null.

ArgumentOutOfRangeException

Thrown when value is longer than idunno.Bluesky.Maximum.MutedWordLengthInBytes bytes or idunno.Bluesky.Maximum.MutedWordLengthInGraphemes graphemes, when actorTarget is idunno.Bluesky.Actor.MutedWordActorTarget.Unknown, or when targets contains idunno.Bluesky.Actor.MutedWordTarget.Unknown.

MutedWord(MutedWord)

protected MutedWord(MutedWord original)

Parameters

original MutedWord

Properties

ActorTarget

Groups of users to apply the muted word to.

[JsonIgnore]
public MutedWordActorTarget ActorTarget { get; }

Property Value

MutedWordActorTarget

Remarks

A target this library does not recognize is reported as idunno.Bluesky.Actor.MutedWordActorTarget.Unknown. When the service does not send a target the lexicon default, idunno.Bluesky.Actor.MutedWordActorTarget.All, is reported.

ActorTarget

Groups of users to apply the muted word to.

[JsonIgnore]
public MutedWordActorTarget ActorTarget { get; }

Property Value

MutedWordActorTarget

Remarks

A target this library does not recognize is reported as idunno.Bluesky.Actor.MutedWordActorTarget.Unknown. When the service does not send a target the lexicon default, idunno.Bluesky.Actor.MutedWordActorTarget.All, is reported.

ActorTarget

Groups of users to apply the muted word to.

[JsonIgnore]
public MutedWordActorTarget ActorTarget { get; }

Property Value

MutedWordActorTarget

Remarks

A target this library does not recognize is reported as idunno.Bluesky.Actor.MutedWordActorTarget.Unknown. When the service does not send a target the lexicon default, idunno.Bluesky.Actor.MutedWordActorTarget.All, is reported.

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

ExpiresAt

The date and time at which the muted word will expire and no longer be applied, if any.

[JsonInclude]
public DateTimeOffset? ExpiresAt { get; init; }

Property Value

DateTimeOffset?

ExpiresAt

The date and time at which the muted word will expire and no longer be applied, if any.

[JsonInclude]
public DateTimeOffset? ExpiresAt { get; init; }

Property Value

DateTimeOffset?

ExpiresAt

The date and time at which the muted word will expire and no longer be applied, if any.

[JsonInclude]
public DateTimeOffset? ExpiresAt { get; init; }

Property Value

DateTimeOffset?

Id

An optional identifier for the muted word configuration.

[JsonInclude]
public string? Id { get; init; }

Property Value

string?

Id

An optional identifier for the muted word configuration.

[JsonInclude]
public string? Id { get; init; }

Property Value

string?

Id

An optional identifier for the muted word configuration.

[JsonInclude]
public string? Id { get; init; }

Property Value

string?

Targets

The intended targets of the muted word.

[JsonIgnore]
public IReadOnlyList<MutedWordTarget> Targets { get; }

Property Value

IReadOnlyList<MutedWordTarget>

Remarks

A target this library does not recognize is reported as idunno.Bluesky.Actor.MutedWordTarget.Unknown.

Targets

The intended targets of the muted word.

[JsonIgnore]
public IReadOnlyList<MutedWordTarget> Targets { get; }

Property Value

IReadOnlyList<MutedWordTarget>

Remarks

A target this library does not recognize is reported as idunno.Bluesky.Actor.MutedWordTarget.Unknown.

Targets

The intended targets of the muted word.

[JsonIgnore]
public IReadOnlyList<MutedWordTarget> Targets { get; }

Property Value

IReadOnlyList<MutedWordTarget>

Remarks

A target this library does not recognize is reported as idunno.Bluesky.Actor.MutedWordTarget.Unknown.

Value

The muted word.

[JsonInclude]
[JsonRequired]
public string Value { get; init; }

Property Value

string

Exceptions

ArgumentNullException

Thrown when the value set is null.

ArgumentOutOfRangeException

Thrown when the value set is longer than idunno.Bluesky.Maximum.MutedWordLengthInBytes bytes or idunno.Bluesky.Maximum.MutedWordLengthInGraphemes graphemes.

Value

The muted word.

[JsonInclude]
[JsonRequired]
public string Value { get; init; }

Property Value

string

Exceptions

ArgumentNullException

Thrown when the value set is null.

ArgumentOutOfRangeException

Thrown when the value set is longer than idunno.Bluesky.Maximum.MutedWordLengthInBytes bytes or idunno.Bluesky.Maximum.MutedWordLengthInGraphemes graphemes.

Value

The muted word.

[JsonInclude]
[JsonRequired]
public string Value { get; init; }

Property Value

string

Exceptions

ArgumentNullException

Thrown when the value set is null.

ArgumentOutOfRangeException

Thrown when the value set is longer than idunno.Bluesky.Maximum.MutedWordLengthInBytes bytes or idunno.Bluesky.Maximum.MutedWordLengthInGraphemes graphemes.

Methods

<Clone>$()

public virtual MutedWord <Clone>$()

Returns

MutedWord

<Clone>$()

public virtual MutedWord <Clone>$()

Returns

MutedWord

<Clone>$()

public virtual MutedWord <Clone>$()

Returns

MutedWord

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

Equals(MutedWord?)

public virtual bool Equals(MutedWord? other)

Parameters

other MutedWord?

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

Equals(MutedWord?)

public virtual bool Equals(MutedWord? other)

Parameters

other MutedWord?

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

Equals(MutedWord?)

public virtual bool Equals(MutedWord? other)

Parameters

other MutedWord?

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

GetHashCode()

public override int GetHashCode()

Returns

int

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

ToString()

public override string ToString()

Returns

string

ToString()

public override string ToString()

Returns

string

Operators

operator ==(MutedWord?, MutedWord?)

public static bool operator ==(MutedWord? left, MutedWord? right)

Parameters

left MutedWord?
right MutedWord?

Returns

bool

operator ==(MutedWord?, MutedWord?)

public static bool operator ==(MutedWord? left, MutedWord? right)

Parameters

left MutedWord?
right MutedWord?

Returns

bool

operator ==(MutedWord?, MutedWord?)

public static bool operator ==(MutedWord? left, MutedWord? right)

Parameters

left MutedWord?
right MutedWord?

Returns

bool

operator !=(MutedWord?, MutedWord?)

public static bool operator !=(MutedWord? left, MutedWord? right)

Parameters

left MutedWord?
right MutedWord?

Returns

bool

operator !=(MutedWord?, MutedWord?)

public static bool operator !=(MutedWord? left, MutedWord? right)

Parameters

left MutedWord?
right MutedWord?

Returns

bool

operator !=(MutedWord?, MutedWord?)

public static bool operator !=(MutedWord? left, MutedWord? right)

Parameters

left MutedWord?
right MutedWord?

Returns

bool