Class UserExtensions

Namespace

Kook

Assembly

Kook.Net.Core.dll

提供用于各种用户实体的扩展方法。

public static class UserExtensions

Inheritance

object

UserExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

BanAsync(IGuildUser, int, string?, RequestOptions?)

封禁服务器内的用户。

public static Task BanAsync(this IGuildUser user, int pruneDays = 0, string? reason = null, RequestOptions? options = null)

Parameters

user IGuildUser

要封禁的用户。

pruneDays int

要删除此服务器中来自此用户的最近几天的消息，范围为 0 至 7，0 表示不删除。

reason string

封禁原因。

options RequestOptions

发送请求时要使用的选项。

Returns

Task

一个表示异步封禁操作的任务。

Exceptions

ArgumentException

pruneDays 超出了 0 至 7 的范围。

SendCardAsync(IUser, ICard, IQuote?, RequestOptions?)

通过私聊发送卡片消息。

public static Task<Cacheable<IUserMessage, Guid>> SendCardAsync(this IUser user, ICard card, IQuote? quote = null, RequestOptions? options = null)

Parameters

user IUser

要发送消息的用户。

card ICard

要发送的卡片。

quote IQuote

消息引用，用于回复消息。

options RequestOptions

发送请求时要使用的选项。

Returns

Task<Cacheable<IUserMessage, Guid>>

一个表示异步发送操作的任务。任务的结果包含所发送消息的可延迟加载的消息对象。

SendCardsAsync(IUser, IEnumerable<ICard>, IQuote?, RequestOptions?)

通过私聊发送卡片消息。

public static Task<Cacheable<IUserMessage, Guid>> SendCardsAsync(this IUser user, IEnumerable<ICard> cards, IQuote? quote = null, RequestOptions? options = null)

Parameters

user IUser

要发送消息的用户。

cards IEnumerable<ICard>

要发送的卡片。

quote IQuote

消息引用，用于回复消息。

options RequestOptions

发送请求时要使用的选项。

Returns

Task<Cacheable<IUserMessage, Guid>>

一个表示异步发送操作的任务。任务的结果包含所发送消息的可延迟加载的消息对象。

SendFileAsync(IUser, FileAttachment, IQuote?, RequestOptions?)

通过私聊发送文件。

public static Task<Cacheable<IUserMessage, Guid>> SendFileAsync(this IUser user, FileAttachment attachment, IQuote? quote = null, RequestOptions? options = null)

Parameters

user IUser

要发送消息的用户。

attachment FileAttachment

文件的附件信息。

quote IQuote

消息引用，用于回复消息。

options RequestOptions

发送请求时要使用的选项。

Returns

Task<Cacheable<IUserMessage, Guid>>

一个表示异步发送操作的任务。任务的结果包含所发送消息的可延迟加载的消息对象。

SendFileAsync(IUser, Stream, string, AttachmentType, IQuote?, RequestOptions?)

通过私聊发送文件。

public static Task<Cacheable<IUserMessage, Guid>> SendFileAsync(this IUser user, Stream stream, string filename, AttachmentType type = AttachmentType.File, IQuote? quote = null, RequestOptions? options = null)

Parameters

user IUser

要发送消息的用户。

stream Stream

文件的流。

filename string

文件名。

type AttachmentType

文件的媒体类型。

quote IQuote

消息引用，用于回复消息。

options RequestOptions

发送请求时要使用的选项。

Returns

Task<Cacheable<IUserMessage, Guid>>

一个表示异步发送操作的任务。任务的结果包含所发送消息的可延迟加载的消息对象。

SendFileAsync(IUser, string, string?, AttachmentType, IQuote?, RequestOptions?)

通过私聊发送文件。

public static Task<Cacheable<IUserMessage, Guid>> SendFileAsync(this IUser user, string path, string? filename = null, AttachmentType type = AttachmentType.File, IQuote? quote = null, RequestOptions? options = null)

Parameters

user IUser

要发送消息的用户。

path string

文件的路径。

filename string

文件名。

type AttachmentType

文件的媒体类型。

quote IQuote

消息引用，用于回复消息。

options RequestOptions

发送请求时要使用的选项。

Returns

Task<Cacheable<IUserMessage, Guid>>

一个表示异步发送操作的任务。任务的结果包含所发送消息的可延迟加载的消息对象。

SendTextAsync(IUser, string, IQuote?, RequestOptions?)

通过私聊发送文本消息。

public static Task<Cacheable<IUserMessage, Guid>> SendTextAsync(this IUser user, string content, IQuote? quote = null, RequestOptions? options = null)

Parameters

user IUser

要发送消息的用户。

content string

The KMarkdown content to be sent.

quote IQuote

消息引用，用于回复消息。

options RequestOptions

发送请求时要使用的选项。

Returns

Task<Cacheable<IUserMessage, Guid>>

一个表示异步发送操作的任务。任务的结果包含所发送消息的可延迟加载的消息对象。