Class CountdownModuleBuilder

Namespace

Kook

Assembly

Kook.Net.Core.dll

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

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

Inheritance

object

CountdownModuleBuilder

Implements

IModuleBuilder

IEquatable<CountdownModuleBuilder>

IEquatable<IModuleBuilder>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CountdownModuleBuilder()

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

public CountdownModuleBuilder()

CountdownModuleBuilder(CountdownMode, DateTimeOffset, DateTimeOffset?)

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

public CountdownModuleBuilder(CountdownMode mode, DateTimeOffset endTime, DateTimeOffset? startTime = null)

Parameters

mode CountdownMode

倒计时的显示模式。

endTime DateTimeOffset

倒计时结束的时间。

startTime DateTimeOffset?

倒计时开始的时间。

Properties

EndTime

获取或设置倒计时结束的时间。

public DateTimeOffset EndTime { get; set; }

Property Value

DateTimeOffset

Mode

获取或设置倒计时的显示模式。

public CountdownMode Mode { get; set; }

Property Value

CountdownMode

StartTime

获取或设置倒计时开始的时间。

public DateTimeOffset? StartTime { get; set; }

Property Value

DateTimeOffset?

Remarks

仅当 Mode 为 Second 时，才允许设置 StartTime。

Type

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

public ModuleType Type { get; }

Property Value

ModuleType

Methods

Build()

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

public CountdownModule Build()

Returns

CountdownModule

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

Exceptions

ArgumentOutOfRangeException

CountdownMode 不为 Second 时，不允许设置 StartTime。

ArgumentOutOfRangeException

EndTime 早于当前时间。

ArgumentOutOfRangeException

StartTime 早于 Unix 纪元时间。

ArgumentOutOfRangeException

EndTime 应晚于 StartTime。

Equals(CountdownModuleBuilder?)

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

public bool Equals(CountdownModuleBuilder? countdownModuleBuilder)

Parameters

countdownModuleBuilder CountdownModuleBuilder

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.

WithEndTime(DateTimeOffset)

设置倒计时结束的时间。

public CountdownModuleBuilder WithEndTime(DateTimeOffset endTime)

Parameters

endTime DateTimeOffset

倒计时结束的时间。

Returns

CountdownModuleBuilder

当前构建器。

WithMode(CountdownMode)

设置倒计时的显示模式。

public CountdownModuleBuilder WithMode(CountdownMode mode)

Parameters

mode CountdownMode

倒计时的显示模式。

Returns

CountdownModuleBuilder

当前构建器。

WithStartTime(DateTimeOffset?)

设置倒计时开始的时间。

public CountdownModuleBuilder WithStartTime(DateTimeOffset? startTime)

Parameters

startTime DateTimeOffset?

倒计时开始的时间。

Returns

CountdownModuleBuilder

当前构建器。

Remarks

仅当 Mode 为 Second 时，才允许设置 StartTime。

Operators

operator ==(CountdownModuleBuilder?, CountdownModuleBuilder?)

判定两个 CountdownModuleBuilder 是否相等。

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

Parameters

left CountdownModuleBuilder

right CountdownModuleBuilder

Returns

bool

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

operator !=(CountdownModuleBuilder?, CountdownModuleBuilder?)

判定两个 CountdownModuleBuilder 是否不相等。

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

Parameters

left CountdownModuleBuilder

right CountdownModuleBuilder

Returns

bool

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