Class MentionUtils

Namespace

Kook

Assembly

Kook.Net.Core.dll

提供一组用于生成与解析提及标签的辅助方法。

public static class MentionUtils

Inheritance

object

MentionUtils

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

KMarkdownMentionChannel(ulong)

返回基于频道 ID 的 KMarkdown 格式化频道提及字符串。

public static string KMarkdownMentionChannel(ulong id)

Parameters

id ulong

Returns

string

格式化为 KMarkdown 的频道提及字符串。

KMarkdownMentionRole(uint)

返回基于角色 ID 的 KMarkdown 格式化角色提及字符串。

public static string KMarkdownMentionRole(uint id)

Parameters

id uint

Returns

string

格式化为 KMarkdown 的角色提及字符串。

KMarkdownMentionUser(ulong)

返回基于用户 ID 的 KMarkdown 格式化用户提及字符串。

public static string KMarkdownMentionUser(ulong id)

Parameters

id ulong

Returns

string

格式化为 KMarkdown 的用户提及字符串。

ParseChannel(string, TagMode)

解析指定的频道提及字符串。

public static ulong ParseChannel(string text, TagMode tagMode)

Parameters

text string

要解析的频道提及字符串。

tagMode TagMode

提及标签的语法模式。

Returns

ulong

解析的频道 ID。

Exceptions

ArgumentException

无效的频道提及字符串格式。

ArgumentOutOfRangeException

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

ParseRole(string, TagMode)

解析指定的角色提及字符串。

public static ulong ParseRole(string text, TagMode tagMode)

Parameters

text string

要解析的角色提及字符串。

tagMode TagMode

提及标签的语法模式。

Returns

ulong

解析的角色 ID。

Exceptions

ArgumentException

无效的角色提及字符串格式。

ArgumentOutOfRangeException

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

ParseUser(string, TagMode)

将指定的用户提及字符串解析为用户 ID。

public static ulong ParseUser(string text, TagMode tagMode)

Parameters

text string

要解析的用户提及字符串。

tagMode TagMode

提及标签的语法模式。

Returns

ulong

解析的用户 ID。

Exceptions

ArgumentException

无效的用户提及字符串格式。

ArgumentOutOfRangeException

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

PlainTextMentionChannel(ulong)

返回基于频道 ID 的纯文本格式化频道提及字符串。

public static string PlainTextMentionChannel(ulong id)

Parameters

id ulong

Returns

string

格式化为纯文本的频道提及字符串。

PlainTextMentionRole(uint)

返回基于角色 ID 的纯文本格式化角色提及字符串。

public static string PlainTextMentionRole(uint id)

Parameters

id uint

Returns

string

格式化为纯文本的角色提及字符串。

PlainTextMentionUser(string, ulong)

返回基于用户名称与用户 ID 的纯文本格式化用户提及字符串。

public static string PlainTextMentionUser(string username, ulong id)

Parameters

username string

id ulong

Returns

string

格式化为纯文本的用户提及字符串。

TryParseChannel(string, out ulong, TagMode)

尝试解析指定的频道提及字符串。

public static bool TryParseChannel(string text, out ulong channelId, TagMode tagMode)

Parameters

text string

要解析的频道提及字符串。

channelId ulong

如果解析成功，则为频道 ID；否则为 0。

tagMode TagMode

提及标签的语法模式。

Returns

bool

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

Exceptions

ArgumentOutOfRangeException

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

TryParseRole(string, out uint, TagMode)

尝试解析指定的角色提及字符串。

public static bool TryParseRole(string text, out uint roleId, TagMode tagMode)

Parameters

text string

T 要解析的角色提及字符串。

roleId uint

如果解析成功，则为角色 ID；否则为 0。

tagMode TagMode

提及标签的语法模式。

Returns

bool

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

Exceptions

ArgumentOutOfRangeException

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

TryParseUser(string, out ulong, TagMode)

尝试解析指定的用户提及字符串。

public static bool TryParseUser(string text, out ulong userId, TagMode tagMode)

Parameters

text string

要解析的用户提及字符串。

userId ulong

如果解析成功，则为用户 ID；否则为 0。

tagMode TagMode

提及标签的语法模式。

Returns

bool

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

Exceptions

ArgumentOutOfRangeException

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