kord-core/dev.kord.core.behavior

Package-level declarations

Types

ApplicationCommandBehavior

interface ApplicationCommandBehavior : Entity

The behavior of an Application Command.

ChatInputCommandBehavior

interface ChatInputCommandBehavior : ApplicationCommandBehavior

GlobalApplicationCommandBehavior

interface GlobalApplicationCommandBehavior : ApplicationCommandBehavior

The behavior of an Application Command that can be used in DMs and Guilds.

GlobalChatInputCommandBehavior

interface GlobalChatInputCommandBehavior : ChatInputCommandBehavior, GlobalApplicationCommandBehavior

GlobalMessageCommandBehavior

interface GlobalMessageCommandBehavior : MessageCommandBehavior, GlobalApplicationCommandBehavior

GlobalUserCommandBehavior

interface GlobalUserCommandBehavior : UserCommandBehavior, GlobalApplicationCommandBehavior

GuildApplicationCommandBehavior

interface GuildApplicationCommandBehavior : ApplicationCommandBehavior

The behavior of Application Command.

GuildBehavior

interface GuildBehavior : KordEntity, Strategizable

The behavior of a Discord Guild.

GuildChatInputCommandBehavior

interface GuildChatInputCommandBehavior : ChatInputCommandBehavior, GuildApplicationCommandBehavior

GuildEmojiBehavior

interface GuildEmojiBehavior : KordEntity, Strategizable

The behavior of a Discord Emoij.

GuildMessageCommandBehavior

interface GuildMessageCommandBehavior : MessageCommandBehavior, GuildApplicationCommandBehavior

GuildScheduledEventBehavior

interface GuildScheduledEventBehavior : KordEntity, Strategizable

Behavior of a ADD LINK.

GuildUserCommandBehavior

interface GuildUserCommandBehavior : UserCommandBehavior, GuildApplicationCommandBehavior

MemberBehavior

interface MemberBehavior : KordEntity, UserBehavior

The behavior of a Discord Member.

MessageBehavior

interface MessageBehavior : KordEntity, Strategizable

The behavior of a Discord Message.

MessageCommandBehavior

interface MessageCommandBehavior : ApplicationCommandBehavior

RoleBehavior

interface RoleBehavior : KordEntity, Strategizable

The behavior of a Discord Role associated to a guild.

StageInstanceBehavior

interface StageInstanceBehavior : KordEntity, Strategizable

StickerBehavior

interface StickerBehavior : KordEntity, Strategizable

TemplateBehavior

interface TemplateBehavior : KordObject

ThreadMemberBehavior

interface ThreadMemberBehavior : UserBehavior

UserBehavior

interface UserBehavior : KordEntity, Strategizable

The behavior of a Discord User

UserCommandBehavior

interface UserCommandBehavior : ApplicationCommandBehavior

WebhookBehavior

interface WebhookBehavior : KordEntity, Strategizable

The behavior of a Discord Webhook.

Functions

ban

inline suspend fun MemberBehavior.ban(builder: BanCreateBuilder.() -> Unit = {})

Requests to ban this member.

inline suspend fun GuildBehavior.ban(userId: Snowflake, builder: BanCreateBuilder.() -> Unit)

Requests to ban the given userId in this guild.

createApplicationCommands

inline suspend fun GuildBehavior.createApplicationCommands(builder: GuildMultiApplicationCommandBuilder.() -> Unit): Flow<GuildApplicationCommand>

createCategory

inline suspend fun GuildBehavior.createCategory(name: String, builder: CategoryCreateBuilder.() -> Unit = {}): Category

Requests to create a new category.

createChatInputCommand

inline suspend fun GuildBehavior.createChatInputCommand(name: String, description: String, builder: ChatInputCreateBuilder.() -> Unit = {}): GuildChatInputCommand

createEmoji

inline suspend fun GuildBehavior.createEmoji(name: String, image: Image, builder: EmojiCreateBuilder.() -> Unit = {}): GuildEmoji

createForumChannel

inline suspend fun GuildBehavior.createForumChannel(name: String, builder: ForumChannelCreateBuilder.() -> Unit = {}): ForumChannel

createGuild

suspend fun TemplateBehavior.createGuild(name: String, builder: GuildFromTemplateCreateBuilder.() -> Unit): Guild

createKeywordAutoModerationRule

inline suspend fun GuildBehavior.createKeywordAutoModerationRule(name: String, eventType: AutoModerationRuleEventType = MessageSend, builder: KeywordAutoModerationRuleCreateBuilder.() -> Unit): KeywordAutoModerationRule

Requests to create a new KeywordAutoModerationRule in this guild and returns it.

createKeywordPresetAutoModerationRule

