Class RestGuild

Namespace

Kook.Rest

Assembly

Kook.Net.Rest.dll

表示一个基于 REST 的服务器。

public class RestGuild : RestEntity<ulong>, IGuild, IEntity<ulong>, IUpdateable

Inheritance

object

RestEntity<ulong>

RestGuild

Implements

IGuild

IEntity<ulong>

IUpdateable

Inherited Members

RestEntity<ulong>.Id

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Properties

AutoDeleteTime

TODO: To be documented.

public string? AutoDeleteTime { get; }

Property Value

string

Banner

获取此服务器横幅图像的 URL。

public string Banner { get; }

Property Value

string

BoostLevel

获取此服务器的服务器助力等级。

public BoostLevel BoostLevel { get; }

Property Value

BoostLevel

BoostSubscriptionCount

获取此服务器的服务器助力包的数量。

public int BoostSubscriptionCount { get; }

Property Value

int

BufferBoostSubscriptionCount

获取此服务器来自拥有 BUFF 会员的用的服务器助力包的数量。

public int BufferBoostSubscriptionCount { get; }

Property Value

int

CategoryChannels

获取此服务器中的所有分组频道。

public IReadOnlyCollection<RestCategoryChannel> CategoryChannels { get; }

Property Value

IReadOnlyCollection<RestCategoryChannel>

Channels

获取此服务器中的所有频道。

public IReadOnlyCollection<RestGuildChannel> Channels { get; }

Property Value

IReadOnlyCollection<RestGuildChannel>

CurrentUserDisplayName

获取当前用户在此服务器的显示名称。

public string CurrentUserDisplayName { get; }

Property Value

string

Remarks

如果当前用户在此服务器内设置了昵称，则此属性为设置的昵称；否则为当前用户的用户名。

CurrentUserNickname

获取当前用户在此服务器的昵称。

public string? CurrentUserNickname { get; }

Property Value

string

Remarks

如果当前用户在此服务器未设置昵称，或所设置的昵称与当前用户的用户名相同，则此属性为 null。

CurrentUserRoles

获取当前用户在此服务器所拥有的所有角色。

public IReadOnlyCollection<RestRole> CurrentUserRoles { get; }

Property Value

IReadOnlyCollection<RestRole>

DefaultChannelId

获取默认文字频道的 ID。

public ulong? DefaultChannelId { get; }

Property Value

ulong?

Emotes

获取此服务器的所有自定义表情。

public IReadOnlyCollection<GuildEmote> Emotes { get; }

Property Value

IReadOnlyCollection<GuildEmote>

Remarks

warning

如果当前服务器是通过 GetGuildAsync(ulong, RequestOptions?) 获取的，此属性可能不包含任何元素。访问 GetEmoteAsync(string, RequestOptions?) 以获取所有服务器自定义表情。

EveryoneRole

获取此服务器中的 @全体成员 全体成员角色。

public RestRole EveryoneRole { get; }

Property Value

RestRole

Features

获取此服务器的所有特性。

public GuildFeatures Features { get; }

Property Value

GuildFeatures

Icon

获取此服务器图标的 URL。

public string Icon { get; }

Property Value

string

IsAvailable

确定此服务器实体是否已准备就绪以供用户代码访问。

public bool IsAvailable { get; }

Property Value

bool

Remarks

note

此属性仅对基于网关连接的客户端有意义。

此属性为 true 表示，此服务器实体已完整缓存基础数据，并与网关同步。
缓存基础数据包括服务器基本信息、频道、角色、频道权限重写、当前用户在服务器内的昵称。

IsOpenEnabled

获取此服务器是否为公开服务器。

public bool IsOpenEnabled { get; }

Property Value

bool

MaxBitrate

获取此服务器中语音频道的最高比特率。

public int MaxBitrate { get; }

Property Value

int

Remarks

此限制取决于服务器的助力状态。

MaxUploadLimit

获取此服务器的文件上传限制，以字节为单位。

public ulong MaxUploadLimit { get; }

Property Value

ulong

Remarks

此限制取决于服务器的助力状态。

Name

获取此服务器的名称。

public string Name { get; }

