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

Channel

interface Channel : ChannelBehavior(source)

An instance of a Discord Channel

Inheritors

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
abstract val data: ChannelData
Link copied to clipboard
open val flags: ChannelFlags?

The flags of this channel, if present.

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

Link copied to clipboard
open val type: ChannelType

The type of this channel.

Functions

Link copied to clipboard
open suspend fun asChannel(): Channel

Requests to get this behavior as a Channel .

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

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

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

Retrieve the Channel associated with this behaviour from the provided EntitySupplier

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

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

Link copied to clipboard
@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
Link copied to clipboard
open override fun withStrategy(strategy: EntitySupplyStrategy<*>): Channel

Returns a new Channel with the given strategy.