Whether the channel is archived. Users cannot edit messages, add reactions, use slash commands, or join archived threads. The only operation that should happen within an archived thread is messages being deleted. Sending a message will automatically unarchive the thread, unless the thread has been locked by a moderator.

isLocked

open val isLocked: Boolean

Threads that have isLocked set to true can only be unarchived by a user with the Manage Threads permission.

isNsfw

open val isNsfw: Boolean

Whether the channel is nsfw. This is inherited from the parent channel.

kord

open override val kord: Kord

The kord instance that created this object.

lastMessage

open val lastMessage: MessageBehavior?

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

lastMessageId

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

member

open val member: ThreadMember?

The member of the current user in the thread.

memberCount

open val memberCount: Int?

An approximate count of users in this thread, stops counting at 50.

members

open val members: Flow<ThreadMember>

Requests to get all members of the current thread.

mention

open val mention: String

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

message

open val message: Message?

Only available when creating a thread in a ForumChannel or MediaChannel.

messageCount

open val messageCount: Int?

Number of messages (not including the initial message or deleted messages) in this thread.

messages

open val messages: Flow<Message>

Requests to get all messages in this channel.

name

open val name: String

The name of this channel.

owner

open val owner: UserBehavior

ownerId

open val ownerId: Snowflake

The id of the user who created the thread.

parent

open val parent: ThreadParentChannelBehavior

parentId

open override val parentId: Snowflake

pinnedMessages

open val pinnedMessages: Flow<Message>

Requests to get the pinned messages in this channel.

rateLimitPerUser

open val rateLimitPerUser: Duration?

The amount of time a user has to wait before sending another message.

supplier

open override val supplier: EntitySupplier

The supplier used to request entities.

totalMessageSent

open val totalMessageSent: Int?

Number of messages ever sent in this thread, it's similar to messageCount on message creation, but will not decrement the number when a message is deleted.

type

open val type: ChannelType

The type of this channel.

Functions

addUser

open suspend fun addUser(userId: Snowflake)

Adds the user identified by id from the current thread. Requires the thread is not locked. or current bot has Manage Threads permission

asChannel

open suspend override fun asChannel(): NewsChannelThread

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 override fun asChannelOrNull(): NewsChannelThread

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

bulkDelete

open suspend fun bulkDelete(messages: Iterable<Snowflake>, deleteOlderMessages: Boolean = true, reason: String? = null)

Requests to bulk delete the messages.

compareTo

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

Compares entities on id.

createEmbed

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

Requests to create a message with only an embed.

createMessage

open suspend fun createMessage(content: String): Message

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

createMessage

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

Requests to create a message configured by the builder.

delete

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

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

deleteMessage

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

Requests to delete a message in this channel.

edit

inline suspend fun ThreadChannelBehavior.edit(builder: ThreadModifyBuilder.() -> Unit): ThreadChannel

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.

getLastMessage

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.

getMessage

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.

getParent

open suspend override fun getParent(): NewsChannel

Requests to get this channel's ThreadParentChannel.

getParentOrNull

open suspend override fun getParentOrNull(): NewsChannel?

Requests to get this channel's ThreadParentChannel, returns null if the thread parent isn't present.

join

open suspend fun join()

Join the the current thread. Requires the thread is not locked. or current bot has Manage Threads permission

leave

open suspend fun leave()

Leaves the current thread if the bot has already joined. Requires the thread is not locked. or current bot has Manage Threads permission

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

removeUser

open suspend fun removeUser(userId: Snowflake)

Removes the user identified by id from the current thread. Requires the thread is not locked. or current bot has Manage Threads permission

type

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.

typeUntil

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.

withStrategy

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

Returns a new GuildMessageChannel with the given strategy.