Property Value

string

NotifyType

获取此服务器的默认通知类型。

public NotifyType NotifyType { get; }

Property Value

NotifyType

OpenId

获取此服务器的公开 ID。

public uint? OpenId { get; }

Property Value

uint?

Remarks

当 IsOpenEnabled 为 true 时，此属性应该返回一个有效的公开服务器 ID； 如果 IsOpenEnabled 为 false，则此属性应该返回 null。

OwnerId

获取此服务器所有者的用户 ID。

public ulong OwnerId { get; }

Property Value

ulong

RecommendInfo

获取此服务器的推荐信息。

public RecommendInfo? RecommendInfo { get; }

Property Value

RecommendInfo

Region

获取此服务器的默认语音服务器区域。

public string Region { get; }

Property Value

string

Remarks

语音服务器区域是指语音服务器所在的地理位置，各个语音服务器区域由一个唯一的字符串表示。
可用语音服务器区域参考列表：

区域 ID	区域名称
chengdu	西南(成都)
beijing	华北(北京)
shanghai	华东(上海)
shenzhen	华南(深圳)
hk	亚太(香港)
vnga	国际专线(助力专享)

此列表仅供参考。

Roles

获取此服务器的所有角色。

public IReadOnlyCollection<RestRole> Roles { get; }

Property Value

IReadOnlyCollection<RestRole>

Status

TODO: To be documented.

public int Status { get; }

Property Value

int

TextChannels

获取此服务器中所有具有文字聊天能力的频道。

public IReadOnlyCollection<RestTextChannel> TextChannels { get; }

Property Value

IReadOnlyCollection<RestTextChannel>

Remarks

语音频道也是一种文字频道，此计算属性本意用于获取所有具有文字聊天能力的频道，通过此方法获取到的文字频道列表中也包含了语音频道。 如需获取频道的实际类型，请参考 GetChannelType(IChannel)。

Topic

获取此服务器的介绍。

public string Topic { get; }

Property Value

string

VoiceChannels

获取此服务器中所有具有语音聊天能力的频道。

public IReadOnlyCollection<RestVoiceChannel> VoiceChannels { get; }

Property Value

IReadOnlyCollection<RestVoiceChannel>

WelcomeChannelId

获取欢迎通知频道的 ID。

public ulong? WelcomeChannelId { get; }

Property Value

ulong?

Methods

AddBanAsync(IUser, int, string?, RequestOptions?)

封禁服务器内的用户。

public Task AddBanAsync(IUser user, int pruneDays = 0, string? reason = null, RequestOptions? options = null)

Parameters

user IUser

要封禁的用户。

pruneDays int

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

reason string

封禁原因。

options RequestOptions

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

Returns

Task

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

Exceptions

ArgumentException

pruneDays 超出了 0 至 7 的范围。

AddBanAsync(ulong, int, string?, RequestOptions?)

封禁服务器内的用户。

public Task AddBanAsync(ulong userId, int pruneDays = 0, string? reason = null, RequestOptions? options = null)

Parameters

userId ulong

要封禁的用户的 ID。

pruneDays int

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

reason string

封禁原因。

options RequestOptions

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

Returns

Task

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

Exceptions

ArgumentException

pruneDays 超出了 0 至 7 的范围。

CreateCategoryChannelAsync(string, Action<CreateCategoryChannelProperties>?, RequestOptions?)

在此服务器内创建一个新的分组频道。

public Task<RestCategoryChannel> CreateCategoryChannelAsync(string name, Action<CreateCategoryChannelProperties>? func = null, RequestOptions? options = null)

Parameters

name string

频道的名称。

func Action<CreateCategoryChannelProperties>

一个包含要应用到新创建频道的配置的委托。

options RequestOptions

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

Returns

Task<RestCategoryChannel>

一个表示异步创建操作的任务。任务的结果包含新创建的分组频道。

CreateEmoteAsync(string, Image, RequestOptions?)

在此服务器内创建一个新的自定义表情。

public Task<GuildEmote> CreateEmoteAsync(string name, Image image, RequestOptions? options = null)

Parameters

name string

新自定义表情的名称。

