Zum Inhalt

bostie.events

Die Event-Liste gruppiert diese Klassen nach Thema, zusammen mit ihren Intents.

bostie.events

Event

Bases: Struct

Base of the typed gateway events.

INTENTS are the intents Discord needs to send the event; the bot warns when a privileged one is missing.

NAME class-attribute

NAME: str

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

Ready

Bases: Event

A shard started a session; its guilds then arrive as GuildCreate events.

NAME class-attribute instance-attribute

NAME = 'READY'

v instance-attribute

v: int

user instance-attribute

guilds instance-attribute

guilds: tuple[UnavailableGuild, ...]

application instance-attribute

application: PartialApplication

session_id instance-attribute

session_id: str

resume_gateway_url instance-attribute

resume_gateway_url: str

shard class-attribute instance-attribute

shard: tuple[int, int] | None = None

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

Resumed

Bases: Event

NAME class-attribute instance-attribute

NAME = 'RESUMED'

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

GuildCreate

Bases: Event

A guild the bot joined, or one available again; its children lack guild_id.

NAME class-attribute instance-attribute

NAME = 'GUILD_CREATE'

INTENTS class-attribute instance-attribute

INTENTS = Intents.GUILDS

guild instance-attribute

joined class-attribute instance-attribute

joined: bool = False

channels class-attribute instance-attribute

channels: tuple[Channel, ...] = ()

threads class-attribute instance-attribute

threads: tuple[Channel, ...] = ()

voice_states class-attribute instance-attribute

voice_states: tuple[VoiceState, ...] = ()

stage_instances class-attribute instance-attribute

stage_instances: tuple[StageInstance, ...] = ()

guild_scheduled_events class-attribute instance-attribute

guild_scheduled_events: tuple[ScheduledEvent, ...] = ()

soundboard_sounds class-attribute instance-attribute

soundboard_sounds: tuple[SoundboardSound, ...] = ()

members property

members: tuple[Member, ...]

presences property

presences: tuple[Presence, ...]

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

GuildUpdate

Bases: Event

A guild changed; old is the cached guild before the change.

NAME class-attribute instance-attribute

NAME = 'GUILD_UPDATE'

INTENTS class-attribute instance-attribute

INTENTS = Intents.GUILDS

guild instance-attribute

guild: Guild

old class-attribute instance-attribute

old: Guild | None = None

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

GuildDelete

Bases: Event

The bot left a guild, or it went unavailable; guild is the cached one.

NAME class-attribute instance-attribute

NAME = 'GUILD_DELETE'

INTENTS class-attribute instance-attribute

INTENTS = Intents.GUILDS

guild_id class-attribute instance-attribute

guild_id: int = msgspec.field(name='id')

unavailable class-attribute instance-attribute

unavailable: bool = False

guild class-attribute instance-attribute

guild: Guild | None = None

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

ChannelCreate

Bases: _ChannelEvent

NAME class-attribute instance-attribute

NAME = 'CHANNEL_CREATE'

INTENTS class-attribute instance-attribute

INTENTS = Intents.GUILDS

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

channel instance-attribute

channel: Channel

ChannelUpdate

Bases: _ChannelEvent

A channel changed; old is the cached channel before the change.

NAME class-attribute instance-attribute

NAME = 'CHANNEL_UPDATE'

old class-attribute instance-attribute

old: Channel | None = None

INTENTS class-attribute instance-attribute

INTENTS = Intents.GUILDS

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

channel instance-attribute

channel: Channel

ChannelDelete

Bases: _ChannelEvent

NAME class-attribute instance-attribute

NAME = 'CHANNEL_DELETE'

INTENTS class-attribute instance-attribute

INTENTS = Intents.GUILDS

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

channel instance-attribute

channel: Channel

ChannelPinsUpdate

Bases: Event

A message was pinned or unpinned; not sent when a pinned message is deleted.

NAME class-attribute instance-attribute

NAME = 'CHANNEL_PINS_UPDATE'

INTENTS class-attribute instance-attribute

guild_id class-attribute instance-attribute

guild_id: int | None = None

channel_id instance-attribute

channel_id: int

last_pin_timestamp class-attribute instance-attribute

last_pin_timestamp: datetime | None = None

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

ThreadCreate

Bases: _ChannelEvent

A thread was created or the bot was added to one, then member is the bot's.

NAME class-attribute instance-attribute

NAME = 'THREAD_CREATE'

newly_created class-attribute instance-attribute

newly_created: bool = False

member class-attribute instance-attribute

member: ThreadMember | None = None

INTENTS class-attribute instance-attribute

INTENTS = Intents.GUILDS

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

channel instance-attribute

channel: Channel

ThreadUpdate

Bases: _ChannelEvent

A thread changed; old is the cached thread before the change.

NAME class-attribute instance-attribute

