Class PlainTextElementBuilder
- Namespace
- Kook
- Assembly
- Kook.Net.Core.dll
用来构建 PlainTextElement 元素的构建器。
public class PlainTextElementBuilder : IElementBuilder, IEquatable<PlainTextElementBuilder>, IEquatable<IElementBuilder>
- Inheritance
-
PlainTextElementBuilder
- Implements
- Inherited Members
Constructors
PlainTextElementBuilder()
初始化一个 PlainTextElementBuilder 类的新实例。
public PlainTextElementBuilder()
PlainTextElementBuilder(string?, bool)
初始化一个 PlainTextElementBuilder 类的新实例。
public PlainTextElementBuilder(string? content, bool emoji = true)
Parameters
- See Also
Fields
MaxPlainTextLength
纯文本的最大长度。
public const int MaxPlainTextLength = 2000
Field Value
Properties
Content
获取或设置纯文本的文本内容。
public string? Content { get; set; }
Property Value
Emoji
获取或设置 Emoji 表情符号的短代码是否应被解析为表情符号。
public bool Emoji { get; set; }
Property Value
- See Also
Type
获取此构建器构建的元素的类型。
public ElementType Type { get; }
Property Value
Methods
Build()
构建当前构建器为一个 PlainTextElement。
public PlainTextElement Build()
Returns
- PlainTextElement
由当前构建器表示的属性构建的 PlainTextElement 对象。
Exceptions
- ArgumentNullException
Content 为
null
。- ArgumentException
Content 的长度超过了 MaxPlainTextLength。
Equals(PlainTextElementBuilder?)
Indicates whether the current object is equal to another object of the same type.
public bool Equals(PlainTextElementBuilder? plainTextElementBuilder)
Parameters
plainTextElementBuilder
PlainTextElementBuilder
Returns
Equals(object?)
Determines whether the specified object is equal to the current object.
public override bool Equals(object? obj)
Parameters
obj
objectThe object to compare with the current object.
Returns
GetHashCode()
Serves as the default hash function.
public override int GetHashCode()
Returns
- int
A hash code for the current object.
WithContent(string)
设置纯文本的文本内容。
public PlainTextElementBuilder WithContent(string content)
Parameters
content
string纯文本的文本内容。
Returns
- PlainTextElementBuilder
当前构建器。
WithEmoji(bool)
设置 Emoji 表情符号的短代码是否应被解析为表情符号。
public PlainTextElementBuilder WithEmoji(bool emoji)
Parameters
emoji
boolEmoji 表情符号的短代码是否应被解析为表情符号。
Returns
- PlainTextElementBuilder
当前构建器。
- See Also
Operators
operator ==(PlainTextElementBuilder?, PlainTextElementBuilder?)
判定两个 PlainTextElementBuilder 是否相等。
public static bool operator ==(PlainTextElementBuilder? left, PlainTextElementBuilder? right)
Parameters
left
PlainTextElementBuilderright
PlainTextElementBuilder
Returns
- bool
如果两个 PlainTextElementBuilder 相等,则为
true
;否则为false
。
implicit operator PlainTextElementBuilder(string)
使用指定的纯文本内容初始化一个新的 PlainTextElementBuilder 类的实例。
public static implicit operator PlainTextElementBuilder(string content)
Parameters
content
string纯文本内容。
Returns
- PlainTextElementBuilder
一个使用指定的纯文本内容初始化的 PlainTextElementBuilder 类的实例。
operator !=(PlainTextElementBuilder?, PlainTextElementBuilder?)
判定两个 PlainTextElementBuilder 是否不相等。
public static bool operator !=(PlainTextElementBuilder? left, PlainTextElementBuilder? right)
Parameters
left
PlainTextElementBuilderright
PlainTextElementBuilder
Returns
- bool
如果两个 PlainTextElementBuilder 不相等,则为
true
;否则为false
。