image Image

新自定义表情的图像信息。

options RequestOptions

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

Returns

Task<GuildEmote>

一个表示异步创建操作的任务。任务的结果包含新创建的自定义表情。

CreateInviteAsync(InviteMaxAge, InviteMaxUses, RequestOptions?)

创建一个到此服务器的新邀请。

public Task<RestInvite> CreateInviteAsync(InviteMaxAge maxAge = InviteMaxAge._604800, InviteMaxUses maxUses = InviteMaxUses.Unlimited, RequestOptions? options = null)

Parameters

maxAge InviteMaxAge

邀请链接的有效时长，null 表示永不过期。

maxUses InviteMaxUses

邀请链接的可用人次，null 表示无限制。

options RequestOptions

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

Returns

Task<RestInvite>

一个表示异步创建操作的任务。任务的结果包含新创建的邀请链接的元数据，其中包含有关邀请链接的信息。

CreateInviteAsync(int?, int?, RequestOptions?)

创建一个到此服务器的新邀请。

public Task<RestInvite> CreateInviteAsync(int? maxAge = 604800, int? maxUses = null, RequestOptions? options = null)

Parameters

maxAge int?

邀请链接的有效时长，NeverExpires 表示永不过期。

maxUses int?

邀请链接的可用人次，Unlimited 表示无限制。

options RequestOptions

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

Returns

Task<RestInvite>

一个表示异步创建操作的任务。任务的结果包含新创建的邀请链接的元数据，其中包含有关邀请链接的信息。

CreateRoleAsync(string?, RequestOptions?)

在此服务器内创建一个新角色。

public Task<RestRole> CreateRoleAsync(string? name = null, RequestOptions? options = null)

Parameters

name string

角色的名称。

options RequestOptions

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

Returns

Task<RestRole>

一个表示异步创建操作的任务。任务的结果包含新创建的角色。

CreateTextChannelAsync(string, Action<CreateTextChannelProperties>?, RequestOptions?)

在此服务器内创建一个新的文字频道。

public Task<RestTextChannel> CreateTextChannelAsync(string name, Action<CreateTextChannelProperties>? func = null, RequestOptions? options = null)

Parameters

name string

频道的名称。

func Action<CreateTextChannelProperties>

一个包含要应用到新创建频道的配置的委托。

options RequestOptions

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

Returns

Task<RestTextChannel>

一个表示异步创建操作的任务。任务的结果包含新创建的文字频道。

CreateVoiceChannelAsync(string, Action<CreateVoiceChannelProperties>?, RequestOptions?)

在此服务器内创建一个新的语音频道。

public Task<RestVoiceChannel> CreateVoiceChannelAsync(string name, Action<CreateVoiceChannelProperties>? func = null, RequestOptions? options = null)

Parameters

name string

频道的名称。

func Action<CreateVoiceChannelProperties>

一个包含要应用到新创建频道的配置的委托。

options RequestOptions

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

Returns

Task<RestVoiceChannel>

一个表示异步创建操作的任务。任务的结果包含新创建的语音频道。

DeleteEmoteAsync(GuildEmote, RequestOptions?)

删除此服务器内的现有自定义表情。

public Task DeleteEmoteAsync(GuildEmote emote, RequestOptions? options = null)

Parameters

emote GuildEmote

要删除的自定义表情。

options RequestOptions

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

Returns

Task

一个表示异步删除操作的任务。

GetActiveBoostSubscriptionsAsync(RequestOptions?)

获取此服务器所有生效中的服务器助力包。

public Task<ImmutableDictionary<IUser, IReadOnlyCollection<BoostSubscriptionMetadata>>> GetActiveBoostSubscriptionsAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task<ImmutableDictionary<IUser, IReadOnlyCollection<BoostSubscriptionMetadata>>>

一个表示异步获取操作的任务。任务的结果是所有为此服务器助力的用户及所应用的生效中的服务器助力包。

GetBadgeAsync(BadgeStyle, RequestOptions?)

获取与此服务器关联的徽章。

public Task<Stream> GetBadgeAsync(BadgeStyle style = BadgeStyle.GuildName, RequestOptions? options = null)

