Class MessageExtensions

Namespace

Kook.Commands

Assembly

Kook.Net.Commands.dll

提供用于 IUserMessage 与命令相关的扩展方法。

public static class MessageExtensions

Inheritance

object

MessageExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

HasCharPrefix(IUserMessage, char, ref int)

获取消息是否以提供的字符开头。

public static bool HasCharPrefix(this IUserMessage msg, char c, ref int argPos)

Parameters

msg IUserMessage

要检查的消息。

c char

要检查的前导字符。

argPos int

开始检查的位置。

Returns

bool

如果消息以指定的字符开头，则为 true；否则为 false。

HasMentionPrefix(IUserMessage, IUser, ref int)

获取消息是否以提供的用户提及开头。

public static bool HasMentionPrefix(this IUserMessage msg, IUser user, ref int argPos)

Parameters

msg IUserMessage

要检查的消息。

user IUser

要检查的用户。

argPos int

开始检查的位置。

Returns

bool

如果消息以指定的用户提及开头，则为 true；否则为 false。

HasStringPrefix(IUserMessage, string, ref int, StringComparison)

获取消息是否以提供的字符串开头。

public static bool HasStringPrefix(this IUserMessage msg, string str, ref int argPos, StringComparison comparisonType = StringComparison.Ordinal)

Parameters

msg IUserMessage

要检查的消息。

str string

要检查的前导字符。

argPos int

开始检查的位置。

comparisonType StringComparison

字符串比较模式。

Returns

bool

如果消息以指定的字符串开头，则为 true；否则为 false。

TryExpandCardContent(IUserMessage, out string?)

尝试将消息内卡片的内容展开为单个字符串。

[Obsolete("Use `Kook.MessageExtensions.TryExtractCardContent(IUserMessage, out string)` instead.")]
public static bool TryExpandCardContent(this IUserMessage msg, out string? expandedContent)

Parameters

msg IUserMessage

要展开的消息。

expandedContent string

Returns

bool

如果成功展开，则为 true；否则为 false。

Remarks

仅图文混排消息可以用于内容展开，参见 MaybeTextImageMixedMessage(IUserMessage)。