Class MeaningData

Namespace

Nyra.Entities

Assembly

Nyra.dll

The meaning text of a track, a summary of what the song is about.

public sealed record MeaningData : IEquatable<MeaningData>

Inheritance

object

MeaningData

Implements

IEquatable<MeaningData>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

Description

The description of the meaning.

[JsonPropertyName("description")]
[JsonInclude]
public string? Description { get; }

Property Value

string

ErrorMessage

Present only when LoadType is Error.

[JsonPropertyName("message")]
[JsonInclude]
public string? ErrorMessage { get; }

Property Value

string

ErrorSeverity

Present only when LoadType is Error.

[JsonPropertyName("severity")]
[JsonInclude]
public ErrorSeverity? ErrorSeverity { get; }

Property Value

ErrorSeverity?

Remarks

Null when the server reports the error as a bare message, set when it reports the severity in-band.

Meta

The metadata of the meaning.

[JsonPropertyName("meaningMeta")]
[JsonInclude]
public MeaningMeta? Meta { get; }

Property Value

MeaningMeta

Paragraphs

The paragraphs of the meaning.

[JsonPropertyName("paragraphs")]
[JsonInclude]
public IReadOnlyList<string> Paragraphs { get; }

Property Value

IReadOnlyList<string>

Provider

Provider that produced the meaning, such as wikipedia or letrasmus.

[JsonPropertyName("provider")]
[JsonInclude]
public string? Provider { get; }

Property Value

string

Song

The song the meaning is about.

[JsonPropertyName("song")]
[JsonInclude]
public MeaningSong? Song { get; }

Property Value

MeaningSong

Title

The title of the meaning.

[JsonPropertyName("title")]
[JsonInclude]
public string? Title { get; }

Property Value

string

Translation

Machine translation of the meaning, requested through the language parameter.

[JsonPropertyName("translation")]
[JsonInclude]
public MeaningTranslation? Translation { get; }

Property Value

MeaningTranslation

Type

What the provider took the meaning for, track or artist.

[JsonPropertyName("type")]
[JsonInclude]
public string? Type { get; }

Property Value

string

Url

The URL the meaning was loaded from.

[JsonPropertyName("url")]
[JsonInclude]
public string? Url { get; }

Property Value

string

Methods

Equals(MeaningData?)

Indicates whether both meanings carry the same members.

public bool Equals(MeaningData? other)

Parameters

other MeaningData

The meaning to compare with.

Returns

bool

Whether every member matches, the paragraphs compared by content.

GetHashCode()

Returns a hash of the meaning's comparable members.

public override int GetHashCode()

Returns

int

The hash code.

ToString()

Returns the meaning as its title and paragraph count.

public override string ToString()

Returns

string

The meaning's title and paragraph count.