Class HelpTopicSummary

Namespace

Kuestenlogik.Bowire.Help

Assembly

Kuestenlogik.Bowire.dll

Lightweight projection of HelpTopic for list views. The body is omitted so a Topics call doesn't pull the whole markdown set into the browser when the user only wants to scan titles. The Summary rides along so the topic-tree nav can render a one-line excerpt under the short title.

public sealed record HelpTopicSummary : IEquatable<HelpTopicSummary>

Inheritance

object

HelpTopicSummary

Implements

IEquatable<HelpTopicSummary>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

HelpTopicSummary(string, string, string?, string?)

Lightweight projection of HelpTopic for list views. The body is omitted so a Topics call doesn't pull the whole markdown set into the browser when the user only wants to scan titles. The Summary rides along so the topic-tree nav can render a one-line excerpt under the short title.

public HelpTopicSummary(string Id, string Title, string? Summary, string? CategoryId)

Parameters

Id string

Title string

Summary string

CategoryId string

Properties

CategoryId

public string? CategoryId { get; init; }

Property Value

string

Id

public string Id { get; init; }

Property Value

string

Summary

public string? Summary { get; init; }

Property Value

string

Title

public string Title { get; init; }

Property Value

string

Methods

Deconstruct(out string, out string, out string?, out string?)

public void Deconstruct(out string Id, out string Title, out string? Summary, out string? CategoryId)

Parameters

Id string

Title string

Summary string

CategoryId string

Equals(HelpTopicSummary?)

public bool Equals(HelpTopicSummary? other)

Parameters

other HelpTopicSummary

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(HelpTopicSummary?, HelpTopicSummary?)

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

Parameters

left HelpTopicSummary

right HelpTopicSummary

Returns

bool

operator !=(HelpTopicSummary?, HelpTopicSummary?)

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

Parameters

left HelpTopicSummary

right HelpTopicSummary

Returns

bool