NAME = 'THREAD_UPDATE'

old class-attribute instance-attribute

old: Channel | None = None

INTENTS class-attribute instance-attribute

INTENTS = Intents.GUILDS

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

channel instance-attribute

channel: Channel

ThreadDelete

Bases: Event, Snowflake

A thread was deleted; thread is the cached one.

NAME class-attribute instance-attribute

NAME = 'THREAD_DELETE'

INTENTS class-attribute instance-attribute

INTENTS = Intents.GUILDS

id instance-attribute

id: int

guild_id instance-attribute

guild_id: int

parent_id instance-attribute

parent_id: int | None

type instance-attribute

thread class-attribute instance-attribute

thread: Channel | None = None

created_at property

created_at: datetime

When the object was created, in UTC, read from its id.

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

ThreadListSync

Bases: Event

The active threads of some channels, or of the guild if channel_ids is None.

NAME class-attribute instance-attribute

NAME = 'THREAD_LIST_SYNC'

INTENTS class-attribute instance-attribute

INTENTS = Intents.GUILDS

guild_id instance-attribute

guild_id: int

channel_ids class-attribute instance-attribute

channel_ids: tuple[int, ...] | None = None

threads instance-attribute

threads: tuple[Channel, ...]

members instance-attribute

members: tuple[ThreadMember, ...]

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

RoleCreate

Bases: _RoleEvent

NAME class-attribute instance-attribute

NAME = 'GUILD_ROLE_CREATE'

INTENTS class-attribute instance-attribute

INTENTS = Intents.GUILDS

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

guild_id instance-attribute

guild_id: int

role instance-attribute

role: Role

RoleUpdate

Bases: _RoleEvent

A role changed; old is the cached role before the change.

NAME class-attribute instance-attribute

NAME = 'GUILD_ROLE_UPDATE'

old class-attribute instance-attribute

old: Role | None = None

INTENTS class-attribute instance-attribute

INTENTS = Intents.GUILDS

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

guild_id instance-attribute

guild_id: int

role instance-attribute

role: Role

RoleDelete

Bases: Event

A role was deleted; role is the cached one.

NAME class-attribute instance-attribute

NAME = 'GUILD_ROLE_DELETE'

INTENTS class-attribute instance-attribute

INTENTS = Intents.GUILDS

guild_id instance-attribute

guild_id: int

role_id instance-attribute

role_id: int

role class-attribute instance-attribute

role: Role | None = None

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

MessageCreate

Bases: _MessageEvent

NAME class-attribute instance-attribute

NAME = 'MESSAGE_CREATE'

INTENTS class-attribute instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

message instance-attribute

MessageUpdate

Bases: _MessageEvent

A message was edited; old is the copy Bot(max_messages=...) cached, if any.

NAME class-attribute instance-attribute

NAME = 'MESSAGE_UPDATE'

old class-attribute instance-attribute

old: Message | WebhookMessage | None = None

INTENTS class-attribute instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

message instance-attribute

MessageDelete

Bases: Event, Snowflake

A message was deleted; message is the cached one if any.

NAME class-attribute instance-attribute

NAME = 'MESSAGE_DELETE'

INTENTS class-attribute instance-attribute

id instance-attribute

id: int

channel_id instance-attribute

channel_id: int

guild_id class-attribute instance-attribute

guild_id: int | None = None

message class-attribute instance-attribute

message: Message | WebhookMessage | None = None

created_at property

created_at: datetime

When the object was created, in UTC, read from its id.

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

MessageDeleteBulk

Bases: Event

Messages were deleted; messages are those the message cache held.

NAME class-attribute instance-attribute

NAME = 'MESSAGE_DELETE_BULK'

INTENTS class-attribute instance-attribute

ids instance-attribute

ids: tuple[int, ...]

channel_id instance-attribute

channel_id: int

guild_id class-attribute instance-attribute

guild_id: int | None = None

messages class-attribute instance-attribute

messages: tuple[Message | WebhookMessage, ...] = ()

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

ReactionAdd

Bases: _ReactionEvent

NAME class-attribute instance-attribute

NAME = 'MESSAGE_REACTION_ADD'

member class-attribute instance-attribute

member: Member | None = None

message_author_id class-attribute instance-attribute

message_author_id: int | None = None

burst_colors class-attribute instance-attribute

burst_colors: tuple[str, ...] = ()

INTENTS class-attribute instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

user_id instance-attribute

user_id: int

channel_id instance-attribute

channel_id: int

message_id instance-attribute

message_id: int

guild_id class-attribute instance-attribute

guild_id: int | None = None

emoji instance-attribute

emoji: PartialEmoji

burst instance-attribute

burst: bool

type instance-attribute

ReactionRemove

Bases: _ReactionEvent

NAME class-attribute instance-attribute

NAME = 'MESSAGE_REACTION_REMOVE'

