kord-core/dev.kord.core.behavior.channel.threads/PrivateThreadParentChannelBehavior

PrivateThreadParentChannelBehavior

interface PrivateThreadParentChannelBehavior : ThreadParentChannelBehavior(source)

Behavior of channels that can contain private threads. This derives from ThreadParentChannelBehavior since Discord allows all public operations on private thread parents.

Inheritors

TextChannelBehavior

Properties

activeThreads

open val activeThreads: Flow<ThreadChannel>

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

guild

open val guild: GuildBehavior

The guild behavior this channel is associated to.

guildId

abstract val guildId: Snowflake

The id of the guild this channel is associated to.

abstract val id: Snowflake

The unique identifier of this entity.

invites

open val invites: Flow<InviteWithMetadata>

Requests to get the invites of this channel.

kord

abstract val kord: Kord

The kord instance that created this object.

mention

open val mention: String

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

supplier

abstract val supplier: EntitySupplier

The supplier used to request entities.

webhooks

open val webhooks: Flow<Webhook>

Requests to get all webhooks for this channel.

Functions

addOverwrite

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

Requests to add or replace a PermissionOverwrite to this entity.

asChannel

open suspend override fun asChannel(): ThreadParentChannel

Requests to get this behavior as a CategorizableChannel.

asChannelOf

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(): ThreadParentChannel?

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.

compareTo

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

Compares entities on id.

createInvite

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

Request to create an InviteWithMetadata for this channel.

createWebhook

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

Requests to create a new webhook configured by the builder.

delete

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

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

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.

fetchChannel

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.

getGuild

open suspend fun getGuild(): Guild

Requests to get this channel's Guild.

getGuildOrNull

open suspend fun getGuildOrNull(): Guild?

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

getJoinedPrivateArchivedThreads

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

Returns archived threads in the channel that are private, and the user has joined. Threads are ordered by their id in descending order. Requires the Read Message History Permission.

getPosition

open suspend fun getPosition(): Int

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

getPrivateArchivedThreads

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

Returns archived threads in the channel that are private. Threads are ordered by archive timestamp in descending order. Requires the Read Message History Permission and Manage Threads Permission

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

withStrategy

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

Returns a new CategorizableChannelBehavior with the given strategy.