diskord-core/com.jessecorbett.diskord.api.common

Package-level declarations

Types

@Serializable

data class ActionRow(val components: List<MessageComponent>) : MessageComponent

@Serializable

data class Attachment(val id: String, val fileName: String, val contentType: String? = null, val sizeInBytes: Int, val url: String, val proxiedUrl: String, val imageHeight: Int? = null, val imageWidth: Int? = null)

BarePresenceUpdate

@Serializable

data class BarePresenceUpdate(val user: BareUser, val status: UserStatus)

BareUser

@Serializable

data class BareUser(val id: String)

BulkMessageDelete

@Serializable

data class BulkMessageDelete(val ids: List<String>, val channelId: String, val guildId: String? = null)

Button

@Serializable

data class Button(val customId: String? = null, val disabled: Boolean = false, val style: ButtonStyle, val label: String? = null, val emoji: PartialEmoji? = null, val url: String? = null) : MessageComponent

ButtonStyle

@Serializable(with = ButtonStyleSerializer::class)

enum ButtonStyle : Enum<ButtonStyle> , CodeEnum

ButtonStyleSerializer

class ButtonStyleSerializer : CodeEnumSerializer<ButtonStyle>

Channel

@Serializable

sealed class Channel

ChannelSelectMenu

@Serializable

data class ChannelSelectMenu(val customId: String, val disabled: Boolean = false, val channelTypes: List<ChannelType> = ChannelType.values().toList(), val placeholder: String? = null, val minValues: Int = 1, val maxValues: Int = 1) : MessageComponent

ChannelType

@Serializable(with = ChannelTypeSerializer::class)

enum ChannelType : Enum<ChannelType> , CodeEnum

ChannelTypeSerializer

class ChannelTypeSerializer : CodeEnumSerializer<ChannelType>

Color

typealias Color = Int

A representation of a color for use with Discord's embed API.

interface DM : TextChannel

DMChannel

@Serializable

@SerialName(value = "1")

data class DMChannel(val id: String, val lastMessageId: String?, val recipients: List<User>, val ownerId: String? = null, val lastPinTime: String? = null) : Channel, DM

Emoji

@Serializable

data class Emoji(val id: String? = null, val name: String? = null, val whitelistedRoles: List<String>? = null, val creator: User? = null, val requiresWrappingColons: Boolean? = null, val isManaged: Boolean? = null, val isAnimated: Boolean = false, val isAvailable: Boolean = false)

ExplicitContentFilterLevel

@Serializable(with = ExplicitContentFilterLevelSerializer::class)

enum ExplicitContentFilterLevel : Enum<ExplicitContentFilterLevel> , CodeEnum

ExplicitContentFilterLevelSerializer

class ExplicitContentFilterLevelSerializer : CodeEnumSerializer<ExplicitContentFilterLevel>

GroupDMChannel

@Serializable

@SerialName(value = "3")

data class GroupDMChannel(val id: String, val name: String, val lastMessageId: String?, val recipients: List<User>, val iconHash: String?, val ownerId: String, val applicationId: String?, val lastPinTime: String? = null) : Channel, NamedChannel, DM

Guild

@Serializable

data class Guild(val id: String, val name: String, val iconHash: String?, val splashHash: String?, val discoverySplashHash: String?, val userIsOwner: Boolean? = null, val ownerId: String, val permissions: Permissions? = null, val afkChannelId: String?, val afkTimeoutSeconds: Int, val widgetEnabled: Boolean? = null, val widgetChannelId: String? = null, val verificationLevel: VerificationLevel, val defaultMessageNotificationLevel: NotificationsLevel, val explicitContentFilterLevel: ExplicitContentFilterLevel, val roles: List<Role>, val emojis: List<Emoji>, val features: List<GuildFeatures>, val mfaLevel: MFALevel, val owningApplicationId: String?, val systemMessageChannelId: String?, val systemChannelFlags: SystemChannelFlags, val rulesChannelId: String?, val maxPresences: Int? = null, val maxMembers: Int? = null, val vanityCodeUrl: String?, val description: String?, val bannerHash: String?, val premiumType: GuildPremiumType, val guildBoostCount: Int? = null, val preferredLocale: String, val publicUpdatesChannelId: String?, val maxVideoChannelUsers: Int? = null, val approximateMemberCount: Int? = null, val approximatePresenceCount: Int? = null, val welcomeScreen: WelcomeScreen? = null, val nsfwLevel: GuildNSFWLevel, val stageInstances: List<StageInstance>? = null, val sticker: List<Sticker>? = null)