INTENTS class-attribute instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

user_id instance-attribute

user_id: int

channel_id instance-attribute

channel_id: int

message_id instance-attribute

message_id: int

guild_id class-attribute instance-attribute

guild_id: int | None = None

emoji instance-attribute

emoji: PartialEmoji

burst instance-attribute

burst: bool

type instance-attribute

ReactionRemoveAll

Bases: Event

NAME class-attribute instance-attribute

NAME = 'MESSAGE_REACTION_REMOVE_ALL'

INTENTS class-attribute instance-attribute

channel_id instance-attribute

channel_id: int

message_id instance-attribute

message_id: int

guild_id class-attribute instance-attribute

guild_id: int | None = None

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

ReactionRemoveEmoji

Bases: Event

NAME class-attribute instance-attribute

NAME = 'MESSAGE_REACTION_REMOVE_EMOJI'

INTENTS class-attribute instance-attribute

channel_id instance-attribute

channel_id: int

guild_id class-attribute instance-attribute

guild_id: int | None = None

message_id instance-attribute

message_id: int

emoji instance-attribute

emoji: PartialEmoji

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

PollVoteAdd

Bases: _PollVoteEvent

NAME class-attribute instance-attribute

NAME = 'MESSAGE_POLL_VOTE_ADD'

INTENTS class-attribute instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

user_id instance-attribute

user_id: int

channel_id instance-attribute

channel_id: int

message_id instance-attribute

message_id: int

guild_id class-attribute instance-attribute

guild_id: int | None = None

answer_id instance-attribute

answer_id: int

PollVoteRemove

Bases: _PollVoteEvent

NAME class-attribute instance-attribute

NAME = 'MESSAGE_POLL_VOTE_REMOVE'

INTENTS class-attribute instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

user_id instance-attribute

user_id: int

channel_id instance-attribute

channel_id: int

message_id instance-attribute

message_id: int

guild_id class-attribute instance-attribute

guild_id: int | None = None

answer_id instance-attribute

answer_id: int

TypingStart

Bases: Event

A user started typing; member and guild_id are None in DMs.

NAME class-attribute instance-attribute

NAME = 'TYPING_START'

INTENTS class-attribute instance-attribute

channel_id instance-attribute

channel_id: int

guild_id class-attribute instance-attribute

guild_id: int | None = None

user_id instance-attribute

user_id: int

timestamp instance-attribute

timestamp: datetime

member class-attribute instance-attribute

member: Member | None = None

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

MemberJoin

Bases: Event

NAME class-attribute instance-attribute

NAME = 'GUILD_MEMBER_ADD'

INTENTS class-attribute instance-attribute

guild_id instance-attribute

guild_id: int

member instance-attribute

member: Member

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

MemberUpdate

Bases: Event

A member changed; old is the cached member before the change.

Without GUILD_MEMBERS only the bot's own updates arrive.

NAME class-attribute instance-attribute

NAME = 'GUILD_MEMBER_UPDATE'

INTENTS class-attribute instance-attribute

guild_id instance-attribute

guild_id: int

roles instance-attribute

roles: tuple[int, ...]

user instance-attribute

user: User

nick class-attribute instance-attribute

nick: str | None = None

avatar instance-attribute

avatar: str | None

banner instance-attribute

banner: str | None

joined_at instance-attribute

joined_at: datetime | None

premium_since class-attribute instance-attribute

premium_since: datetime | None = None

deaf class-attribute instance-attribute

deaf: bool | None = None

mute class-attribute instance-attribute

mute: bool | None = None

pending class-attribute instance-attribute

pending: bool = False

communication_disabled_until class-attribute instance-attribute

communication_disabled_until: datetime | None = None

unusual_dm_activity_until class-attribute instance-attribute

unusual_dm_activity_until: datetime | None = None

flags class-attribute instance-attribute

avatar_decoration_data class-attribute instance-attribute

avatar_decoration_data: AvatarDecorationData | None = None

collectibles class-attribute instance-attribute

collectibles: Collectibles | None = None

old class-attribute instance-attribute

old: Member | None = None

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

MemberRemove

Bases: Event

A member left or was removed; member is the cached one.

NAME class-attribute instance-attribute

NAME = 'GUILD_MEMBER_REMOVE'

INTENTS class-attribute instance-attribute

guild_id instance-attribute

guild_id: int

user instance-attribute

user: User

member class-attribute instance-attribute

member: Member | None = None

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

InteractionCreate

Bases: Event

NAME class-attribute instance-attribute

NAME = 'INTERACTION_CREATE'

interaction instance-attribute

interaction: Interaction

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

VoiceStateUpdate

Bases: Event

A user joined, left or changed voice; old is their cached voice state.

NAME class-attribute instance-attribute

NAME = 'VOICE_STATE_UPDATE'

