Table of Contents

Interface INestedChannel

Namespace
Kook
Assembly
Kook.Net.Core.dll

表示一个通用的嵌套频道，即可以嵌套在分组频道中的服务器频道。

public interface INestedChannel : IGuildChannel, IChannel, IEntity<ulong>, IDeletable
Inherited Members
Extension Methods

Properties

CategoryId

获取此嵌套频道在服务器频道列表中所属的分组频道的 ID。

ulong? CategoryId { get; }

Property Value

ulong?

Remarks

如果当前频道不属于任何分组频道，则会返回 null。

IsPermissionSynced

指示此嵌套频道的权限是否与其所属分组频道同步。

bool? IsPermissionSynced { get; }

Property Value

bool?

Remarks

如果权限同步，则此属性返回 true；如果权限不同步，则返回 false；如果无法确定权限是否同步，则返回 null。

Methods

CreateInviteAsync(InviteMaxAge, InviteMaxUses, RequestOptions?)

创建一个到此频道新邀请。

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

Parameters

maxAge InviteMaxAge

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

maxUses InviteMaxUses

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

options RequestOptions

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

Returns

Task<IInvite>

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

CreateInviteAsync(int?, int?, RequestOptions?)

创建一个到此频道新邀请。

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

Parameters

maxAge int?

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

maxUses int?

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

options RequestOptions

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

Returns

Task<IInvite>

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

GetCategoryAsync(CacheMode, RequestOptions?)

获取此频道的所属分组频道。

Task<ICategoryChannel?> GetCategoryAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions? options = null)

Parameters

mode CacheMode

指示当前方法是否应该仅从缓存中获取结果，还是可以通过 API 请求获取数据。

options RequestOptions

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

Returns

Task<ICategoryChannel>

一个表示异步获取操作的任务。任务的结果包含此频道所属的分组频道，如果当前频道不属于任何分组频道，则为 null。

GetInvitesAsync(RequestOptions?)

获取此嵌套频道的所有邀请信息。

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

Parameters

options RequestOptions

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

Returns

Task<IReadOnlyCollection<IInvite>>

一个表示异步获取操作的任务。任务的结果包含此频道中找到的所有邀请信息。

SyncPermissionsAsync(RequestOptions?)

同步此嵌套频道的权限配置与其所属分组频道一致，并保持同步。

Task SyncPermissionsAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task

一个表示异步频道权限同步操作的任务。

Edit this page