ThreadChannelBehavior

Properties

Link copied to clipboard

The guild behavior this channel is associated to.

Link copied to clipboard
abstract val guildId: Snowflake

The id of the guild this channel is associated to.

Link copied to clipboard
abstract 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

Requests to get all members of the current thread.

Link copied to clipboard
open val mention: String

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

Link copied to clipboard
open val messages: Flow<Message>

Requests to get all messages in this channel.

Link copied to clipboard
Link copied to clipboard
abstract val parentId: Snowflake
Link copied to clipboard

Requests to get the pinned messages in this channel.

Link copied to clipboard
abstract val supplier: EntitySupplier

The supplier used to request entities.

Functions

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

Link copied to clipboard
open suspend override fun asChannel(): ThreadChannel

Requests to get this behavior as a TopGuildChannel.

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

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

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

Requests to bulk delete the messages.

Link copied to clipboard
open operator override fun compareTo(other: Entity): Int

Compares entities on id.

Link copied to clipboard
inline suspend fun MessageChannelBehavior.createEmbed(block: EmbedBuilder.() -> Unit): Message

Requests to create a message with only an embed.

Link copied to clipboard
open suspend fun createMessage(content: String): Message

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

Link copied to clipboard

Requests to create a message configured by the builder.

Link copied to clipboard
open suspend override fun delete(reason: String?)

Deleting a thread requires the Manage Threads permission.

Link copied to clipboard
open suspend fun deleteMessage(id: Snowflake, reason: String? = null)

Requests to delete a message in this channel.

Link copied to clipboard
Link copied to clipboard
open suspend override fun fetchChannel(): GuildMessageChannel

Retrieve the GuildMessageChannel associated with this behaviour from the provided EntitySupplier

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

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

Link copied to clipboard
open suspend fun getGuild(): Guild

Requests to get this channel's Guild.

Link copied to clipboard
open suspend fun getGuildOrNull(): Guild?

Requests to get this channel's Guild, returns null if the guild isn't present.

Link copied to clipboard
open suspend fun getMessage(messageId: Snowflake): Message

Requests to get a message with the given messageId.

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

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

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

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

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

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

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

Link copied to clipboard
open suspend fun getParent(): ThreadParentChannel

Requests to get this channel's ThreadParentChannel.

Link copied to clipboard

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

Link copied to clipboard
open suspend fun join()

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

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

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

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

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

Link copied to clipboard

Returns a new GuildMessageChannelBehavior with the given strategy.