INTENTS class-attribute instance-attribute

voice_state instance-attribute

voice_state: VoiceState

old class-attribute instance-attribute

old: VoiceState | None = None

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

VoiceChannelEffectSend

Bases: Event

Someone sent an emoji reaction or a soundboard sound in the bot's channel.

NAME class-attribute instance-attribute

NAME = 'VOICE_CHANNEL_EFFECT_SEND'

INTENTS class-attribute instance-attribute

channel_id instance-attribute

channel_id: int

guild_id instance-attribute

guild_id: int

user_id instance-attribute

user_id: int

emoji class-attribute instance-attribute

emoji: Emoji | None = None

animation_type class-attribute instance-attribute

animation_type: AnimationType | None = None

animation_id class-attribute instance-attribute

animation_id: int | None = None

sound_id class-attribute instance-attribute

sound_id: int | None = None

sound_volume class-attribute instance-attribute

sound_volume: float | None = None

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

VoiceChannelStatusUpdate

Bases: Event, Snowflake

NAME class-attribute instance-attribute

NAME = 'VOICE_CHANNEL_STATUS_UPDATE'

INTENTS class-attribute instance-attribute

INTENTS = Intents.GUILDS

id instance-attribute

id: int

guild_id instance-attribute

guild_id: int

status instance-attribute

status: str | None

created_at property

created_at: datetime

When the object was created, in UTC, read from its id.

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

VoiceChannelStartTimeUpdate

Bases: Event, Snowflake

NAME class-attribute instance-attribute

NAME = 'VOICE_CHANNEL_START_TIME_UPDATE'

INTENTS class-attribute instance-attribute

INTENTS = Intents.GUILDS

id instance-attribute

id: int

guild_id instance-attribute

guild_id: int

voice_start_time class-attribute instance-attribute

voice_start_time: datetime | None = None

created_at property

created_at: datetime

When the object was created, in UTC, read from its id.

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

ChannelInfo

Bases: Event

The voice data of a guild's channels, sent for a Request Channel Info.

NAME class-attribute instance-attribute

NAME = 'CHANNEL_INFO'

guild_id instance-attribute

guild_id: int

channels instance-attribute

channels: tuple[VoiceChannelInfo, ...]

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

VoiceServerUpdate

Bases: Event

NAME class-attribute instance-attribute

NAME = 'VOICE_SERVER_UPDATE'

token instance-attribute

token: str

guild_id instance-attribute

guild_id: int

endpoint instance-attribute

endpoint: str | None

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

AutoModerationRuleCreate

Bases: _AutoModerationRuleEvent

NAME class-attribute instance-attribute

NAME = 'AUTO_MODERATION_RULE_CREATE'

INTENTS class-attribute instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

rule instance-attribute

AutoModerationRuleUpdate

Bases: _AutoModerationRuleEvent

NAME class-attribute instance-attribute

NAME = 'AUTO_MODERATION_RULE_UPDATE'

INTENTS class-attribute instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

rule instance-attribute

AutoModerationRuleDelete

Bases: _AutoModerationRuleEvent

NAME class-attribute instance-attribute

NAME = 'AUTO_MODERATION_RULE_DELETE'

INTENTS class-attribute instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

rule instance-attribute

AutoModerationActionExecution

Bases: Event

A rule acted on a user's content; content needs the MESSAGE_CONTENT intent.

NAME class-attribute instance-attribute

NAME = 'AUTO_MODERATION_ACTION_EXECUTION'

INTENTS class-attribute instance-attribute

guild_id instance-attribute

guild_id: int

action instance-attribute

rule_id instance-attribute

rule_id: int

rule_trigger_type instance-attribute

rule_trigger_type: AutoModerationTriggerType

user_id instance-attribute

user_id: int

channel_id class-attribute instance-attribute

channel_id: int | None = None

message_id class-attribute instance-attribute

message_id: int | None = None

alert_system_message_id class-attribute instance-attribute

alert_system_message_id: int | None = None

content instance-attribute

content: str

matched_keyword instance-attribute

matched_keyword: str | None

matched_content instance-attribute

matched_content: str | None

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

AuditLogEntryCreate

Bases: Event

NAME class-attribute instance-attribute

NAME = 'GUILD_AUDIT_LOG_ENTRY_CREATE'

INTENTS class-attribute instance-attribute

guild_id instance-attribute

guild_id: int

entry instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

BanAdd

Bases: _BanEvent

NAME class-attribute instance-attribute

NAME = 'GUILD_BAN_ADD'

INTENTS class-attribute instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

guild_id instance-attribute

guild_id: int

user instance-attribute

user: User

BanRemove

Bases: _BanEvent

NAME class-attribute instance-attribute

NAME = 'GUILD_BAN_REMOVE'

INTENTS class-attribute instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

guild_id instance-attribute

guild_id: int

