Class HeaderModuleBuilder

Namespace

Kook

Assembly

Kook.Net.Core.dll

用来构建 HeaderModule 模块的构建器。

public class HeaderModuleBuilder : IModuleBuilder, IEquatable<HeaderModuleBuilder>, IEquatable<IModuleBuilder>

Inheritance

object

HeaderModuleBuilder

Implements

IModuleBuilder

IEquatable<HeaderModuleBuilder>

IEquatable<IModuleBuilder>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

HeaderModuleBuilder()

初始化一个 HeaderModuleBuilder 类的新实例。

public HeaderModuleBuilder()

HeaderModuleBuilder(PlainTextElementBuilder)

初始化一个 HeaderModuleBuilder 类的新实例。

public HeaderModuleBuilder(PlainTextElementBuilder text)

Parameters

text PlainTextElementBuilder

标题文本。

HeaderModuleBuilder(string)

初始化一个 HeaderModuleBuilder 类的新实例。

public HeaderModuleBuilder(string text)

Parameters

text string

标题文本。

Fields

MaxHeaderContentLength

标题内容文本的最大长度。

public const int MaxHeaderContentLength = 100

Field Value

int

Properties

Text

获取或设置标题文本。

public PlainTextElementBuilder? Text { get; set; }

Property Value

PlainTextElementBuilder

Type

获取此构建器构建的模块的类型。

public ModuleType Type { get; }

Property Value

ModuleType

Methods

Build()

构建当前构建器为一个 HeaderModule 对象。

public HeaderModule Build()

Returns

HeaderModule

由当前构建器表示的属性构建的 HeaderModule 对象。

Exceptions

ArgumentNullException

Text 为 null。

ArgumentException

Text 的内容为 null。

ArgumentException

Text 的内容长度超过了 MaxHeaderContentLength。

Equals(HeaderModuleBuilder?)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(HeaderModuleBuilder? headerModuleBuilder)

Parameters

headerModuleBuilder HeaderModuleBuilder

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

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

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

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

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

WithText(PlainTextElementBuilder)

设置标题文本。

public HeaderModuleBuilder WithText(PlainTextElementBuilder text)

Parameters

text PlainTextElementBuilder

要设置的标题文本。

Returns

HeaderModuleBuilder

当前构建器。

WithText(Action<PlainTextElementBuilder>?)

设置标题文本。

public HeaderModuleBuilder WithText(Action<PlainTextElementBuilder>? action = null)

Parameters

action Action<PlainTextElementBuilder>

一个包含对要设置的标题文本进行配置的操作的委托。

Returns

HeaderModuleBuilder

当前构建器。

WithText(string)

设置标题文本。

public HeaderModuleBuilder WithText(string text)

Parameters

text string

要设置的标题文本。

Returns

HeaderModuleBuilder

当前构建器。

Operators

operator ==(HeaderModuleBuilder?, HeaderModuleBuilder?)

判定两个 HeaderModuleBuilder 是否相等。

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

Parameters

left HeaderModuleBuilder

right HeaderModuleBuilder

Returns

bool

如果两个 HeaderModuleBuilder 相等，则为 true；否则为 false。

implicit operator HeaderModuleBuilder(string)

初始化一个 HeaderModuleBuilder 类的新实例。

public static implicit operator HeaderModuleBuilder(string text)

Parameters

text string

标题文本。

Returns

HeaderModuleBuilder

operator !=(HeaderModuleBuilder?, HeaderModuleBuilder?)

判定两个 HeaderModuleBuilder 是否不相等。

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

Parameters

left HeaderModuleBuilder

right HeaderModuleBuilder

Returns

bool

如果两个 HeaderModuleBuilder 不相等，则为 true；否则为 false。