Table of Contents

Class SocketThreadChannel

Namespace
Kook.WebSocket
Assembly
Kook.Net.WebSocket.dll

表示服务器中一个基于网关的帖子频道，可以浏览、发布和回复帖子。

public class SocketThreadChannel : SocketGuildChannel, IUpdateable, IThreadChannel, INestedChannel, IGuildChannel, IChannel, IEntity<ulong>, IDeletable, IMentionable
Inheritance
SocketThreadChannel
Implements
Inherited Members
Extension Methods

Remarks

warning

网关目前不会下发有关帖子频道信息变更的事件，此实体的信息可能会过时。如需获取最新信息，请先调用 UpdateAsync(RequestOptions?)

Properties

Category

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

public ICategoryChannel? Category { get; }

Property Value

ICategoryChannel

Remarks

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

warning

网关目前不会下发有关帖子频道信息变更的事件，此实体的信息可能会过时。如需获取最新信息，请先调用 UpdateAsync(RequestOptions?)

CategoryId

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

public ulong? CategoryId { get; }

Property Value

ulong?

Remarks

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

IsPermissionSynced

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

public bool? IsPermissionSynced { get; }

Property Value

bool?

Remarks

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

KMarkdownMention

返回一个用于在 KMarkdown 格式文本中提及此对象的格式化字符串。

public string KMarkdownMention { get; }

Property Value

string

PlainTextMention

获取一个用于在纯文本格式文本中提及此对象的格式化字符串。

public string PlainTextMention { get; }

Property Value

string

PostCreationInterval

获取此频道设置的发帖速率限制。

public int PostCreationInterval { get; }

Property Value

int

一个 int，表示用户在可以发布另一条帖子之前需要等待的时间（以秒为单位）；如果未启用，则为 0。

Remarks

拥有 ManageMessages 或 ManageChannels 权限的用户不受慢速模式延迟的限制。

ReplyInterval

获取此频道设置的回帖速率限制。

public int? ReplyInterval { get; }

Property Value

int?

一个 int，表示用户在可以对任意帖子发布另一条回复之前需要等待的时间（以秒为单位）；如果未启用，则为 0。

Remarks

拥有 ManageMessages 或 ManageChannels 权限的用户不受慢速模式延迟的限制。

Topic

获取此频道的说明。

public string Topic { get; }

Property Value

string

Remarks

warning

网关目前不会下发有关帖子频道信息变更的事件，此实体的信息可能会过时。如需获取最新信息，请先调用 UpdateAsync(RequestOptions?)

Users

获取用户缓存列表中的可以访问此频道的所有用户。

public override IReadOnlyCollection<SocketGuildUser> Users { get; }

Property Value

IReadOnlyCollection<SocketGuildUser>

Remarks

此属性仅会返回缓存中可以访问此频道的所有用户，如果未启用用户列表缓存，或者由于网关事件确实导致本地缓存不同步，此属性所返回的用户列表可能不准确。

Methods

CreateInviteAsync(InviteMaxAge, InviteMaxUses, RequestOptions?)

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

public 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?)

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

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

Parameters

maxAge int?

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

maxUses int?

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

options RequestOptions

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

Returns

Task<IInvite>

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

GetInvitesAsync(RequestOptions?)

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

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

Parameters

options RequestOptions

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

Returns

Task<IReadOnlyCollection<IInvite>>

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

GetUser(ulong)

获取此频道中的一个服务器用户。

public override SocketGuildUser? GetUser(ulong id)

Parameters

id ulong

要获取的服务器用户的 ID。

Returns

SocketGuildUser

如果找到了具有指定 ID 的服务器用户，则返回该用户；否则返回 null。

ModifyAsync(Action<ModifyThreadChannelProperties>, RequestOptions?)

修改此频道的属性。

public virtual Task ModifyAsync(Action<ModifyThreadChannelProperties> func, RequestOptions? options = null)

Parameters

func Action<ModifyThreadChannelProperties>

一个包含修改帖子频道的属性的委托。

options RequestOptions

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

Returns

Task

一个表示异步修改操作的任务。

See Also

SyncPermissionsAsync(RequestOptions?)

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

public virtual Task SyncPermissionsAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task

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

Edit this page