Class HeaderModule

Namespace

Kook

Assembly

Kook.Net.Core.dll

Represents a header module in an ICard.

public class HeaderModule : IModule, IEquatable<HeaderModule>, IEquatable<IModule>

Inheritance

object

HeaderModule

Implements

IModule

IEquatable<HeaderModule>

IEquatable<IModule>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

CardExtensions.ToBuilder(HeaderModule)

CardExtensions.ToBuilder(IModule)

Properties

Text

Gets the text element of the header.

public PlainTextElement? Text { get; }

Property Value

PlainTextElement

A PlainTextElement representing the text of the header.

Type

Gets the type of the module.

public ModuleType Type { get; }

Property Value

ModuleType

A ModuleType value that represents the type of the module.

Methods

Equals(HeaderModule?)

Determines whether the specified HeaderModule is equal to the current HeaderModule.

public bool Equals(HeaderModule? headerModule)

Parameters

headerModule HeaderModule

The HeaderModule to compare with the current HeaderModule.

Returns

bool

true if the specified HeaderModule is equal to the current HeaderModule; otherwise, false.

Equals(object?)

Determines whether the specified HeaderModule is equal to the current HeaderModule.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current HeaderModule.

Returns

bool

true if the specified HeaderModule is equal to the current HeaderModule; otherwise, false.

Remarks

If the object passes is an HeaderModule, Equals(HeaderModule?) will be called to compare the 2 instances.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

ToString()

Returns a string that represents the current object.

public override string? ToString()

Returns

string

A string that represents the current object.

Operators

operator ==(HeaderModule, HeaderModule)

Determines whether the specified HeaderModule is equal to the current HeaderModule.

public static bool operator ==(HeaderModule left, HeaderModule right)

Parameters

left HeaderModule

right HeaderModule

Returns

bool

true if the specified HeaderModule is equal to the current HeaderModule; otherwise, false.

operator !=(HeaderModule, HeaderModule)

Determines whether the specified HeaderModule is not equal to the current HeaderModule.

public static bool operator !=(HeaderModule left, HeaderModule right)

Parameters

left HeaderModule

right HeaderModule

Returns

bool

true if the specified HeaderModule is not equal to the current HeaderModule; otherwise, false.