kord-core/dev.kord.core.behavior.channel/ForumChannelBehavior

ForumChannelBehavior

interface ForumChannelBehavior : ThreadOnlyChannelBehavior(source)

Inheritors

Properties

open override val activeThreads: Flow<TextChannelThread>

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

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.

abstract val kord: Kord

The kord instance that created this object.

open val mention: String

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

abstract val supplier: EntitySupplier

The supplier used to request entities.

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 ForumChannel.

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 ForumChannel, returns null if the channel isn't present or if the channel isn't a ForumChannel.

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 suspend override fun fetchChannel(): ForumChannel

Retrieve the ForumChannel associated with this behavior from the provided EntitySupplier.

fetchChannelOrNull

open suspend override fun fetchChannelOrNull(): ForumChannel?

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

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.

open suspend fun getPosition(): Int

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

getPublicArchivedThreads

open override fun getPublicArchivedThreads(before: Instant?, limit: Int?): Flow<TextChannelThread>

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

startPublicThread

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

abstract override fun withStrategy(strategy: EntitySupplyStrategy<*>): ForumChannelBehavior

Returns a new CategorizableChannelBehavior with the given strategy.