user instance-attribute

user: User

EmojisUpdate

Bases: Event

A guild's emojis changed; old are those of the cached guild.

NAME class-attribute instance-attribute

NAME = 'GUILD_EMOJIS_UPDATE'

INTENTS class-attribute instance-attribute

guild_id instance-attribute

guild_id: int

emojis instance-attribute

emojis: tuple[Emoji, ...]

old class-attribute instance-attribute

old: tuple[Emoji, ...] | None = None

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

StickersUpdate

Bases: Event

A guild's stickers changed; old are those of the cached guild.

NAME class-attribute instance-attribute

NAME = 'GUILD_STICKERS_UPDATE'

INTENTS class-attribute instance-attribute

guild_id instance-attribute

guild_id: int

stickers instance-attribute

stickers: tuple[Sticker, ...]

old class-attribute instance-attribute

old: tuple[Sticker, ...] | None = None

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

SoundboardSoundCreate

Bases: _SoundboardSoundEvent

NAME class-attribute instance-attribute

NAME = 'GUILD_SOUNDBOARD_SOUND_CREATE'

INTENTS class-attribute instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

sound instance-attribute

SoundboardSoundUpdate

Bases: _SoundboardSoundEvent

A soundboard sound changed; old is the cached sound before the change.

NAME class-attribute instance-attribute

NAME = 'GUILD_SOUNDBOARD_SOUND_UPDATE'

old class-attribute instance-attribute

old: SoundboardSound | None = None

INTENTS class-attribute instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

sound instance-attribute

SoundboardSoundDelete

Bases: Event

A soundboard sound was deleted; sound is the cached one.

NAME class-attribute instance-attribute

NAME = 'GUILD_SOUNDBOARD_SOUND_DELETE'

INTENTS class-attribute instance-attribute

sound_id instance-attribute

sound_id: int

guild_id instance-attribute

guild_id: int

sound class-attribute instance-attribute

sound: SoundboardSound | None = None

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

SoundboardSoundsUpdate

Bases: Event

Several soundboard sounds changed; old holds the cached ones among them.

NAME class-attribute instance-attribute

NAME = 'GUILD_SOUNDBOARD_SOUNDS_UPDATE'

INTENTS class-attribute instance-attribute

soundboard_sounds instance-attribute

soundboard_sounds: tuple[SoundboardSound, ...]

guild_id instance-attribute

guild_id: int

old class-attribute instance-attribute

old: tuple[SoundboardSound, ...] = ()

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

SoundboardSounds

Bases: Event

A guild's soundboard sounds, sent for a Request Soundboard Sounds.

NAME class-attribute instance-attribute

NAME = 'SOUNDBOARD_SOUNDS'

soundboard_sounds instance-attribute

soundboard_sounds: tuple[SoundboardSound, ...]

guild_id instance-attribute

guild_id: int

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

ScheduledEventCreate

Bases: _ScheduledEventEvent

NAME class-attribute instance-attribute

NAME = 'GUILD_SCHEDULED_EVENT_CREATE'

INTENTS class-attribute instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

scheduled_event instance-attribute

scheduled_event: ScheduledEvent

ScheduledEventUpdate

Bases: _ScheduledEventEvent

A scheduled event changed; old is the cached event before the change.

NAME class-attribute instance-attribute

NAME = 'GUILD_SCHEDULED_EVENT_UPDATE'

old class-attribute instance-attribute

old: ScheduledEvent | None = None

INTENTS class-attribute instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

scheduled_event instance-attribute

scheduled_event: ScheduledEvent

ScheduledEventDelete

Bases: _ScheduledEventEvent

NAME class-attribute instance-attribute

NAME = 'GUILD_SCHEDULED_EVENT_DELETE'

INTENTS class-attribute instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

scheduled_event instance-attribute

scheduled_event: ScheduledEvent

ScheduledEventUserAdd

Bases: _ScheduledEventUserEvent

NAME class-attribute instance-attribute

NAME = 'GUILD_SCHEDULED_EVENT_USER_ADD'

INTENTS class-attribute instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

guild_scheduled_event_id instance-attribute

guild_scheduled_event_id: int

user_id instance-attribute

user_id: int

guild_id instance-attribute

guild_id: int

ScheduledEventUserRemove

Bases: _ScheduledEventUserEvent

NAME class-attribute instance-attribute

NAME = 'GUILD_SCHEDULED_EVENT_USER_REMOVE'

INTENTS class-attribute instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

guild_scheduled_event_id instance-attribute

guild_scheduled_event_id: int

user_id instance-attribute

user_id: int

guild_id instance-attribute

guild_id: int

EntitlementCreate

Bases: _EntitlementEvent

NAME class-attribute instance-attribute

NAME = 'ENTITLEMENT_CREATE'

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

entitlement instance-attribute