Parameters

style BadgeStyle

要获取的徽章的样式。

options RequestOptions

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

Returns

Task<Stream>

一个表示异步获取操作的任务。任务的结果包含与此服务器关联的徽章的流。

GetBanAsync(IUser, RequestOptions?)

获取指定用户在此服务器内当前的封禁信息。

public Task<RestBan?> GetBanAsync(IUser user, RequestOptions? options = null)

Parameters

user IUser

要获取封禁信息的用户。

options RequestOptions

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

Returns

Task<RestBan>

一个表示异步获取操作的任务。任务的结果包含该用户在此服务器内的封禁信息；如果该用户当前未被此服务器封禁，则返回 null。

GetBanAsync(ulong, RequestOptions?)

获取指定用户在此服务器内的封禁信息。

public Task<RestBan?> GetBanAsync(ulong userId, RequestOptions? options = null)

Parameters

userId ulong

要获取封禁信息的用户的 ID。

options RequestOptions

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

Returns

Task<RestBan>

一个表示异步获取操作的任务。任务的结果包含该用户在此服务器内的封禁信息；如果该用户未被此服务器封禁，或封禁已过期或解除，则返回 null。

GetBansAsync(RequestOptions?)

获取此服务器的所有封禁信息。

public Task<IReadOnlyCollection<RestBan>> GetBansAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task<IReadOnlyCollection<RestBan>>

一个表示异步获取操作的任务。任务的结果包含此服务器的所有封禁信息。

GetBoostSubscriptionsAsync(RequestOptions?)

所有此服务器的所有服务器助力包。

public Task<ImmutableDictionary<IUser, IReadOnlyCollection<BoostSubscriptionMetadata>>> GetBoostSubscriptionsAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task<ImmutableDictionary<IUser, IReadOnlyCollection<BoostSubscriptionMetadata>>>

一个表示异步获取操作的任务。任务的结果是所有为此服务器助力的用户及所应用的服务器助力包。

GetCategoryChannelAsync(ulong, RequestOptions?)

获取此服务器内指定的分组频道。

public Task<RestCategoryChannel?> GetCategoryChannelAsync(ulong id, RequestOptions? options = null)

Parameters

id ulong

要获取的频道的 ID。

options RequestOptions

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

Returns

Task<RestCategoryChannel>

一个表示异步获取操作的任务。任务的结果包含与指定的 id 关联的频道；如果未找到，则返回 null。

GetCategoryChannelsAsync(RequestOptions?)

获取此服务器中的所有分组频道。

public Task<IReadOnlyCollection<RestCategoryChannel>> GetCategoryChannelsAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task<IReadOnlyCollection<RestCategoryChannel>>

一个表示异步获取操作的任务。任务的结果包含此服务器的所有分组频道。

GetChannelAsync(ulong, RequestOptions?)

获取此服务器内的频道。

public Task<RestGuildChannel> GetChannelAsync(ulong id, RequestOptions? options = null)

Parameters

id ulong

要获取的频道的 ID。

options RequestOptions

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

Returns

Task<RestGuildChannel>

一个表示异步获取操作的任务。任务的结果包含与指定的 id 关联的频道；如果未找到，则返回 null。

GetChannelsAsync(RequestOptions?)

获取此服务器的所有频道。

public Task<IReadOnlyCollection<RestGuildChannel>> GetChannelsAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task<IReadOnlyCollection<RestGuildChannel>>

一个表示异步获取操作的任务。任务的结果包含此服务器的所有频道。

GetCurrentUserAsync(RequestOptions?)

获取此服务器内当前登录的用户。

public Task<RestGuildUser> GetCurrentUserAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task<RestGuildUser>

一个表示异步获取操作的任务。任务的结果包含此服务器内当前登录的用户。

GetDefaultChannelAsync(RequestOptions?)

获取此服务器的默认文字频道。

public Task<RestTextChannel?> GetDefaultChannelAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task<RestTextChannel>

一个表示异步获取操作的任务。任务的结果包含此服务器的默认文字频道；如果未找到，则返回 null。

GetEmoteAsync(string, RequestOptions?)

