Class Emote

Namespace

Kook

Assembly

Kook.Net.Core.dll

表示一个表情符号。

public class Emote : IEmote, IEntity<string>

Inheritance

object

Emote

Implements

IEmote

IEntity<string>

Derived

GuildEmote

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

Emote(string, string, bool?)

创建一个新的 Emote 实例。

public Emote(string id, string name, bool? animated = null)

Parameters

id string

name string

animated bool?

Properties

Animated

获取此表情符号是否为动态表情。如果无法确定此表情符号是否为动态表情，则为 null。

public bool? Animated { get; }

Property Value

bool?

Id

获取此表情符号的唯一标识符。

public string Id { get; }

Property Value

string

Name

获取此表情符号的名称。

public string Name { get; }

Property Value

string

Methods

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.

Parse(string?, TagMode)

从一个表情符号的原始格式中解析出一个 Emote。

public static Emote Parse(string? text, TagMode tagMode)

Parameters

text string

表情符号的原始格式。例如：tagMode 为 PlainText 时的 [:emotename:1991895624896587/hbCFVWhu923k03k]；为 KMarkdown 时的 (emj)emotename(emj)[1991895624896587/hbCFVWhu923k03k]。

tagMode TagMode

解析标签的语法模式。

Returns

Emote

解析出的 Emote。

Exceptions

ArgumentException

无法以 tagMode 的语法模式解析 text 为一个有效的表情符号。

ToKMarkdownString()

获取此表情的 KMarkdown 格式字符串。

public string ToKMarkdownString()

Returns

string

此表情的 KMarkdown 格式字符串。

ToPlainTextString()

获取此表情的纯文本格式字符串。

public string ToPlainTextString()

Returns

string

此表情的纯文本格式字符串。

ToString()

获取此表情的 KMarkdown 格式字符串。

public override string ToString()

Returns

string

此表情的 KMarkdown 格式字符串。

ToString(TagMode)

获取此表情的字符串表示形式。

public string ToString(TagMode tagMode)

Parameters

tagMode TagMode

标签的语法模式。

Returns

string

此表情的字符串表示形式。

Exceptions

ArgumentOutOfRangeException

tagMode 不是有效的标签语法模式。

TryParse(string?, out Emote?, TagMode)

尝试从一个表情符号的原始格式中解析出一个 Emote。

public static bool TryParse(string? text, out Emote? result, TagMode tagMode)

Parameters

text string

表情符号的原始格式。例如：tagMode 为 PlainText 时的 [:emotename:1991895624896587/hbCFVWhu923k03k]；为 KMarkdown 时的 (emj)emotename(emj)[1991895624896587/hbCFVWhu923k03k]。

result Emote

如果解析成功，则为解析出的 Emote；否则为 null。

tagMode TagMode

解析标签的语法模式。

Returns

bool

如果解析成功，则为 true；否则为 false。