Class MessageExtensions
- Namespace
- Kook
- Assembly
- Kook.Net.Core.dll
提供用于各种消息实体的扩展方法。
public static class MessageExtensions
- Inheritance
-
MessageExtensions
- Inherited Members
Methods
AddReactionsAsync(IUserMessage, IEnumerable<IEmote>, RequestOptions?)
向消息添加多个回应。
public static Task AddReactionsAsync(this IUserMessage msg, IEnumerable<IEmote> reactions, RequestOptions? options = null)
Parameters
msg
IUserMessage要添加回应的消息。
reactions
IEnumerable<IEmote>要用于向此消息添加回应的所有表情符号。
options
RequestOptions发送请求时要使用的选项。
Returns
- Task
一个表示异步添加操作的任务。
Remarks
此方法会对每个要添加的回应分别发送请求。
- See Also
GetJumpUrl(IMessage)
获取一个跳转到消息的 URL。
public static string GetJumpUrl(this IMessage msg)
Parameters
msg
IMessage要获取跳转 URL 的消息。
Returns
- string
一个包含用于在聊天中跳转到消息的 URL 的字符串。
MaybeTextImageMixedMessage(IUserMessage)
获取此消息是否可能是图文混排消息。
public static bool MaybeTextImageMixedMessage(this IUserMessage msg)
Parameters
msg
IUserMessage要判断的消息。
Returns
- bool
如果此消息可能是图文混排消息,则为
true
;否则为false
。
RemoveReactionsAsync(IUserMessage, IUser, IEnumerable<IEmote>, RequestOptions?)
移除消息上的多个回应。
public static Task RemoveReactionsAsync(this IUserMessage msg, IUser user, IEnumerable<IEmote> reactions, RequestOptions? options = null)
Parameters
msg
IUserMessage要添加回应的消息。
user
IUser要删除其回应的用户。
reactions
IEnumerable<IEmote>要从此消息移除的回应的所有表情符号。
options
RequestOptions发送请求时要使用的选项。
Returns
- Task
一个表示异步移除操作的任务。
Remarks
此方法会对每个要移除的回应分别发送请求。
- See Also
ReplyCardAsync(IUserMessage, ICard, bool, bool, RequestOptions?)
向消息所属的频道回复卡片消息。
public static Task<Cacheable<IUserMessage, Guid>> ReplyCardAsync(this IUserMessage message, ICard card, bool isQuote = false, bool isEphemeral = false, RequestOptions? options = null)
Parameters
message
IUserMessage要回复的消息。
card
ICard要发送的卡片。
isQuote
bool是否在回复消息时引用被回复的消息。
isEphemeral
bool是否以临时消息的方式回复。如果设置为
true
,则仅该被回复的消息的作者可以看到此回复消息,否则所有人都可以看到此回复消息。options
RequestOptions发送请求时要使用的选项。
Returns
ReplyCardsAsync(IUserMessage, IEnumerable<ICard>, bool, bool, RequestOptions?)
向消息所属的频道回复卡片消息。
public static Task<Cacheable<IUserMessage, Guid>> ReplyCardsAsync(this IUserMessage message, IEnumerable<ICard> cards, bool isQuote = false, bool isEphemeral = false, RequestOptions? options = null)
Parameters
message
IUserMessage要回复的消息。
cards
IEnumerable<ICard>要发送的卡片。
isQuote
bool是否在回复消息时引用被回复的消息。
isEphemeral
bool是否以临时消息的方式回复。如果设置为
true
,则仅该被回复的消息的作者可以看到此回复消息,否则所有人都可以看到此回复消息。options
RequestOptions发送请求时要使用的选项。
Returns
ReplyFileAsync(IUserMessage, FileAttachment, bool, bool, RequestOptions?)
向消息所属的频道回复文件消息。
public static Task<Cacheable<IUserMessage, Guid>> ReplyFileAsync(this IUserMessage message, FileAttachment attachment, bool isQuote = false, bool isEphemeral = false, RequestOptions? options = null)
Parameters
message
IUserMessage要回复的消息。
attachment
FileAttachment文件的附件信息。
isQuote
bool是否在回复消息时引用被回复的消息。
isEphemeral
bool是否以临时消息的方式回复。如果设置为
true
,则仅该被回复的消息的作者可以看到此回复消息,否则所有人都可以看到此回复消息。options
RequestOptions发送请求时要使用的选项。
Returns
ReplyFileAsync(IUserMessage, Stream, string, AttachmentType, bool, bool, RequestOptions?)
向消息所属的频道回复文件消息。
public static Task<Cacheable<IUserMessage, Guid>> ReplyFileAsync(this IUserMessage message, Stream stream, string filename, AttachmentType type = AttachmentType.File, bool isQuote = false, bool isEphemeral = false, RequestOptions? options = null)
Parameters
message
IUserMessage要回复的消息。
stream
Stream文件的流。
filename
string文件名。
type
AttachmentType文件的媒体类型。
isQuote
bool是否在回复消息时引用被回复的消息。
isEphemeral
bool是否以临时消息的方式回复。如果设置为
true
,则仅该被回复的消息的作者可以看到此回复消息,否则所有人都可以看到此回复消息。options
RequestOptions发送请求时要使用的选项。
Returns
ReplyFileAsync(IUserMessage, string, string?, AttachmentType, bool, bool, RequestOptions?)
向消息所属的频道回复文件消息。
public static Task<Cacheable<IUserMessage, Guid>> ReplyFileAsync(this IUserMessage message, string path, string? filename = null, AttachmentType type = AttachmentType.File, bool isQuote = false, bool isEphemeral = false, RequestOptions? options = null)
Parameters
message
IUserMessage要回复的消息。
path
string文件的路径。
filename
string文件名。
type
AttachmentType文件的媒体类型。
isQuote
bool是否在回复消息时引用被回复的消息。
isEphemeral
bool是否以临时消息的方式回复。如果设置为
true
,则仅该被回复的消息的作者可以看到此回复消息,否则所有人都可以看到此回复消息。options
RequestOptions发送请求时要使用的选项。
Returns
ReplyTextAsync(IUserMessage, string, bool, bool, RequestOptions?)
向消息所属的频道回复文字消息。
public static Task<Cacheable<IUserMessage, Guid>> ReplyTextAsync(this IUserMessage message, string content, bool isQuote = false, bool isEphemeral = false, RequestOptions? options = null)
Parameters
message
IUserMessage要回复的消息。
content
stringContents of the message.
isQuote
bool是否在回复消息时引用被回复的消息。
isEphemeral
bool是否以临时消息的方式回复。如果设置为
true
,则仅该被回复的消息的作者可以看到此回复消息,否则所有人都可以看到此回复消息。options
RequestOptions发送请求时要使用的选项。