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

GuildChannel

interface GuildChannel : Channel, GuildChannelBehavior(source)

An instance of a Discord channel associated to a guild.

Inheritors

GuildMessageChannel

TopGuildChannel

Properties

data

abstract val data: ChannelData

flags

open val flags: ChannelFlags?

The flags of this channel, if present.

guild

open val guild: GuildBehavior

The guild behavior this channel is associated to.

guildId

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.

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.

name

open val name: String

The name of this channel.

supplier

abstract val supplier: EntitySupplier

The supplier used to request entities.

type

open val type: ChannelType

The type of this channel.

Functions

asChannel

open suspend fun asChannel(): Channel

Requests to get this behavior as a Channel .

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

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

compareTo

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

Compares entities on id.

delete

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

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

fetchChannel

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.

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.

live

@KordPreview

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

@KordPreview

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

withStrategy

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

Returns a new Channel with the given strategy.