Class CatalogueProbe

Namespace

EncDotNet.S100.Collections.KnownSources

Assembly

EncDotNet.S100.Collections.dll

What CatalogueFormatDetector found at a catalogue URL or in a stream.

public sealed record CatalogueProbe : IEquatable<CatalogueProbe>

Inheritance

object

CatalogueProbe

Implements

IEquatable<CatalogueProbe>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CatalogueProbe(string?, KnownCatalogueFormat?, string?, bool, string?)

What CatalogueFormatDetector found at a catalogue URL or in a stream.

public CatalogueProbe(string? RootElement, KnownCatalogueFormat? Format, string? Title, bool IsJson = false, string? Machine = null)

Parameters

RootElement string

The document's root element (local name), or null when it is not XML.

Format KnownCatalogueFormat?

The recognised, supported format, or null.

Title string

The catalogue's own title (Header/title), when it has one.

IsJson bool

True when the document is JSON rather than XML (an S-100 feed, or something else).

Machine string

For an S-100 feed, the publishing computer's name, when the feed gives it.

Properties

Format

The recognised, supported format, or null.

public KnownCatalogueFormat? Format { get; init; }

Property Value

KnownCatalogueFormat?

IsJson

True when the document is JSON rather than XML (an S-100 feed, or something else).

public bool IsJson { get; init; }

Property Value

bool

IsS100ExchangeCatalogue

True when the document is an S-100 exchange catalogue (CATALOG.XML).

public bool IsS100ExchangeCatalogue { get; }

Property Value

bool

Machine

For an S-100 feed, the publishing computer's name, when the feed gives it.

public string? Machine { get; init; }

Property Value

string

RootElement

The document's root element (local name), or null when it is not XML.

public string? RootElement { get; init; }

Property Value

string

Title

The catalogue's own title (Header/title), when it has one.

public string? Title { get; init; }

Property Value

string