获取此服务器的指定自定义表情。

public Task<GuildEmote?> GetEmoteAsync(string id, RequestOptions? options = null)

Parameters

id string

要获取的自定义表情的 ID。

options RequestOptions

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

Returns

Task<GuildEmote>

一个表示异步获取操作的任务。任务的结果包含与指定的 id 关联的自定义表情；如果未找到，则返回 null。

GetEmotesAsync(RequestOptions?)

获取此服务器的所有自定义表情。

public Task<IReadOnlyCollection<GuildEmote>> GetEmotesAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task<IReadOnlyCollection<GuildEmote>>

一个表示异步获取操作的任务。任务的结果包含此服务器的所有自定义表情。

GetInvitesAsync(RequestOptions?)

获取此服务器内的所有邀请信息。

public Task<IReadOnlyCollection<IInvite>> GetInvitesAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task<IReadOnlyCollection<IInvite>>

一个表示异步获取操作的任务。任务的结果包含此服务器内的所有邀请信息。

GetOwnerAsync(RequestOptions?)

获取此服务器的所有者。

public Task<RestGuildUser> GetOwnerAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task<RestGuildUser>

一个表示异步获取操作的任务。任务的结果包含此服务器的所有者。

GetRole(uint)

获取此服务器内的角色。

public RestRole? GetRole(uint id)

Parameters

id uint

要获取的角色的 ID。

Returns

RestRole

一个表示异步获取操作的任务。任务的结果包含与指定的 id 关联的角色；如果未找到，则返回 null。

GetTextChannelAsync(ulong, RequestOptions?)

获取此服务器内指定具有文字聊天能力的频道。

public Task<RestTextChannel?> GetTextChannelAsync(ulong id, RequestOptions? options = null)

Parameters

id ulong

要获取的频道的 ID。

options RequestOptions

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

Returns

Task<RestTextChannel>

一个表示异步获取操作的任务。任务的结果包含与指定的 id 关联的频道；如果未找到，则返回 null。

Remarks

语音频道也是一种文字频道，此方法本意用于获取具有文字聊天能力的频道。如果通过此方法传入的 ID 对应的频道是语音频道，那么也会返回对应的语音频道实体。 如需获取频道的实际类型，请参考 GetChannelType(IChannel)。

GetTextChannelsAsync(RequestOptions?)

获取此服务器中所有具有文字聊天能力的频道。

public Task<IReadOnlyCollection<RestTextChannel>> GetTextChannelsAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task<IReadOnlyCollection<RestTextChannel>>

一个表示异步获取操作的任务。任务的结果包含此服务器的所有具有文字聊天能力的频道。

Remarks

语音频道也是一种文字频道，此方法本意用于获取所有具有文字聊天能力的频道，通过此方法获取到的文字频道列表中也包含了语音频道。 如需获取频道的实际类型，请参考 GetChannelType(IChannel)。

GetUserAsync(ulong, RequestOptions?)

获取此服务器内的用户。

public Task<RestGuildUser> GetUserAsync(ulong id, RequestOptions? options = null)

Parameters

id ulong

要获取的用户的 ID。

options RequestOptions

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

Returns

Task<RestGuildUser>

一个表示异步获取操作的任务。任务的结果包含与指定的 id 关联的用户；如果未找到，则返回 null。

GetUsersAsync(RequestOptions?)

获取此服务器内的所有用户。

public IAsyncEnumerable<IReadOnlyCollection<RestGuildUser>> GetUsersAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

IAsyncEnumerable<IReadOnlyCollection<RestGuildUser>>

一个表示异步获取操作的任务。任务的结果包含此服务器内的所有用户。

GetVoiceChannelAsync(ulong, RequestOptions?)

获取此服务器内指定具有语音聊天能力的频道。

public Task<RestVoiceChannel?> GetVoiceChannelAsync(ulong id, RequestOptions? options = null)

Parameters

id ulong

要获取的频道的 ID。

options RequestOptions

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

Returns

Task<RestVoiceChannel>

一个表示异步获取操作的任务。任务的结果包含与指定的 id 关联的频道；如果未找到，则返回 null。