entitlement: PartialEntitlement

EntitlementUpdate

Bases: _EntitlementEvent

An entitlement changed; subscriptions send it only when they end.

NAME class-attribute instance-attribute

NAME = 'ENTITLEMENT_UPDATE'

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

entitlement instance-attribute

entitlement: PartialEntitlement

EntitlementDelete

Bases: _EntitlementEvent

NAME class-attribute instance-attribute

NAME = 'ENTITLEMENT_DELETE'

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

entitlement instance-attribute

entitlement: PartialEntitlement

ApplicationAuthorized

Bases: Event

A user added the app to a guild or to their account; only a webhook event.

NAME class-attribute instance-attribute

NAME = 'APPLICATION_AUTHORIZED'

integration_type class-attribute instance-attribute

integration_type: ApplicationIntegrationType | None = None

user instance-attribute

user: User

scopes instance-attribute

scopes: tuple[OAuth2Scope, ...]

guild class-attribute instance-attribute

guild: Guild | None = None

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

ApplicationDeauthorized

Bases: Event

A user removed the app, or its OAuth2 tokens ended; only a webhook event.

NAME class-attribute instance-attribute

NAME = 'APPLICATION_DEAUTHORIZED'

user instance-attribute

user: User

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

QuestUserEnrollment

Bases: Event

A user was added to a Quest; Discord does not send it to apps yet.

NAME class-attribute instance-attribute

NAME = 'QUEST_USER_ENROLLMENT'

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

LobbyMessageCreate

Bases: _LobbyMessageEvent

A message arrived in a lobby; only a webhook event.

NAME class-attribute instance-attribute

NAME = 'LOBBY_MESSAGE_CREATE'

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

message instance-attribute

message: LobbyMessage

LobbyMessageUpdate

Bases: _LobbyMessageEvent

A lobby message was edited; only a webhook event.

NAME class-attribute instance-attribute

NAME = 'LOBBY_MESSAGE_UPDATE'

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

message instance-attribute

message: LobbyMessage

LobbyMessageDelete

Bases: Event, Snowflake

A lobby message was deleted; only a webhook event.

NAME class-attribute instance-attribute

NAME = 'LOBBY_MESSAGE_DELETE'

id instance-attribute

id: int

lobby_id instance-attribute

lobby_id: int

created_at property

created_at: datetime

When the object was created, in UTC, read from its id.

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

GameDirectMessageCreate

Bases: _GameDirectMessageEvent

A direct message was sent in a Social SDK session; only a webhook event.

NAME class-attribute instance-attribute

NAME = 'GAME_DIRECT_MESSAGE_CREATE'

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

message instance-attribute

GameDirectMessageUpdate

Bases: _GameDirectMessageEvent

A direct message was edited in a Social SDK session; only a webhook event.

NAME class-attribute instance-attribute

NAME = 'GAME_DIRECT_MESSAGE_UPDATE'

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

message instance-attribute

GameDirectMessageDelete

Bases: _GameDirectMessageEvent

A direct message was deleted in a Social SDK session; only a webhook event.

NAME class-attribute instance-attribute

NAME = 'GAME_DIRECT_MESSAGE_DELETE'

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

message instance-attribute

SubscriptionCreate

Bases: _SubscriptionEvent

NAME class-attribute instance-attribute

NAME = 'SUBSCRIPTION_CREATE'

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

subscription instance-attribute

subscription: Subscription

SubscriptionUpdate

Bases: _SubscriptionEvent

NAME class-attribute instance-attribute

NAME = 'SUBSCRIPTION_UPDATE'

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

subscription instance-attribute

subscription: Subscription

SubscriptionDelete

Bases: _SubscriptionEvent

NAME class-attribute instance-attribute

NAME = 'SUBSCRIPTION_DELETE'

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

subscription instance-attribute

subscription: Subscription

ThreadMemberUpdate

Bases: Event

The bot's own membership in a thread changed.

NAME class-attribute instance-attribute

NAME = 'THREAD_MEMBER_UPDATE'

INTENTS class-attribute instance-attribute

INTENTS = Intents.GUILDS

guild_id instance-attribute

guild_id: int

thread_member instance-attribute

thread_member: ThreadMember

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

ThreadMembersUpdate

Bases: Event, Snowflake

Members joined or left a thread; members besides the bot need GUILD_MEMBERS.

NAME class-attribute instance-attribute

NAME = 'THREAD_MEMBERS_UPDATE'

INTENTS class-attribute instance-attribute

id instance-attribute

id: int

guild_id instance-attribute

guild_id: int

member_count instance-attribute

member_count: int

added_members class-attribute instance-attribute

added_members: tuple[AddedThreadMember, ...] = ()

removed_member_ids class-attribute instance-attribute

removed_member_ids: tuple[int, ...] = ()

created_at property

created_at: datetime

