hikari.events.guild_events#
Events that fire when something occurs within a guild.
Bases: GuildEvent
Event sent when a guild audit log entry was created.
class-attribute instance-attribute #
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
Bases: BanEvent
Event that is fired when a user is banned from a guild.
class-attribute instance-attribute #
ID of the guild that this event relates to.
class-attribute instance-attribute #
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
Bases: BanEvent
Event that is fired when a user is unbanned from a guild.
class-attribute instance-attribute #
ID of the guild that this event relates to.
class-attribute instance-attribute #
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
Bases: GuildEvent
Event that is fired when the emojis in a guild are updated.
class-attribute instance-attribute #
App instance for this application.
class-attribute instance-attribute #
emojis: Sequence[KnownCustomEmoji] = field()
Sequence of all emojis in this guild.
class-attribute instance-attribute #
ID of the guild that this event relates to.
class-attribute instance-attribute #
old_emojis: Optional[Sequence[KnownCustomEmoji]] = field()
Sequence of all old emojis in this guild.
This will be None if it's missing from the cache.
class-attribute instance-attribute #
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
async #
fetch_emojis() -> Sequence[KnownCustomEmoji]
Perform an API call to retrieve an up-to-date view of the emojis.
| RETURNS | DESCRIPTION |
|---|---|
Sequence[KnownCustomEmoji] | All emojis in the guild. |
Bases: GuildVisibilityEvent
Event fired when a guild becomes available.
This will occur on startup or after outages.
Note
Some fields like members and presences are included here but not on the other hikari.events.guild_events.GuildUpdateEvent and hikari.events.guild_events.GuildUnavailableEvent guild visibility event models.
class-attribute instance-attribute #
channels: Mapping[Snowflake, PermissibleGuildChannel] = field(repr=False)
Mapping of channel IDs to the channels in the guild.
class-attribute instance-attribute #
Nonce used to request the member chunks for this guild.
This will be None if no chunks were requested.
Note
This is a synthetic field.
class-attribute instance-attribute #
emojis: Mapping[Snowflake, KnownCustomEmoji] = field(repr=False)
Mapping of emoji IDs to the emojis in the guild.
class-attribute instance-attribute #
guild: GatewayGuild = field()
Guild that just became available.
class-attribute instance-attribute #
Mapping of user IDs to the members in the guild.
class-attribute instance-attribute #
presences: Mapping[Snowflake, MemberPresence] = field(repr=False)
Mapping of user IDs to the presences for the guild.
class-attribute instance-attribute #
Mapping of role IDs to the roles in the guild.
class-attribute instance-attribute #
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
class-attribute instance-attribute #
stickers: Mapping[Snowflake, GuildSticker] = field(repr=False)
Mapping of sticker IDs to the stickers in the guild.
class-attribute instance-attribute #
threads: Mapping[Snowflake, GuildThreadChannel] = field(repr=False)
Mapping of channel IDs to the threads in the guild.
class-attribute instance-attribute #
voice_states: Mapping[Snowflake, VoiceState] = field(repr=False)
Mapping of user IDs to the voice states active in this guild.
Bases: ShardEvent, ABC
Event base for any guild-bound event.
async #
fetch_guild() -> RESTGuild
Perform an API call to get the guild that this event relates to.
| RETURNS | DESCRIPTION |
|---|---|
RESTGuild | The guild this event occurred in. |
async #
fetch_guild_preview() -> GuildPreview
Perform an API call to get the preview of the event's guild.
| RETURNS | DESCRIPTION |
|---|---|
GuildPreview | The preview of the guild this event occurred in. |
get_guild() -> Optional[GatewayGuild]
Get the cached guild that this event relates to, if known.
If not known, this will return None instead.
| RETURNS | DESCRIPTION |
|---|---|
Optional[GatewayGuild] | The guild this event relates to, or |
Bases: GuildVisibilityEvent
Event fired when the bot joins a new guild.
Note
Some fields like members and presences are included here but not on the other hikari.events.guild_events.GuildUpdateEvent and hikari.events.guild_events.GuildUnavailableEvent guild visibility event models.
class-attribute instance-attribute #
channels: Mapping[Snowflake, PermissibleGuildChannel] = field(repr=False)
Mapping of channel IDs to the channels in the guild.
class-attribute instance-attribute #
Nonce used to request the member chunks for this guild.
This will be None if no chunks were requested.
Note
This is a synthetic field.
class-attribute instance-attribute #
emojis: Mapping[Snowflake, KnownCustomEmoji] = field(repr=False)
Mapping of emoji IDs to the emojis in the guild.
class-attribute instance-attribute #
guild: GatewayGuild = field()
The guild the bot just joined.
class-attribute instance-attribute #
Mapping of user IDs to the members in the guild.
class-attribute instance-attribute #
presences: Mapping[Snowflake, MemberPresence] = field(repr=False)
Mapping of user IDs to the presences for the guild.
class-attribute instance-attribute #
Mapping of role IDs to the roles in the guild.
class-attribute instance-attribute #
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
class-attribute instance-attribute #
stickers: Mapping[Snowflake, GuildSticker] = field(repr=False)
Mapping of sticker IDs to the stickers in the guild.
class-attribute instance-attribute #
threads: Mapping[Snowflake, GuildThreadChannel] = field(repr=False)
Mapping of channel IDs to the threads in the guild.
class-attribute instance-attribute #
voice_states: Mapping[Snowflake, VoiceState] = field(repr=False)
Mapping of user IDs to the voice states active in this guild.
Bases: GuildVisibilityEvent
Event fired when the bot is banned/kicked/leaves a guild.
This will also fire if the guild was deleted.
class-attribute instance-attribute #
App instance for this application.
class-attribute instance-attribute #
ID of the guild that this event relates to.
class-attribute instance-attribute #
old_guild: Optional[GatewayGuild] = field()
The old guild object.
This will be None if the guild missing from the cache.
class-attribute instance-attribute #
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
Bases: GuildVisibilityEvent
Event fired when a guild becomes unavailable because of an outage.
class-attribute instance-attribute #
App instance for this application.
class-attribute instance-attribute #
ID of the guild that this event relates to.
class-attribute instance-attribute #
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
Bases: GuildEvent
Event fired when an existing guild is updated.
class-attribute instance-attribute #
emojis: Mapping[Snowflake, KnownCustomEmoji] = field(repr=False)
Mapping of emoji IDs to the emojis in the guild.
class-attribute instance-attribute #
guild: GatewayGuild = field()
Guild that was just updated.
class-attribute instance-attribute #
old_guild: Optional[GatewayGuild] = field()
The old guild object.
This will be None if the guild missing from the cache.
class-attribute instance-attribute #
Mapping of role IDs to the roles in the guild.
class-attribute instance-attribute #
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
class-attribute instance-attribute #
stickers: Mapping[Snowflake, GuildSticker] = field(repr=False)
Mapping of sticker IDs to the stickers in the guild.
Bases: GuildEvent, ABC
Event base for any event that changes the visibility of a guild.
This includes when a guild becomes available after an outage, when a guild becomes available on startup, when a guild becomes unavailable due to an outage, when the user is kicked/banned/leaves a guild, or when the user joins a new guild.
Bases: IntegrationEvent
Event that is fired when an integration is created in a guild.
class-attribute instance-attribute #
App instance for this application.
property #
ID of Discord bot application this integration is connected to.
class-attribute instance-attribute #
integration: Integration = field()
Integration that was created.
class-attribute instance-attribute #
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
Bases: IntegrationEvent
Event that is fired when an integration is deleted in a guild.
class-attribute instance-attribute #
App instance for this application.
class-attribute instance-attribute #
ID of Discord bot application this integration is connected to.
class-attribute instance-attribute #
ID of the guild that this event relates to.
class-attribute instance-attribute #
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
Bases: GuildEvent, ABC
Event base for any integration related events.
abstractmethod property #
ID of Discord bot application this integration is connected to.
async #
fetch_integrations() -> Sequence[Integration]
Perform an API call to fetch some number of guild integrations.
Warning
The results of this are not clearly defined by Discord. The current behaviour appears to be that only the first 50 integrations actually get returned. Discord have made it clear that they are not willing to fix this in https://github.com/discord/discord-api-docs/issues/1990.
| RETURNS | DESCRIPTION |
|---|---|
Sequence[Integration] | Some possibly random subset of the integrations in a guild, probably. |
Bases: IntegrationEvent
Event that is fired when an integration is updated in a guild.
class-attribute instance-attribute #
App instance for this application.
property #
ID of Discord bot application this integration is connected to.
class-attribute instance-attribute #
integration: Integration = field()
Integration that was updated.
class-attribute instance-attribute #
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
Bases: ShardEvent
Event fired when a user in a guild updates their presence in a guild.
Sent when a guild member changes their presence in a specific guild.
If the user is changed (e.g. new username), then this may fire many times (once for every guild the bot is part of). This is a limitation of how Discord implements their event system, unfortunately.
Furthermore, if the target user is a bot and the bot only updates their presence on specific shards, this will only fire for the corresponding shards that saw the presence update.
class-attribute instance-attribute #
old_presence: Optional[MemberPresence] = field()
The old member presence object.
This will be None if the member presence missing from the cache.
class-attribute instance-attribute #
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
class-attribute instance-attribute #
user: Optional[PartialUser] = field()
User that was updated.
This is a partial user object that only contains the fields that were updated on the user profile.
Will be None if the user itself did not change. This is always the case if the user only updated their member representation and did not change their user profile directly.
Bases: GuildEvent
Event that is fired when the emojis in a guild are updated.
class-attribute instance-attribute #
App instance for this application.
class-attribute instance-attribute #
ID of the guild that this event relates to.
class-attribute instance-attribute #
old_stickers: Optional[Sequence[GuildSticker]] = field()
Sequence of all old stickers in this guild.
This will be None if it's missing from the cache.
class-attribute instance-attribute #
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
class-attribute instance-attribute #
stickers: Sequence[GuildSticker] = field()
Sequence of all stickers in this guild.
async #
fetch_stickers() -> Sequence[GuildSticker]
Perform an API call to retrieve an up-to-date view of the emojis.
| RETURNS | DESCRIPTION |
|---|---|
Sequence[GuildSticker] | All emojis in the guild. |