Package dev.kord.core.behavior.channel

Types

BaseVoiceChannelBehavior
Link copied to clipboard
interface BaseVoiceChannelBehavior : CategorizableChannelBehavior
CategorizableChannelBehavior
Link copied to clipboard
interface CategorizableChannelBehavior : TopGuildChannelBehavior
CategoryBehavior
Link copied to clipboard
interface CategoryBehavior : TopGuildChannelBehavior

The behavior of a Discord category associated to a guild.

ChannelBehavior
Link copied to clipboard
interface ChannelBehavior : KordEntity, Strategizable

The behavior of a Discord Channel

GuildChannelBehavior
Link copied to clipboard
interface GuildChannelBehavior : ChannelBehavior, Strategizable

The behavior of a Discord channel associated to a guild.

GuildMessageChannelBehavior
Link copied to clipboard

The behavior of a Discord message channel associated to a guild.

MessageChannelBehavior
Link copied to clipboard
interface MessageChannelBehavior : ChannelBehavior, Strategizable

The behavior of a Discord channel that can use messages.

NewsChannelBehavior
Link copied to clipboard
interface NewsChannelBehavior : ThreadParentChannelBehavior

The behavior of a Discord News Channel associated to a guild.

StageChannelBehavior
Link copied to clipboard
interface StageChannelBehavior : BaseVoiceChannelBehavior
StoreChannelBehavior
Link copied to clipboard
interface StoreChannelBehavior : CategorizableChannelBehavior

The behavior of a Discord Store Channel associated to a guild.

TextChannelBehavior
Link copied to clipboard
interface TextChannelBehavior : PrivateThreadParentChannelBehavior
TopGuildChannelBehavior
Link copied to clipboard
interface TopGuildChannelBehavior : GuildChannelBehavior

The behavior of a non-thread Discord channel associated to a guild.

TopGuildMessageChannelBehavior
Link copied to clipboard

The behavior of a non-thread Discord message channel associated to a guild.

VoiceChannelBehavior
Link copied to clipboard
interface VoiceChannelBehavior : BaseVoiceChannelBehavior

The behavior of a Discord Voice Channel associated to a guild.

Functions

asChannelOf
Link copied to clipboard
inline suspend fun <T : Channel> ChannelBehavior.asChannelOf(): T

Requests to get the Channel represented by the id.

asChannelOfOrNull
Link copied to clipboard
inline suspend fun <T : Channel> ChannelBehavior.asChannelOfOrNull(): T?

Requests to get the Channel represented by the id, returns null if the Channel isn't present.

CategoryBehavior
Link copied to clipboard
fun CategoryBehavior(guildId: Snowflake, id: Snowflake, kord: Kord, strategy: EntitySupplyStrategy<*> = kord.resources.defaultStrategy): CategoryBehavior
ChannelBehavior
Link copied to clipboard
fun ChannelBehavior(id: Snowflake, kord: Kord, strategy: EntitySupplyStrategy<*> = kord.resources.defaultStrategy): ChannelBehavior
createEmbed
Link copied to clipboard
inline suspend fun MessageChannelBehavior.createEmbed(block: EmbedBuilder.() -> Unit): Message

Requests to create a message with only an embed.

createInvite
Link copied to clipboard
inline suspend fun CategorizableChannelBehavior.createInvite(builder: InviteCreateBuilder.() -> Unit = {}): InviteWithMetadata

Request to create an InviteWithMetadata for this channel.

createMessage
Link copied to clipboard
inline suspend fun MessageChannelBehavior.createMessage(builder: UserMessageCreateBuilder.() -> Unit): Message

Requests to create a message configured by the builder.

createNewsChannel
Link copied to clipboard
inline suspend fun CategoryBehavior.createNewsChannel(name: String, builder: NewsChannelCreateBuilder.() -> Unit = {}): NewsChannel

Requests to create a new news channel with this category as parent.

createTextChannel
Link copied to clipboard
inline suspend fun CategoryBehavior.createTextChannel(name: String, builder: TextChannelCreateBuilder.() -> Unit = {}): TextChannel

Requests to create a new text channel with this category as parent.

createVoiceChannel
Link copied to clipboard
inline suspend fun CategoryBehavior.createVoiceChannel(name: String, builder: VoiceChannelCreateBuilder.() -> Unit = {}): VoiceChannel

Requests to create a new voice channel with this category as parent.

