gaato/discord/model does not have a README file
ApplicationId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}AttachmentId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}AuditLogEntryId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}AutoModerationRuleId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}ChannelId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}CommandId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}CommandVersionId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}EmojiId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}EntitlementId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}GenericId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}GuildId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}IntegrationId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}InteractionId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}MessageId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}RoleId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}ScheduledEventId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}SkuId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}SoundboardSoundId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}StageInstanceId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}StickerId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}StickerPackId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}SubscriptionId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}TeamId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}UserId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}WebhookId
A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}AllowedMentionsError
pub(all) suberror AllowedMentionsError {
ParseAndExplicit(typ~ : AllowedMentionType)
TooManyRoles(count~ : Int)
TooManyUsers(count~ : Int)
} derive(Eq, Debug)An invalid allowed-mentions configuration rejected during construction.
TimestampError
Raised when a string is not a valid ISO 8601 timestamp.
ActionMetadata
pub(all) struct ActionMetadata {
channel_id : Id[ChannelMarker]?
duration_seconds : Int?
custom_message : String?
} derive(ToJson, Debug, FromJson)Optional execution settings for an auto-moderation action.
ActionRow
A layout row containing nested interactive components.
ActiveGuildThreads
Active thread channels in a guild and their membership records.
Activity
pub(all) struct Activity {
name : String
typ : ActivityType
url : Nullable[String]?
created_at : Int64
timestamps : ActivityTimestamps?
application_id : Id[ApplicationMarker]?
status_display_type : Nullable[Int]?
details : Nullable[String]?
details_url : Nullable[String]?
state : Nullable[String]?
state_url : Nullable[String]?
emoji : Nullable[ActivityEmoji]?
party : ActivityParty?
assets : ActivityAssets?
secrets : ActivitySecrets?
instance : Bool?
flags : ActivityFlags?
buttons : Array[ActivityButton]?
} derive(ToJson, Debug)ActivityAssets
Rich-presence artwork references and their hover texts.
ActivityButton
A custom label/url button shown on a rich presence.
ActivityEmoji
pub(all) struct ActivityEmoji {
name : String
id : Id[EmojiMarker]?
animated : Bool?
} derive(ToJson, Debug, FromJson)The custom or unicode emoji attached to a custom status.
ActivityFlags
Bit set describing which rich-presence interactions an activity supports.
impl ToJson for ActivityFlagsimpl Debug for ActivityFlagsimpl FromJson for ActivityFlagsActivityInstance
pub(all) struct ActivityInstance {
application_id : Id[ApplicationMarker]
instance_id : String
launch_id : Id[GenericMarker]
location : ActivityLocation
users : Array[Id[UserMarker]]
} derive(ToJson, Debug, FromJson)A live instance of an application activity.
ActivityLocation
pub(all) struct ActivityLocation {
id : String
kind : ActivityLocationKind
channel_id : Id[ChannelMarker]
guild_id : Nullable[Id[GuildMarker]]?
} derive(ToJson, Debug, FromJson)The Discord location hosting an application activity instance.
ActivityLocationKind
The channel context hosting an application activity instance.
impl ToJson for ActivityLocationKindimpl FromJson for ActivityLocationKindActivityLocationKind::from_string
ActivityLocationKind::to_string
ActivityParty
The rich-presence party, with size as [current, max] when present.
ActivitySecrets
Secrets for joining or spectating a rich-presence session.
ActivityTimestamps
Unix millisecond start and end times of an activity.
impl ToJson for ActivityTimestampsimpl FromJson for ActivityTimestampsActivityType
An activity category reported in a presence update.
impl ToJson for ActivityTypeimpl FromJson for ActivityTypeAllowedMentionType
A mention category Discord may derive directly from message content.
impl ToJson for AllowedMentionTypeAllowedMentions
Controls which mentions Discord resolves and notifies for an outgoing
message.
Use AllowedMentions(...) so parse categories and explicit ID lists cannot
conflict. The stored arrays are copied during construction to preserve that
invariant if callers later mutate their input arrays.
impl ToJson for AllowedMentionsAllowedMentions::AllowedMentions
fn AllowedMentions::AllowedMentions(parse? : Array[AllowedMentionType], roles? : Array[Id[RoleMarker]], users? : Array[Id[UserMarker]], replied_user? : Bool) -> AllowedMentions raise AllowedMentionsErrorConstruct a validated allowed-mentions object.
test "allow selected users without parsing every user mention" {
let user_id : @model.UserId = Id(42UL)
let mentions = @model.AllowedMentions(
parse=[Roles],
users=[user_id],
replied_user=false,
)
json_inspect(mentions, content={
"parse": ["roles"],
"users": ["42"],
"replied_user": false,
})
}AllowedMentions::none
Suppress every mention parsed from message content.
AllowedMentions::safe_default
Allow user and role mentions while suppressing @everyone and @here.
This is the HTTP client's default for ordinary channel messages.
Application
pub(all) struct Application {
id : Id[ApplicationMarker]
name : String
icon : Nullable[ImageHash]
description : String
bot : User?
owner : User?
flags : ApplicationFlags?
flags_new : ApplicationFlags?
approximate_guild_count : Int?
approximate_user_install_count : Int?
rpc_origins : Array[String]?
bot_public : Bool?
bot_require_code_grant : Bool?
terms_of_service_url : String?
privacy_policy_url : String?
verify_key : String?
team : Nullable[Team]?
guild_id : Id[GuildMarker]?
guild : PartialGuild?
primary_sku_id : Id[SkuMarker]?
slug : String?
cover_image : ImageHash?
approximate_user_authorization_count : Int?
redirect_uris : Array[String]?
interactions_endpoint_url : Nullable[String]?
role_connections_verification_url : Nullable[String]?
event_webhooks_url : Nullable[String]?
event_webhooks_status : ApplicationEventWebhookStatus?
event_webhooks_types : Array[String]?
tags : Array[String]?
install_params : InstallParams?
integration_types_config : Map[String, ApplicationIntegrationTypeConfiguration]?
custom_install_url : String?
} derive(ToJson, Debug, FromJson)A Discord application record. Fields that are absent from partial
application payloads remain optional on receipt.
Application::effective_flags
Return Discord's full response bitfield when present, falling back to the
legacy numeric flags field for older payloads.
ApplicationAuthorizedEvent
Data sent when a user authorizes an application.
ApplicationCommand
pub(all) struct ApplicationCommand {
id : Id[CommandMarker]
typ : ApplicationCommandType?
application_id : Id[ApplicationMarker]
guild_id : Id[GuildMarker]?
name : String
name_localizations : Nullable[Map[String, String]]?
description : String
description_localizations : Nullable[Map[String, String]]?
options : Array[CommandOption]?
default_member_permissions : Nullable[Permissions]
dm_permission : Bool?
nsfw : Bool?
integration_types : Array[ApplicationIntegrationType]?
contexts : Nullable[Array[InteractionContextType]]?
version : Id[CommandVersionMarker]
handler : EntryPointCommandHandlerType?
name_localized : String?
description_localized : String?
} derive(ToJson, Debug, FromJson)A registered Discord application command.
ApplicationCommandPermission
pub(all) struct ApplicationCommandPermission {
id : Id[GenericMarker]
typ : ApplicationCommandPermissionType
permission : Bool
} derive(ToJson, Debug, FromJson)One role, user, or channel permission override for an application command.
ApplicationCommandPermissionType
The target kind of an application-command permission override.
impl ToJson for ApplicationCommandPermissionTypeimpl FromJson for ApplicationCommandPermissionTypefn from_json(json : Json, path : JsonPath) -> ApplicationCommandPermissionType raise JsonDecodeErrorApplicationCommandPermissionType::from_int
ApplicationCommandPermissionType::to_int
ApplicationCommandType
The invocation category of an application command.
impl ToJson for ApplicationCommandTypeimpl FromJson for ApplicationCommandTypeApplicationCommandType::from_int
ApplicationCommandType::to_int
ApplicationDeauthorizedEvent
Data sent when a user deauthorizes an application.
ApplicationEventWebhookStatus
Whether Discord delivers event webhooks to the application;
DisabledByDiscord means delivery was deactivated for inactivity.
impl ToJson for ApplicationEventWebhookStatusimpl FromJson for ApplicationEventWebhookStatusApplicationEventWebhookStatus::from_int
ApplicationEventWebhookStatus::to_int
ApplicationFlags
Bit flags describing capabilities and privileged access for an application.
impl BitAnd for ApplicationFlagsimpl BitOr for ApplicationFlagsimpl ToJson for ApplicationFlagsimpl Debug for ApplicationFlagsimpl FromJson for ApplicationFlagsApplicationFlags::application_auto_moderation_rule_create_badge
ApplicationFlags::application_command_badge
ApplicationFlags::contains
ApplicationFlags::embedded_first_party
ApplicationFlags::embedded_released
ApplicationFlags::gateway_guild_members
ApplicationFlags::gateway_guild_members_limited
ApplicationFlags::gateway_message_content
ApplicationFlags::gateway_message_content_limited
ApplicationFlags::gateway_presence_limited
ApplicationFlags::rpc_has_connected
ApplicationFlags::verification_pending_guild_limit
ApplicationIntegrationType
Where an application command is installed.
impl ToJson for ApplicationIntegrationTypeimpl FromJson for ApplicationIntegrationTypeApplicationIntegrationType::from_int
ApplicationIntegrationType::to_int
ApplicationIntegrationTypeConfiguration
pub(all) struct ApplicationIntegrationTypeConfiguration {
oauth2_install_params : InstallParams?
} derive(ToJson, Debug, FromJson)Installation settings for one application integration context.
ApplicationMarker
pub enum ApplicationMarker {
}Phantom marker types for Id[M]. These are empty enums: they have no
values and exist only at the type level.
ApplicationRoleConnection
Metadata attached to a user's application role connection.
ApplicationRoleConnectionMetadata
One application role connection metadata record.
ApplicationRoleConnectionMetadataType
The comparison used for an application role connection metadata record.
fn from_json(json : Json, path : JsonPath) -> ApplicationRoleConnectionMetadataType raise JsonDecodeErrorApplicationRoleConnectionMetadataType::from_int
fn ApplicationRoleConnectionMetadataType::from_int(value : Int) -> ApplicationRoleConnectionMetadataTypeApplicationRoleConnectionMetadataType::to_int
fn ApplicationRoleConnectionMetadataType::to_int(self : ApplicationRoleConnectionMetadataType) -> IntArchivedThreads
Archived thread channels and their membership records.
Attachment
pub(all) struct Attachment {
id : Id[AttachmentMarker]
filename : String
title : String?
description : String?
content_type : String?
size : Int
url : String
proxy_url : String
height : Nullable[Int]?
width : Nullable[Int]?
ephemeral : Bool?
duration_secs : Double?
waveform : String?
flags : AttachmentFlags?
placeholder : String?
placeholder_version : Int?
clip_participants : Array[User]?
clip_created_at : Timestamp?
application : Nullable[Application]?
} derive(ToJson, Debug, FromJson)A file attached to a Discord message.
AttachmentFlags
Bit flags describing special properties of an attachment.
impl BitAnd for AttachmentFlagsimpl BitOr for AttachmentFlagsimpl ToJson for AttachmentFlagsimpl Debug for AttachmentFlagsimpl FromJson for AttachmentFlagsAttachmentFlags::contains
AttachmentRequest
pub(all) struct AttachmentRequest {
id : Id[AttachmentMarker]
filename : String?
title : String?
description : String?
duration_secs : Double?
waveform : String?
is_spoiler : Bool?
} derive(Debug)An existing attachment to retain when editing a message, per the
documented attachment-request structure. description and is_spoiler
may be updated in place; absent fields are omitted from the wire, leaving
them unchanged. New uploads are announced by the typed wrappers from
their files parameter instead.
impl ToJson for AttachmentRequestAuditLog
pub(all) struct AuditLog {
audit_log_entries : Array[AuditLogEntry]
users : Array[User]
webhooks : Array[Webhook]
integrations : Array[Integration]
application_commands : Array[ApplicationCommand]
auto_moderation_rules : Array[AutoModerationRule]
threads : Array[Channel]
guild_scheduled_events : Array[GuildScheduledEvent]
} derive(ToJson, Debug, FromJson)A guild audit log with referenced domain objects.
AuditLogChange
A raw before-and-after field change recorded in an audit entry.
AuditLogEntry
pub(all) struct AuditLogEntry {
target_id : Nullable[String]
changes : Array[AuditLogChange]?
user_id : Nullable[Id[UserMarker]]
id : Id[AuditLogEntryMarker]
action_type : AuditLogEvent
options : Json?
reason : String?
} derive(ToJson, Debug, FromJson)One actor action recorded in a guild audit log.
AuditLogEvent
pub(all) enum AuditLogEvent {
GuildUpdate
ChannelCreate
ChannelUpdate
ChannelDelete
ChannelOverwriteCreate
ChannelOverwriteUpdate
ChannelOverwriteDelete
MemberKick
MemberPrune
MemberBanAdd
MemberBanRemove
MemberUpdate
MemberRoleUpdate
MemberMove
MemberDisconnect
BotAdd
RoleCreate
RoleUpdate
RoleDelete
InviteCreate
InviteUpdate
InviteDelete
WebhookCreate
WebhookUpdate
WebhookDelete
EmojiCreate
EmojiUpdate
EmojiDelete
MessageDelete
MessageBulkDelete
MessagePin
MessageUnpin
IntegrationCreate
IntegrationUpdate
IntegrationDelete
StageInstanceCreate
StageInstanceUpdate
StageInstanceDelete
StickerCreate
StickerUpdate
StickerDelete
GuildScheduledEventCreate
GuildScheduledEventUpdate
GuildScheduledEventDelete
ThreadCreate
ThreadUpdate
ThreadDelete
ApplicationCommandPermissionUpdate
SoundboardSoundCreate
SoundboardSoundUpdate
SoundboardSoundDelete
AutoModerationRuleCreate
AutoModerationRuleUpdate
AutoModerationRuleDelete
AutoModerationBlockMessage
AutoModerationFlagToChannel
AutoModerationUserCommunicationDisabled
AutoModerationQuarantineUser
CreatorMonetizationRequestCreated
CreatorMonetizationTermsAccepted
OnboardingPromptCreate
OnboardingPromptUpdate
OnboardingPromptDelete
OnboardingCreate
OnboardingUpdate
HomeSettingsCreate
HomeSettingsUpdate
VoiceChannelStatusCreate
VoiceChannelStatusDelete
Unknown(Int)
} derive(Eq, Debug)The action category recorded by a guild audit log.
impl ToJson for AuditLogEventimpl FromJson for AuditLogEventAuthorizationInformation
Details about the OAuth2 authorization represented by an access token.
Discord returns a partial application object here. Application is safe
for that payload because it requires only the guaranteed id, name,
icon, and description fields; all other application fields are optional.
AutoModerationAction
pub(all) struct AutoModerationAction {
typ : AutoModerationActionType
metadata : ActionMetadata?
} derive(ToJson, Debug, FromJson)An action executed when an auto-moderation rule matches.
AutoModerationActionExecutionEvent
pub(all) struct AutoModerationActionExecutionEvent {
guild_id : Id[GuildMarker]
action : AutoModerationAction
rule_id : Id[AutoModerationRuleMarker]
rule_trigger_type : AutoModerationTriggerType
user_id : Id[UserMarker]
channel_id : Id[ChannelMarker]?
message_id : Id[MessageMarker]?
alert_system_message_id : Id[MessageMarker]?
content : String
matched_keyword : Nullable[String]
matched_content : Nullable[String]
} derive(ToJson, Debug, FromJson)An auto-moderation action was executed against user content.
AutoModerationActionType
The operation performed by auto moderation.
impl ToJson for AutoModerationActionTypeimpl FromJson for AutoModerationActionTypeAutoModerationActionType::from_int
AutoModerationActionType::to_int
AutoModerationEventType
The guild event evaluated by an auto-moderation rule.
impl ToJson for AutoModerationEventTypeimpl FromJson for AutoModerationEventTypeAutoModerationEventType::from_int
AutoModerationEventType::to_int
AutoModerationKeywordPresetType
A built-in keyword set used by auto moderation.
impl ToJson for AutoModerationKeywordPresetTypeimpl FromJson for AutoModerationKeywordPresetTypeAutoModerationKeywordPresetType::from_int
AutoModerationKeywordPresetType::to_int
AutoModerationRule
pub(all) struct AutoModerationRule {
id : Id[AutoModerationRuleMarker]
guild_id : Id[GuildMarker]
name : String
creator_id : Id[UserMarker]
event_type : AutoModerationEventType
trigger_type : AutoModerationTriggerType
trigger_metadata : TriggerMetadata
actions : Array[AutoModerationAction]
enabled : Bool
exempt_roles : Array[Id[RoleMarker]]
exempt_channels : Array[Id[ChannelMarker]]
} derive(ToJson, Debug, FromJson)A guild auto-moderation rule and its configured actions.
AutoModerationTriggerType
The condition category that activates an auto-moderation rule.
impl ToJson for AutoModerationTriggerTypeimpl FromJson for AutoModerationTriggerTypeAutoModerationTriggerType::from_int
AutoModerationTriggerType::to_int
AvailableGuildCreateEvent
pub(all) struct AvailableGuildCreateEvent {
guild : Guild
joined_at : Timestamp
large : Bool
unavailable : Bool?
member_count : Int
voice_states : Array[VoiceState]
members : Array[GuildMember]
channels : Array[Channel]
threads : Array[Channel]
presences : Array[PresenceUpdateEvent]
stage_instances : Array[StageInstance]
guild_scheduled_events : Array[GuildScheduledEvent]
soundboard_sounds : Array[SoundboardSound]
} derive(Debug)The complete guild and gateway-only collections sent when it becomes
available to the client.
impl FromJson for AvailableGuildCreateEventAvatarDecorationData
Metadata identifying the decoration displayed over a user's avatar.
BaseTheme
The base client theme a SharedClientTheme gradient is mixed against.
BulkBanResponse
pub(all) struct BulkBanResponse {
banned_users : Array[Id[UserMarker]]
failed_users : Array[Id[UserMarker]]
} derive(ToJson, Debug, FromJson)The result of banning several users in one request.
Button
A clickable button component.
ButtonStyle
The visual and behavioral style of a button.
impl ToJson for ButtonStyleimpl FromJson for ButtonStyleChannel
pub(all) struct Channel {
id : Id[ChannelMarker]
typ : ChannelType
guild_id : Id[GuildMarker]?
position : Int?
permission_overwrites : Array[Overwrite]?
name : Nullable[String]?
topic : Nullable[String]?
nsfw : Bool?
last_message_id : Nullable[Id[MessageMarker]]?
bitrate : Int?
user_limit : Int?
rate_limit_per_user : Int?
recipients : Array[User]?
icon : Nullable[ImageHash]?
owner_id : Id[UserMarker]?
application_id : Id[ApplicationMarker]?
managed : Bool?
parent_id : Nullable[Id[ChannelMarker]]?
last_pin_timestamp : Nullable[Timestamp]?
rtc_region : Nullable[String]?
video_quality_mode : VideoQualityMode?
message_count : Int?
member_count : Int?
thread_metadata : ThreadMetadata?
thread_member : ThreadMember?
default_auto_archive_duration : ThreadAutoArchiveDuration?
permissions : Permissions?
flags : ChannelFlags?
total_message_sent : Int?
available_tags : Array[ForumTag]?
applied_tags : Array[Id[GenericMarker]]?
default_reaction_emoji : Nullable[DefaultReaction]?
default_thread_rate_limit_per_user : Int?
default_sort_order : Nullable[SortOrderType]?
default_forum_layout : ForumLayoutType?
} derive(ToJson, Debug, FromJson)A flat channel model covering every Discord channel variant.
ChannelFlags
Bit flags describing special behavior assigned to a channel.
impl BitAnd for ChannelFlagsimpl BitOr for ChannelFlagsimpl ToJson for ChannelFlagsimpl Debug for ChannelFlagsimpl FromJson for ChannelFlagsChannelFlags::active_channels_removed
ChannelFlags::contains
ChannelFlags::hide_media_download_options
ChannelFlags::is_guild_resource_channel
ChannelFlags::is_scheduled_for_deletion
ChannelInfo
Ephemeral status and voice-session data for one channel.
ChannelInfoEvent
pub(all) struct ChannelInfoEvent {
guild_id : Id[GuildMarker]
channels : Array[ChannelInfo]
} derive(ToJson, Debug, FromJson)Ephemeral voice-channel information returned for a guild.
ChannelMention
pub(all) struct ChannelMention {
id : Id[ChannelMarker]
guild_id : Id[GuildMarker]
typ : ChannelType
name : String
} derive(ToJson, Debug, FromJson)A channel referenced directly in message content.
ChannelPins
pub(all) struct ChannelPins {
items : Array[MessagePin]
has_more : Bool
} derive(ToJson, Debug, FromJson)One page from GET /channels/{channel.id}/messages/pins.
ChannelPinsUpdateEvent
pub(all) struct ChannelPinsUpdateEvent {
guild_id : Id[GuildMarker]?
channel_id : Id[ChannelMarker]
last_pin_timestamp : Nullable[Timestamp]?
} derive(ToJson, Debug, FromJson)The most recent pin timestamp changed for a channel.
ChannelType
The type of a channel.
This is the reference implementation of the wire-enum pattern used across
the whole model layer: an Unknown(raw) catch-all so decoding never fails
on values Discord adds later, plus total to_int/from_int conversions
and hand-written JSON impls (the derived enum representation is not
Discord's scalar encoding).
impl ToJson for ChannelTypeimpl FromJson for ChannelTypeCheckbox
A single modal checkbox.
CheckboxGroup
A modal checkbox group accepting zero or more options.
ClientStatus
pub(all) struct ClientStatus {
desktop : PresenceStatus?
mobile : PresenceStatus?
web : PresenceStatus?
} derive(ToJson, Debug)The Discord client families on which a user is active.
impl FromJson for ClientStatusCollectibles
Collectible profile cosmetics owned by a user or guild member.
CommandData
pub(all) struct CommandData {
id : Id[CommandMarker]
name : String
typ : ApplicationCommandType
resolved : ResolvedData?
options : Array[CommandDataOption]?
guild_id : Id[GuildMarker]?
target_id : Id[GenericMarker]?
} derive(ToJson, Debug, FromJson)Application-command data carried by command and autocomplete interactions.
CommandDataOption
pub(all) struct CommandDataOption {
name : String
typ : CommandOptionType
value : Json?
options : Array[CommandDataOption]?
focused : Bool?
} derive(ToJson, Debug, FromJson)A submitted command option with its raw scalar or nested option value.
CommandOption
pub(all) struct CommandOption {
typ : CommandOptionType
name : String
name_localizations : Nullable[Map[String, String]]?
description : String
description_localizations : Nullable[Map[String, String]]?
required : Bool?
choices : Array[CommandOptionChoice]?
options : Array[CommandOption]?
channel_types : Array[ChannelType]?
min_value : Json?
max_value : Json?
min_length : Int?
max_length : Int?
autocomplete : Bool?
} derive(ToJson, Debug, FromJson)A flat command option supporting every current slash-command option shape.
CommandOptionChoice
A named value offered as a predefined command option choice.
CommandOptionType
The value category accepted by a command option.
impl ToJson for CommandOptionTypeimpl FromJson for CommandOptionTypeComponent
pub(all) enum Component {
ActionRow(ActionRow)
Button(Button)
StringSelect(SelectMenu)
TextInput(TextInput)
UserSelect(SelectMenu)
RoleSelect(SelectMenu)
MentionableSelect(SelectMenu)
ChannelSelect(SelectMenu)
Section(Section)
TextDisplay(TextDisplay)
Thumbnail(Thumbnail)
MediaGallery(MediaGallery)
File(FileComponent)
Separator(Separator)
Container(Container)
Label(Label)
FileUpload(FileUpload)
RadioGroup(RadioGroup)
CheckboxGroup(CheckboxGroup)
Checkbox(Checkbox)
Unknown(Json)
} derive(Debug)ComponentData
pub(all) struct ComponentData {
custom_id : String
component_type : Int
values : Array[String]?
resolved : ResolvedData?
} derive(ToJson, Debug, FromJson)Component-specific data carried by a message component interaction.
Connection
pub(all) struct Connection {
id : String
name : String
typ : ConnectionService
revoked : Bool?
integrations : Array[Integration]?
verified : Bool
friend_sync : Bool
show_activity : Bool
two_way_link : Bool
visibility : Int
} derive(ToJson, Debug, FromJson)A user's linked external service account.
ConnectionService
An external service linked to a Discord user account.
impl ToJson for ConnectionServiceimpl FromJson for ConnectionServiceConnectionService::from_string
ConnectionService::to_string
Container
A Components v2 container with an optional accent color.
CurrentUserGuild
pub(all) struct CurrentUserGuild {
id : Id[GuildMarker]
name : String
icon : Nullable[ImageHash]
banner : Nullable[ImageHash]
owner : Bool
permissions : Permissions
features : Array[GuildFeature]
approximate_member_count : Int?
approximate_presence_count : Int?
} derive(ToJson, Debug, FromJson)The partial guild representation returned for the current user's guilds.
DefaultMessageNotifications
Discord's default message notification level.
impl ToJson for DefaultMessageNotificationsimpl FromJson for DefaultMessageNotificationsDefaultMessageNotifications::from_int
DefaultMessageNotifications::to_int
DefaultReaction
The default custom or Unicode reaction for a forum or media channel.
Embed
pub(all) struct Embed {
title : String?
typ : EmbedType?
url : String?
description : String?
timestamp : Timestamp?
color : Int?
footer : EmbedFooter?
image : EmbedImage?
thumbnail : EmbedThumbnail?
video : EmbedVideo?
provider : EmbedProvider?
author : EmbedAuthor?
fields : Array[EmbedField]?
flags : EmbedFlags?
} derive(ToJson, Debug, FromJson)Rich content embedded in a Discord message.
Use Embed(...) to construct outgoing embeds from fields Discord accepts
when sending. Embed models remain public records so received metadata can
be inspected. Pass outgoing values to
Client::create_message(embeds=[...]), CommandReply::message(embeds=[...]),
ctx.respond, or a followup method. Discord applies its documented embed
count and text-length limits.
test "construct an outgoing embed" {
let embed = @model.Embed(
title="Build complete",
description="All checks passed.",
timestamp=Timestamp("2026-07-15T00:00:00Z"),
color=0x57F287,
footer=EmbedFooter("build 42"),
fields=[
EmbedField("Target", "native", inline=true),
EmbedField("Tests", "325 passed", inline=true),
],
)
json_inspect(embed, content={
"title": "Build complete",
"description": "All checks passed.",
"timestamp": "2026-07-15T00:00:00Z",
"color": 5763719,
"footer": { "text": "build 42" },
"fields": [
{ "name": "Target", "value": "native", "inline": true },
{ "name": "Tests", "value": "325 passed", "inline": true },
],
})
}Embed::Embed
fn Embed::Embed(title? : String, description? : String, url? : String, timestamp? : Timestamp, color? : Int, footer? : EmbedFooter, image? : EmbedImage, thumbnail? : EmbedThumbnail, author? : EmbedAuthor, fields? : Array[EmbedField]) -> EmbedConstruct an embed containing only fields accepted in outgoing payloads.
Receive-only fields are left unset. The fields array is copied so later
mutations of the caller's array do not affect the embed.
EmbedAuthor
Author information displayed at the top of an embed.
EmbedAuthor::EmbedAuthor
Construct author information for an outgoing embed.
EmbedField
A named value displayed in an embed's field grid.
EmbedField::EmbedField
Construct a field for an outgoing embed.
EmbedFlags
Bit flags describing special rendering behavior of an embed.
impl ToJson for EmbedFlagsimpl Debug for EmbedFlagsimpl FromJson for EmbedFlagsEmbedFlags::is_content_inventory_entry
Footer text and optional icon URLs for an embed.
Construct footer content for an outgoing embed.
EmbedImage
Image media displayed within an embed.
EmbedImage::EmbedImage
Construct image media for an outgoing embed.
EmbedProvider
Attribution information for the provider of an embed.
EmbedThumbnail
Thumbnail media displayed beside an embed.
EmbedThumbnail::EmbedThumbnail
Construct thumbnail media for an outgoing embed.
EmbedType
The string discriminator describing an embed's rendering category.
EmbedVideo
Video media attached to an embed.
Emoji
A Discord custom or reaction emoji.
Entitlement
pub(all) struct Entitlement {
id : Id[EntitlementMarker]
sku_id : Id[SkuMarker]
application_id : Id[ApplicationMarker]
user_id : Id[UserMarker]?
typ : EntitlementType
deleted : Bool
starts_at : Nullable[Timestamp]?
ends_at : Nullable[Timestamp]?
guild_id : Id[GuildMarker]?
consumed : Bool?
} derive(ToJson, Debug, FromJson)A grant of access to a Discord application SKU.
EntitlementOwnerType
The owner scope used when creating a test entitlement.
impl ToJson for EntitlementOwnerTypeimpl FromJson for EntitlementOwnerTypeEntitlementOwnerType::from_int
EntitlementOwnerType::to_int
EntitlementType
The origin of an application entitlement.
impl ToJson for EntitlementTypeimpl FromJson for EntitlementTypeEntityMetadata
Optional metadata describing a scheduled event's external entity.
EntryPointCommandHandlerType
The handler used for a primary entry-point command.
impl ToJson for EntryPointCommandHandlerTypeimpl FromJson for EntryPointCommandHandlerTypeEntryPointCommandHandlerType::from_int
EntryPointCommandHandlerType::to_int
Event
pub(all) enum Event {
ApplicationCommandPermissionsUpdate(GuildApplicationCommandPermissions)
AutoModerationActionExecution(AutoModerationActionExecutionEvent)
AutoModerationRuleCreate(AutoModerationRule)
AutoModerationRuleDelete(AutoModerationRule)
AutoModerationRuleUpdate(AutoModerationRule)
ChannelCreate(Channel)
ChannelDelete(Channel)
ChannelInfo(ChannelInfoEvent)
ChannelPinsUpdate(ChannelPinsUpdateEvent)
ChannelUpdate(Channel)
EntitlementCreate(Entitlement)
EntitlementDelete(Entitlement)
EntitlementUpdate(Entitlement)
GuildAuditLogEntryCreate(GuildAuditLogEntryCreateEvent)
GuildBanAdd(GuildBanEvent)
GuildBanRemove(GuildBanEvent)
GuildCreate(GuildCreateEvent)
GuildDelete(UnavailableGuild)
GuildEmojisUpdate(GuildEmojisUpdateEvent)
GuildIntegrationsUpdate(GuildIntegrationsUpdateEvent)
GuildMemberAdd(GuildMemberAddEvent)
GuildMemberRemove(GuildMemberRemoveEvent)
GuildMembersChunk(GuildMembersChunkEvent)
GuildMemberUpdate(GuildMemberUpdateEvent)
GuildRoleCreate(GuildRoleEvent)
GuildRoleDelete(GuildRoleDeleteEvent)
GuildRoleUpdate(GuildRoleEvent)
GuildScheduledEventCreate(GuildScheduledEvent)
GuildScheduledEventDelete(GuildScheduledEvent)
GuildScheduledEventUpdate(GuildScheduledEvent)
GuildScheduledEventUserAdd(GuildScheduledEventUserEvent)
GuildScheduledEventUserRemove(GuildScheduledEventUserEvent)
GuildSoundboardSoundCreate(SoundboardSound)
GuildSoundboardSoundDelete(GuildSoundboardSoundDeleteEvent)
GuildSoundboardSoundsUpdate(SoundboardSoundsEvent)
GuildSoundboardSoundUpdate(SoundboardSound)
SoundboardSounds(SoundboardSoundsEvent)
GuildStickersUpdate(GuildStickersUpdateEvent)
GuildUpdate(Guild)
IntegrationCreate(IntegrationEvent)
IntegrationDelete(IntegrationDeleteEvent)
IntegrationUpdate(IntegrationEvent)
InteractionCreate(Interaction)
InviteCreate(InviteCreateEvent)
InviteDelete(InviteDeleteEvent)
MessageCreate(MessageCreateEvent)
MessageDelete(MessageDeleteEvent)
MessageDeleteBulk(MessageDeleteBulkEvent)
MessagePollVoteAdd(MessagePollVoteEvent)
MessagePollVoteRemove(MessagePollVoteEvent)
MessageReactionAdd(MessageReactionAddEvent)
MessageReactionRemove(MessageReactionRemoveEvent)
MessageReactionRemoveAll(MessageReactionRemoveAllEvent)
MessageReactionRemoveEmoji(MessageReactionRemoveEmojiEvent)
MessageUpdate(MessageUpdateEvent)
PresenceUpdate(PresenceUpdateEvent)
RateLimited(GatewayRateLimitedEvent)
Ready(Ready)
Resumed
StageInstanceCreate(StageInstance)
StageInstanceDelete(StageInstance)
StageInstanceUpdate(StageInstance)
SubscriptionCreate(Subscription)
SubscriptionDelete(Subscription)
SubscriptionUpdate(Subscription)
ThreadCreate(ThreadCreateEvent)
ThreadDelete(ThreadDeleteEvent)
ThreadListSync(ThreadListSyncEvent)
ThreadMembersUpdate(ThreadMembersUpdateEvent)
ThreadMemberUpdate(ThreadMemberUpdateEvent)
ThreadUpdate(Channel)
TypingStart(TypingStartEvent)
UserUpdate(User)
VoiceChannelEffectSend(VoiceChannelEffectSendEvent)
VoiceChannelStartTimeUpdate(VoiceChannelStartTimeUpdateEvent)
VoiceChannelStatusUpdate(VoiceChannelStatusUpdateEvent)
VoiceServerUpdate(VoiceServerUpdateEvent)
VoiceStateUpdate(VoiceState)
WebhooksUpdate(WebhooksUpdateEvent)
Unknown(t~ : String, d~ : Json)
} derive(Debug)A gateway dispatch event decoded by its wire event name.
Unknown event names retain both the name and payload for forward
compatibility.
EventKind
pub(all) enum EventKind {
KApplicationCommandPermissionsUpdate
KAutoModerationActionExecution
KAutoModerationRuleCreate
KAutoModerationRuleDelete
KAutoModerationRuleUpdate
KChannelCreate
KChannelDelete
KChannelInfo
KChannelPinsUpdate
KChannelUpdate
KEntitlementCreate
KEntitlementDelete
KEntitlementUpdate
KGuildAuditLogEntryCreate
KGuildBanAdd
KGuildBanRemove
KGuildCreate
KGuildDelete
KGuildEmojisUpdate
KGuildIntegrationsUpdate
KGuildMemberAdd
KGuildMemberRemove
KGuildMembersChunk
KGuildMemberUpdate
KGuildRoleCreate
KGuildRoleDelete
KGuildRoleUpdate
KGuildScheduledEventCreate
KGuildScheduledEventDelete
KGuildScheduledEventUpdate
KGuildScheduledEventUserAdd
KGuildScheduledEventUserRemove
KGuildSoundboardSoundCreate
KGuildSoundboardSoundDelete
KGuildSoundboardSoundsUpdate
KGuildSoundboardSoundUpdate
KSoundboardSounds
KGuildStickersUpdate
KGuildUpdate
KIntegrationCreate
KIntegrationDelete
KIntegrationUpdate
KInteractionCreate
KInviteCreate
KInviteDelete
KMessageCreate
KMessageDelete
KMessageDeleteBulk
KMessagePollVoteAdd
KMessagePollVoteRemove
KMessageReactionAdd
KMessageReactionRemove
KMessageReactionRemoveAll
KMessageReactionRemoveEmoji
KMessageUpdate
KPresenceUpdate
KRateLimited
KReady
KResumed
KStageInstanceCreate
KStageInstanceDelete
KStageInstanceUpdate
KSubscriptionCreate
KSubscriptionDelete
KSubscriptionUpdate
KThreadCreate
KThreadDelete
KThreadListSync
KThreadMembersUpdate
KThreadMemberUpdate
KThreadUpdate
KTypingStart
KUserUpdate
KVoiceChannelEffectSend
KVoiceChannelStartTimeUpdate
KVoiceChannelStatusUpdate
KVoiceServerUpdate
KVoiceStateUpdate
KWebhooksUpdate
KUnknown
} derive(Eq, Debug)A dispatch event category without its payload.
EventKind::of_name
Map a gateway dispatch name (e.g. "MESSAGE_CREATE") to its kind;
unrecognized names map to KUnknown.
EventKind::required_intents
Gateway intents that can cause this dispatch event to be delivered.
Events shared by guild and direct-message contexts return the union of
both intents. MESSAGE_CONTENT is deliberately absent because it controls
field visibility rather than event delivery.
ExplicitContentFilter
Discord's explicit content filter level.
impl ToJson for ExplicitContentFilterimpl FromJson for ExplicitContentFilterExplicitContentFilter::from_int
ExplicitContentFilter::to_int
FileComponent
pub(all) struct FileComponent {
id : Int?
file : UnfurledMediaItem
spoiler : Bool?
name : String?
size : Int?
} derive(ToJson, Debug, FromJson)A file attachment rendered as a Components v2 file component.
FileUpload
A modal file upload component.
FollowedChannel
pub(all) struct FollowedChannel {
channel_id : Id[ChannelMarker]
webhook_id : Id[WebhookMarker]
} derive(ToJson, Debug, FromJson)The announcement channel and webhook created by following a channel.
ForumLayoutType
The presentation layout used by a forum channel.
impl ToJson for ForumLayoutTypeimpl FromJson for ForumLayoutTypeForumTag
pub(all) struct ForumTag {
id : Id[GenericMarker]
name : String
moderated : Bool
emoji_id : Nullable[Id[EmojiMarker]]
emoji_name : Nullable[String]
} derive(ToJson, Debug, FromJson)A tag available for categorizing threads in a forum or media channel.
ForumTagRequest
pub(all) struct ForumTagRequest {
id : Id[GenericMarker]?
name : String
moderated : Bool?
emoji_id : Id[EmojiMarker]?
emoji_name : String?
} derive(Debug)A forum tag as sent in available_tags when creating or modifying a
forum or media channel. Only name is required; omit id to create a
new tag, keep an existing tag's id to update it in place. At most one
of emoji_id and emoji_name may be set.
impl ToJson for ForumTagRequestGameDirectMessage
pub(all) struct GameDirectMessage {
id : Id[MessageMarker]
typ : MessageType?
content : String?
channel_id : Id[ChannelMarker]?
channel : Channel?
author : User?
recipient_id : Id[UserMarker]?
timestamp : Timestamp?
edited_timestamp : Nullable[Timestamp]?
flags : MessageFlags?
application_id : Id[ApplicationMarker]?
attachments : Array[Attachment]?
components : Array[Component]?
activity : MessageActivity?
application : Json?
raw : Json
} derive(Debug)A compact, lossless view of a Social SDK direct message.
These webhook objects may be standard messages or the smaller SDK DM
shape. Fields that differ between those forms are optional, and raw
preserves all unmodeled standard-message and SDK extension fields.
impl ToJson for GameDirectMessageimpl FromJson for GameDirectMessageGatewayBotInfo
pub(all) struct GatewayBotInfo {
url : String
shards : Int
session_start_limit : SessionStartLimit
} derive(ToJson, Debug, FromJson)Response of GET /gateway/bot.
GatewayOpcode
Gateway opcodes (send and receive).
GatewayRateLimitedEvent
A gateway request was rate limited.
Guild
pub(all) struct Guild {
id : Id[GuildMarker]
name : String
icon : Nullable[ImageHash]
icon_hash : Nullable[ImageHash]?
splash : Nullable[ImageHash]
discovery_splash : Nullable[ImageHash]
owner : Bool?
owner_id : Id[UserMarker]
permissions : Permissions?
afk_channel_id : Nullable[Id[ChannelMarker]]
afk_timeout : Int
widget_enabled : Bool?
widget_channel_id : Nullable[Id[ChannelMarker]]?
verification_level : VerificationLevel
default_message_notifications : DefaultMessageNotifications
explicit_content_filter : ExplicitContentFilter
roles : Array[Role]
emojis : Array[Emoji]
features : Array[GuildFeature]
mfa_level : MfaLevel
application_id : Nullable[Id[ApplicationMarker]]
system_channel_id : Nullable[Id[ChannelMarker]]
system_channel_flags : SystemChannelFlags
rules_channel_id : Nullable[Id[ChannelMarker]]
max_presences : Nullable[Int]?
max_members : Int?
vanity_url_code : Nullable[String]
description : Nullable[String]
banner : Nullable[ImageHash]
premium_tier : PremiumTier
premium_subscription_count : Int?
preferred_locale : String
public_updates_channel_id : Nullable[Id[ChannelMarker]]
max_video_channel_users : Int?
max_stage_video_channel_users : Int?
approximate_member_count : Int?
approximate_presence_count : Int?
welcome_screen : WelcomeScreen?
nsfw_level : NsfwLevel?
stickers : Array[Sticker]?
premium_progress_bar_enabled : Bool?
safety_alerts_channel_id : Nullable[Id[ChannelMarker]]
incidents_data : Nullable[IncidentsData]?
} derive(ToJson, Debug, FromJson)A Discord guild and its configured capabilities.
GuildApplicationCommandPermissions
pub(all) struct GuildApplicationCommandPermissions {
id : Id[CommandMarker]
application_id : Id[ApplicationMarker]
guild_id : Id[GuildMarker]
permissions : Array[ApplicationCommandPermission]
} derive(ToJson, Debug, FromJson)Guild-scoped permission overrides for one application command.
GuildAuditLogEntryCreateEvent
pub(all) struct GuildAuditLogEntryCreateEvent {
guild_id : Id[GuildMarker]
entry : AuditLogEntry
} derive(Debug)An audit-log entry created in a guild, decoded from the flattened object.
impl FromJson for GuildAuditLogEntryCreateEventGuildBan
A ban record pairing a user with an optional reason.
GuildBanEvent
A user ban added to or removed from a guild.
GuildCreateEvent
pub(all) enum GuildCreateEvent {
Available(AvailableGuildCreateEvent)
Unavailable(UnavailableGuild)
} derive(Debug)A guild-create dispatch is either a complete available guild or the small
unavailable-guild sentinel emitted while Discord is having an outage.
impl FromJson for GuildCreateEventGuildEmojisUpdateEvent
Guild emoji collection replacement.
GuildFeature
pub(all) enum GuildFeature {
AnimatedBanner
AnimatedIcon
ApplicationCommandPermissionsV2
AutoModeration
Banner
Community
CreatorMonetizableProvisional
CreatorStorePage
DeveloperSupportServer
Discoverable
Featurable
HasDirectoryEntry
Hub
InvitesDisabled
InviteSplash
LinkedToHub
MemberVerificationGateEnabled
MoreSoundboard
MonetizationEnabled
MoreStickers
News
Partnered
PreviewEnabled
PrivateThreads
RaidAlertsDisabled
RelayEnabled
RoleIcons
RoleSubscriptionsAvailableForPurchase
RoleSubscriptionsEnabled
Soundboard
TicketedEventsEnabled
VanityUrl
Verified
VipRegions
WelcomeScreenEnabled
GuildTags
EnhancedRoleColors
GuestsEnabled
PinPermissionMigrationComplete
Unknown(String)
} derive(Eq, Debug)GuildIntegrationsUpdateEvent
pub(all) struct GuildIntegrationsUpdateEvent {
guild_id : Id[GuildMarker]
} derive(ToJson, Debug, FromJson)Notification that a guild's integrations changed.
GuildMember
pub(all) struct GuildMember {
user : User?
nick : Nullable[String]?
avatar : Nullable[ImageHash]?
banner : Nullable[ImageHash]?
roles : Array[Id[RoleMarker]]
joined_at : Nullable[Timestamp]
premium_since : Nullable[Timestamp]?
deaf : Bool?
mute : Bool?
flags : GuildMemberFlags?
pending : Bool?
permissions : Permissions?
communication_disabled_until : Nullable[Timestamp]?
avatar_decoration_data : Nullable[AvatarDecorationData]?
collectibles : Nullable[Collectibles]?
} derive(ToJson, Debug, FromJson)A user's membership state and profile within a guild.
GuildMemberAddEvent
pub(all) struct GuildMemberAddEvent {
guild_id : Id[GuildMarker]
guild_member : GuildMember
} derive(Debug)A guild member joined event decoded from Discord's flattened member object.
impl FromJson for GuildMemberAddEventGuildMemberFlags
Bit flags describing onboarding, verification, and moderation member state.
impl BitAnd for GuildMemberFlagsimpl BitOr for GuildMemberFlagsimpl ToJson for GuildMemberFlagsimpl Debug for GuildMemberFlagsimpl FromJson for GuildMemberFlagsGuildMemberFlags::auto_mod_quarantined_guild_tag
GuildMemberFlags::automod_quarantined_bio
GuildMemberFlags::automod_quarantined_username_or_guild_nickname
GuildMemberFlags::bypasses_verification
GuildMemberFlags::completed_home_actions
GuildMemberFlags::completed_onboarding
GuildMemberFlags::contains
GuildMemberFlags::dm_settings_upsell_acknowledged
GuildMemberFlags::started_home_actions
GuildMemberFlags::started_onboarding
GuildMemberRemoveEvent
A user removed from a guild.
GuildMemberUpdateEvent
pub(all) struct GuildMemberUpdateEvent {
guild_id : Id[GuildMarker]
roles : Array[Id[RoleMarker]]
user : User
nick : Nullable[String]?
avatar : Nullable[ImageHash]
joined_at : Nullable[Timestamp]
premium_since : Nullable[Timestamp]?
deaf : Bool?
mute : Bool?
pending : Bool?
communication_disabled_until : Nullable[Timestamp]?
flags : GuildMemberFlags?
avatar_decoration_data : Nullable[AvatarDecorationData]?
} derive(ToJson, Debug, FromJson)Mutable guild-member fields delivered by GUILD_MEMBER_UPDATE.
GuildMembersChunkEvent
pub(all) struct GuildMembersChunkEvent {
guild_id : Id[GuildMarker]
members : Array[GuildMember]
chunk_index : Int
chunk_count : Int
not_found : Array[Json]?
presences : Array[PresenceUpdateEvent]?
nonce : String?
} derive(ToJson, Debug, FromJson)A chunk returned by a gateway guild-member request.
GuildMessageSearchResults
A guild message search response. All fields are optional because Discord
returns either completed results or an HTTP 202 indexing response. When
retry_after is Some, the search index was not ready and the caller
should retry after that many seconds.
GuildOnboarding
pub(all) struct GuildOnboarding {
guild_id : Id[GuildMarker]
prompts : Array[OnboardingPrompt]
default_channel_ids : Array[Id[ChannelMarker]]
enabled : Bool
mode : OnboardingMode
} derive(ToJson, Debug, FromJson)A guild's onboarding configuration.
GuildPreview
pub(all) struct GuildPreview {
id : Id[GuildMarker]
name : String
icon : Nullable[ImageHash]
splash : Nullable[ImageHash]
discovery_splash : Nullable[ImageHash]
emojis : Array[Emoji]
features : Array[GuildFeature]
approximate_member_count : Int
approximate_presence_count : Int
description : Nullable[String]
stickers : Array[Sticker]
} derive(ToJson, Debug, FromJson)A guild's public preview, available for discoverable guilds.
GuildPruneResult
The number of members pruned, or null when a begin-prune request did not
compute the count.
GuildRoleDeleteEvent
pub(all) struct GuildRoleDeleteEvent {
guild_id : Id[GuildMarker]
role_id : Id[RoleMarker]
} derive(ToJson, Debug, FromJson)A role deleted from a guild.
GuildRoleEvent
A role created or updated in a guild.
GuildScheduledEvent
pub(all) struct GuildScheduledEvent {
id : Id[ScheduledEventMarker]
guild_id : Id[GuildMarker]
channel_id : Nullable[Id[ChannelMarker]]
creator_id : Nullable[Id[UserMarker]]?
name : String
description : Nullable[String]?
scheduled_start_time : Timestamp
scheduled_end_time : Nullable[Timestamp]
privacy_level : GuildScheduledEventPrivacyLevel
status : GuildScheduledEventStatus
entity_type : GuildScheduledEventEntityType
entity_id : Nullable[Id[GenericMarker]]
entity_metadata : Nullable[EntityMetadata]
creator : User?
user_count : Int?
image : Nullable[ImageHash]?
recurrence_rule : Nullable[GuildScheduledEventRecurrenceRule]
} derive(ToJson, Debug, FromJson)A guild event scheduled for a stage, voice channel, or external location.
GuildScheduledEventEntityType
The hosting entity used by a scheduled event.
impl ToJson for GuildScheduledEventEntityTypeimpl FromJson for GuildScheduledEventEntityTypeGuildScheduledEventEntityType::from_int
GuildScheduledEventEntityType::to_int
GuildScheduledEventPrivacyLevel
The audience allowed to access a scheduled event.
impl ToJson for GuildScheduledEventPrivacyLevelimpl FromJson for GuildScheduledEventPrivacyLevelGuildScheduledEventPrivacyLevel::from_int
GuildScheduledEventPrivacyLevel::to_int
GuildScheduledEventRecurrenceRule
pub(all) struct GuildScheduledEventRecurrenceRule {
start : Timestamp
end : Nullable[Timestamp]?
frequency : GuildScheduledEventRecurrenceRuleFrequency
interval : Int
by_weekday : Array[GuildScheduledEventRecurrenceRuleWeekday]?
by_n_weekday : Array[GuildScheduledEventRecurrenceRuleNWeekday]?
by_month : Array[GuildScheduledEventRecurrenceRuleMonth]?
by_month_day : Array[Int]?
by_year_day : Array[Int]?
count : Int?
} derive(ToJson, Debug, FromJson)A recurrence schedule attached to a guild scheduled event.
GuildScheduledEventRecurrenceRuleFrequency
The base period used by a scheduled-event recurrence rule.
fn from_json(json : Json, path : JsonPath) -> GuildScheduledEventRecurrenceRuleFrequency raise JsonDecodeErrorGuildScheduledEventRecurrenceRuleFrequency::from_int
fn GuildScheduledEventRecurrenceRuleFrequency::from_int(value : Int) -> GuildScheduledEventRecurrenceRuleFrequencyGuildScheduledEventRecurrenceRuleFrequency::to_int
fn GuildScheduledEventRecurrenceRuleFrequency::to_int(self : GuildScheduledEventRecurrenceRuleFrequency) -> IntGuildScheduledEventRecurrenceRuleMonth
A calendar month used by a scheduled-event recurrence rule.
fn from_json(json : Json, path : JsonPath) -> GuildScheduledEventRecurrenceRuleMonth raise JsonDecodeErrorGuildScheduledEventRecurrenceRuleMonth::from_int
fn GuildScheduledEventRecurrenceRuleMonth::from_int(value : Int) -> GuildScheduledEventRecurrenceRuleMonthGuildScheduledEventRecurrenceRuleMonth::to_int
fn GuildScheduledEventRecurrenceRuleMonth::to_int(self : GuildScheduledEventRecurrenceRuleMonth) -> IntGuildScheduledEventRecurrenceRuleNWeekday
pub(all) struct GuildScheduledEventRecurrenceRuleNWeekday {
n : Int
day : GuildScheduledEventRecurrenceRuleWeekday
} derive(ToJson, Debug, FromJson)An ordinal weekday constraint such as the first Monday of a month.
GuildScheduledEventRecurrenceRuleWeekday
A weekday used by a scheduled-event recurrence rule (Monday is zero).
fn from_json(json : Json, path : JsonPath) -> GuildScheduledEventRecurrenceRuleWeekday raise JsonDecodeErrorGuildScheduledEventRecurrenceRuleWeekday::from_int
fn GuildScheduledEventRecurrenceRuleWeekday::from_int(value : Int) -> GuildScheduledEventRecurrenceRuleWeekdayGuildScheduledEventRecurrenceRuleWeekday::to_int
fn GuildScheduledEventRecurrenceRuleWeekday::to_int(self : GuildScheduledEventRecurrenceRuleWeekday) -> IntGuildScheduledEventStatus
The lifecycle state of a scheduled event.
impl ToJson for GuildScheduledEventStatusimpl FromJson for GuildScheduledEventStatusGuildScheduledEventStatus::from_int
GuildScheduledEventStatus::to_int
GuildScheduledEventUser
pub(all) struct GuildScheduledEventUser {
guild_scheduled_event_id : Id[ScheduledEventMarker]
user : User
guild_member : GuildMember?
} derive(ToJson, Debug, FromJson)A user interested in a guild scheduled event.
GuildScheduledEventUserEvent
pub(all) struct GuildScheduledEventUserEvent {
guild_scheduled_event_id : Id[ScheduledEventMarker]
user_id : Id[UserMarker]
guild_id : Id[GuildMarker]
} derive(ToJson, Debug, FromJson)A user added to or removed from a scheduled guild event.
GuildSoundboardSoundDeleteEvent
pub(all) struct GuildSoundboardSoundDeleteEvent {
sound_id : Id[SoundboardSoundMarker]
guild_id : Id[GuildMarker]
} derive(ToJson, Debug, FromJson)A soundboard sound deleted from a guild.
GuildStickersUpdateEvent
Guild sticker collection replacement.
GuildTemplate
pub(all) struct GuildTemplate {
code : String
name : String
description : Nullable[String]
usage_count : Int
creator_id : Id[UserMarker]
creator : User
created_at : Timestamp
updated_at : Timestamp
source_guild_id : Id[GuildMarker]
serialized_source_guild : GuildTemplateSource
is_dirty : Nullable[Bool]
} derive(ToJson, Debug, FromJson)A reusable Discord guild template and its serialized guild snapshot.
GuildTemplateChannel
pub(all) struct GuildTemplateChannel {
id : Int
typ : ChannelType
name : String
position : Int
topic : Nullable[String]?
bitrate : Int?
user_limit : Int?
nsfw : Bool?
rate_limit_per_user : Int?
parent_id : Nullable[Int]?
permission_overwrites : Array[GuildTemplatePermissionOverwrite]?
} derive(ToJson, Debug, FromJson)A channel in a template snapshot, using integer placeholder IDs.
GuildTemplatePermissionOverwrite
pub(all) struct GuildTemplatePermissionOverwrite {
id : Int
typ : Int
allow : GuildTemplatePermissions
deny : GuildTemplatePermissions
} derive(ToJson, Debug, FromJson)A permission overwrite using a template placeholder ID.
GuildTemplatePermissions
A permission bitset encoded as a JSON number in template snapshots.
impl ToJson for GuildTemplatePermissionsimpl Debug for GuildTemplatePermissionsimpl FromJson for GuildTemplatePermissionsGuildTemplatePermissions::bits
GuildTemplateRole
pub(all) struct GuildTemplateRole {
id : Int
name : String
permissions : GuildTemplatePermissions
color : Int
colors : Nullable[RoleColors]?
hoist : Bool
mentionable : Bool
icon : Nullable[ImageHash]?
unicode_emoji : Nullable[String]?
} derive(ToJson, Debug, FromJson)A role in a template snapshot, using the snapshot's integer placeholder ID.
GuildTemplateSource
pub(all) struct GuildTemplateSource {
name : String?
description : Nullable[String]?
region : String?
verification_level : VerificationLevel?
default_message_notifications : DefaultMessageNotifications?
explicit_content_filter : ExplicitContentFilter?
preferred_locale : String?
afk_timeout : Int?
roles : Array[GuildTemplateRole]?
channels : Array[GuildTemplateChannel]?
afk_channel_id : Nullable[Int]?
system_channel_id : Nullable[Int]?
system_channel_flags : SystemChannelFlags?
icon_hash : Nullable[ImageHash]?
} derive(ToJson, Debug, FromJson)Stable guild settings exposed in a serialized template snapshot.
Discord uses integer placeholder IDs for nested roles and channels in this
payload, so this is intentionally distinct from PartialGuild.
GuildVanityUrl
A guild's vanity invite code and its current use count.
GuildWidget
pub(all) struct GuildWidget {
id : Id[GuildMarker]
name : String
instant_invite : Nullable[String]
channels : Array[GuildWidgetChannel]
members : Array[GuildWidgetMember]
presence_count : Int
} derive(ToJson, Debug, FromJson)The public JSON representation of a guild widget.
GuildWidgetChannel
pub(all) struct GuildWidgetChannel {
id : Id[ChannelMarker]
name : String
position : Int
} derive(ToJson, Debug, FromJson)A voice channel shown in a public guild widget.
GuildWidgetMember
An anonymized member shown in a public guild widget. Widget member IDs are
opaque strings rather than Discord snowflakes.
GuildWidgetSettings
Whether a guild widget is enabled and the channel it links to.
Hello
Payload of opcode 10 (Hello).
Id
pub(all) struct Id[M](UInt64)A Discord snowflake ID, tagged with a phantom marker type so that IDs of
different resources cannot be mixed up (Id[UserMarker] vs Id[GuildMarker]).
Wire format: Discord serializes snowflakes as decimal strings (and
historically as integers in a few places). We accept both on decode and
always emit a string, going through the string representation so values
above 2^53 never pass through a Double.
test "parse and explicitly retag a snowflake" {
let user_id : @model.UserId = @model.Id::parse("175928847299117063")
inspect(user_id.to_string(), content="175928847299117063")
inspect(user_id.timestamp_ms(), content="1462015105796")
let guild_id : @model.GuildId = user_id.cast()
assert_eq(guild_id.value(), user_id.value())
}Id::cast
Re-tag an ID with a different marker, for the few places where Discord
aliases ID domains (e.g. the @everyone role ID equals the guild ID).
Id::timestamp_ms
Milliseconds since the Unix epoch encoded in the snowflake.
ImageHash
A guild/user avatar or icon hash, kept raw (e.g. a_1269e74af4df7417b13759eae50c83dc).
ImageHash::is_animated
Animated assets (GIF avatars etc.) are prefixed with a_.
IncidentsData
Temporary safety restrictions and detection timestamps for a guild.
InstallParams
pub(all) struct InstallParams {
scopes : Array[String]
permissions : Permissions
} derive(ToJson, Debug, FromJson)Default OAuth2 installation scopes and bot permissions for an application.
Integration
pub(all) struct Integration {
id : Id[IntegrationMarker]?
name : String?
typ : String?
enabled : Bool?
syncing : Bool?
role_id : Id[RoleMarker]?
enable_emoticons : Bool?
expire_behavior : IntegrationExpireBehavior?
expire_grace_period : Int?
user : User?
account : IntegrationAccount?
synced_at : Timestamp?
subscriber_count : Int?
revoked : Bool?
application : IntegrationApplication?
application_id : Id[ApplicationMarker]?
scopes : Array[String]?
} derive(ToJson, Debug, FromJson)A guild integration. All fields are optional because audit logs and user
connections carry documented partial forms of this object.
IntegrationAccount
The provider-side account an integration is linked to.
IntegrationApplication
The OAuth2 application backing a Discord-app integration.
IntegrationDeleteEvent
pub(all) struct IntegrationDeleteEvent {
id : Id[IntegrationMarker]
guild_id : Id[GuildMarker]
application_id : Id[ApplicationMarker]?
} derive(ToJson, Debug, FromJson)A guild integration deletion.
IntegrationEvent
A guild integration payload retained raw alongside its guild id.
impl FromJson for IntegrationEventIntegrationExpireBehavior
What happens to a subscriber when their integration expires.
impl ToJson for IntegrationExpireBehaviorimpl FromJson for IntegrationExpireBehaviorIntegrationExpireBehavior::from_int
IntegrationExpireBehavior::to_int
Intents
Gateway intents: the server-side event subscription bitfield sent in
Identify. Unknown bits are preserved. Wire format: JSON number.
test "compose the gateway event subscriptions a bot needs" {
let intents = @model.Intents::guilds() |
@model.Intents::guild_messages() |
@model.Intents::message_content()
inspect(
intents.bits(),
content=(
#|33281
),
)
assert_true(intents.contains(@model.Intents::message_content()))
}Intents::auto_moderation_configuration
AUTO_MODERATION_CONFIGURATION: auto moderation rule events.
Intents::auto_moderation_execution
AUTO_MODERATION_EXECUTION: auto moderation action execution events.
Intents::direct_message_polls
DIRECT_MESSAGE_POLLS: poll vote events in DM channels.
Intents::direct_message_reactions
DIRECT_MESSAGE_REACTIONS: reaction events in DM channels.
Intents::direct_message_typing
DIRECT_MESSAGE_TYPING: typing indicators in DM channels.
Intents::direct_messages
DIRECT_MESSAGES: message events in DM channels.
Intents::guild_expressions
GUILD_EXPRESSIONS: emoji, sticker, and soundboard sound updates.
Intents::guild_integrations
GUILD_INTEGRATIONS: integration create, update, and delete events.
Intents::guild_invites
GUILD_INVITES: invite create and delete events.
Intents::guild_members
GUILD_MEMBERS (privileged): member join, leave, and update events.
Must also be enabled in the developer portal.
Intents::guild_message_polls
GUILD_MESSAGE_POLLS: poll vote events in guilds.
Intents::guild_message_reactions
GUILD_MESSAGE_REACTIONS: reaction events in guilds.
Intents::guild_message_typing
GUILD_MESSAGE_TYPING: typing indicators in guilds.
Intents::guild_messages
GUILD_MESSAGES: message events in guilds. Content fields also need
message_content.
Intents::guild_moderation
GUILD_MODERATION: ban events and audit log entry creation.
Intents::guild_presences
GUILD_PRESENCES (privileged): member presence updates. Must also be
enabled in the developer portal.
Intents::guild_scheduled_events
GUILD_SCHEDULED_EVENTS: scheduled event lifecycle and user
subscription events.
Intents::guild_voice_states
GUILD_VOICE_STATES: voice state updates and voice channel effects.
Intents::guild_webhooks
GUILD_WEBHOOKS: webhook update events.
Intents::guilds
GUILDS: guild, channel, thread, role, and stage lifecycle events.
Intents::message_content
MESSAGE_CONTENT (privileged): unlocks content, embeds,
attachments, and components on guild messages not addressed to
the bot. Delivers no events by itself; must also be enabled in the
developer portal.
Interaction
pub(all) struct Interaction {
id : Id[InteractionMarker]
application_id : Id[ApplicationMarker]
typ : InteractionType
data : InteractionData?
guild : PartialGuild?
guild_id : Id[GuildMarker]?
channel : Channel?
channel_id : Id[ChannelMarker]?
guild_member : GuildMember?
user : User?
token : String
version : Int
message : Message?
app_permissions : Permissions?
locale : String?
guild_locale : String?
entitlements : Array[Entitlement]?
authorizing_integration_owners : Map[String, String]?
context : InteractionContextType?
attachment_size_limit : Int?
} derive(Debug)An interaction delivered by Discord to an application.
impl ToJson for Interactionimpl FromJson for InteractionInteractionCallback
pub(all) struct InteractionCallback {
id : Id[InteractionMarker]
typ : InteractionType
activity_instance_id : String?
response_message_id : Id[MessageMarker]?
response_message_loading : Bool?
response_message_ephemeral : Bool?
} derive(ToJson, Debug, FromJson)The interaction as seen by the callback endpoint.
InteractionCallbackActivityInstance
The Activity instance launched by an interaction response. Distinct from
the fuller ActivityInstance resource returned by the application
endpoints.
InteractionCallbackResource
pub(all) struct InteractionCallbackResource {
typ : InteractionResponseType
activity_instance : InteractionCallbackActivityInstance?
message : Message?
} derive(ToJson, Debug, FromJson)What the interaction response created. message is set for message
callbacks, activity_instance when an Activity was launched.
InteractionCallbackResponse
pub(all) struct InteractionCallbackResponse {
interaction : InteractionCallback
resource : InteractionCallbackResource?
} derive(ToJson, Debug, FromJson)The envelope returned by Create Interaction Response when the caller asks
for it with with_response=true.
InteractionContextType
Where an interaction was triggered.
impl ToJson for InteractionContextTypeimpl FromJson for InteractionContextTypeInteractionContextType::from_int
InteractionContextType::to_int
InteractionData
pub(all) enum InteractionData {
Command(CommandData)
Component(ComponentData)
Modal(ModalData)
Unknown(Json)
} derive(Debug)Polymorphic interaction data selected by the parent interaction type.
impl ToJson for InteractionDataInteractionResponse
pub(all) struct InteractionResponse {
typ : InteractionResponseType
data : Json?
} derive(ToJson, Debug, FromJson)A response envelope sent for an interaction callback.
InteractionResponseType
The callback behavior requested by an interaction response.
impl ToJson for InteractionResponseTypeimpl FromJson for InteractionResponseTypeInteractionResponseType::from_int
InteractionResponseType::to_int
InteractionType
The dispatch category of an interaction.
impl ToJson for InteractionTypeimpl FromJson for InteractionTypeInvite
pub(all) struct Invite {
typ : InviteType?
code : String
guild : PartialGuild?
channel : Nullable[PartialChannel]?
inviter : User?
target_type : InviteTargetType?
target_user : User?
target_application : Application?
approximate_presence_count : Int?
approximate_member_count : Int?
expires_at : Nullable[Timestamp]?
guild_scheduled_event : GuildScheduledEvent?
flags : InviteFlags?
roles : Array[PartialRole]?
uses : Int?
max_uses : Int?
max_age : Int?
temporary : Bool?
created_at : Timestamp?
} derive(ToJson, Debug, FromJson)A Discord invite with optional usage metadata.
InviteCreateEvent
pub(all) struct InviteCreateEvent {
channel_id : Id[ChannelMarker]
code : String
created_at : Timestamp
guild_id : Id[GuildMarker]?
inviter : User?
max_age : Int
max_uses : Int
target_type : InviteTargetType?
target_user : User?
target_application : Json?
temporary : Bool
uses : Int
expires_at : Nullable[Timestamp]
role_ids : Array[Id[RoleMarker]]?
} derive(ToJson, Debug, FromJson)An invite created in a channel.
InviteDeleteEvent
pub(all) struct InviteDeleteEvent {
channel_id : Id[ChannelMarker]
guild_id : Id[GuildMarker]?
code : String
} derive(ToJson, Debug, FromJson)An invite deleted from a channel.
InviteFlags
Bit flags describing a guild invite.
impl ToJson for InviteFlagsimpl Debug for InviteFlagsimpl FromJson for InviteFlagsInviteTargetType
The special target carried by a voice channel invite.
impl ToJson for InviteTargetTypeimpl FromJson for InviteTargetTypeInviteType
Label
A modal label wrapping one interactive component.
LobbyMessage
pub(all) struct LobbyMessage {
id : Id[MessageMarker]
typ : MessageType
content : String
lobby_id : Id[GenericMarker]
channel_id : Id[ChannelMarker]
author : User
metadata : Json?
flags : MessageFlags
application_id : Id[ApplicationMarker]?
timestamp : Timestamp?
edited_timestamp : Nullable[Timestamp]?
raw : Json
} derive(Debug)A lobby message view for outbound webhook events.
The documented fields are decoded for direct use while raw preserves
the complete object, including SDK extensions that are not a Lobby domain.
impl ToJson for LobbyMessageimpl FromJson for LobbyMessageLobbyMessageDeleteEvent
pub(all) struct LobbyMessageDeleteEvent {
id : Id[MessageMarker]
lobby_id : Id[GenericMarker]
raw : Json
} derive(Debug)Identifiers for a lobby message that was deleted.
impl ToJson for LobbyMessageDeleteEventimpl FromJson for LobbyMessageDeleteEventMediaGallery
pub(all) struct MediaGallery {
id : Int?
items : Array[MediaGalleryItem]
} derive(ToJson, Debug, FromJson)A gallery containing one to ten media items.
MediaGalleryItem
pub(all) struct MediaGalleryItem {
media : UnfurledMediaItem
description : String?
spoiler : Bool?
} derive(ToJson, Debug, FromJson)One item in a media gallery.
Message
pub(all) struct Message {
id : Id[MessageMarker]
channel_id : Id[ChannelMarker]
author : User
content : String
timestamp : Timestamp
edited_timestamp : Nullable[Timestamp]
tts : Bool
mention_everyone : Bool
mentions : Array[User]
mention_roles : Array[Id[RoleMarker]]
mention_channels : Array[ChannelMention]?
attachments : Array[Attachment]
embeds : Array[Embed]
reactions : Array[Reaction]?
nonce : Nonce?
pinned : Bool
webhook_id : Id[WebhookMarker]?
typ : MessageType
activity : MessageActivity?
application_id : Id[ApplicationMarker]?
message_reference : MessageReference?
flags : MessageFlags?
referenced_message : Nullable[Message]?
thread : Channel?
components : Array[Component]?
sticker_items : Array[StickerItem]?
position : Int?
role_subscription_data : RoleSubscriptionData?
poll : Poll?
call : MessageCall?
application : Application?
interaction_metadata : MessageInteractionMetadata?
resolved : ResolvedData?
message_snapshots : Array[MessageSnapshot]?
shared_client_theme : SharedClientTheme?
} derive(ToJson, Debug, FromJson)A message sent to a Discord channel.
MessageActivity
pub(all) struct MessageActivity {
typ : MessageActivityType
party_id : String?
} derive(ToJson, Debug, FromJson)Rich Presence activity metadata attached to a message.
MessageActivityType
The Rich Presence action represented by a message activity.
impl ToJson for MessageActivityTypeimpl FromJson for MessageActivityTypeMessageActivityType::from_int
MessageCall
Participant and end-time data for a call message.
MessageCreateEvent
pub(all) struct MessageCreateEvent {
message : Message
guild_id : Id[GuildMarker]?
guild_member : GuildMember?
mention_members : Map[Id[UserMarker], GuildMember]
channel_type : ChannelType?
} derive(Debug)A message-create dispatch with gateway-only message fields.
impl FromJson for MessageCreateEventMessageDeleteBulkEvent
pub(all) struct MessageDeleteBulkEvent {
ids : Array[Id[MessageMarker]]
channel_id : Id[ChannelMarker]
guild_id : Id[GuildMarker]?
} derive(ToJson, Debug, FromJson)A bulk message deletion.
MessageDeleteEvent
pub(all) struct MessageDeleteEvent {
id : Id[MessageMarker]
channel_id : Id[ChannelMarker]
guild_id : Id[GuildMarker]?
} derive(ToJson, Debug, FromJson)A message deletion containing only resource identifiers.
MessageFlags
Bit flags describing delivery and presentation behavior of a message.
impl BitAnd for MessageFlagsimpl BitOr for MessageFlagsimpl ToJson for MessageFlagsimpl Debug for MessageFlagsimpl FromJson for MessageFlagsMessageFlags::contains
MessageFlags::failed_to_mention_some_roles_in_thread
MessageFlags::should_show_link_not_discord_warning
MessageInteractionMetadata
pub(all) struct MessageInteractionMetadata {
id : Id[InteractionMarker]
typ : InteractionType
user : User
authorizing_integration_owners : Map[String, String]
original_response_message_id : Id[MessageMarker]?
target_user : User?
target_message_id : Id[MessageMarker]?
interacted_message_id : Id[MessageMarker]?
triggering_interaction_metadata : MessageInteractionMetadata?
} derive(ToJson, Debug, FromJson)Metadata identifying the interaction that produced a message.
The optional fields cover the documented command, component, and modal
variants. type determines which subset is present.
MessagePin
One entry returned by the paginated channel-pins endpoint.
MessagePollVoteEvent
pub(all) struct MessagePollVoteEvent {
user_id : Id[UserMarker]
channel_id : Id[ChannelMarker]
message_id : Id[MessageMarker]
guild_id : Id[GuildMarker]?
answer_id : Int
} derive(ToJson, Debug, FromJson)A user added or removed a vote from a poll answer.
MessageReactionAddEvent
pub(all) struct MessageReactionAddEvent {
user_id : Id[UserMarker]
channel_id : Id[ChannelMarker]
message_id : Id[MessageMarker]
guild_id : Id[GuildMarker]?
guild_member : GuildMember?
emoji : Emoji
message_author_id : Id[UserMarker]?
burst : Bool
burst_colors : Array[String]?
typ : Int
} derive(ToJson, Debug, FromJson)A reaction added to a message.
MessageReactionRemoveAllEvent
pub(all) struct MessageReactionRemoveAllEvent {
channel_id : Id[ChannelMarker]
message_id : Id[MessageMarker]
guild_id : Id[GuildMarker]?
} derive(ToJson, Debug, FromJson)All reactions removed from a message.
MessageReactionRemoveEmojiEvent
pub(all) struct MessageReactionRemoveEmojiEvent {
channel_id : Id[ChannelMarker]
message_id : Id[MessageMarker]
guild_id : Id[GuildMarker]?
emoji : Emoji
} derive(ToJson, Debug, FromJson)Every reaction for one emoji removed from a message.
MessageReactionRemoveEvent
pub(all) struct MessageReactionRemoveEvent {
user_id : Id[UserMarker]
channel_id : Id[ChannelMarker]
message_id : Id[MessageMarker]
guild_id : Id[GuildMarker]?
emoji : Emoji
burst : Bool
typ : Int
} derive(ToJson, Debug, FromJson)A reaction removed from a message.
MessageReference
pub(all) struct MessageReference {
typ : MessageReferenceType?
message_id : Id[MessageMarker]?
channel_id : Id[ChannelMarker]?
guild_id : Id[GuildMarker]?
fail_if_not_exists : Bool?
} derive(ToJson, Debug, FromJson)Origin identifiers and delivery behavior for a message reference.
MessageReferenceType
The reference mode used for a reply or forwarded message.
impl ToJson for MessageReferenceTypeimpl FromJson for MessageReferenceTypeMessageReferenceType::from_int
MessageReferenceType::to_int
MessageSnapshot
A forwarded message snapshot.
MessageSnapshotContent
pub(all) struct MessageSnapshotContent {
typ : MessageType?
content : String?
embeds : Array[Embed]?
attachments : Array[Attachment]?
timestamp : Timestamp?
edited_timestamp : Nullable[Timestamp]?
flags : MessageFlags?
mentions : Array[User]?
mention_roles : Array[Id[RoleMarker]]?
sticker_items : Array[StickerItem]?
components : Array[Component]?
} derive(ToJson, Debug, FromJson)The documented subset of a message retained in a forwarded snapshot.
MessageType
pub(all) enum MessageType {
Default
RecipientAdd
RecipientRemove
Call
ChannelNameChange
ChannelIconChange
ChannelPinnedMessage
UserJoin
GuildBoost
GuildBoostTier1
GuildBoostTier2
GuildBoostTier3
ChannelFollowAdd
GuildDiscoveryDisqualified
GuildDiscoveryRequalified
GuildDiscoveryGracePeriodInitialWarning
GuildDiscoveryGracePeriodFinalWarning
ThreadCreated
Reply
ChatInputCommand
ThreadStarterMessage
GuildInviteReminder
ContextMenuCommand
AutoModerationAction
RoleSubscriptionPurchase
InteractionPremiumUpsell
StageStart
StageEnd
StageSpeaker
StageRaiseHand
StageTopic
GuildApplicationPremiumSubscription
GuildIncidentAlertModeEnabled
GuildIncidentAlertModeDisabled
GuildIncidentReportRaid
GuildIncidentReportFalseAlarm
PurchaseNotification
PollResult
Unknown(Int)
} derive(Eq, Debug)The system or user event category represented by a message.
impl ToJson for MessageTypeimpl FromJson for MessageTypeMessageUpdateEvent
pub(all) struct MessageUpdateEvent {
message : Message
before : Message?
guild_id : Id[GuildMarker]?
guild_member : GuildMember?
mention_members : Map[Id[UserMarker], GuildMember]
channel_type : ChannelType?
} derive(Debug)A message-update dispatch with the same gateway-only fields as message
creation.
impl FromJson for MessageUpdateEventMessageUpdateEvent::is_edit
Whether this update changed the message's edit timestamp.
Without before, this uses the presence of an edited timestamp as a
heuristic and may misclassify pin or unfurl updates to an already-edited
message as edits.
MfaLevel
Discord's guild MFA level.
ModalData
Submitted modal data containing the modal's component tree.
Nameplate
A profile nameplate collectible.
Nonce
NsfwLevel
Discord's guild NSFW level.
Nullable
A field that is always present on the wire but may be JSON null.
Use as a struct field type: Nullable[T] for "present, maybe null",
Nullable[T]? for "maybe absent, maybe null" (composes with the derived
FromJson/ToJson optional-field handling).
test "convert nullable and PATCH values to options" {
let nickname = @model.Nullable::from_option(Some("Moon"))
debug_inspect(
nickname.to_option(),
content=(
#|Some("Moon")
),
)
let missing : @model.Undefinable[String] = Missing
let cleared : @model.Undefinable[String] = Null
assert_true(missing.to_option() is None)
assert_true(cleared.to_option() is None)
}Nullable::from_option
Value for Some, Null for None.
ObjBuilder
pub struct ObjBuilder {
// private fields
}Incremental JSON object builder for request bodies.
Field emission rules match Discord's PATCH semantics:
- field: always emitted
- opt: emitted only when Some
- und: Missing omitted, Null emitted as JSON null, Value emitted
test "build a PATCH object with omitted and cleared fields" {
let nickname : String? = None
let avatar : @model.Undefinable[String] = Null
json_inspect(
@model.ObjBuilder()
.field("name", "discord.mbt")
.opt("nickname", nickname)
.und("avatar", avatar)
.build(),
content={ "name": "discord.mbt", "avatar": null },
)
}ObjBuilder::field
Set key to value unconditionally.
ObjBuilder::opt
Set key when value is present; omit the field otherwise.
ObjBuilder::und
fn[T : ToJson] ObjBuilder::und(self : ObjBuilder, key : String, value : Undefinable[T]) -> ObjBuilderSet key from an Undefinable: a value, an explicit JSON null, or
omitted entirely when Missing.
OnboardingMode
How extensively onboarding is configured for a guild.
impl ToJson for OnboardingModeimpl FromJson for OnboardingModeOnboardingPrompt
pub(all) struct OnboardingPrompt {
id : Id[GenericMarker]
typ : OnboardingPromptType
options : Array[OnboardingPromptOption]
title : String
single_select : Bool
required : Bool
in_onboarding : Bool
} derive(ToJson, Debug, FromJson)A question presented during guild onboarding.
OnboardingPromptOption
pub(all) struct OnboardingPromptOption {
id : Id[GenericMarker]
channel_ids : Array[Id[ChannelMarker]]
role_ids : Array[Id[RoleMarker]]
emoji : Emoji?
emoji_id : Id[EmojiMarker]?
emoji_name : String?
emoji_animated : Bool?
title : String
description : Nullable[String]
} derive(ToJson, Debug, FromJson)A selectable answer to an onboarding prompt.
OnboardingPromptType
The input control used by an onboarding prompt.
impl ToJson for OnboardingPromptTypeimpl FromJson for OnboardingPromptTypeOnboardingPromptType::from_int
OnboardingPromptType::to_int
Overwrite
pub(all) struct Overwrite {
id : Id[GenericMarker]
typ : OverwriteType
allow : Permissions
deny : Permissions
} derive(ToJson, Debug, FromJson)A role or member permission override on a channel.
OverwriteType
The target category of a permission overwrite.
impl ToJson for OverwriteTypeimpl FromJson for OverwriteTypePartialChannel
pub(all) struct PartialChannel {
id : Id[ChannelMarker]
typ : ChannelType?
name : Nullable[String]?
icon : Nullable[ImageHash]?
permissions : Permissions?
} derive(ToJson, Debug, FromJson)The documented subset of a channel embedded in another Discord resource.
PartialGuild
pub(all) struct PartialGuild {
id : Id[GuildMarker]
name : String?
icon : Nullable[ImageHash]?
splash : Nullable[ImageHash]?
banner : Nullable[ImageHash]?
description : Nullable[String]?
features : Array[GuildFeature]?
verification_level : VerificationLevel?
vanity_url_code : Nullable[String]?
nsfw_level : NsfwLevel?
premium_subscription_count : Int?
locale : String?
} derive(ToJson, Debug, FromJson)The documented subset of a guild embedded in another Discord resource.
Partial guild payloads vary by endpoint, so fields other than id are
optional on receipt.
PartialRole
pub(all) struct PartialRole {
id : Id[RoleMarker]
name : String
position : Int
color : Int
colors : RoleColors?
icon : Nullable[ImageHash]?
unicode_emoji : Nullable[String]?
} derive(ToJson, Debug, FromJson)The subset of a role returned on an invite.
Permissions
Guild/channel permissions bitfield. Unknown bits are preserved.
Wire format: a decimal string (Discord serializes permissions as
strings because they exceed JavaScript's 53-bit safe-integer range).
impl BitAnd for Permissionsimpl BitOr for Permissionsimpl ToJson for Permissionsimpl Debug for Permissionsimpl FromJson for PermissionsPermissions::contains
Permissions::create_guild_expressions
Permissions::manage_guild_expressions
Permissions::send_messages_in_threads
Permissions::set_voice_channel_status
Permissions::use_application_commands
Permissions::view_creator_monetization_analytics
Poll
pub(all) struct Poll {
question : PollMedia
answers : Array[PollAnswer]
expiry : Nullable[Timestamp]
allow_multiselect : Bool
layout_type : PollLayoutType
results : PollResults?
} derive(ToJson, Debug, FromJson)A poll attached to a Discord message.
PollAnswer
A selectable answer in a poll.
PollAnswerCount
Vote count and current-user state for one poll answer.
PollAnswerVoters
Users returned by the poll answer-voters endpoint.
PollCreateRequest
pub(all) struct PollCreateRequest {
question : PollMedia
answers : Array[PollMedia]
duration : Int?
allow_multiselect : Bool?
layout_type : PollLayoutType?
} derive(Debug)Poll definition attached when creating a message or executing a webhook.
Answers carry their media directly; Discord assigns the answer ids.
duration is the number of hours the poll stays open (up to 32 days,
default 24).
impl ToJson for PollCreateRequestPollLayoutType
The presentation layout used by a poll.
impl ToJson for PollLayoutTypeimpl FromJson for PollLayoutTypePollMedia
Text and emoji content used by a poll question or answer.
PollResults
pub(all) struct PollResults {
is_finalized : Bool
answer_counts : Array[PollAnswerCount]
} derive(ToJson, Debug, FromJson)Aggregated results for a poll.
PremiumTier
PremiumType
The type of Nitro subscription on a user's account.
impl ToJson for PremiumTypeimpl FromJson for PremiumTypePresenceStatus
PresenceUpdateEvent
pub(all) struct PresenceUpdateEvent {
user : PresenceUser?
guild_id : Id[GuildMarker]?
status : PresenceStatus?
activities : Array[Activity]?
client_status : ClientStatus?
} derive(ToJson, Debug)A gateway presence update decoded field-by-field.
Discord does not validate the presence payload. A missing field or a field
whose value has the wrong type is represented as None; one bad field never
prevents the rest of the event from being delivered.
impl FromJson for PresenceUpdateEventPresenceUser
The user fragment carried by a presence update.
Discord only normally requires id, but explicitly warns that presence
fields and their types are not validated. Keeping the id optional lets a
malformed user fragment remain observable without rejecting the event.
impl FromJson for PresenceUserRadioGroup
pub(all) struct RadioGroup {
id : Int?
custom_id : String
options : Array[RadioOption]
required : Bool?
value : String?
} derive(ToJson, Debug, FromJson)A modal radio group accepting one option.
RadioOption
A selectable option shared by radio and checkbox groups.
Reaction
Aggregate reaction state for one emoji on a message.
ReactionCountDetails
Normal and burst reaction counts for a reaction.
ReactionType
Whether a reaction is a normal or a burst (super) reaction, as selected
by the type query parameter of the reaction endpoints.
impl ToJson for ReactionTypeimpl FromJson for ReactionTypeReady
pub(all) struct Ready {
v : Int
user : User
guilds : Array[UnavailableGuild]
session_id : String
resume_gateway_url : String
shard : Array[Int]?
application : ReadyApplication
} derive(ToJson, Debug, FromJson)Payload of the READY dispatch.
ReadyApplication
pub(all) struct ReadyApplication {
id : Id[ApplicationMarker]
flags : ApplicationFlags?
} derive(ToJson, Debug, FromJson)Partial application object included in READY.
ResolvedData
Entity maps resolved alongside interaction option values.
Role
pub(all) struct Role {
id : Id[RoleMarker]
name : String
color : Int
colors : RoleColors?
hoist : Bool
icon : Nullable[ImageHash]?
unicode_emoji : Nullable[String]?
position : Int
permissions : Permissions
managed : Bool
mentionable : Bool
tags : RoleTags?
flags : RoleFlags?
} derive(ToJson, Debug, FromJson)A Discord guild role and its permissions.
RoleColors
Primary and optional enhanced gradient colors of a role.
RoleFlags
Bit flags describing special behavior assigned to a role.
RoleSubscriptionData
Subscription tier data attached to a role purchase message.
RoleTags
pub(all) struct RoleTags {
bot_id : Id[UserMarker]?
premium_subscriber : Bool
integration_id : Id[IntegrationMarker]?
subscription_listing_id : Id[SkuMarker]?
available_for_purchase : Bool
guild_connections : Bool
} derive(Eq, Debug)Role ownership tags, including null-valued markers whose presence means true.
Discord represents premium_subscriber, available_for_purchase, and
guild_connections as optional fields whose only wire value is null.
Their Boolean values record whether each field was present.
Section
A section containing text components and a button or thumbnail accessory.
SelectDefaultValue
pub(all) struct SelectDefaultValue {
id : Id[GenericMarker]
typ : String
} derive(ToJson, Debug, FromJson)A preselected entity in an auto-populated select menu.
SelectMenu
pub(all) struct SelectMenu {
id : Int?
custom_id : String
placeholder : String?
min_values : Int?
max_values : Int?
disabled : Bool?
options : Array[SelectOption]?
channel_types : Array[ChannelType]?
default_values : Array[SelectDefaultValue]?
values : Array[String]?
} derive(ToJson, Debug, FromJson)A text or auto-populated select menu component.
SelectOption
A selectable option in a string select menu.
Separator
A visual separator between Components v2 content blocks.
SessionStartLimit
Identify session allowance: how many session starts remain in the current
window and how many shards may identify concurrently.
impl FromJson for SessionStartLimitTheme colors shared by an activity-card message.
Sku
A purchasable Discord application product.
SkuFlags
Bit flags describing availability and subscription scope for a SKU.
SkuType
The product category represented by a SKU.
SortOrderType
The ordering used for posts in a forum or media channel.
impl ToJson for SortOrderTypeimpl FromJson for SortOrderTypeSoundboardSound
pub(all) struct SoundboardSound {
name : String
sound_id : Id[SoundboardSoundMarker]
volume : Double
emoji_id : Nullable[Id[EmojiMarker]]
emoji_name : Nullable[String]
guild_id : Id[GuildMarker]?
available : Bool
user : User?
} derive(ToJson, Debug, FromJson)A reusable soundboard sound configured for Discord playback.
SoundboardSoundsEvent
pub(all) struct SoundboardSoundsEvent {
soundboard_sounds : Array[SoundboardSound]
guild_id : Id[GuildMarker]
} derive(ToJson, Debug, FromJson)The complete soundboard sound collection for a guild.
StageInstance
pub(all) struct StageInstance {
id : Id[StageInstanceMarker]
guild_id : Id[GuildMarker]
channel_id : Id[ChannelMarker]
topic : String
privacy_level : StagePrivacyLevel
guild_scheduled_event_id : Nullable[Id[ScheduledEventMarker]]
} derive(ToJson, Debug, FromJson)A live stage instance associated with a guild stage channel.
StagePrivacyLevel
The audience allowed to discover a stage instance.
impl ToJson for StagePrivacyLevelimpl FromJson for StagePrivacyLevelSticker
pub(all) struct Sticker {
id : Id[StickerMarker]
pack_id : Id[StickerPackMarker]?
name : String
description : Nullable[String]
tags : String
asset : String?
typ : StickerType
format_type : StickerFormatType
available : Bool?
guild_id : Id[GuildMarker]?
user : User?
sort_value : Int?
} derive(ToJson, Debug, FromJson)A Discord standard or guild sticker.
StickerFormatType
The media format used by a sticker asset.
impl ToJson for StickerFormatTypeimpl FromJson for StickerFormatTypeStickerItem
pub(all) struct StickerItem {
id : Id[StickerMarker]
name : String
format_type : StickerFormatType
} derive(ToJson, Debug, FromJson)The compact sticker representation included in messages.
StickerPack
pub(all) struct StickerPack {
id : Id[StickerPackMarker]
stickers : Array[Sticker]
name : String
sku_id : Id[SkuMarker]
cover_sticker_id : Id[StickerMarker]?
description : String
banner_asset_id : Id[GenericMarker]?
} derive(ToJson, Debug, FromJson)A purchasable collection of standard stickers.
StickerPacksResponse
pub(all) struct StickerPacksResponse {
sticker_packs : Array[StickerPack]
} derive(ToJson, Debug, FromJson)The envelope returned by the sticker-packs listing endpoint.
StickerType
Subscription
pub(all) struct Subscription {
id : Id[GenericMarker]
user_id : Id[UserMarker]
sku_ids : Array[Id[SkuMarker]]
entitlement_ids : Array[Id[EntitlementMarker]]
renewal_sku_ids : Nullable[Array[Id[SkuMarker]]]
current_period_start : Timestamp
current_period_end : Timestamp
status : SubscriptionStatus
canceled_at : Nullable[Timestamp]
country : String?
} derive(ToJson, Debug, FromJson)A user's recurring subscription to one or more application SKUs.
SubscriptionStatus
The renewal state of a Discord application subscription.
impl ToJson for SubscriptionStatusimpl FromJson for SubscriptionStatusSubscriptionStatus::from_int
SystemChannelFlags
Bit flags controlling messages sent to a guild system channel.
impl BitAnd for SystemChannelFlagsimpl BitOr for SystemChannelFlagsimpl ToJson for SystemChannelFlagsimpl Debug for SystemChannelFlagsimpl FromJson for SystemChannelFlagsSystemChannelFlags::contains
SystemChannelFlags::from_bits
SystemChannelFlags::suppress_guild_reminder_notifications
SystemChannelFlags::suppress_join_notification_replies
SystemChannelFlags::suppress_join_notifications
SystemChannelFlags::suppress_role_subscription_purchase_notification_replies
fn SystemChannelFlags::suppress_role_subscription_purchase_notification_replies() -> SystemChannelFlagsSystemChannelFlags::suppress_role_subscription_purchase_notifications
TargetUsersJobStatus
Progress and outcome of an invite target-user CSV update.
TargetUsersJobStatusCode
State of an invite target-user CSV update job.
impl ToJson for TargetUsersJobStatusCodeimpl FromJson for TargetUsersJobStatusCodeTargetUsersJobStatusCode::from_int
TargetUsersJobStatusCode::to_int
Team
pub(all) struct Team {
icon : Nullable[ImageHash]
id : Id[TeamMarker]
members : Array[TeamMember]
name : String
owner_user_id : Id[UserMarker]
} derive(ToJson, Debug, FromJson)A Discord developer team and its members.
TeamMember
pub(all) struct TeamMember {
membership_state : TeamMembershipState
team_id : Id[TeamMarker]
user : User
role : String?
} derive(ToJson, Debug, FromJson)A user's membership record within a developer team.
TeamMembershipState
A user's invitation state within a developer team.
impl ToJson for TeamMembershipStateimpl FromJson for TeamMembershipStateTeamMembershipState::from_int
TextDisplay
A markdown text block displayed in a Components v2 layout.
TextInput
pub(all) struct TextInput {
id : Int?
custom_id : String
style : TextInputStyle?
label : String?
min_length : Int?
max_length : Int?
required : Bool?
value : String?
placeholder : String?
} derive(ToJson, Debug, FromJson)A free-form text input component used in a modal.
TextInputStyle
The single-line or multi-line style of a text input.
impl ToJson for TextInputStyleimpl FromJson for TextInputStyleThreadAutoArchiveDuration
The inactivity duration in minutes before a thread is archived.
impl ToJson for ThreadAutoArchiveDurationimpl FromJson for ThreadAutoArchiveDurationThreadAutoArchiveDuration::from_int
ThreadAutoArchiveDuration::to_int
ThreadCreateEvent
A thread channel delivered with THREAD_CREATE-only metadata.
impl FromJson for ThreadCreateEventThreadDeleteEvent
pub(all) struct ThreadDeleteEvent {
id : Id[ChannelMarker]
guild_id : Id[GuildMarker]
parent_id : Id[ChannelMarker]
typ : ChannelType
} derive(ToJson, Debug, FromJson)A deleted thread's identifying fields.
ThreadListSyncEvent
pub(all) struct ThreadListSyncEvent {
guild_id : Id[GuildMarker]
channel_ids : Array[Id[ChannelMarker]]?
threads : Array[Channel]
members : Array[ThreadMember]
} derive(ToJson, Debug, FromJson)Threads and memberships synchronized for a guild.
ThreadMember
pub(all) struct ThreadMember {
id : Id[ChannelMarker]?
user_id : Id[UserMarker]?
join_timestamp : Timestamp
flags : Int
guild_member : GuildMember?
} derive(ToJson, Debug, FromJson)A user's membership state in a thread.
ThreadMemberUpdateEvent
pub(all) struct ThreadMemberUpdateEvent {
guild_id : Id[GuildMarker]
thread_member : ThreadMember
} derive(Debug)The current user's thread membership decoded from a flattened object.
impl FromJson for ThreadMemberUpdateEventThreadMembersUpdateEvent
pub(all) struct ThreadMembersUpdateEvent {
id : Id[ChannelMarker]
guild_id : Id[GuildMarker]
member_count : Int
added_members : Array[ThreadMember]?
removed_member_ids : Array[Id[UserMarker]]?
} derive(ToJson, Debug, FromJson)Membership changes for a thread.
ThreadMetadata
Metadata controlling a thread's archive and lock state.
Thumbnail
pub(all) struct Thumbnail {
id : Int?
media : UnfurledMediaItem
description : String?
spoiler : Bool?
} derive(ToJson, Debug, FromJson)A thumbnail accessory rendered from an unfurled media item.
Timestamp
An ISO 8601 timestamp, kept as the raw string for lossless round-tripping.
Discord sends e.g. 2021-03-11T18:15:37.907000+00:00.
Timestamp::unix_ms
Parse the timestamp into milliseconds since the Unix epoch.
Supports the shapes Discord emits: YYYY-MM-DDTHH:MM:SS[.f...](Z|±HH:MM).
test "parse a Discord timestamp without losing its source text" {
let timestamp = @model.Timestamp("2021-03-11T18:15:37.907000+00:00")
inspect(timestamp.to_string(), content="2021-03-11T18:15:37.907000+00:00")
inspect(timestamp.unix_ms(), content="1615486537907")
}TriggerMetadata
Optional condition settings used by auto-moderation triggers.
TypingStartEvent
pub(all) struct TypingStartEvent {
channel_id : Id[ChannelMarker]
guild_id : Id[GuildMarker]?
user_id : Id[UserMarker]
timestamp : Int64
guild_member : GuildMember?
} derive(ToJson, Debug)A user began typing in a channel.
impl FromJson for TypingStartEventpub(all) struct UnavailableGuild {
id : Id[GuildMarker]
unavailable : Bool
} derive(ToJson, Debug, FromJson)A guild that is temporarily unavailable to the client.
Undefinable
Tri-state value for PATCH-style requests: leave a field untouched
(Missing, omitted from the payload), clear it (Null, an explicit JSON
null), or set it (Value).
This is an input type for request builders (see ObjBuilder::und); it is
not meant to appear in received models. Decoding never produces Missing.
impl ToJson for Undefinable[T]impl FromJson for Undefinable[T]Undefinable::to_option
Some for a value; None for both JSON null and an absent field.
UnfurledMediaItem
Media metadata used by thumbnail, gallery, and file components.
User
pub(all) struct User {
id : Id[UserMarker]
username : String
discriminator : String
global_name : Nullable[String]?
avatar : Nullable[ImageHash]
bot : Bool?
system : Bool?
mfa_enabled : Bool?
banner : Nullable[ImageHash]?
accent_color : Nullable[Int]?
locale : String?
verified : Bool?
email : Nullable[String]?
flags : UserFlags?
premium_type : PremiumType?
public_flags : UserFlags?
avatar_decoration : Nullable[ImageHash]?
avatar_decoration_data : Nullable[AvatarDecorationData]?
collectibles : Nullable[Collectibles]?
primary_guild : Nullable[UserPrimaryGuild]?
} derive(ToJson, Debug, FromJson)A Discord user account returned by the API.
UserFlags
Bit flags describing badges and account properties assigned to a user.
UserPrimaryGuild
The primary-guild identity displayed on a user's profile.
VerificationLevel
Discord's guild verification level.
impl ToJson for VerificationLevelimpl FromJson for VerificationLevelVideoQualityMode
The camera quality mode used by a voice channel.
impl ToJson for VideoQualityModeimpl FromJson for VideoQualityModeVoiceChannelEffectSendEvent
pub(all) struct VoiceChannelEffectSendEvent {
channel_id : Id[ChannelMarker]
guild_id : Id[GuildMarker]
user_id : Id[UserMarker]
emoji : Nullable[Emoji]?
animation_type : Nullable[Int]?
animation_id : Int?
sound_id : Json?
sound_volume : Double?
} derive(ToJson, Debug, FromJson)A visual or soundboard effect sent in a voice channel.
VoiceChannelStartTimeUpdateEvent
pub(all) struct VoiceChannelStartTimeUpdateEvent {
id : Id[ChannelMarker]
guild_id : Id[GuildMarker]
voice_start_time : Nullable[Int64]?
} derive(ToJson, Debug, FromJson)A voice channel's session start time changed.
VoiceChannelStatusUpdateEvent
pub(all) struct VoiceChannelStatusUpdateEvent {
id : Id[ChannelMarker]
guild_id : Id[GuildMarker]
status : Nullable[String]
} derive(ToJson, Debug, FromJson)A voice channel's text status changed.
VoiceRegion
A voice server region available to Discord clients.
VoiceServerUpdateEvent
Voice server connection information for a guild.
VoiceState
pub(all) struct VoiceState {
guild_id : Id[GuildMarker]?
channel_id : Nullable[Id[ChannelMarker]]
user_id : Id[UserMarker]
guild_member : GuildMember?
session_id : String
deaf : Bool
mute : Bool
self_deaf : Bool
self_mute : Bool
self_stream : Bool?
self_video : Bool?
suppress : Bool
request_to_speak_timestamp : Nullable[Timestamp]
} derive(ToJson, Debug, FromJson)A user's connection state in a Discord voice channel.
Webhook
pub(all) struct Webhook {
id : Id[WebhookMarker]
typ : WebhookType
guild_id : Nullable[Id[GuildMarker]]?
channel_id : Nullable[Id[ChannelMarker]]
user : User?
name : Nullable[String]
avatar : Nullable[ImageHash]
token : String?
application_id : Nullable[Id[ApplicationMarker]]
source_guild : PartialGuild?
source_channel : PartialChannel?
url : String?
} derive(ToJson, Debug, FromJson)A Discord webhook and its execution metadata.
WebhookEvent
pub(all) enum WebhookEvent {
ApplicationAuthorized(ApplicationAuthorizedEvent)
ApplicationDeauthorized(ApplicationDeauthorizedEvent)
EntitlementCreate(Entitlement)
EntitlementUpdate(Entitlement)
EntitlementDelete(Entitlement)
LobbyMessageCreate(LobbyMessage)
LobbyMessageUpdate(LobbyMessage)
LobbyMessageDelete(LobbyMessageDeleteEvent)
GameDirectMessageCreate(GameDirectMessage)
GameDirectMessageUpdate(GameDirectMessage)
GameDirectMessageDelete(GameDirectMessage)
QuestUserEnrollment
Unknown(typ~ : String, data~ : Json?)
} derive(Debug)A webhook event projected into its documented payload shape.
Known event names always use a typed variant. Unknown names retain their
original name and optional data for forward compatibility.
WebhookEventBody
The timestamped body nested inside an event webhook payload.
WebhookEventBody::project
Decode the event-specific data carried by this body.
Unknown event names never raise. A known event raises when its data does
not match the documented wire shape.
WebhookEventPayload
pub(all) struct WebhookEventPayload {
version : Int
application_id : Id[ApplicationMarker]
typ : WebhookPayloadType
event : WebhookEventBody?
} derive(ToJson, Debug, FromJson)An outbound HTTP webhook event payload sent by Discord.
WebhookEventType
pub(all) enum WebhookEventType {
ApplicationAuthorized
ApplicationDeauthorized
EntitlementCreate
EntitlementUpdate
EntitlementDelete
LobbyMessageCreate
LobbyMessageUpdate
LobbyMessageDelete
GameDirectMessageCreate
GameDirectMessageUpdate
GameDirectMessageDelete
QuestUserEnrollment
Unknown(String)
} derive(Eq, Debug)A subscribable outbound webhook event category.
impl ToJson for WebhookEventTypeimpl FromJson for WebhookEventTypeWebhookEventType::from_string
WebhookPayloadType
The outer category of an outbound Discord webhook payload.
impl ToJson for WebhookPayloadTypeimpl FromJson for WebhookPayloadTypeWebhookPayloadType::from_int
WebhookType
WebhooksUpdateEvent
pub(all) struct WebhooksUpdateEvent {
guild_id : Id[GuildMarker]
channel_id : Id[ChannelMarker]
} derive(ToJson, Debug, FromJson)Webhook configuration changed in a guild channel.
WelcomeScreen
The welcome screen shown to new members of a community guild.
WelcomeScreenChannel
pub(all) struct WelcomeScreenChannel {
channel_id : Id[ChannelMarker]
description : String
emoji_id : Nullable[Id[EmojiMarker]]
emoji_name : Nullable[String]
} derive(ToJson, Debug, FromJson)A channel suggested on a guild welcome screen.
dispatch_event
Decode a dispatch payload by event name.
Unknown names never raise. A known event raises only when its payload does
not match the modeled wire shape; the gateway converts that failure into an
unknown event so shard processing remains lenient.
flatten
Collapse an optional nullable field to a plain option: None for both an
absent key and JSON null, Some(v) for a present value.
This is a lossy view. Do not use it when the distinction between a missing
key and JSON null matters, such as when building PATCH bodies or merging
cache updates.
test "flatten optional nullable fields" {
let absent : @model.Nullable[String]? = None
let null_value : @model.Nullable[String]? = Some(Null)
let present : @model.Nullable[String]? = Some(Value("Moon"))
debug_inspect(
[
@model.flatten(absent),
@model.flatten(null_value),
@model.flatten(present),
],
content=(
#|[None, None, Some("Moon")]
),
)
}requires_components_v2
Whether any top-level component requires Discord's Components V2 message
flag.
test "detect top-level Components V2 layouts" {
let row : @model.Component = ActionRow({ id: None, components: [], })
let container : @model.Component = Container({
id: None,
components: [],
accent_color: None,
spoiler: None,
})
assert_false(@model.requires_components_v2([row]))
assert_true(@model.requires_components_v2([row, container]))
}Source Files
- activity_instance.mbt
- allowed_mentions.mbt
- application.mbt
- attachment.mbt
- audit_log.mbt
- auto_moderation.mbt
- channel.mbt
- channel_type.mbt
- command.mbt
- command_permissions.mbt
- component.mbt
- embed.mbt
- emoji.mbt
- event.mbt
- event_intents.mbt
- event_payloads.mbt
- gateway_info.mbt
- gateway_payloads.mbt
- gateway_presence.mbt
- guild.mbt
- guild_create.mbt
- guild_management.mbt
- guild_widget.mbt
- id.mbt
- id_aliases.mbt
- integration.mbt
- integration_context.mbt
- intents.mbt
- interaction.mbt
- invite.mbt
- markers.mbt
- member.mbt
- message.mbt
- message_event.mbt
- monetization.mbt
- oauth2.mbt
- obj_builder.mbt
- onboarding.mbt
- partial.mbt
- permissions.mbt
- poll.mbt
- role.mbt
- role_connection_metadata.mbt
- scheduled_event.mbt
- soundboard.mbt
- stage.mbt
- sticker.mbt
- team.mbt
- template.mbt
- timestamp.mbt
- undefinable.mbt
- user.mbt
- voice.mbt
- webhook.mbt
- webhook_event.mbt
Install
Download zipAn experimental Discord library for MoonBit: typed APIs, a native gateway with voice (DAVE E2EE), and JS/serverless HTTP interactions.
discordbotgatewayapivoiceinteractions
0.1.0
Apache-2.0
Updated 16 hours ago
2 downloadsDependencies
- moonbitlang/async0.21.2
- hustcer/ed255190.6.0
- gaato/dave0.1.0