inline suspend fun GuildBehavior.createKeywordPresetAutoModerationRule(name: String, eventType: AutoModerationRuleEventType = MessageSend, builder: KeywordPresetAutoModerationRuleCreateBuilder.() -> Unit): KeywordPresetAutoModerationRule

Requests to create a new KeywordPresetAutoModerationRule in this guild and returns it.

createMediaChannel

inline suspend fun GuildBehavior.createMediaChannel(name: String, builder: MediaChannelCreateBuilder.() -> Unit = {}): MediaChannel

createMentionSpamAutoModerationRule

inline suspend fun GuildBehavior.createMentionSpamAutoModerationRule(name: String, eventType: AutoModerationRuleEventType = MessageSend, builder: MentionSpamAutoModerationRuleCreateBuilder.() -> Unit): MentionSpamAutoModerationRule

Requests to create a new MentionSpamAutoModerationRule in this guild and returns it.

createMessageCommand

inline suspend fun GuildBehavior.createMessageCommand(name: String, builder: MessageCommandCreateBuilder.() -> Unit = {}): GuildMessageCommand

createNewsChannel

inline suspend fun GuildBehavior.createNewsChannel(name: String, builder: NewsChannelCreateBuilder.() -> Unit = {}): NewsChannel

Requests to create a new news channel.

createRole

inline suspend fun GuildBehavior.createRole(builder: RoleCreateBuilder.() -> Unit = {}): Role

Requests to add a new role to this guild.

createScheduledEvent

suspend fun GuildBehavior.createScheduledEvent(name: String, privacyLevel: GuildScheduledEventPrivacyLevel, scheduledStartTime: Instant, entityType: ScheduledEntityType, builder: ScheduledEventCreateBuilder.() -> Unit): GuildScheduledEvent

Creates a new GuildScheduledEvent.

createSpamAutoModerationRule

inline suspend fun GuildBehavior.createSpamAutoModerationRule(name: String, eventType: AutoModerationRuleEventType = MessageSend, builder: SpamAutoModerationRuleCreateBuilder.() -> Unit): SpamAutoModerationRule

Requests to create a new SpamAutoModerationRule in this guild and returns it.

createStageChannel

inline suspend fun GuildBehavior.createStageChannel(name: String, builder: StageChannelCreateBuilder.() -> Unit = {}): StageChannel

Requests to create a new stage channel.

createTextChannel

inline suspend fun GuildBehavior.createTextChannel(name: String, builder: TextChannelCreateBuilder.() -> Unit = {}): TextChannel

Requests to create a new text channel.

createUserCommand

inline suspend fun GuildBehavior.createUserCommand(name: String, builder: UserCommandCreateBuilder.() -> Unit = {}): GuildUserCommand

createVoiceChannel

inline suspend fun GuildBehavior.createVoiceChannel(name: String, builder: VoiceChannelCreateBuilder.() -> Unit = {}): VoiceChannel

Requests to create a new voice channel.

edit

inline suspend fun GuildBehavior.edit(builder: GuildModifyBuilder.() -> Unit): Guild

Requests to edit this guild.

inline suspend fun GuildEmojiBehavior.edit(builder: EmojiModifyBuilder.() -> Unit): GuildEmoji

Requests to edit this emoji.

inline suspend fun GuildScheduledEventBehavior.edit(builder: ScheduledEventModifyBuilder.() -> Unit): GuildScheduledEvent

Requests to modify this event according to the specified builder.

inline suspend fun MemberBehavior.edit(builder: MemberModifyBuilder.() -> Unit): Member

Requests to edit this member.

inline suspend fun MessageBehavior.edit(builder: UserMessageModifyBuilder.() -> Unit): Message

Requests to edit this message.

inline suspend fun RoleBehavior.edit(builder: RoleModifyBuilder.() -> Unit): Role

Requests to edit this role.

inline suspend fun StageInstanceBehavior.edit(builder: StageInstanceModifyBuilder.() -> Unit): StageInstance

inline suspend fun StickerBehavior.edit(builder: StickerModifyBuilder.() -> Unit): Sticker

suspend fun TemplateBehavior.edit(builder: GuildTemplateModifyBuilder.() -> Unit): Template

inline suspend fun WebhookBehavior.edit(builder: WebhookModifyBuilder.() -> Unit): Webhook

Requests to edit the webhook, this user must be the creator.

inline suspend fun WebhookBehavior.edit(token: String, builder: WebhookModifyBuilder.() -> Unit): Webhook

Requests to edit the webhook.

inline suspend fun MessageBehavior.edit(webhookId: Snowflake, token: String, threadId: Snowflake? = null, builder: WebhookMessageModifyBuilder.() -> Unit): Message