GuildCategory

@Serializable

@SerialName(value = "4")

data class GuildCategory(val id: String, val guildId: String? = null, val position: Int, val permissionOverwrites: List<Overwrite> = emptyList(), val name: String, val nsfw: Boolean? = null) : Channel, GuildChannel

GuildChannel

interface GuildChannel : NamedChannel

GuildDirectory

@Serializable

@SerialName(value = "14")

data class GuildDirectory(val id: String, val name: String, val guildId: String? = null, val position: Int, val nsfw: Boolean? = null, val permissionOverwrites: List<Overwrite> = emptyList()) : Channel, GuildChannel

GuildFeatures

@Serializable(with = GuildFeaturesSerializer::class)

enum GuildFeatures : Enum<GuildFeatures>

GuildFeaturesSerializer

class GuildFeaturesSerializer : KSerializer<GuildFeatures>

GuildForum

@Serializable

@SerialName(value = "15")

data class GuildForum(val id: String, val guildId: String? = null, val position: Int, val permissionOverwrites: List<Overwrite> = emptyList(), val name: String, val topic: String? = null, val nsfw: Boolean? = null, val lastMessageId: String?, val rateLimitPerUser: Int? = null, val parentId: String? = null, val lastPinTime: String? = null) : Channel, GuildText

GuildIntegration

@Serializable

data class GuildIntegration(val id: String, val name: String, val type: String, val enabled: Boolean, val syncing: Boolean, val roleId: String, val twitchEmojiSync: Boolean? = null, val expireBehavior: IntegrationExpireBehavior, val expirationGracePeriod: Int, val user: User? = null, val account: IntegrationAccount, val syncedAt: String? = null, val subscriberCount: Int? = null, val revoked: Boolean? = null, val application: IntegrationApplication? = null)

GuildMember

@Serializable

data class GuildMember(val user: User? = null, val nickname: String? = null, val roleIds: List<String>, val joinedAt: String, val isDeaf: Boolean, val isMute: Boolean)

GuildNewsChannel

@Serializable

@SerialName(value = "5")

data class GuildNewsChannel(val id: String, val guildId: String? = null, val position: Int, val permissionOverwrites: List<Overwrite> = emptyList(), val name: String, val topic: String? = null, val nsfw: Boolean? = null, val lastMessageId: String?, val rateLimitPerUser: Int? = null, val parentId: String? = null, val lastPinTime: String? = null) : Channel, GuildText

GuildNewsThread

@Serializable

@SerialName(value = "10")

data class GuildNewsThread(val id: String, val name: String, val lastMessageId: String?, val lastPinTime: String? = null, val guildId: String? = null, val rateLimitPerUser: Int? = null, val ownerId: String?, val parentId: String? = null, val messageCount: Int, val memberCount: Int, val metadata: ThreadMetadata? = null, val member: ThreadMember? = null) : GuildThread

GuildNSFWLevel

@Serializable(with = GuildNSFWLevelSerializer::class)

enum GuildNSFWLevel : Enum<GuildNSFWLevel> , CodeEnum

GuildNSFWLevelSerializer

class GuildNSFWLevelSerializer : CodeEnumSerializer<GuildNSFWLevel>

GuildPremiumType

@Serializable(with = GuildPremiumTypeSerializer::class)

enum GuildPremiumType : Enum<GuildPremiumType> , CodeEnum

GuildPremiumTypeSerializer

class GuildPremiumTypeSerializer : CodeEnumSerializer<GuildPremiumType>

GuildPrivateThread

@Serializable

@SerialName(value = "12")

