Class SocketGuildExperimentalExtensions

Namespace

Kook.WebSocket

Assembly

Kook.Net.Experimental.dll

提供对 SocketGuild 的实验性方法。

public static class SocketGuildExperimentalExtensions

Inheritance

object

SocketGuildExperimentalExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

CreateBehaviorRestrictionAsync(SocketGuild, string, IReadOnlyCollection<IBehaviorRestrictionCondition>, TimeSpan, BehaviorRestrictionType, bool, RequestOptions?)

创建服务器行为限制。

public static Task<RestBehaviorRestriction> CreateBehaviorRestrictionAsync(this SocketGuild guild, string name, IReadOnlyCollection<IBehaviorRestrictionCondition> conditions, TimeSpan duration, BehaviorRestrictionType restrictionType, bool isEnabled = true, RequestOptions? options = null)

Parameters

guild SocketGuild

要创建行为限制的服务器。

name string

行为限制名称。

conditions IReadOnlyCollection<IBehaviorRestrictionCondition>

行为限制条件集合。

duration TimeSpan

行为限制持续时间。

restrictionType BehaviorRestrictionType

行为限制类型。

isEnabled bool

是否启用行为限制。

options RequestOptions

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

Returns

Task<RestBehaviorRestriction>

一个表示异步操作的任务，任务的结果是创建的行为限制。

Exceptions

NotSupportedException

当 guild 不是 RestGuild 或 SocketGuild 时引发。

CreateContentFilterAsync(SocketGuild, IContentFilterTarget, IReadOnlyCollection<IContentFilterHandler>?, IReadOnlyCollection<ContentFilterExemption>?, bool, RequestOptions?)

创建服务器内容过滤。

public static Task<RestContentFilter> CreateContentFilterAsync(this SocketGuild guild, IContentFilterTarget target, IReadOnlyCollection<IContentFilterHandler>? handlers = null, IReadOnlyCollection<ContentFilterExemption>? exemptions = null, bool isEnabled = true, RequestOptions? options = null)

Parameters

guild SocketGuild

要创建内容过滤的服务器。

target IContentFilterTarget

内容过滤目标。

handlers IReadOnlyCollection<IContentFilterHandler>

内容过滤处理程序集合。

exemptions IReadOnlyCollection<ContentFilterExemption>

内容过滤豁免集合。

isEnabled bool

是否启用内容过滤。

options RequestOptions

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

Returns

Task<RestContentFilter>

一个表示异步操作的任务，任务的结果是创建的内容过滤。

Exceptions

NotSupportedException

当 guild 不是 RestGuild 或 SocketGuild 时引发。

GetBehaviorRestrictionsAsync(SocketGuild, RequestOptions?)

获取服务器的行为限制信息。

public static Task<IReadOnlyCollection<RestBehaviorRestriction>> GetBehaviorRestrictionsAsync(this SocketGuild guild, RequestOptions? options = null)

Parameters

guild SocketGuild

要获取行为限制信息的服务器。

options RequestOptions

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

Returns

Task<IReadOnlyCollection<RestBehaviorRestriction>>

一个表示异步操作的任务，任务的结果是服务器的所有行为限制信息。

Exceptions

NotSupportedException

当 guild 不是 RestGuild 或 SocketGuild 时引发。

GetContentFiltersAsync(SocketGuild, RequestOptions?)

获取服务器的内容过滤信息。

public static Task<IReadOnlyCollection<RestContentFilter>> GetContentFiltersAsync(this SocketGuild guild, RequestOptions? options = null)

Parameters

guild SocketGuild

要获取内容过滤信息的服务器。

options RequestOptions

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

Returns

Task<IReadOnlyCollection<RestContentFilter>>

一个表示异步操作的任务，任务的结果是服务器的所有内容过滤信息。

Exceptions

NotSupportedException

当 guild 不是 RestGuild 或 SocketGuild 时引发。