Requests to edit this message if it was previously sent from a Webhook with the given webhookId using the token for authentication.

editOnboarding

inline suspend fun GuildBehavior.editOnboarding(builder: GuildOnboardingModifyBuilder.() -> Unit): GuildOnboarding

Requests to edit the GuildOnboarding object of the guild and returns the edited onboarding object.

editWidget

inline suspend fun GuildBehavior.editWidget(builder: GuildWidgetModifyBuilder.() -> Unit): GuildWidget

execute

inline suspend fun WebhookBehavior.execute(token: String, threadId: Snowflake? = null, builder: WebhookMessageCreateBuilder.() -> Unit): Message

Requests to execute this webhook.

executeIgnored

inline suspend fun WebhookBehavior.executeIgnored(token: String, threadId: Snowflake? = null, builder: WebhookMessageCreateBuilder.() -> Unit)

Requests to execute this webhook.

getApplicationCommandOf

inline suspend fun <T : GuildApplicationCommand> GuildBehavior.getApplicationCommandOf(commandId: Snowflake): T

getApplicationCommandOfOrNull

inline suspend fun <T : GuildApplicationCommand> GuildBehavior.getApplicationCommandOfOrNull(commandId: Snowflake): T?

getAuditLogEntries

inline fun GuildBehavior.getAuditLogEntries(builder: AuditLogGetRequestBuilder.() -> Unit = {}): Flow<AuditLogEntry>

The Audit log entries from this guild, configured by the builder.

getChannelOf

inline suspend fun <T : GuildChannel> GuildBehavior.getChannelOf(channelId: Snowflake): T

Requests to get the GuildChannel represented by the channelId as type T.

getChannelOfOrNull

inline suspend fun <T : GuildChannel> GuildBehavior.getChannelOfOrNull(channelId: Snowflake): T?

Requests to get the GuildChannel represented by the channelId as type T, returns null if the GuildChannel isn't present.

GlobalApplicationCommandBehavior

fun GlobalApplicationCommandBehavior(applicationId: Snowflake, id: Snowflake, service: InteractionService): GlobalApplicationCommandBehavior

GuildApplicationCommandBehavior

fun GuildApplicationCommandBehavior(guildId: Snowflake, applicationId: Snowflake, id: Snowflake, service: InteractionService): GuildApplicationCommandBehavior

GuildBehavior

fun GuildBehavior(id: Snowflake, kord: Kord, strategy: EntitySupplyStrategy<*> = kord.resources.defaultStrategy): GuildBehavior

MemberBehavior

fun MemberBehavior(guildId: Snowflake, id: Snowflake, kord: Kord, strategy: EntitySupplyStrategy<*> = kord.resources.defaultStrategy): MemberBehavior

MessageBehavior

fun MessageBehavior(channelId: Snowflake, messageId: Snowflake, kord: Kord, strategy: EntitySupplyStrategy<*> = kord.resources.defaultStrategy): MessageBehavior

inline suspend fun MessageBehavior.reply(builder: UserMessageCreateBuilder.() -> Unit): Message

Request to reply to this message, setting messageReference to this message's id.

requestMembers

@PrivilegedIntent

inline fun GuildBehavior.requestMembers(builder: RequestGuildMembersBuilder.() -> Unit = { requestAllMembers() }): Flow<MembersChunkEvent>

Executes a RequestGuildMembers command configured by the builder for guild on this gateway, returning a flow of MembersChunkEvent responses.

RoleBehavior

fun RoleBehavior(guildId: Snowflake, id: Snowflake, kord: Kord, strategy: EntitySupplyStrategy<*> = kord.resources.defaultStrategy): RoleBehavior

StickerBehavior

fun StickerBehavior(guildId: Snowflake, id: Snowflake, kord: Kord, supplier: EntitySupplier): StickerBehavior

swapChannelPositions

inline suspend fun GuildBehavior.swapChannelPositions(builder: GuildChannelPositionModifyBuilder.() -> Unit)

Requests to swap positions of channels in this guild.

swapRolePositions

inline suspend fun GuildBehavior.swapRolePositions(builder: RolePositionsModifyBuilder.() -> Unit): Flow<Role>

Requests to swap positions of roles in this guild.

TemplateBehavior

fun TemplateBehavior(guildId: Snowflake, code: String, kord: Kord): TemplateBehavior

ThreadMemberBehavior

fun ThreadMemberBehavior(id: Snowflake, threadId: Snowflake, kord: Kord, supplier: EntitySupplier = kord.defaultSupplier): ThreadMemberBehavior

UserBehavior

fun UserBehavior(id: Snowflake, kord: Kord, strategy: EntitySupplyStrategy<*> = kord.resources.defaultStrategy): UserBehavior