GetVoiceChannelsAsync(RequestOptions?)

获取此服务器中所有具有语音聊天能力的频道。

public Task<IReadOnlyCollection<RestVoiceChannel>> GetVoiceChannelsAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task<IReadOnlyCollection<RestVoiceChannel>>

一个表示异步获取操作的任务。任务的结果包含此服务器的所有具有语音聊天能力的频道。

GetWelcomeChannelAsync(RequestOptions?)

获取此服务器的欢迎通知频道。

public Task<RestTextChannel?> GetWelcomeChannelAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task<RestTextChannel>

一个表示异步获取操作的任务。任务的结果包含此服务器的欢迎通知频道；如果未找到，则返回 null。

LeaveAsync(RequestOptions?)

退出此服务器。

public Task LeaveAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task

一个表示异步退出操作的任务。

ModifyEmoteNameAsync(GuildEmote, string, RequestOptions?)

修改此服务器内的现有自定义表情。

public Task ModifyEmoteNameAsync(GuildEmote emote, string name, RequestOptions? options = null)

Parameters

emote GuildEmote

要修改的自定义表情。

name string

新的自定义表情名称。

options RequestOptions

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

Returns

Task

一个表示异步修改操作的任务。任务的结果包含修改后的自定义表情。

Exceptions

ArgumentNullException

name is null.

MoveUsersAsync(IEnumerable<IGuildUser>, IVoiceChannel, RequestOptions?)

移动用户到语音频道。

public Task MoveUsersAsync(IEnumerable<IGuildUser> users, IVoiceChannel targetChannel, RequestOptions? options = null)

Parameters

users IEnumerable<IGuildUser>

要移动的用户。

targetChannel IVoiceChannel

要移动用户到的语音频道。

options RequestOptions

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

Returns

Task

一个表示异步移动操作的任务。

RemoveBanAsync(IUser, RequestOptions?)

解除服务器对用户的封禁。

public Task RemoveBanAsync(IUser user, RequestOptions? options = null)

Parameters

user IUser

要解除封禁的用户。

options RequestOptions

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

Returns

Task

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

RemoveBanAsync(ulong, RequestOptions?)

解除服务器对用户的封禁。

public Task RemoveBanAsync(ulong userId, RequestOptions? options = null)

Parameters

userId ulong

要解除封禁的用户的 ID。

options RequestOptions

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

Returns

Task

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

SearchUsersAsync(Action<SearchGuildMemberProperties>, int, RequestOptions?)

获取此服务器内与指定搜索条件匹配的用户。

public IAsyncEnumerable<IReadOnlyCollection<RestGuildUser>> SearchUsersAsync(Action<SearchGuildMemberProperties> func, int limit = 50, RequestOptions? options = null)

Parameters

func Action<SearchGuildMemberProperties>

一个包含设置服务器用户搜索条件属性的委托。

limit int

要获取搜索到的服务器用户的数量。

options RequestOptions

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

Returns

IAsyncEnumerable<IReadOnlyCollection<RestGuildUser>>

分页的服务器用户集合的异步可枚举对象。

Remarks

important

返回的集合是一个异步可枚举对象；调用 FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) 可以异步枚举所有分页，并将其合并为一个集合。

此方法将尝试获取所有与指定搜索条件匹配的用户。此方法会根据 MaxUsersPerBatch 将请求拆分。换句话说，如果搜索结果有 3000 名用户，而 MaxUsersPerBatch 的常量为 50，则请求将被拆分为 60 个单独请求，因此异步枚举器会异步枚举返回 60 个响应。 FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) 方法可以展开这 60 个响应返回的集合，并将其合并为一个集合。

ToString()

获取此服务器的名称。

public override string ToString()

Returns

string

此服务器的名称。

UpdateAsync(RequestOptions?)

通过 REST API 获取此实体对象的最新状态，并替换当前对象的属性。

public Task UpdateAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task

一个表示异步更新操作的任务。

Remarks

warning

此方法将从 KOOK REST API 获取最新数据，并替换当前对象的属性，而非使用指定的属性修改 KOOK 服务端的数据。