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

Category

class Category(val data: ChannelData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : TopGuildChannel, CategoryBehavior(source)

An instance of a Discord category associated to a guild.

Constructors

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

Properties

open val channels: Flow<CategorizableChannel>

Requests to get the channels that belong to this Category.

open override val data: ChannelData

open val flags: ChannelFlags?

The flags of this channel, if present.

open override val guild: GuildBehavior

The guild behavior this channel is associated to.

open override val guildId: Snowflake

The id of the guild this channel is associated to.

open override val id: Snowflake

The unique identifier of this entity.

open override 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.

open val name: String

The name of this channel.

permissionOverwrites

open val permissionOverwrites: Set<PermissionOverwriteEntity>

The permission overwrites for this channel.

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 type: ChannelType

The type of 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(): Category

Requests to get this behavior as a Channel .

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(): Category

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

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

Compares entities on id.

createNewsChannel

inline suspend fun CategoryBehavior.createNewsChannel(name: String, builder: NewsChannelCreateBuilder.() -> Unit = {}): NewsChannel

Requests to create a new news channel with this category as parent.

createStageChannel

inline suspend fun CategoryBehavior.createStageChannel(name: String, builder: StageChannelCreateBuilder.() -> Unit = {}): StageChannel

Requests to create a new stage channel with this category as parent.

createTextChannel

inline suspend fun CategoryBehavior.createTextChannel(name: String, builder: TextChannelCreateBuilder.() -> Unit = {}): TextChannel

Requests to create a new text channel with this category as parent.

createVoiceChannel

inline suspend fun CategoryBehavior.createVoiceChannel(name: String, builder: VoiceChannelCreateBuilder.() -> Unit = {}): VoiceChannel

Requests to create a new voice channel with this category as parent.

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

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

suspend fun CategoryBehavior.edit(builder: CategoryModifyBuilder.() -> Unit): Category

Requests to edit this category.

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 fun fetchChannel(): Channel

Retrieve the Channel associated with this behaviour from the provided EntitySupplier

fetchChannelOrNull

open suspend fun fetchChannelOrNull(): Channel?

Retrieve the Channel associated with this behaviour from the provided EntitySupplier returns null if the Channel 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.

open override fun hashCode(): Int

fun Category.live(coroutineScope: CoroutineScope = kord + SupervisorJob(kord.coroutineContext.job)): LiveCategory

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

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

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

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

open override fun toString(): String

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

Returns a new Category with the given strategy.