When the object was created, in UTC, read from its id.

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

MembersChunk

Bases: Event

Members sent for a Request Guild Members.

NAME class-attribute instance-attribute

NAME = 'GUILD_MEMBERS_CHUNK'

guild_id instance-attribute

guild_id: int

members instance-attribute

members: tuple[Member, ...]

chunk_index instance-attribute

chunk_index: int

chunk_count instance-attribute

chunk_count: int

not_found class-attribute instance-attribute

not_found: tuple[int, ...] = ()

presences class-attribute instance-attribute

presences: tuple[Presence, ...] = ()

nonce class-attribute instance-attribute

nonce: str | None = None

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

PresenceUpdate

Bases: Event

A member's status, activities or user changed; old is the cached presence.

NAME class-attribute instance-attribute

NAME = 'PRESENCE_UPDATE'

INTENTS class-attribute instance-attribute

guild_id instance-attribute

guild_id: int

presence instance-attribute

presence: Presence

old class-attribute instance-attribute

old: Presence | None = None

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

UserUpdate

Bases: Event

The bot's user changed; old is the cached user before the change.

NAME class-attribute instance-attribute

NAME = 'USER_UPDATE'

user instance-attribute

old class-attribute instance-attribute

old: CurrentUser | None = None

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

CommandPermissionsUpdate

Bases: Event

NAME class-attribute instance-attribute

NAME = 'APPLICATION_COMMAND_PERMISSIONS_UPDATE'

permissions instance-attribute

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

GuildIntegrationsUpdate

Bases: Event

NAME class-attribute instance-attribute

NAME = 'GUILD_INTEGRATIONS_UPDATE'

INTENTS class-attribute instance-attribute

guild_id instance-attribute

guild_id: int

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

IntegrationCreate

Bases: _IntegrationEvent

NAME class-attribute instance-attribute

NAME = 'INTEGRATION_CREATE'

INTENTS class-attribute instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

guild_id instance-attribute

guild_id: int

integration instance-attribute

integration: Integration

IntegrationUpdate

Bases: _IntegrationEvent

NAME class-attribute instance-attribute

NAME = 'INTEGRATION_UPDATE'

INTENTS class-attribute instance-attribute

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

guild_id instance-attribute

guild_id: int

integration instance-attribute

integration: Integration

IntegrationDelete

Bases: Event, Snowflake

NAME class-attribute instance-attribute

NAME = 'INTEGRATION_DELETE'

INTENTS class-attribute instance-attribute

id instance-attribute

id: int

guild_id instance-attribute

guild_id: int

application_id class-attribute instance-attribute

application_id: int | None = None

created_at property

created_at: datetime

When the object was created, in UTC, read from its id.

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

InviteCreate

Bases: Event

NAME class-attribute instance-attribute

NAME = 'INVITE_CREATE'

INTENTS class-attribute instance-attribute

channel_id instance-attribute

channel_id: int

code instance-attribute

code: str

created_at instance-attribute

created_at: datetime

guild_id class-attribute instance-attribute

guild_id: int | None = None

inviter class-attribute instance-attribute

inviter: User | None = None

max_age instance-attribute

max_age: int

max_uses instance-attribute

max_uses: int

target_type class-attribute instance-attribute

target_type: InviteTargetType | None = None

target_user class-attribute instance-attribute

target_user: User | None = None

target_application class-attribute instance-attribute

target_application: PartialApplication | None = None

temporary instance-attribute

temporary: bool

uses instance-attribute

uses: int

expires_at instance-attribute

expires_at: datetime | None

role_ids class-attribute instance-attribute

role_ids: tuple[int, ...] = ()

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

InviteDelete

Bases: Event

NAME class-attribute instance-attribute

NAME = 'INVITE_DELETE'

INTENTS class-attribute instance-attribute

channel_id instance-attribute

channel_id: int

guild_id class-attribute instance-attribute

guild_id: int | None = None

code instance-attribute

code: str

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

StageInstanceCreate

Bases: _StageInstanceEvent

NAME class-attribute instance-attribute

NAME = 'STAGE_INSTANCE_CREATE'

INTENTS class-attribute instance-attribute

INTENTS = Intents.GUILDS

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

stage_instance instance-attribute

stage_instance: StageInstance

StageInstanceUpdate

Bases: _StageInstanceEvent

A stage instance changed; old is the cached instance before the change.

NAME class-attribute instance-attribute

NAME = 'STAGE_INSTANCE_UPDATE'

old class-attribute instance-attribute

old: StageInstance | None = None

INTENTS class-attribute instance-attribute

INTENTS = Intents.GUILDS

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

stage_instance instance-attribute

stage_instance: StageInstance

StageInstanceDelete

Bases: _StageInstanceEvent

NAME class-attribute instance-attribute

NAME = 'STAGE_INSTANCE_DELETE'

