kord-core/dev.kord.core.behavior.channel

Package-level declarations

Types

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

The behavior of a Discord category associated to a guild.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
interface GuildChannelBehavior : ChannelBehavior, Strategizable

The behavior of a Discord channel associated to a guild.

Link copied to clipboard
interface GuildMessageChannelBehavior : GuildChannelBehavior, MessageChannelBehavior

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

Link copied to clipboard
Link copied to clipboard
interface MessageChannelBehavior : ChannelBehavior, Strategizable

The behavior of a Discord channel that can use messages.

Link copied to clipboard
interface NewsChannelBehavior : TopGuildMessageChannelBehavior, ThreadParentChannelBehavior

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

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

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

Link copied to clipboard
interface TopGuildMessageChannelBehavior : CategorizableChannelBehavior, GuildMessageChannelBehavior

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

Link copied to clipboard
interface VoiceChannelBehavior : TopGuildMessageChannelBehavior, BaseVoiceChannelBehavior

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

Functions

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
fun CategoryBehavior(guildId: Snowflake, id: Snowflake, kord: Kord, strategy: EntitySupplyStrategy<*> = kord.resources.defaultStrategy): CategoryBehavior
Link copied to clipboard
fun ChannelBehavior(id: Snowflake, kord: Kord, strategy: EntitySupplyStrategy<*> = kord.resources.defaultStrategy): ChannelBehavior
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
inline suspend fun CategorizableChannelBehavior.createInvite(builder: InviteCreateBuilder.() -> Unit = {}): InviteWithMetadata

Request to create an InviteWithMetadata for this channel.

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

Requests to create a message configured by the builder.

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.

Link copied to clipboard
inline suspend fun CategoryBehavior.createStageChannel(name: String, builder: StageChannelCreateBuilder.() -> Unit = {}): StageChannel

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

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

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.

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

Requests to create a new webhook configured by the builder.

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

Requests to edit this category.

inline suspend fun ForumChannelBehavior.edit(builder: ForumChannelModifyBuilder.() -> Unit): ForumChannel
inline suspend fun MediaChannelBehavior.edit(builder: MediaChannelModifyBuilder.() -> Unit): MediaChannel

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

Requests to edit this channel.

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

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

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

Requests to add or replace a PermissionOverwrite for the memberId.

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

Requests to add or replace a PermissionOverwrite for the roleId.

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.

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

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