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

DmChannel

data class DmChannel(val data: ChannelData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : MessageChannel(source)

An instance of a Discord DM channel.

Constructors

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

Properties

open override val data: ChannelData

open val flags: ChannelFlags?

The flags of this channel, if present.

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 lastMessage: MessageBehavior?

The behavior of the last message sent to this channel, if present.

open val lastMessageId: Snowflake?

The id of the last message sent to this channel, if present.

lastPinTimestamp

open val lastPinTimestamp: Instant?

The timestamp of the last pin

open val mention: String

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

open val messages: Flow<Message>

Requests to get all messages in this channel.

open val pinnedMessages: Flow<Message>

Requests to get the pinned messages in this channel.

recipientBehaviors

val recipientBehaviors: Set<UserBehavior>

The behaviors of the recipients of the channel.

val recipientIds: Set<Snowflake>

The ids of the recipients of the channel.

val recipients: Flow<User>

Requests to get the recipients of the channel.

open override val supplier: EntitySupplier

The supplier used to request entities.

open val type: ChannelType

The type of this channel.

Functions

open suspend override fun asChannel(): MessageChannel

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

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.

inline suspend fun MessageChannelBehavior.createEmbed(block: EmbedBuilder.() -> Unit): Message

Requests to create a message with only an embed.

open suspend fun createMessage(content: String): Message

Requests to create a message with only a MessageCreateBuilder.content.

inline suspend fun MessageChannelBehavior.createMessage(builder: UserMessageCreateBuilder.() -> Unit): Message

Requests to create a message configured by the builder.

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

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

open suspend fun deleteMessage(id: Snowflake, reason: String? = null)

Requests to delete a message in this channel.

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.

open suspend fun getLastMessage(): Message?

Requests to get the last message sent to this channel, return null if no lastMessageId is present or if the message itself isn't present.

open suspend fun getMessage(messageId: Snowflake): Message

Requests to get a message with the given messageId.

getMessageOrNull

open suspend fun getMessageOrNull(messageId: Snowflake): Message?

Requests to get a message with the given messageId, returns null if the message isn't present or is not part of this channel.

getMessagesAfter

open fun getMessagesAfter(messageId: Snowflake, limit: Int? = null): Flow<Message>

Requests to get all messages in this channel that were created after messageId.

getMessagesAround

open fun getMessagesAround(messageId: Snowflake, limit: Int = 100): Flow<Message>

Requests to get Messages around (both older and newer) the messageId.

getMessagesBefore

open fun getMessagesBefore(messageId: Snowflake, limit: Int? = null): Flow<Message>

Requests to get all messages in this channel that were created before messageId.

open override fun hashCode(): Int

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

fun DmChannel.live(coroutineScope: CoroutineScope = kord + SupervisorJob(kord.coroutineContext.job)): LiveDmChannel

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

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

open override fun toString(): String

open suspend fun type()

Requests to trigger the typing indicator for the bot in this channel. The typing status will persist for 10 seconds or until the bot creates a message in the channel.

open suspend fun typeUntil(mark: TimeMark)

Requests to trigger the typing indicator for the bot in this channel. The typing status will persist until the mark is reached.

open suspend fun typeUntil(instant: Instant)

Requests to trigger the typing indicator for the bot in this channel. The typing status will persist until the instant is reached.

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

returns a new DmChannel with the given strategy.