data class GuildPrivateThread(val id: String, val name: String, val lastMessageId: String?, val lastPinTime: String? = null, val guildId: String? = null, val rateLimitPerUser: Int? = null, val ownerId: String?, val parentId: String? = null, val messageCount: Int, val memberCount: Int, val metadata: ThreadMetadata? = null, val member: ThreadMember? = null) : GuildThread

GuildPublicThread

@Serializable

@SerialName(value = "11")

data class GuildPublicThread(val id: String, val name: String, val lastMessageId: String?, val lastPinTime: String? = null, val guildId: String? = null, val rateLimitPerUser: Int? = null, val ownerId: String?, val parentId: String? = null, val messageCount: Int, val memberCount: Int, val metadata: ThreadMetadata? = null, val member: ThreadMember? = null) : GuildThread

GuildStageVoice

@Serializable

@SerialName(value = "13")

data class GuildStageVoice(val id: String, val name: String, val guildId: String? = null, val position: Int, val nsfw: Boolean? = null, val permissionOverwrites: List<Overwrite> = emptyList()) : Channel, GuildChannel

GuildStoreChannel

@Serializable

@SerialName(value = "6")

data class GuildStoreChannel(val id: String, val guildId: String? = null, val position: Int, val permissionOverwrites: List<Overwrite> = emptyList(), val name: String, val nsfw: Boolean? = null, val parentId: String? = null) : Channel, GuildChannel

GuildText

interface GuildText : GuildChannel, TextChannel

GuildTextChannel

@Serializable

@SerialName(value = "0")

data class GuildTextChannel(val id: String, val guildId: String? = null, val position: Int, val permissionOverwrites: List<Overwrite> = emptyList(), val name: String, val topic: String? = null, val nsfw: Boolean? = null, val lastMessageId: String?, val rateLimitPerUser: Int? = null, val parentId: String? = null, val lastPinTime: String? = null) : Channel, GuildText

GuildThread

@Serializable

sealed class GuildThread : Channel, Thread

GuildVoiceChannel

@Serializable

@SerialName(value = "2")

data class GuildVoiceChannel(val id: String, val guildId: String? = null, val position: Int, val permissionOverwrites: List<Overwrite> = emptyList(), val name: String, val bitrate: Int, val userLimit: Int, val parentId: String? = null, val nsfw: Boolean? = null, val rtcRegion: String? = null) : Channel, GuildChannel

GuildWidget

@Serializable

data class GuildWidget(val enabled: Boolean, val channelId: String)

IntegrationAccount

@Serializable

data class IntegrationAccount(val id: String, val name: String)

IntegrationApplication

@Serializable

data class IntegrationApplication(val id: String, val name: String, val iconHash: String?, val description: String, val summary: String, val botUser: User)

IntegrationExpireBehavior

@Serializable(with = IntegrationExpireBehaviorSerializer::class)

enum IntegrationExpireBehavior : Enum<IntegrationExpireBehavior> , CodeEnum

IntegrationExpireBehaviorSerializer

class IntegrationExpireBehaviorSerializer : CodeEnumSerializer<IntegrationExpireBehavior>

Invite

@Serializable

data class Invite(val code: String, val guild: Guild? = null, val channel: Channel, val approximateOnlineMembers: Int? = null, val approximateMembers: Int? = null, val metadata: InviteMetadata? = null, val invitedBy: User? = null, val targetUser: User? = null, val targetUserType: Int? = null)

InviteMetadata

@Serializable

data class InviteMetadata(val useCount: Int, val maxUses: Int, val expiresAfterSeconds: Int, val grantsTemporaryMembership: Boolean, val createdAt: String)

MentionableSelectMenu

@Serializable

data class MentionableSelectMenu(val customId: String, val disabled: Boolean = false, val placeholder: String? = null, val minValues: Int = 1, val maxValues: Int = 1) : MessageComponent

Message

@Serializable

