kord-core/dev.kord.core.entity

Package-level declarations

Types

class Application(val data: ApplicationData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : BaseApplication

The details of an Application.

Asset

class Asset : KordObject

Attachment

data class Attachment(val data: AttachmentData, val kord: Kord) : KordEntity

An instance of a Discord Attachment.

AuditLog

class AuditLog(val data: DiscordAuditLog, val guildId: Snowflake, val kord: Kord) : KordObject

AuditLogEntry

class AuditLogEntry(val data: DiscordAuditLogEntry, val kord: Kord) : KordObject

Ban

class Ban(val data: BanData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : KordObject, Strategizable

An instance of a Discord Ban.

BaseApplication

sealed class BaseApplication : KordEntity, Strategizable

ClientStatus

class ClientStatus(val data: ClientStatusData)

Embed

data class Embed(val data: EmbedData, val kord: Kord) : KordObject

An instance of a Discord Embed.

Emoji

sealed interface Emoji

Either a StandardEmoji or a GuildEmoji.

Entity

interface Entity : Comparable<Entity>

Guild

class Guild(val data: GuildData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : GuildBehavior

An instance of a Discord Guild.

GuildEmoji

class GuildEmoji(val data: EmojiData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : Emoji, KordEntity, Strategizable

An instance of an emoji belonging to a specific Guild.

GuildOnboarding

class GuildOnboarding(val data: DiscordGuildOnboarding, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : KordObject, Strategizable

Represents the onboarding flow for a Guild.

GuildPreview

class GuildPreview(val data: GuildPreviewData, val kord: Kord) : KordEntity

GuildScheduledEvent

class GuildScheduledEvent(val data: GuildScheduledEventData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : GuildScheduledEventBehavior

An instance of a Guild scheduled event belonging to a specific guild.

GuildSticker

class GuildSticker(val data: StickerData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : Sticker, StickerBehavior

GuildWidget

class GuildWidget(val data: GuildWidgetData, val guildId: Snowflake, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : KordObject, Strategizable

Integration

class Integration(val data: IntegrationData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : KordEntity, Strategizable

A Discord integration.

Invite

open class Invite(val data: BaseInviteData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : KordObject, Strategizable

An instance of a Discord Invite.

InviteWithMetadata

class InviteWithMetadata(val data: InviteWithMetadataData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : Invite

An instance of a Discord Invite with extra information.

KordEntity

interface KordEntity : KordObject, Entity

An object that is identified by its id. This object holds a KordObject

Member

class Member(val memberData: MemberData, userData: UserData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : User, MemberBehavior

An instance of a Discord Member.

Message

class Message(val data: MessageData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : MessageBehavior

An instance of a https://discord.com/developers/docs/resources/channel#message-object.

MessageReference

class MessageReference(val data: MessageReferenceData, val kord: Kord) : KordObject

PartialApplication

class PartialApplication(val data: PartialApplicationData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : BaseApplication

The partial details of an Application sent in InviteCreateEvents.

PartialGuild

class PartialGuild(val data: PartialGuildData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : GuildBehavior

PermissionOverwrite

open class PermissionOverwrite(val data: PermissionOverwriteData)

PermissionOverwriteEntity

class PermissionOverwriteEntity(val guildId: Snowflake, val channelId: Snowflake, val data: PermissionOverwriteData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : PermissionOverwrite, KordObject, Strategizable

Presence

class Presence(val data: PresenceData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : KordObject, Strategizable

Reaction

class Reaction(val data: ReactionData, val kord: Kord) : KordObject

An instance of a Discord Reaction.

ReactionEmoji

sealed class ReactionEmoji

Region

class Region(val data: RegionData, val kord: Kord) : KordObject

Role

data class Role(val data: RoleData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : RoleBehavior

RoleTags

class RoleTags(val data: RoleTagsData, val guildId: Snowflake, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : KordObject, Strategizable

StageInstance

class StageInstance(val data: StageInstanceData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : StageInstanceBehavior

StandardEmoji

class StandardEmoji(val name: String) : Emoji

An instance of a standard emoji.

Sticker

open class Sticker(val data: StickerData, val kord: Kord) : KordEntity

A sticker image that can be used in messages.

StickerItem

class StickerItem(val data: StickerItemData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : KordEntity, Strategizable

StickerPack

class StickerPack(val data: StickerPackData, val kord: Kord) : KordEntity

Strategizable

interface Strategizable

A class that will defer the requesting of Entities to a supplier. Copies of this class with a different supplier can be made through withStrategy.

Team

class Team(val data: TeamData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : KordEntity, Strategizable

A Discord developer team which can own applications.

TeamMember

class TeamMember(val data: TeamMemberData, val kord: Kord)

A member of a Discord developer team.

Template

class Template(val data: TemplateData, val kord: Kord) : KordObject, TemplateBehavior

User

open class User(val data: UserData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : UserBehavior

An instance of a Discord User.

VoiceState

class VoiceState(val data: VoiceStateData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : KordObject, Strategizable

Webhook

data class Webhook(val data: WebhookData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : WebhookBehavior, Strategizable

WelcomeScreen

class WelcomeScreen(val data: WelcomeScreenData, val kord: Kord) : KordObject

Shown to new members in community guild, returned when in the invite object.

Properties

effectiveName

val User.effectiveName: String

The user's effective name, prioritizing globalName over username.

Functions

edit

inline suspend fun Integration.edit(builder: IntegrationModifyBuilder.() -> Unit)

Requests to edit this integration.

toRawType

fun Attachment.toRawType(): DiscordAttachment