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

TopGuildChannelBehavior

interface TopGuildChannelBehavior : GuildChannelBehavior(source)

The behavior of a non-thread Discord channel associated to a guild.

'Top' channels are those that do not require a parent channel to be created, and can be found at the top of the UI's hierarchy.

Inheritors

Properties

Link copied to clipboard
open val guild: GuildBehavior

The guild behavior this channel is associated to.

Link copied to clipboard
abstract val guildId: Snowflake

The id of the guild this channel is associated to.

Link copied to clipboard
abstract val id: Snowflake

The unique identifier of this entity.

Link copied to clipboard
abstract val kord: Kord

The kord instance that created this object.

Link copied to clipboard
open val mention: String

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

Link copied to clipboard
abstract val supplier: EntitySupplier

The supplier used to request entities.

Functions

Link copied to clipboard
open suspend fun addOverwrite(overwrite: PermissionOverwrite, reason: String? = null)

Requests to add or replace a PermissionOverwrite to this entity.

Link copied to clipboard
open suspend override fun asChannel(): TopGuildChannel

Requests to get this behavior as a TopGuildChannel.

Link copied to clipboard
inline suspend fun <T : Channel> ChannelBehavior.asChannelOf(): T

Requests to get the Channel represented by this ChannelBehavior.

Link copied to clipboard
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.

Link copied to clipboard
open suspend override fun asChannelOrNull(): TopGuildChannel?

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

Link copied to clipboard
open operator override fun compareTo(other: Entity): Int

Compares entities on id.

Link copied to clipboard
open suspend fun delete(reason: String? = null)

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

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

Requests to add or replace a PermissionOverwrite for the memberId.

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

Requests to add or replace a PermissionOverwrite for the roleId.

Link copied to clipboard
open suspend override fun fetchChannel(): TopGuildChannel

Retrieve the TopGuildChannel associated with this behaviour from the provided EntitySupplier

Link copied to clipboard
open suspend override fun fetchChannelOrNull(): TopGuildChannel?

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

Link copied to clipboard
open suspend fun getGuild(): Guild

Requests to get this channel's Guild.

Link copied to clipboard
open suspend fun getGuildOrNull(): Guild?

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

Link copied to clipboard
open suspend fun getPosition(): Int

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

Link copied to clipboard
open override fun withStrategy(strategy: EntitySupplyStrategy<*>): TopGuildChannelBehavior

Returns a new TopGuildChannelBehavior with the given strategy.