createWebhook
Link copied to clipboard
inline suspend fun TopGuildMessageChannelBehavior.createWebhook(name: String, builder: WebhookCreateBuilder.() -> Unit = {}): Webhook

Requests to create a new webhook configured by the builder.

edit
Link copied to clipboard
suspend fun CategoryBehavior.edit(builder: CategoryModifyBuilder.() -> Unit): Category

Requests to edit this category.

inline suspend fun NewsChannelBehavior.edit(builder: NewsChannelModifyBuilder.() -> Unit): NewsChannel
suspend fun StageChannelBehavior.edit(builder: StageVoiceChannelModifyBuilder.() -> Unit): StageChannel
inline suspend fun StoreChannelBehavior.edit(builder: StoreChannelModifyBuilder.() -> Unit): StoreChannel
inline suspend fun TextChannelBehavior.edit(builder: TextChannelModifyBuilder.() -> Unit): TextChannel
inline suspend fun VoiceChannelBehavior.edit(builder: VoiceChannelModifyBuilder.() -> Unit): VoiceChannel

Requests to edit this channel.

editCurrentVoiceState
Link copied to clipboard
inline suspend fun StageChannelBehavior.editCurrentVoiceState(builder: CurrentVoiceStateModifyBuilder.() -> Unit)

Requests to edit the current user's voice state in this StageChannel.

editMemberPermission
Link copied to clipboard
inline suspend fun TopGuildChannelBehavior.editMemberPermission(memberId: Snowflake, builder: ChannelPermissionModifyBuilder.() -> Unit)

Requests to add or replace a PermissionOverwrite for the memberId.

editRolePermission
Link copied to clipboard
inline suspend fun TopGuildChannelBehavior.editRolePermission(roleId: Snowflake, builder: ChannelPermissionModifyBuilder.() -> Unit)

Requests to add or replace a PermissionOverwrite for the roleId.

editVoiceState
Link copied to clipboard
inline suspend fun StageChannelBehavior.editVoiceState(userId: Snowflake, builder: VoiceStateModifyBuilder.() -> Unit)

Requests to edit the another user's voice state in this StageChannel.

GuildChannelBehavior
Link copied to clipboard
fun GuildChannelBehavior(guildId: Snowflake, id: Snowflake, kord: Kord, strategy: EntitySupplyStrategy<*> = kord.resources.defaultStrategy): GuildChannelBehavior
MessageChannelBehavior
Link copied to clipboard
fun MessageChannelBehavior(id: Snowflake, kord: Kord, strategy: EntitySupplyStrategy<*> = kord.resources.defaultStrategy): MessageChannelBehavior
NewsChannelBehavior
Link copied to clipboard
fun NewsChannelBehavior(guildId: Snowflake, id: Snowflake, kord: Kord, strategy: EntitySupplyStrategy<*> = kord.resources.defaultStrategy): NewsChannelBehavior
of
Link copied to clipboard
inline suspend fun <T : Channel> ChannelBehavior.of(): T

Requests to get the Channel represented by the id.

ofOrNull
Link copied to clipboard
inline suspend fun <T : Channel> ChannelBehavior.ofOrNull(): T?

Requests to get the Channel represented by the id, returns null if the Channel isn't present.

StageChannelBehavior
Link copied to clipboard
fun StageChannelBehavior(id: Snowflake, guildId: Snowflake, kord: Kord, supplier: EntitySupplier = kord.defaultSupplier): StageChannelBehavior
StoreChannelBehavior
Link copied to clipboard
fun StoreChannelBehavior(guildId: Snowflake, id: Snowflake, kord: Kord, strategy: EntitySupplyStrategy<*> = kord.resources.defaultStrategy): StoreChannelBehavior
TextChannelBehavior
Link copied to clipboard
fun TextChannelBehavior(guildId: Snowflake, id: Snowflake, kord: Kord, strategy: EntitySupplyStrategy<*> = kord.resources.defaultStrategy): TextChannelBehavior
VoiceChannelBehavior
Link copied to clipboard
fun VoiceChannelBehavior(guildId: Snowflake, id: Snowflake, kord: Kord, strategy: EntitySupplyStrategy<*> = kord.resources.defaultStrategy): VoiceChannelBehavior
withTyping
Link copied to clipboard
inline suspend fun <T : MessageChannelBehavior> T.withTyping(block: T.() -> Unit)

Requests to trigger the typing indicator for the bot in this channel. The typing status will be refreshed until the block has been completed.