data class Message(val id: String, val channelId: String, val guildId: String? = null, val author: User, val partialMember: GuildMember? = null, val content: String, val sentAt: String, val editedAt: String?, val isTTS: Boolean, val mentionsEveryone: Boolean, val usersMentioned: List<User> = emptyList(), val rolesIdsMentioned: List<String> = emptyList(), val attachments: List<Attachment> = emptyList(), val embeds: List<Embed> = emptyList(), val reactions: List<Reaction> = emptyList(), val validationNonce: String? = null, val isPinned: Boolean, val webhookId: String? = null, val type: MessageType, val activity: MessageActivity? = null, val application: MessageApplication? = null, val reference: MessageReference? = null, val flags: Int? = null, val interaction: MessageInteraction? = null, val thread: Channel? = null, val components: List<MessageComponent> = emptyList(), val stickerList: List<PartialSticker> = emptyList())

MessageActivity

@Serializable

data class MessageActivity(val type: MessageActivityType, val partyId: String? = null)

MessageActivityType

@Serializable(with = MessageActivityTypeSerializer::class)

enum MessageActivityType : Enum<MessageActivityType> , CodeEnum

MessageActivityTypeSerializer

class MessageActivityTypeSerializer : CodeEnumSerializer<MessageActivityType>

MessageApplication

@Serializable

data class MessageApplication(val id: String, val coverImage: String? = null, val description: String, val icon: String?, val name: String)

MessageComponent

@Serializable(with = MessageComponentSerializer::class)

sealed class MessageComponent

MessageDelete

@Serializable

data class MessageDelete(val id: String, val channelId: String, val guildId: String? = null)

MessageInteraction

@Serializable

data class MessageInteraction(val id: String, val type: InteractionType, val commandName: String, val invokingUser: User, val guildMember: GuildMember? = null)

The interaction that triggered this message, if the original interaction does not have a message of its own So MessageComponent interactions don't have this property, since they require an existing message

MessageReference

@Serializable

data class MessageReference(val messageId: String? = null, val channelId: String? = null, val guildId: String? = null)

MessageType

@Serializable(with = MessageTypeSerializer::class)

enum MessageType : Enum<MessageType> , CodeEnum

MessageTypeSerializer

class MessageTypeSerializer : CodeEnumSerializer<MessageType>

MFALevel

@Serializable(with = MFALevelSerializer::class)

enum MFALevel : Enum<MFALevel> , CodeEnum

MFALevelSerializer

class MFALevelSerializer : CodeEnumSerializer<MFALevel>

NamedChannel

interface NamedChannel

NotificationsLevel

@Serializable(with = NotificationsLevelSerializer::class)

enum NotificationsLevel : Enum<NotificationsLevel> , CodeEnum

NotificationsLevelSerializer

class NotificationsLevelSerializer : CodeEnumSerializer<NotificationsLevel>

Overwrite

@Serializable

data class Overwrite(val id: String, val type: OverwriteType, val allowed: Permissions, val denied: Permissions)

OverwriteType

@Serializable(with = OverwriteTypeSerializer::class)

enum OverwriteType : Enum<OverwriteType> , CodeEnum

OverwriteTypeSerializer

class OverwriteTypeSerializer : KSerializer<OverwriteType>

PartialChannel

@Serializable

@SerialName(value = "7")

data class PartialChannel(val id: String, val name: String, val type: Int, val permissionOverwrites: List<Overwrite> = emptyList()) : Channel, NamedChannel

PartialEmoji

@Serializable

data class PartialEmoji(val id: String? = null, val name: String? = null, val isAnimated: Boolean = false)

PartialMember

@Serializable

data class PartialMember(val nickname: String? = null, val roleIds: List<String>, val joinedAt: String)

PartialSticker

@Serializable

data class PartialSticker(val id: String, val name: String, val formatType: StickerFormat) : StickerItem

Permission

enum Permission : Enum<Permission>

Permissions

@Serializable(with = PermissionsSerializer::class)

data class Permissions(val value: Long)

PermissionsSerializer

object PermissionsSerializer : KSerializer<Permissions>

PremiumType

@Serializable(with = PremiumTypeSerializer::class)

enum PremiumType : Enum<PremiumType> , CodeEnum

PremiumTypeSerializer

class PremiumTypeSerializer : CodeEnumSerializer<PremiumType>

Pruned

@Serializable

data class Pruned(val prunedCount: Int)

Reaction

@Serializable

data class Reaction(val count: Int, val userHasReacted: Boolean, val emoji: Emoji)

Role

@Serializable