INTENTS class-attribute instance-attribute

INTENTS = Intents.GUILDS

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

stage_instance instance-attribute

stage_instance: StageInstance

WebhooksUpdate

Bases: Event

A webhook of the channel was created, updated or deleted.

NAME class-attribute instance-attribute

NAME = 'WEBHOOKS_UPDATE'

INTENTS class-attribute instance-attribute

guild_id instance-attribute

guild_id: int

channel_id instance-attribute

channel_id: int

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

GatewayRateLimited

Bases: Event

A gateway command was rate limited; only Request Guild Members has meta.

NAME class-attribute instance-attribute

NAME = 'RATE_LIMITED'

opcode instance-attribute

opcode: int

retry_after instance-attribute

retry_after: float

meta class-attribute instance-attribute

meta: RequestGuildMembersRateLimit | None = None

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

RawEvent

Bases: Event

Any dispatch, modelled or not, with its payload in raw.

NAME class-attribute instance-attribute

NAME = '*'

name instance-attribute

name: str

seq instance-attribute

seq: int

INTENTS class-attribute

INTENTS: Intents = Intents(0)

shard_id class-attribute instance-attribute

shard_id: int = msgspec.field(default=0, name='__bostie_shard__')

raw_json class-attribute instance-attribute

raw_json: bytes = msgspec.field(default=b'', name='__bostie_raw__')

raw property

raw: Any

The event's payload as a new dict.

BotEvent

Bases: Struct

Base of the events that come from the bot, not Discord: bostie's and yours.

Subclass it for an event of your own and send it with bot.dispatch(); a subclass without a NAME is named <module>.<qualname>.

NAME class-attribute

NAME: str

INTENTS class-attribute

INTENTS: Intents = Intents(0)

Starting

Bases: BotEvent

start() is about to sync commands and connect; REST works already.

start() awaits each listener in turn, and raises what one raises.

NAME class-attribute instance-attribute

NAME = 'bot.starting'

INTENTS class-attribute

INTENTS: Intents = Intents(0)

Started

Bases: BotEvent

Every shard is ready, sent once per start(), when wait_until_ready() returns.

NAME class-attribute instance-attribute

NAME = 'bot.started'

INTENTS class-attribute

INTENTS: Intents = Intents(0)

Stopping

Bases: BotEvent

close() began after Started; it awaits these listeners with the gateway open.

NAME class-attribute instance-attribute

NAME = 'bot.stopping'

INTENTS class-attribute

INTENTS: Intents = Intents(0)

Stopped

Bases: BotEvent

close() ended a run that sent Starting; the gateway and REST are closed.

NAME class-attribute instance-attribute

NAME = 'bot.stopped'

INTENTS class-attribute

INTENTS: Intents = Intents(0)

ShardReady

Bases: BotEvent

A shard's new session is ready: the guilds its READY listed have arrived.

NAME class-attribute instance-attribute

NAME = 'shard.ready'

shard_id instance-attribute

shard_id: int

INTENTS class-attribute

INTENTS: Intents = Intents(0)

ShardDisconnect

Bases: BotEvent

A shard lost its connection; it resumes the session if resuming.

NAME class-attribute instance-attribute

NAME = 'shard.disconnect'

shard_id instance-attribute

shard_id: int

code instance-attribute

code: int | None

reason instance-attribute

reason: str

resuming instance-attribute

resuming: bool

INTENTS class-attribute

INTENTS: Intents = Intents(0)

ShardStop

Bases: BotEvent

A shard stopped for good: close() ran, or Discord ended it with code.

NAME class-attribute instance-attribute

NAME = 'shard.stop'

shard_id instance-attribute

shard_id: int

code instance-attribute

code: int | None

reason instance-attribute

reason: str

INTENTS class-attribute

INTENTS: Intents = Intents(0)

ShardBackpressure

Bases: BotEvent

A shard paused reading: queued_bytes of events wait for the event loop.

NAME class-attribute instance-attribute

NAME = 'shard.backpressure'

shard_id instance-attribute

shard_id: int

queued_bytes instance-attribute

queued_bytes: int

INTENTS class-attribute

INTENTS: Intents = Intents(0)

ListenerError

Bases: BotEvent

A listener raised; without a ListenerError listener the error is logged.

NAME class-attribute instance-attribute

NAME = 'bot.listener_error'

listener instance-attribute

listener: Callable[..., Any]

event instance-attribute

event: Any

error instance-attribute

error: Exception

INTENTS class-attribute

INTENTS: Intents = Intents(0)

TaskError

Bases: BotEvent

A task raised and runs again at its next time; with no listener it is logged.

NAME class-attribute instance-attribute

NAME = 'bot.task_error'

task instance-attribute

task: Task

error instance-attribute

error: Exception

INTENTS class-attribute

INTENTS: Intents = Intents(0)