kord-core/dev.kord.core.entity.channel/ForumChannel

ForumChannel

class ForumChannel(val data: ChannelData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : ThreadOnlyChannel, ForumChannelBehavior(source)

Constructors

constructor(data: ChannelData, kord: Kord, supplier: EntitySupplier = kord.defaultSupplier)

Properties

open val activeThreads: Flow<ThreadChannel>

Returns all active public and private threads in the channel. Threads are ordered by their id, in descending order.

open val availableTags: List<ForumTag>

The set of tags that can be used in this channel.

open val category: CategoryBehavior?

The category behavior this channel belongs to, if any.

open val categoryId: Snowflake?

The id of the category this channel belongs to, if any.

open override val data: ChannelData

defaultAutoArchiveDuration

open val defaultAutoArchiveDuration: ArchiveDuration?

Default ArchiveDuration, copied onto newly created threads in this channel. Threads will stop showing in the channel list after the specified period of inactivity.

defaultForumLayout

val defaultForumLayout: ForumLayoutType?

The default layout of the forum, if present.

defaultReactionEmoji

open val defaultReactionEmoji: DefaultReaction?

The emoji to show in the add reaction button on a thread in this channel.

defaultSortOrder

open val defaultSortOrder: SortOrderType?

The default SortOrderType used to order posts in this channel.

defaultThreadRateLimitPerUser

open val defaultThreadRateLimitPerUser: Duration?

The initial ThreadChannel.rateLimitPerUser to set on newly created threads in this channel. This field is copied to the thread at creation time and does not live update.

open val flags: ChannelFlags?

The flags of this channel, if present.

open val guild: GuildBehavior

The guild behavior this channel is associated to.

abstract val guildId: Snowflake

The id of the guild this channel is associated to.

abstract val id: Snowflake

The unique identifier of this entity.

open val invites: Flow<InviteWithMetadata>

Requests to get the invites of this channel.

open val isNsfw: Boolean

Whether the channel is nsfw.

open override val kord: Kord

The kord instance that created this object.

open val lastThreadId: Snowflake?

The id of the last thread created in this channel (may not point to an existing or valid thread).

open val mention: String

This channel formatted as a mention as used by the Discord API.

open val name: String

The name of this channel.

permissionOverwrites

open val permissionOverwrites: Set<PermissionOverwriteEntity>

The permission overwrites for this channel.

rateLimitPerUser

open val rateLimitPerUser: Duration?

The amount of time a user has to wait before creating another thread.

open val rawPosition: Int

The raw position of this channel in the guild as displayed by Discord.

open override val supplier: EntitySupplier

The supplier used to request entities.

open val topic: String?

The channel topic, if present.

open val type: ChannelType

The type of this channel.

open val webhooks: Flow<Webhook>

Requests to get all webhooks for this channel.

Functions

open suspend fun addOverwrite(overwrite: PermissionOverwrite, reason: String? = null)

Requests to add or replace a PermissionOverwrite to this entity.

open suspend override fun asChannel(): ForumChannel

Requests to get this behavior as a CategorizableChannel.

inline suspend fun <T : Channel> ChannelBehavior.asChannelOf(): T

Requests to get the Channel represented by this ChannelBehavior.

asChannelOfOrNull

inline suspend fun <T : Channel> ChannelBehavior.asChannelOfOrNull(): T?

Requests to get the Channel represented by this ChannelBehavior, returns null if the Channel isn't present.

asChannelOrNull

open suspend override fun asChannelOrNull(): ForumChannel

Requests to get this behavior as a CategorizableChannel, returns null if the channel isn't present or if the channel isn't a guild channel.

open operator override fun compareTo(other: Entity): Int

Compares entities on id.

inline suspend fun CategorizableChannelBehavior.createInvite(builder: InviteCreateBuilder.() -> Unit = {}): InviteWithMetadata

Request to create an InviteWithMetadata for this channel.

inline suspend fun CategorizableChannelBehavior.createWebhook(name: String, builder: WebhookCreateBuilder.() -> Unit = {}): Webhook

Requests to create a new webhook configured by the builder.

open suspend fun delete(reason: String? = null)

Requests to delete a channel (or close it if this is a dm channel).

inline suspend fun ForumChannelBehavior.edit(builder: ForumChannelModifyBuilder.() -> Unit): ForumChannel

editMemberPermission

inline suspend fun TopGuildChannelBehavior.editMemberPermission(memberId: Snowflake, builder: ChannelPermissionModifyBuilder.() -> Unit)

Requests to add or replace a PermissionOverwrite for the memberId.

editRolePermission

inline suspend fun TopGuildChannelBehavior.editRolePermission(roleId: Snowflake, builder: ChannelPermissionModifyBuilder.() -> Unit)

Requests to add or replace a PermissionOverwrite for the roleId.

open operator override fun equals(other: Any?): Boolean

open suspend override fun fetchChannel(): ThreadParentChannel

Retrieve the ThreadParentChannel associated with this behaviour from the provided EntitySupplier

fetchChannelOrNull

open suspend override fun fetchChannelOrNull(): ThreadParentChannel?

Retrieve the ThreadParentChannel associated with this behaviour from the provided EntitySupplier returns null if the ThreadParentChannel isn't present.

getEffectivePermissions

open suspend fun getEffectivePermissions(memberId: Snowflake): Permissions

Calculates the effective permissions of the memberId in this channel, applying the overwrite for the member and their roles on top of the base permissions.

open suspend fun getGuild(): Guild

Requests to get this channel's Guild.

open suspend fun getGuildOrNull(): Guild?

Requests to get this channel's Guild, returns null if the guild isn't present.

getPermissionOverwritesForMember

open fun getPermissionOverwritesForMember(memberId: Snowflake): PermissionOverwriteEntity?

Gets the permission overwrite for the memberId in this channel, if present.

getPermissionOverwritesForRole

open fun getPermissionOverwritesForRole(roleId: Snowflake): PermissionOverwriteEntity?

Gets the permission overwrite for the roleId in this channel, if present.

open suspend fun getPosition(): Int

Requests to get the position of this channel in the guild, as displayed in Discord.

getPublicArchivedThreads

open fun getPublicArchivedThreads(before: Instant? = null, limit: Int? = null): Flow<ThreadChannel>

Returns archived threads in the channel that are public. Threads are ordered by ThreadChannel.archiveTimestamp in descending order. Requires the Read Message History Permission

open override fun hashCode(): Int

fun Channel.live(coroutineScope: CoroutineScope = kord + SupervisorJob(kord.coroutineContext.job)): LiveChannel

fun TopGuildChannel.live(coroutineScope: CoroutineScope = kord + SupervisorJob(kord.coroutineContext.job)): LiveGuildChannel

inline fun Channel.live(coroutineScope: CoroutineScope = kord + SupervisorJob(kord.coroutineContext.job), block: LiveChannel.() -> Unit): LiveChannel

inline fun TopGuildChannel.live(coroutineScope: CoroutineScope = kord + SupervisorJob(kord.coroutineContext.job), block: LiveGuildChannel.() -> Unit): LiveGuildChannel

startPublicThread

open suspend fun startPublicThread(name: String, builder: StartForumThreadBuilder.() -> Unit): TextChannelThread

open override fun toString(): String

open override fun withStrategy(strategy: EntitySupplyStrategy<*>): ForumChannel

Returns a new CategorizableChannelBehavior with the given strategy.