data class Role(val id: String, val name: String, val color: Color, val isUserListPinned: Boolean, val position: Int, val permissions: Permissions, val isManagedByIntegration: Boolean, val isMentionable: Boolean)

RoleSelectMenu

@Serializable

data class RoleSelectMenu(val customId: String, val disabled: Boolean = false, val placeholder: String? = null, val minValues: Int = 1, val maxValues: Int = 1) : MessageComponent

SelectOption

@Serializable

data class SelectOption(val label: String, val value: String, val description: String? = null, val emoji: PartialEmoji? = null, val default: Boolean = false)

StageInstance

@Serializable

data class StageInstance(val id: String, val guildId: String, val channelId: String, val topic: String, val privacyLevel: StagePrivacyLevel, val discoverable_disabled: Boolean)

StagePrivacyLevel

@Serializable(with = StagePrivacyLevelSerializer::class)

enum StagePrivacyLevel : Enum<StagePrivacyLevel> , CodeEnum

StagePrivacyLevelSerializer

class StagePrivacyLevelSerializer : CodeEnumSerializer<StagePrivacyLevel>

Sticker

@Serializable

data class Sticker(val id: String, val packId: String? = null, val name: String, val description: String? = null, val tags: String, val hash: String, val type: StickerType, val formatType: StickerFormat, val available: Boolean? = null, val guildId: String? = null, val user: User? = null, val sortValue: Int? = null) : StickerItem

StickerFormat

@Serializable(with = StickerFormatSerializer::class)

enum StickerFormat : Enum<StickerFormat> , CodeEnum

StickerFormatSerializer

class StickerFormatSerializer : CodeEnumSerializer<StickerFormat>

StickerItem

interface StickerItem

StickerPack

@Serializable

data class StickerPack(val id: String, val stickers: List<Sticker>, val name: String, val skuId: String, val coverStickerId: String? = null, val description: String, val bannerAssetId: String)

StickerType

@Serializable(with = StickerTypeSerializer::class)

enum StickerType : Enum<StickerType> , CodeEnum

StickerTypeSerializer

class StickerTypeSerializer : CodeEnumSerializer<StickerType>

SystemChannelFlag

enum SystemChannelFlag : Enum<SystemChannelFlag>

SystemChannelFlags

@Serializable(with = SystemChannelFlagsSerializer::class)

data class SystemChannelFlags(val value: Int)

An immutable collection of SystemChannelFlag values stored as a bitmask integer. This can be used to determine which flags the system channel in a guild contains.

SystemChannelFlagsSerializer

object SystemChannelFlagsSerializer : KSerializer<SystemChannelFlags>

Template

@Serializable

data class Template(val code: String, val name: String, val description: String?, val timesUsed: Int, val creatorId: String, val creator: User, val createdAt: String, val updatedAt: String, val sourceGuildId: String, val guildSnapshot: PartialGuild, val isNotSynchronized: Boolean)

TextChannel

interface TextChannel

TextInput

@Serializable

data class TextInput(val customId: String, val disabled: Boolean = false, val label: String, val style: TextInputStyle = TextInputStyle.Short, val placeholder: String? = null, val mindLength: Int = 0, val maxLength: Int = 4000, val required: Boolean = true, val presetValue: String? = null) : MessageComponent

TextInputStyle

@Serializable(with = TextInputStyleSerializer::class)

enum TextInputStyle : Enum<TextInputStyle> , CodeEnum

TextInputStyleSerializer

class TextInputStyleSerializer : CodeEnumSerializer<TextInputStyle>

TextSelectMenu

@Serializable

data class TextSelectMenu(val customId: String, val disabled: Boolean = false, val options: List<SelectOption>, val placeholder: String? = null, val minValues: Int = 1, val maxValues: Int = 1) : MessageComponent

Thread

interface Thread : NamedChannel, TextChannel

ThreadDelete

@Serializable

data class ThreadDelete(val id: String, val guildId: String? = null, val parentId: String? = null, val type: ChannelType)

ThreadListSync

@Serializable

data class ThreadListSync(val guildId: String, val channelIds: List<String>? = null, val threads: List<GuildThread>, val members: List<ThreadMember>)

ThreadMember

@Serializable

data class ThreadMember(val id: String?, val userId: String?, val joinTimestamp: String?, val flags: Int)

ThreadMembersUpdate

@Serializable

data class ThreadMembersUpdate(val id: String, val guildId: String, val memberCount: Int, val addedMembers: List<ThreadMember>? = null, val removedMemberIds: List<String>? = null)

ThreadMetadata

@Serializable

data class ThreadMetadata(val archived: Boolean, val autoArchiveDuration: Int, val archiveTimestamp: String, val locked: Boolean? = null)

User

@Serializable

data class User(val id: String, val username: String, val discriminator: Long, val avatarHash: String?, val isBot: Boolean? = null, val isSystem: Boolean? = null, val twoFactorAuthEnabled: Boolean? = null, val locale: String? = null, val isVerified: Boolean? = null, val email: String? = null, val flags: UserFlags = UserFlags.NONE, val premiumType: PremiumType? = null, val publicFlags: UserFlags = UserFlags.NONE)

UserConnection

@Serializable

data class UserConnection(val id: String, val name: String, val type: String, val revoked: Boolean, val integrations: List<GuildIntegration>)

UserFlag

enum UserFlag : Enum<UserFlag>

UserFlags

@Serializable(with = UserFlagsSerializer::class)

data class UserFlags(val value: Int)

An immutable collection of UserFlag values stored as a bitmask integer. This can be used to determine which flags a user has.

UserFlagsSerializer

object UserFlagsSerializer : KSerializer<UserFlags>

UserSelectMenu

@Serializable

data class UserSelectMenu(val customId: String, val disabled: Boolean = false, val placeholder: String? = null, val minValues: Int = 1, val maxValues: Int = 1) : MessageComponent

UserStatus

@Serializable(with = UserStatusSerializer::class)

enum UserStatus : Enum<UserStatus>

UserStatusSerializer

object UserStatusSerializer : KSerializer<UserStatus>

VerificationLevel

@Serializable(with = VerificationLevelSerializer::class)

enum VerificationLevel : Enum<VerificationLevel> , CodeEnum

VerificationLevelSerializer

class VerificationLevelSerializer : CodeEnumSerializer<VerificationLevel>

VideoQualityMode

@Serializable(with = VideoQualityModeSerializer::class)

enum VideoQualityMode : Enum<VideoQualityMode> , CodeEnum

VideoQualityModeSerializer

class VideoQualityModeSerializer : CodeEnumSerializer<VideoQualityMode>

VoiceRegion

@Serializable

data class VoiceRegion(val id: String, val name: String, val vipOnly: Boolean, val optimalForCurrentUser: Boolean, val deprecated: Boolean, val customRegion: Boolean)

VoiceState

@Serializable

data class VoiceState(val guildId: String? = null, val channelId: String?, val userId: String, val guildMember: GuildMember? = null, val sessionId: String, val userIsServerDeafened: Boolean, val userIsServerMuted: Boolean, val userSelfIsMuted: Boolean, val userIsSelfDeafened: Boolean, val userIsStreaming: Boolean? = null, val userHasCameraActive: Boolean, val userIsMutedByCurrentUser: Boolean)

Webhook

@Serializable

data class Webhook(val id: String, val type: WebhookType, val guildId: String? = null, val channelId: String, val user: User? = null, val defaultName: String?, val defaultAvatarHash: String?, val token: String? = null, val applicationId: String? = null)

WebhookType

@Serializable(with = WebhookTypeSerializer::class)

enum WebhookType : Enum<WebhookType> , CodeEnum

WebhookTypeSerializer

class WebhookTypeSerializer : CodeEnumSerializer<WebhookType>

WelcomeScreen

@Serializable

data class WelcomeScreen(val description: String?, val welcomeChannels: List<WelcomeScreenChannel>)

WelcomeScreenChannel

@Serializable

data class WelcomeScreenChannel(val channelId: String, val description: String, val emojiId: String?, val emojiName: String?)

Properties

formatted

val Emoji.formatted: String

Formatted version of an emoji for use in a Message.

stringified

val Emoji.stringified: String