Events that fire when something occurs within a guild.
# -*- coding: utf-8 -*-
# cython: language_level=3
# Copyright (c) 2020 Nekokatt
# Copyright (c) 2021-present davfsa
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
"""Events that fire when something occurs within a guild."""
from __future__ import annotations
__all__: typing.List[str] = [
"GuildEvent",
"GuildVisibilityEvent",
"GuildAvailableEvent",
"GuildJoinEvent",
"GuildUnavailableEvent",
"GuildLeaveEvent",
"GuildUpdateEvent",
"BanEvent",
"BanCreateEvent",
"BanDeleteEvent",
"EmojisUpdateEvent",
"IntegrationEvent",
"IntegrationCreateEvent",
"IntegrationDeleteEvent",
"IntegrationUpdateEvent",
"PresenceUpdateEvent",
]
import abc
import typing
import attr
from hikari import intents
from hikari import traits
from hikari.events import base_events
from hikari.events import shard_events
from hikari.internal import attr_extensions
if typing.TYPE_CHECKING:
from hikari import channels as channels_
from hikari import emojis as emojis_
from hikari import guilds
from hikari import presences as presences_
from hikari import snowflakes
from hikari import users
from hikari import voices
from hikari.api import shard as gateway_shard
@base_events.requires_intents(
intents.Intents.GUILDS, intents.Intents.GUILD_BANS, intents.Intents.GUILD_EMOJIS, intents.Intents.GUILD_PRESENCES
)
class GuildEvent(shard_events.ShardEvent, abc.ABC):
"""Event base for any guild-bound event."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def guild_id(self) -> snowflakes.Snowflake:
"""ID of the guild that this event relates to.
Returns
-------
hikari.snowflakes.Snowflake
The ID of the guild that relates to this event.
"""
async def fetch_guild(self) -> guilds.RESTGuild:
"""Perform an API call to get the guild that this event relates to.
Returns
-------
hikari.guilds.RESTGuild
The guild this event occurred in.
"""
return await self.app.rest.fetch_guild(self.guild_id)
async def fetch_guild_preview(self) -> guilds.GuildPreview:
"""Perform an API call to get the preview of the event's guild.
Returns
-------
hikari.guilds.GuildPreview
The preview of the guild this event occurred in.
"""
return await self.app.rest.fetch_guild_preview(self.guild_id)
def get_guild(self) -> typing.Optional[guilds.GatewayGuild]:
"""Get the cached guild that this event relates to, if known.
If not known, this will return `builtins.None` instead.
Returns
-------
typing.Optional[hikari.guilds.GatewayGuild]
The guild this event relates to, or `builtins.None` if not known.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_available_guild(self.guild_id) or self.app.cache.get_unavailable_guild(self.guild_id)
@base_events.requires_intents(intents.Intents.GUILDS)
class GuildVisibilityEvent(GuildEvent, abc.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.
"""
__slots__: typing.Sequence[str] = ()
@attr_extensions.with_copy
@attr.define(kw_only=True, weakref_slot=False)
@base_events.requires_intents(intents.Intents.GUILDS)
class GuildAvailableEvent(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 `GuildUpdateEvent` and `GuildUnavailableEvent` guild visibility
event models.
"""
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
guild: guilds.GatewayGuild = attr.field()
"""Guild that just became available.
Returns
-------
hikari.guilds.Guild
The guild that relates to this event.
"""
emojis: typing.Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji] = attr.field(repr=False)
"""Mapping of emoji IDs to the emojis in the guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.emojis.KnownCustomEmoji]
The emojis in the guild.
"""
roles: typing.Mapping[snowflakes.Snowflake, guilds.Role] = attr.field(repr=False)
"""Mapping of role IDs to the roles in the guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.guilds.Role]
The roles in the guild.
"""
channels: typing.Mapping[snowflakes.Snowflake, channels_.GuildChannel] = attr.field(repr=False)
"""Mapping of channel IDs to the channels in the guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.channels.GuildChannel]
The channels in the guild.
"""
members: typing.Mapping[snowflakes.Snowflake, guilds.Member] = attr.field(repr=False)
"""Mapping of user IDs to the members in the guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.guilds.Member]
The members in the guild.
"""
presences: typing.Mapping[snowflakes.Snowflake, presences_.MemberPresence] = attr.field(repr=False)
"""Mapping of user IDs to the presences for the guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.presences.MemberPresence]
The member presences in the guild.
"""
voice_states: typing.Mapping[snowflakes.Snowflake, voices.VoiceState] = attr.field(repr=False)
"""Mapping of user IDs to the voice states active in this guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.voices.VoiceState]
The voice states active in the guild.
"""
chunk_nonce: typing.Optional[str] = attr.field(repr=False, default=None)
"""Nonce used to request the member chunks for this guild.
This will be `builtins.None` if no chunks were requested.
!!! note
This is a synthetic field.
Returns
-------
typing.Optional[builtins.str]
The nonce used to request the member chunks.
"""
@property
def app(self) -> traits.RESTAware:
# <<inherited docstring from Event>>.
return self.guild.app
@property
def guild_id(self) -> snowflakes.Snowflake:
# <<inherited docstring from GuildEvent>>.
return self.guild.id
@attr_extensions.with_copy
@attr.define(kw_only=True, weakref_slot=False)
@base_events.requires_intents(intents.Intents.GUILDS)
class GuildJoinEvent(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 `GuildUpdateEvent` and `GuildUnavailableEvent` guild visibility
event models.
"""
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
guild: guilds.GatewayGuild = attr.field()
"""The guild the bot just joined."""
emojis: typing.Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji] = attr.field(repr=False)
"""Mapping of emoji IDs to the emojis in the guild."""
roles: typing.Mapping[snowflakes.Snowflake, guilds.Role] = attr.field(repr=False)
"""Mapping of role IDs to the roles in the guild."""
channels: typing.Mapping[snowflakes.Snowflake, channels_.GuildChannel] = attr.field(repr=False)
"""Mapping of channel IDs to the channels in the guild."""
members: typing.Mapping[snowflakes.Snowflake, guilds.Member] = attr.field(repr=False)
"""Mapping of user IDs to the members in the guild."""
presences: typing.Mapping[snowflakes.Snowflake, presences_.MemberPresence] = attr.field(repr=False)
"""Mapping of user IDs to the presences for the guild."""
voice_states: typing.Mapping[snowflakes.Snowflake, voices.VoiceState] = attr.field(repr=False)
"""Mapping of user IDs to the voice states active in this guild."""
chunk_nonce: typing.Optional[str] = attr.field(repr=False, default=None)
"""Nonce used to request the member chunks for this guild.
This will be `builtins.None` if no chunks were requested.
!!! note
This is a synthetic field.
"""
@property
def app(self) -> traits.RESTAware:
# <<inherited docstring from Event>>.
return self.guild.app
@property
def guild_id(self) -> snowflakes.Snowflake:
# <<inherited docstring from GuildEvent>>.
return self.guild.id
@attr_extensions.with_copy
@attr.define(kw_only=True, weakref_slot=False)
@base_events.requires_intents(intents.Intents.GUILDS)
class GuildLeaveEvent(GuildVisibilityEvent):
"""Event fired when the bot is banned/kicked/leaves a guild.
This will also fire if the guild was deleted.
"""
app: traits.RESTAware = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from Event>>.
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
guild_id: snowflakes.Snowflake = attr.field()
# <<inherited docstring from GuildEvent>>.
old_guild: typing.Optional[guilds.GatewayGuild] = attr.field()
"""The old guild object.
This will be `builtins.None` if the guild missing from the cache.
"""
if typing.TYPE_CHECKING:
# This should always fail.
async def fetch_guild(self) -> typing.NoReturn:
...
@attr_extensions.with_copy
@attr.define(kw_only=True, weakref_slot=False)
@base_events.requires_intents(intents.Intents.GUILDS)
class GuildUnavailableEvent(GuildVisibilityEvent):
"""Event fired when a guild becomes unavailable because of an outage."""
app: traits.RESTAware = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from Event>>.
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
guild_id: snowflakes.Snowflake = attr.field()
# <<inherited docstring from GuildEvent>>.
@attr_extensions.with_copy
@attr.define(kw_only=True, weakref_slot=False)
@base_events.requires_intents(intents.Intents.GUILDS)
class GuildUpdateEvent(GuildEvent):
"""Event fired when an existing guild is updated."""
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
old_guild: typing.Optional[guilds.GatewayGuild] = attr.field()
"""The old guild object.
This will be `builtins.None` if the guild missing from the cache.
"""
guild: guilds.GatewayGuild = attr.field()
"""Guild that was just updated.
Returns
-------
hikari.guilds.Guild
The guild that relates to this event.
"""
emojis: typing.Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji] = attr.field(repr=False)
"""Mapping of emoji IDs to the emojis in the guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.emojis.KnownCustomEmoji]
The emojis in the guild.
"""
roles: typing.Mapping[snowflakes.Snowflake, guilds.Role] = attr.field(repr=False)
"""Mapping of role IDs to the roles in the guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.guilds.Role]
The roles in the guild.
"""
@property
def app(self) -> traits.RESTAware:
# <<inherited docstring from Event>>.
return self.guild.app
@property
def guild_id(self) -> snowflakes.Snowflake:
# <<inherited docstring from GuildEvent>>.
return self.guild.id
@base_events.requires_intents(intents.Intents.GUILD_BANS)
class BanEvent(GuildEvent, abc.ABC):
"""Event base for any guild ban or unban."""
__slots__: typing.Sequence[str] = ()
@property
def app(self) -> traits.RESTAware:
# <<inherited docstring from Event>>.
return self.user.app
@property
@abc.abstractmethod
def user(self) -> users.User:
"""User that this ban event affects.
Returns
-------
hikari.users.User
The user that this event concerns.
"""
async def fetch_user(self) -> users.User:
"""Perform an API call to fetch the user this ban event affects.
Returns
-------
hikari.users.User
The user affected by this event.
"""
return await self.app.rest.fetch_user(self.user)
@attr_extensions.with_copy
@attr.define(kw_only=True, weakref_slot=False)
@base_events.requires_intents(intents.Intents.GUILD_BANS)
class BanCreateEvent(BanEvent):
"""Event that is fired when a user is banned from a guild."""
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
guild_id: snowflakes.Snowflake = attr.field()
# <<inherited docstring from GuildEvent>>.
user: users.User = attr.field()
# <<inherited docstring from BanEvent>>.
@property
def user_id(self) -> snowflakes.Snowflake:
"""User ID of the user that got banned.
Returns
-------
hikari.snowflakes.Snowflake
ID of the user the event concerns.
"""
return self.user.id
async def fetch_ban(self) -> guilds.GuildBan:
"""Perform an API call to fetch the details about this ban.
This will include the optionally defined audit log reason for the
ban.
Returns
-------
hikari.guilds.GuildBan
The ban details.
"""
return await self.app.rest.fetch_ban(self.guild_id, self.user)
@attr_extensions.with_copy
@attr.define(kw_only=True, weakref_slot=False)
@base_events.requires_intents(intents.Intents.GUILD_BANS)
class BanDeleteEvent(BanEvent):
"""Event that is fired when a user is unbanned from a guild."""
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
guild_id: snowflakes.Snowflake = attr.field()
# <<inherited docstring from GuildEvent>>.
user: users.User = attr.field()
# <<inherited docstring from BanEvent>>.
@attr_extensions.with_copy
@attr.define(kw_only=True, weakref_slot=False)
@base_events.requires_intents(intents.Intents.GUILD_EMOJIS)
class EmojisUpdateEvent(GuildEvent):
"""Event that is fired when the emojis in a guild are updated."""
app: traits.RESTAware = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from Event>>.
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
guild_id: snowflakes.Snowflake = attr.field()
# <<inherited docstring from GuildEvent>>.
old_emojis: typing.Optional[typing.Sequence[emojis_.KnownCustomEmoji]] = attr.field()
"""Sequence of all old emojis in this guild.
This will be `builtins.None` if it's missing from the cache.
"""
emojis: typing.Sequence[emojis_.KnownCustomEmoji] = attr.field()
"""Sequence of all emojis in this guild.
Returns
-------
typing.Sequence[emojis_.KnownCustomEmoji]
All emojis in the guild.
"""
async def fetch_emojis(self) -> typing.Sequence[emojis_.KnownCustomEmoji]:
"""Perform an API call to retrieve an up-to-date view of the emojis.
Returns
-------
typing.Sequence[emojis_.KnownCustomEmoji]
All emojis in the guild.
"""
return await self.app.rest.fetch_guild_emojis(self.guild_id)
@base_events.requires_intents(intents.Intents.GUILD_INTEGRATIONS)
class IntegrationEvent(GuildEvent, abc.ABC):
"""Event base for any integration related events."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def application_id(self) -> typing.Optional[snowflakes.Snowflake]:
"""ID of Discord bot application this integration is connected to.
Returns
-------
typing.Optional[hikari.snowflakes.Snowflake]
The ID of Discord bot application this integration is connected to.
"""
@property
@abc.abstractmethod
def id(self) -> snowflakes.Snowflake:
"""ID of the integration.
Returns
-------
hikari.snowflakes.Snowflake
The ID of the integration.
"""
async def fetch_integrations(self) -> typing.Sequence[guilds.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
-------
typing.Sequence[hikari.guilds.Integration]
Some possibly random subset of the integrations in a guild,
probably.
"""
return await self.app.rest.fetch_integrations(self.guild_id)
@attr_extensions.with_copy
@attr.define(kw_only=True, weakref_slot=False)
@base_events.requires_intents(intents.Intents.GUILD_INTEGRATIONS)
class IntegrationCreateEvent(IntegrationEvent):
"""Event that is fired when an integration is created in a guild."""
app: traits.RESTAware = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from Event>>.
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
integration: guilds.Integration = attr.field()
"""Integration that was created."""
@property
def application_id(self) -> typing.Optional[snowflakes.Snowflake]:
# <<inherited docstring from IntegrationEvent>>.
return self.integration.application.id if self.integration.application else None
@property
def guild_id(self) -> snowflakes.Snowflake:
# <<inherited docstring from ShardEvent>>.
return self.integration.guild_id
@property
def id(self) -> snowflakes.Snowflake:
# <<inherited docstring from IntegrationEvent>>
return self.integration.id
@attr_extensions.with_copy
@attr.define(kw_only=True, weakref_slot=False)
@base_events.requires_intents(intents.Intents.GUILD_INTEGRATIONS)
class IntegrationDeleteEvent(IntegrationEvent):
"""Event that is fired when an integration is deleted in a guild."""
app: traits.RESTAware = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from Event>>.
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
application_id: typing.Optional[snowflakes.Snowflake] = attr.field()
# <<inherited docstring from IntegrationEvent>>.
guild_id: snowflakes.Snowflake = attr.field()
# <<inherited docstring from ShardEvent>>.
id: snowflakes.Snowflake = attr.field()
# <<inherited docstring from IntegrationEvent>>
@attr_extensions.with_copy
@attr.define(kw_only=True, weakref_slot=False)
@base_events.requires_intents(intents.Intents.GUILD_INTEGRATIONS)
class IntegrationUpdateEvent(IntegrationEvent):
"""Event that is fired when an integration is updated in a guild."""
app: traits.RESTAware = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from Event>>.
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
integration: guilds.Integration = attr.field()
"""Integration that was updated."""
@property
def application_id(self) -> typing.Optional[snowflakes.Snowflake]:
# <<inherited docstring from IntegrationEvent>>.
return self.integration.application.id if self.integration.application else None
@property
def guild_id(self) -> snowflakes.Snowflake:
# <<inherited docstring from GuildEvent>>.
return self.integration.guild_id
@property
def id(self) -> snowflakes.Snowflake:
# <<inherited docstring from IntegrationEvent>>
return self.integration.id
@attr_extensions.with_copy
@attr.define(kw_only=True, weakref_slot=False)
@base_events.requires_intents(intents.Intents.GUILD_PRESENCES)
class PresenceUpdateEvent(shard_events.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.
"""
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
old_presence: typing.Optional[presences_.MemberPresence] = attr.field()
"""The old member presence object.
This will be `builtins.None` if the member presence missing from the cache.
"""
presence: presences_.MemberPresence = attr.field()
"""Member presence.
Returns
-------
hikari.presences.MemberPresence
Presence for the user in this guild.
"""
user: typing.Optional[users.PartialUser] = attr.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 `builtins.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.
Returns
-------
typing.Optional[hikari.users.PartialUser]
The partial user containing the updated fields.
"""
@property
def app(self) -> traits.RESTAware:
# <<inherited docstring from Event>>.
return self.presence.app
@property
def user_id(self) -> snowflakes.Snowflake:
"""User ID of the user that updated their presence.
Returns
-------
hikari.snowflakes.Snowflake
ID of the user the event concerns.
"""
return self.presence.user_id
@property
def guild_id(self) -> snowflakes.Snowflake:
"""Guild ID that the presence was updated in.
Returns
-------
hikari.snowflakes.Snowflake
ID of the guild the event occurred in.
"""
return self.presence.guild_id
def get_user(self) -> typing.Optional[users.User]:
"""Get the full cached user, if it is available.
Returns
-------
typing.Optional[hikari.users.User]
The full cached user, or `builtins.None` if not cached.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_user(self.user_id)
async def fetch_user(self) -> users.User:
"""Perform an API call to fetch the user this event concerns.
Returns
-------
hikari.users.User
The user affected by this event.
"""
return await self.app.rest.fetch_user(self.user_id)
class BanCreateEvent (
*,
shard: gateway_shard.GatewayShard,
guild_id: snowflakes.Snowflake,
user: users.User,
): ...
Event that is fired when a user is banned from a guild.
This requires one of the following combinations of intents in order to be dispatched:
Method generated by attrs for class BanCreateEvent.
class BanCreateEvent(BanEvent):
"""Event that is fired when a user is banned from a guild."""
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
guild_id: snowflakes.Snowflake = attr.field()
# <<inherited docstring from GuildEvent>>.
user: users.User = attr.field()
# <<inherited docstring from BanEvent>>.
@property
def user_id(self) -> snowflakes.Snowflake:
"""User ID of the user that got banned.
Returns
-------
hikari.snowflakes.Snowflake
ID of the user the event concerns.
"""
return self.user.id
async def fetch_ban(self) -> guilds.GuildBan:
"""Perform an API call to fetch the details about this ban.
This will include the optionally defined audit log reason for the
ban.
Returns
-------
hikari.guilds.GuildBan
The ban details.
"""
return await self.app.rest.fetch_ban(self.guild_id, self.user)
Event base for any guild ban or unban …
Event base for any guild-bound event …
Base class for any event that was shard-specific.
Base event type that all Hikari events should subclass.
Helper class that provides a standard way to create an ABC using inheritance.
property app : RESTAware
App instance for this application.
RESTAware
property guild_id : snowflakes.Snowflake
ID of the guild that this event relates to.
Snowflake
property shard : gateway_shard.GatewayShard
Shard that received this event.
GatewayShard
property user : users.User
User that this ban event affects.
User
property user_id : snowflakes.Snowflake
User ID of the user that got banned.
Snowflake
async def fetch_ban() -> guilds.GuildBan: ...
Perform an API call to fetch the details about this ban.
This will include the optionally defined audit log reason for the ban.
GuildBan
async def fetch_ban(self) -> guilds.GuildBan:
"""Perform an API call to fetch the details about this ban.
This will include the optionally defined audit log reason for the
ban.
Returns
-------
hikari.guilds.GuildBan
The ban details.
"""
return await self.app.rest.fetch_ban(self.guild_id, self.user)
async def fetch_guild() -> guilds.RESTGuild: ...
Inherited from:
BanEvent
.fetch_guild
Perform an API call to get the guild that this event relates to.
RESTGuild
async def fetch_guild_preview() -> guilds.GuildPreview: ...
Inherited from:
BanEvent
.fetch_guild_preview
Perform an API call to get the preview of the event's guild.
GuildPreview
async def fetch_user() -> users.User: ...
Inherited from:
BanEvent
.fetch_user
Perform an API call to fetch the user this ban event affects.
User
def get_guild() -> Optional[guilds.GatewayGuild]: ...
Inherited from:
BanEvent
.get_guild
Get the cached guild that this event relates to, if known.
If not known, this will return None
instead.
Optional[GatewayGuild]
None
if not known.def dispatches() -> Sequence[Type[Event]]: ...
Inherited from:
BanEvent
.dispatches
Sequence of the event classes this event is dispatched as.
class BanDeleteEvent (
*,
shard: gateway_shard.GatewayShard,
guild_id: snowflakes.Snowflake,
user: users.User,
): ...
Event that is fired when a user is unbanned from a guild.
This requires one of the following combinations of intents in order to be dispatched:
Method generated by attrs for class BanDeleteEvent.
class BanDeleteEvent(BanEvent):
"""Event that is fired when a user is unbanned from a guild."""
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
guild_id: snowflakes.Snowflake = attr.field()
# <<inherited docstring from GuildEvent>>.
user: users.User = attr.field()
# <<inherited docstring from BanEvent>>.
Event base for any guild ban or unban …
Event base for any guild-bound event …
Base class for any event that was shard-specific.
Base event type that all Hikari events should subclass.
Helper class that provides a standard way to create an ABC using inheritance.
property app : RESTAware
App instance for this application.
RESTAware
property guild_id : snowflakes.Snowflake
ID of the guild that this event relates to.
Snowflake
property shard : gateway_shard.GatewayShard
Shard that received this event.
GatewayShard
property user : users.User
User that this ban event affects.
User
async def fetch_guild() -> guilds.RESTGuild: ...
Inherited from:
BanEvent
.fetch_guild
Perform an API call to get the guild that this event relates to.
RESTGuild
async def fetch_guild_preview() -> guilds.GuildPreview: ...
Inherited from:
BanEvent
.fetch_guild_preview
Perform an API call to get the preview of the event's guild.
GuildPreview
async def fetch_user() -> users.User: ...
Inherited from:
BanEvent
.fetch_user
Perform an API call to fetch the user this ban event affects.
User
def get_guild() -> Optional[guilds.GatewayGuild]: ...
Inherited from:
BanEvent
.get_guild
Get the cached guild that this event relates to, if known.
If not known, this will return None
instead.
Optional[GatewayGuild]
None
if not known.def dispatches() -> Sequence[Type[Event]]: ...
Inherited from:
BanEvent
.dispatches
Sequence of the event classes this event is dispatched as.
class BanEvent: ...
Event base for any guild ban or unban.
This requires one of the following combinations of intents in order to be dispatched:
class BanEvent(GuildEvent, abc.ABC):
"""Event base for any guild ban or unban."""
__slots__: typing.Sequence[str] = ()
@property
def app(self) -> traits.RESTAware:
# <<inherited docstring from Event>>.
return self.user.app
@property
@abc.abstractmethod
def user(self) -> users.User:
"""User that this ban event affects.
Returns
-------
hikari.users.User
The user that this event concerns.
"""
async def fetch_user(self) -> users.User:
"""Perform an API call to fetch the user this ban event affects.
Returns
-------
hikari.users.User
The user affected by this event.
"""
return await self.app.rest.fetch_user(self.user)
Event that is fired when a user is banned from a guild …
Event that is fired when a user is unbanned from a guild …
Event base for any guild-bound event …
Base class for any event that was shard-specific.
Base event type that all Hikari events should subclass.
Helper class that provides a standard way to create an ABC using inheritance.
property app : RESTAware
App instance for this application.
RESTAware
abstract property guild_id : snowflakes.Snowflake
ID of the guild that this event relates to.
Snowflake
abstract property shard : gateway_shard.GatewayShard
Shard that received this event.
GatewayShard
abstract property user : users.User
User that this ban event affects.
User
async def fetch_guild() -> guilds.RESTGuild: ...
Inherited from:
GuildEvent
.fetch_guild
Perform an API call to get the guild that this event relates to.
RESTGuild
async def fetch_guild_preview() -> guilds.GuildPreview: ...
Inherited from:
GuildEvent
.fetch_guild_preview
Perform an API call to get the preview of the event's guild.
GuildPreview
async def fetch_user() -> users.User: ...
Perform an API call to fetch the user this ban event affects.
User
async def fetch_user(self) -> users.User:
"""Perform an API call to fetch the user this ban event affects.
Returns
-------
hikari.users.User
The user affected by this event.
"""
return await self.app.rest.fetch_user(self.user)
def get_guild() -> Optional[guilds.GatewayGuild]: ...
Inherited from:
GuildEvent
.get_guild
Get the cached guild that this event relates to, if known.
If not known, this will return None
instead.
Optional[GatewayGuild]
None
if not known.def bitmask() -> int: ...
Inherited from:
GuildEvent
.bitmask
Bitmask for this event.
def dispatches() -> Sequence[Type[Event]]: ...
Inherited from:
GuildEvent
.dispatches
Sequence of the event classes this event is dispatched as.
class EmojisUpdateEvent (
*,
app: traits.RESTAware,
shard: gateway_shard.GatewayShard,
guild_id: snowflakes.Snowflake,
old_emojis: Optional[Sequence[emojis_.KnownCustomEmoji]],
emojis: Sequence[emojis_.KnownCustomEmoji],
): ...
Event that is fired when the emojis in a guild are updated.
This requires one of the following combinations of intents in order to be dispatched:
Method generated by attrs for class EmojisUpdateEvent.
class EmojisUpdateEvent(GuildEvent):
"""Event that is fired when the emojis in a guild are updated."""
app: traits.RESTAware = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from Event>>.
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
guild_id: snowflakes.Snowflake = attr.field()
# <<inherited docstring from GuildEvent>>.
old_emojis: typing.Optional[typing.Sequence[emojis_.KnownCustomEmoji]] = attr.field()
"""Sequence of all old emojis in this guild.
This will be `builtins.None` if it's missing from the cache.
"""
emojis: typing.Sequence[emojis_.KnownCustomEmoji] = attr.field()
"""Sequence of all emojis in this guild.
Returns
-------
typing.Sequence[emojis_.KnownCustomEmoji]
All emojis in the guild.
"""
async def fetch_emojis(self) -> typing.Sequence[emojis_.KnownCustomEmoji]:
"""Perform an API call to retrieve an up-to-date view of the emojis.
Returns
-------
typing.Sequence[emojis_.KnownCustomEmoji]
All emojis in the guild.
"""
return await self.app.rest.fetch_guild_emojis(self.guild_id)
Event base for any guild-bound event …
Base class for any event that was shard-specific.
Base event type that all Hikari events should subclass.
Helper class that provides a standard way to create an ABC using inheritance.
property app : traits.RESTAware
App instance for this application.
RESTAware
property emojis : Sequence[emojis_.KnownCustomEmoji]
Sequence of all emojis in this guild.
Sequence[emojis_.KnownCustomEmoji]
property guild_id : snowflakes.Snowflake
ID of the guild that this event relates to.
Snowflake
property old_emojis : Optional[Sequence[emojis_.KnownCustomEmoji]]
Sequence of all old emojis in this guild.
This will be None
if it's missing from the cache.
property shard : gateway_shard.GatewayShard
Shard that received this event.
GatewayShard
async def fetch_emojis() -> Sequence[emojis_.KnownCustomEmoji]: ...
Perform an API call to retrieve an up-to-date view of the emojis.
Sequence[emojis_.KnownCustomEmoji]
async def fetch_emojis(self) -> typing.Sequence[emojis_.KnownCustomEmoji]:
"""Perform an API call to retrieve an up-to-date view of the emojis.
Returns
-------
typing.Sequence[emojis_.KnownCustomEmoji]
All emojis in the guild.
"""
return await self.app.rest.fetch_guild_emojis(self.guild_id)
async def fetch_guild() -> guilds.RESTGuild: ...
Inherited from:
GuildEvent
.fetch_guild
Perform an API call to get the guild that this event relates to.
RESTGuild
async def fetch_guild_preview() -> guilds.GuildPreview: ...
Inherited from:
GuildEvent
.fetch_guild_preview
Perform an API call to get the preview of the event's guild.
GuildPreview
def get_guild() -> Optional[guilds.GatewayGuild]: ...
Inherited from:
GuildEvent
.get_guild
Get the cached guild that this event relates to, if known.
If not known, this will return None
instead.
Optional[GatewayGuild]
None
if not known.def bitmask() -> int: ...
Inherited from:
GuildEvent
.bitmask
Bitmask for this event.
def dispatches() -> Sequence[Type[Event]]: ...
Inherited from:
GuildEvent
.dispatches
Sequence of the event classes this event is dispatched as.
class GuildAvailableEvent (
*,
shard: gateway_shard.GatewayShard,
guild: guilds.GatewayGuild,
emojis: Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji],
roles: Mapping[snowflakes.Snowflake, guilds.Role],
channels: Mapping[snowflakes.Snowflake, channels_.GuildChannel],
members: Mapping[snowflakes.Snowflake, guilds.Member],
presences: Mapping[snowflakes.Snowflake, presences_.MemberPresence],
voice_states: Mapping[snowflakes.Snowflake, voices.VoiceState],
chunk_nonce: Optional[str] = None,
): ...
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 GuildUpdateEvent
and GuildUnavailableEvent
guild visibility
event models.
This requires one of the following combinations of intents in order to be dispatched:
Method generated by attrs for class GuildAvailableEvent.
class GuildAvailableEvent(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 `GuildUpdateEvent` and `GuildUnavailableEvent` guild visibility
event models.
"""
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
guild: guilds.GatewayGuild = attr.field()
"""Guild that just became available.
Returns
-------
hikari.guilds.Guild
The guild that relates to this event.
"""
emojis: typing.Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji] = attr.field(repr=False)
"""Mapping of emoji IDs to the emojis in the guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.emojis.KnownCustomEmoji]
The emojis in the guild.
"""
roles: typing.Mapping[snowflakes.Snowflake, guilds.Role] = attr.field(repr=False)
"""Mapping of role IDs to the roles in the guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.guilds.Role]
The roles in the guild.
"""
channels: typing.Mapping[snowflakes.Snowflake, channels_.GuildChannel] = attr.field(repr=False)
"""Mapping of channel IDs to the channels in the guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.channels.GuildChannel]
The channels in the guild.
"""
members: typing.Mapping[snowflakes.Snowflake, guilds.Member] = attr.field(repr=False)
"""Mapping of user IDs to the members in the guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.guilds.Member]
The members in the guild.
"""
presences: typing.Mapping[snowflakes.Snowflake, presences_.MemberPresence] = attr.field(repr=False)
"""Mapping of user IDs to the presences for the guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.presences.MemberPresence]
The member presences in the guild.
"""
voice_states: typing.Mapping[snowflakes.Snowflake, voices.VoiceState] = attr.field(repr=False)
"""Mapping of user IDs to the voice states active in this guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.voices.VoiceState]
The voice states active in the guild.
"""
chunk_nonce: typing.Optional[str] = attr.field(repr=False, default=None)
"""Nonce used to request the member chunks for this guild.
This will be `builtins.None` if no chunks were requested.
!!! note
This is a synthetic field.
Returns
-------
typing.Optional[builtins.str]
The nonce used to request the member chunks.
"""
@property
def app(self) -> traits.RESTAware:
# <<inherited docstring from Event>>.
return self.guild.app
@property
def guild_id(self) -> snowflakes.Snowflake:
# <<inherited docstring from GuildEvent>>.
return self.guild.id
Event base for any event that changes the visibility of a guild …
Event base for any guild-bound event …
Base class for any event that was shard-specific.
Base event type that all Hikari events should subclass.
Helper class that provides a standard way to create an ABC using inheritance.
property app : RESTAware
App instance for this application.
RESTAware
property channels : Mapping[snowflakes.Snowflake, channels_.GuildChannel]
Mapping of channel IDs to the channels in the guild.
Mapping[Snowflake, GuildChannel]
property chunk_nonce : Optional[str]
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.
property emojis : Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji]
Mapping of emoji IDs to the emojis in the guild.
Mapping[Snowflake, KnownCustomEmoji]
property guild : guilds.GatewayGuild
Guild that just became available.
Guild
property guild_id : snowflakes.Snowflake
ID of the guild that this event relates to.
Snowflake
property members : Mapping[snowflakes.Snowflake, guilds.Member]
Mapping of user IDs to the members in the guild.
property presences : Mapping[snowflakes.Snowflake, presences_.MemberPresence]
Mapping of user IDs to the presences for the guild.
Mapping[Snowflake, MemberPresence]
property roles : Mapping[snowflakes.Snowflake, guilds.Role]
Mapping of role IDs to the roles in the guild.
property shard : gateway_shard.GatewayShard
Shard that received this event.
GatewayShard
property voice_states : Mapping[snowflakes.Snowflake, voices.VoiceState]
Mapping of user IDs to the voice states active in this guild.
Mapping[Snowflake, VoiceState]
async def fetch_guild() -> guilds.RESTGuild: ...
Inherited from:
GuildVisibilityEvent
.fetch_guild
Perform an API call to get the guild that this event relates to.
RESTGuild
async def fetch_guild_preview() -> guilds.GuildPreview: ...
Inherited from:
GuildVisibilityEvent
.fetch_guild_preview
Perform an API call to get the preview of the event's guild.
GuildPreview
def get_guild() -> Optional[guilds.GatewayGuild]: ...
Inherited from:
GuildVisibilityEvent
.get_guild
Get the cached guild that this event relates to, if known.
If not known, this will return None
instead.
Optional[GatewayGuild]
None
if not known.def bitmask() -> int: ...
Inherited from:
GuildVisibilityEvent
.bitmask
Bitmask for this event.
def dispatches() -> Sequence[Type[Event]]: ...
Inherited from:
GuildVisibilityEvent
.dispatches
Sequence of the event classes this event is dispatched as.
class GuildEvent: ...
Event base for any guild-bound event.
This requires one of the following combinations of intents in order to be dispatched:
class GuildEvent(shard_events.ShardEvent, abc.ABC):
"""Event base for any guild-bound event."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def guild_id(self) -> snowflakes.Snowflake:
"""ID of the guild that this event relates to.
Returns
-------
hikari.snowflakes.Snowflake
The ID of the guild that relates to this event.
"""
async def fetch_guild(self) -> guilds.RESTGuild:
"""Perform an API call to get the guild that this event relates to.
Returns
-------
hikari.guilds.RESTGuild
The guild this event occurred in.
"""
return await self.app.rest.fetch_guild(self.guild_id)
async def fetch_guild_preview(self) -> guilds.GuildPreview:
"""Perform an API call to get the preview of the event's guild.
Returns
-------
hikari.guilds.GuildPreview
The preview of the guild this event occurred in.
"""
return await self.app.rest.fetch_guild_preview(self.guild_id)
def get_guild(self) -> typing.Optional[guilds.GatewayGuild]:
"""Get the cached guild that this event relates to, if known.
If not known, this will return `builtins.None` instead.
Returns
-------
typing.Optional[hikari.guilds.GatewayGuild]
The guild this event relates to, or `builtins.None` if not known.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_available_guild(self.guild_id) or self.app.cache.get_unavailable_guild(self.guild_id)
Event base for any guild ban or unban …
Event that is fired when the emojis in a guild are updated …
Event fired when an existing guild is updated …
Event base for any event that changes the visibility of a guild …
Event base for any integration related events …
Base class for any event that was shard-specific.
Base event type that all Hikari events should subclass.
Helper class that provides a standard way to create an ABC using inheritance.
abstract property app : RESTAware
App instance for this application.
RESTAware
abstract property guild_id : snowflakes.Snowflake
ID of the guild that this event relates to.
Snowflake
abstract property shard : gateway_shard.GatewayShard
Shard that received this event.
GatewayShard
async def fetch_guild() -> guilds.RESTGuild: ...
Perform an API call to get the guild that this event relates to.
RESTGuild
async def fetch_guild(self) -> guilds.RESTGuild:
"""Perform an API call to get the guild that this event relates to.
Returns
-------
hikari.guilds.RESTGuild
The guild this event occurred in.
"""
return await self.app.rest.fetch_guild(self.guild_id)
async def fetch_guild_preview() -> guilds.GuildPreview: ...
Perform an API call to get the preview of the event's guild.
GuildPreview
async def fetch_guild_preview(self) -> guilds.GuildPreview:
"""Perform an API call to get the preview of the event's guild.
Returns
-------
hikari.guilds.GuildPreview
The preview of the guild this event occurred in.
"""
return await self.app.rest.fetch_guild_preview(self.guild_id)
def get_guild() -> Optional[guilds.GatewayGuild]: ...
Get the cached guild that this event relates to, if known.
If not known, this will return None
instead.
Optional[GatewayGuild]
None
if not known.def get_guild(self) -> typing.Optional[guilds.GatewayGuild]:
"""Get the cached guild that this event relates to, if known.
If not known, this will return `builtins.None` instead.
Returns
-------
typing.Optional[hikari.guilds.GatewayGuild]
The guild this event relates to, or `builtins.None` if not known.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_available_guild(self.guild_id) or self.app.cache.get_unavailable_guild(self.guild_id)
def bitmask() -> int: ...
Inherited from:
ShardEvent
.bitmask
Bitmask for this event.
def dispatches() -> Sequence[Type[Event]]: ...
Inherited from:
ShardEvent
.dispatches
Sequence of the event classes this event is dispatched as.
class GuildJoinEvent (
*,
shard: gateway_shard.GatewayShard,
guild: guilds.GatewayGuild,
emojis: Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji],
roles: Mapping[snowflakes.Snowflake, guilds.Role],
channels: Mapping[snowflakes.Snowflake, channels_.GuildChannel],
members: Mapping[snowflakes.Snowflake, guilds.Member],
presences: Mapping[snowflakes.Snowflake, presences_.MemberPresence],
voice_states: Mapping[snowflakes.Snowflake, voices.VoiceState],
chunk_nonce: Optional[str] = None,
): ...
Event fired when the bot joins a new guild.
Note
Some fields like members
and presences
are included here but not on
the other GuildUpdateEvent
and GuildUnavailableEvent
guild visibility
event models.
This requires one of the following combinations of intents in order to be dispatched:
Method generated by attrs for class GuildJoinEvent.
class GuildJoinEvent(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 `GuildUpdateEvent` and `GuildUnavailableEvent` guild visibility
event models.
"""
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
guild: guilds.GatewayGuild = attr.field()
"""The guild the bot just joined."""
emojis: typing.Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji] = attr.field(repr=False)
"""Mapping of emoji IDs to the emojis in the guild."""
roles: typing.Mapping[snowflakes.Snowflake, guilds.Role] = attr.field(repr=False)
"""Mapping of role IDs to the roles in the guild."""
channels: typing.Mapping[snowflakes.Snowflake, channels_.GuildChannel] = attr.field(repr=False)
"""Mapping of channel IDs to the channels in the guild."""
members: typing.Mapping[snowflakes.Snowflake, guilds.Member] = attr.field(repr=False)
"""Mapping of user IDs to the members in the guild."""
presences: typing.Mapping[snowflakes.Snowflake, presences_.MemberPresence] = attr.field(repr=False)
"""Mapping of user IDs to the presences for the guild."""
voice_states: typing.Mapping[snowflakes.Snowflake, voices.VoiceState] = attr.field(repr=False)
"""Mapping of user IDs to the voice states active in this guild."""
chunk_nonce: typing.Optional[str] = attr.field(repr=False, default=None)
"""Nonce used to request the member chunks for this guild.
This will be `builtins.None` if no chunks were requested.
!!! note
This is a synthetic field.
"""
@property
def app(self) -> traits.RESTAware:
# <<inherited docstring from Event>>.
return self.guild.app
@property
def guild_id(self) -> snowflakes.Snowflake:
# <<inherited docstring from GuildEvent>>.
return self.guild.id
Event base for any event that changes the visibility of a guild …
Event base for any guild-bound event …
Base class for any event that was shard-specific.
Base event type that all Hikari events should subclass.
Helper class that provides a standard way to create an ABC using inheritance.
property app : RESTAware
App instance for this application.
RESTAware
property channels : Mapping[snowflakes.Snowflake, channels_.GuildChannel]
Mapping of channel IDs to the channels in the guild.
property chunk_nonce : Optional[str]
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.
property emojis : Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji]
Mapping of emoji IDs to the emojis in the guild.
property guild : guilds.GatewayGuild
The guild the bot just joined.
property guild_id : snowflakes.Snowflake
ID of the guild that this event relates to.
Snowflake
property members : Mapping[snowflakes.Snowflake, guilds.Member]
Mapping of user IDs to the members in the guild.
property presences : Mapping[snowflakes.Snowflake, presences_.MemberPresence]
Mapping of user IDs to the presences for the guild.
property roles : Mapping[snowflakes.Snowflake, guilds.Role]
Mapping of role IDs to the roles in the guild.
property shard : gateway_shard.GatewayShard
Shard that received this event.
GatewayShard
property voice_states : Mapping[snowflakes.Snowflake, voices.VoiceState]
Mapping of user IDs to the voice states active in this guild.
async def fetch_guild() -> guilds.RESTGuild: ...
Inherited from:
GuildVisibilityEvent
.fetch_guild
Perform an API call to get the guild that this event relates to.
RESTGuild
async def fetch_guild_preview() -> guilds.GuildPreview: ...
Inherited from:
GuildVisibilityEvent
.fetch_guild_preview
Perform an API call to get the preview of the event's guild.
GuildPreview
def get_guild() -> Optional[guilds.GatewayGuild]: ...
Inherited from:
GuildVisibilityEvent
.get_guild
Get the cached guild that this event relates to, if known.
If not known, this will return None
instead.
Optional[GatewayGuild]
None
if not known.def bitmask() -> int: ...
Inherited from:
GuildVisibilityEvent
.bitmask
Bitmask for this event.
def dispatches() -> Sequence[Type[Event]]: ...
Inherited from:
GuildVisibilityEvent
.dispatches
Sequence of the event classes this event is dispatched as.
class GuildLeaveEvent (
*,
app: traits.RESTAware,
shard: gateway_shard.GatewayShard,
guild_id: snowflakes.Snowflake,
old_guild: Optional[guilds.GatewayGuild],
): ...
Event fired when the bot is banned/kicked/leaves a guild.
This will also fire if the guild was deleted.
This requires one of the following combinations of intents in order to be dispatched:
Method generated by attrs for class GuildLeaveEvent.
class GuildLeaveEvent(GuildVisibilityEvent):
"""Event fired when the bot is banned/kicked/leaves a guild.
This will also fire if the guild was deleted.
"""
app: traits.RESTAware = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from Event>>.
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
guild_id: snowflakes.Snowflake = attr.field()
# <<inherited docstring from GuildEvent>>.
old_guild: typing.Optional[guilds.GatewayGuild] = attr.field()
"""The old guild object.
This will be `builtins.None` if the guild missing from the cache.
"""
if typing.TYPE_CHECKING:
# This should always fail.
async def fetch_guild(self) -> typing.NoReturn:
...
Event base for any event that changes the visibility of a guild …
Event base for any guild-bound event …
Base class for any event that was shard-specific.
Base event type that all Hikari events should subclass.
Helper class that provides a standard way to create an ABC using inheritance.
property app : traits.RESTAware
App instance for this application.
RESTAware
property guild_id : snowflakes.Snowflake
ID of the guild that this event relates to.
Snowflake
property old_guild : Optional[guilds.GatewayGuild]
The old guild object.
This will be None
if the guild missing from the cache.
property shard : gateway_shard.GatewayShard
Shard that received this event.
GatewayShard
async def fetch_guild() -> guilds.RESTGuild: ...
Inherited from:
GuildVisibilityEvent
.fetch_guild
Perform an API call to get the guild that this event relates to.
RESTGuild
async def fetch_guild_preview() -> guilds.GuildPreview: ...
Inherited from:
GuildVisibilityEvent
.fetch_guild_preview
Perform an API call to get the preview of the event's guild.
GuildPreview
def get_guild() -> Optional[guilds.GatewayGuild]: ...
Inherited from:
GuildVisibilityEvent
.get_guild
Get the cached guild that this event relates to, if known.
If not known, this will return None
instead.
Optional[GatewayGuild]
None
if not known.def bitmask() -> int: ...
Inherited from:
GuildVisibilityEvent
.bitmask
Bitmask for this event.
def dispatches() -> Sequence[Type[Event]]: ...
Inherited from:
GuildVisibilityEvent
.dispatches
Sequence of the event classes this event is dispatched as.
class GuildUpdateEvent (
*,
shard: gateway_shard.GatewayShard,
old_guild: Optional[guilds.GatewayGuild],
guild: guilds.GatewayGuild,
emojis: Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji],
roles: Mapping[snowflakes.Snowflake, guilds.Role],
): ...
Event fired when an existing guild is updated.
This requires one of the following combinations of intents in order to be dispatched:
Method generated by attrs for class GuildUpdateEvent.
class GuildUpdateEvent(GuildEvent):
"""Event fired when an existing guild is updated."""
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
old_guild: typing.Optional[guilds.GatewayGuild] = attr.field()
"""The old guild object.
This will be `builtins.None` if the guild missing from the cache.
"""
guild: guilds.GatewayGuild = attr.field()
"""Guild that was just updated.
Returns
-------
hikari.guilds.Guild
The guild that relates to this event.
"""
emojis: typing.Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji] = attr.field(repr=False)
"""Mapping of emoji IDs to the emojis in the guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.emojis.KnownCustomEmoji]
The emojis in the guild.
"""
roles: typing.Mapping[snowflakes.Snowflake, guilds.Role] = attr.field(repr=False)
"""Mapping of role IDs to the roles in the guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.guilds.Role]
The roles in the guild.
"""
@property
def app(self) -> traits.RESTAware:
# <<inherited docstring from Event>>.
return self.guild.app
@property
def guild_id(self) -> snowflakes.Snowflake:
# <<inherited docstring from GuildEvent>>.
return self.guild.id
Event base for any guild-bound event …
Base class for any event that was shard-specific.
Base event type that all Hikari events should subclass.
Helper class that provides a standard way to create an ABC using inheritance.
property app : RESTAware
App instance for this application.
RESTAware
property emojis : Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji]
Mapping of emoji IDs to the emojis in the guild.
Mapping[Snowflake, KnownCustomEmoji]
property guild : guilds.GatewayGuild
Guild that was just updated.
Guild
property guild_id : snowflakes.Snowflake
ID of the guild that this event relates to.
Snowflake
property old_guild : Optional[guilds.GatewayGuild]
The old guild object.
This will be None
if the guild missing from the cache.
property roles : Mapping[snowflakes.Snowflake, guilds.Role]
Mapping of role IDs to the roles in the guild.
property shard : gateway_shard.GatewayShard
Shard that received this event.
GatewayShard
async def fetch_guild() -> guilds.RESTGuild: ...
Inherited from:
GuildEvent
.fetch_guild
Perform an API call to get the guild that this event relates to.
RESTGuild
async def fetch_guild_preview() -> guilds.GuildPreview: ...
Inherited from:
GuildEvent
.fetch_guild_preview
Perform an API call to get the preview of the event's guild.
GuildPreview
def get_guild() -> Optional[guilds.GatewayGuild]: ...
Inherited from:
GuildEvent
.get_guild
Get the cached guild that this event relates to, if known.
If not known, this will return None
instead.
Optional[GatewayGuild]
None
if not known.def bitmask() -> int: ...
Inherited from:
GuildEvent
.bitmask
Bitmask for this event.
def dispatches() -> Sequence[Type[Event]]: ...
Inherited from:
GuildEvent
.dispatches
Sequence of the event classes this event is dispatched as.
class GuildVisibilityEvent: ...
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.
This requires one of the following combinations of intents in order to be dispatched:
class GuildVisibilityEvent(GuildEvent, abc.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.
"""
__slots__: typing.Sequence[str] = ()
Event fired when a guild becomes available …
Event fired when the bot joins a new guild …
Event fired when the bot is banned/kicked/leaves a guild …
Event fired when a guild becomes unavailable because of an outage …
Event base for any guild-bound event …
Base class for any event that was shard-specific.
Base event type that all Hikari events should subclass.
Helper class that provides a standard way to create an ABC using inheritance.
abstract property app : RESTAware
App instance for this application.
RESTAware
abstract property guild_id : snowflakes.Snowflake
ID of the guild that this event relates to.
Snowflake
abstract property shard : gateway_shard.GatewayShard
Shard that received this event.
GatewayShard
async def fetch_guild() -> guilds.RESTGuild: ...
Inherited from:
GuildEvent
.fetch_guild
Perform an API call to get the guild that this event relates to.
RESTGuild
async def fetch_guild_preview() -> guilds.GuildPreview: ...
Inherited from:
GuildEvent
.fetch_guild_preview
Perform an API call to get the preview of the event's guild.
GuildPreview
def get_guild() -> Optional[guilds.GatewayGuild]: ...
Inherited from:
GuildEvent
.get_guild
Get the cached guild that this event relates to, if known.
If not known, this will return None
instead.
Optional[GatewayGuild]
None
if not known.def bitmask() -> int: ...
Inherited from:
GuildEvent
.bitmask
Bitmask for this event.
def dispatches() -> Sequence[Type[Event]]: ...
Inherited from:
GuildEvent
.dispatches
Sequence of the event classes this event is dispatched as.
class IntegrationCreateEvent (
*,
app: traits.RESTAware,
shard: gateway_shard.GatewayShard,
integration: guilds.Integration,
): ...
Event that is fired when an integration is created in a guild.
This requires one of the following combinations of intents in order to be dispatched:
Method generated by attrs for class IntegrationCreateEvent.
class IntegrationCreateEvent(IntegrationEvent):
"""Event that is fired when an integration is created in a guild."""
app: traits.RESTAware = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from Event>>.
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
integration: guilds.Integration = attr.field()
"""Integration that was created."""
@property
def application_id(self) -> typing.Optional[snowflakes.Snowflake]:
# <<inherited docstring from IntegrationEvent>>.
return self.integration.application.id if self.integration.application else None
@property
def guild_id(self) -> snowflakes.Snowflake:
# <<inherited docstring from ShardEvent>>.
return self.integration.guild_id
@property
def id(self) -> snowflakes.Snowflake:
# <<inherited docstring from IntegrationEvent>>
return self.integration.id
Event base for any integration related events …
Event base for any guild-bound event …
Base class for any event that was shard-specific.
Base event type that all Hikari events should subclass.
Helper class that provides a standard way to create an ABC using inheritance.
property app : traits.RESTAware
App instance for this application.
RESTAware
property application_id : Optional[snowflakes.Snowflake]
ID of Discord bot application this integration is connected to.
property guild_id : snowflakes.Snowflake
ID of the guild that this event relates to.
Snowflake
property id : snowflakes.Snowflake
ID of the integration.
Snowflake
property integration : guilds.Integration
Integration that was created.
property shard : gateway_shard.GatewayShard
Shard that received this event.
GatewayShard
async def fetch_guild() -> guilds.RESTGuild: ...
Inherited from:
IntegrationEvent
.fetch_guild
Perform an API call to get the guild that this event relates to.
RESTGuild
async def fetch_guild_preview() -> guilds.GuildPreview: ...
Inherited from:
IntegrationEvent
.fetch_guild_preview
Perform an API call to get the preview of the event's guild.
GuildPreview
async def fetch_integrations() -> Sequence[guilds.Integration]: ...
Inherited from:
IntegrationEvent
.fetch_integrations
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.
Sequence[Integration]
def get_guild() -> Optional[guilds.GatewayGuild]: ...
Inherited from:
IntegrationEvent
.get_guild
Get the cached guild that this event relates to, if known.
If not known, this will return None
instead.
Optional[GatewayGuild]
None
if not known.def bitmask() -> int: ...
Inherited from:
IntegrationEvent
.bitmask
Bitmask for this event.
def dispatches() -> Sequence[Type[Event]]: ...
Inherited from:
IntegrationEvent
.dispatches
Sequence of the event classes this event is dispatched as.
class IntegrationDeleteEvent (
*,
app: traits.RESTAware,
shard: gateway_shard.GatewayShard,
application_id: Optional[snowflakes.Snowflake],
guild_id: snowflakes.Snowflake,
id: snowflakes.Snowflake,
): ...
Event that is fired when an integration is deleted in a guild.
This requires one of the following combinations of intents in order to be dispatched:
Method generated by attrs for class IntegrationDeleteEvent.
class IntegrationDeleteEvent(IntegrationEvent):
"""Event that is fired when an integration is deleted in a guild."""
app: traits.RESTAware = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from Event>>.
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
application_id: typing.Optional[snowflakes.Snowflake] = attr.field()
# <<inherited docstring from IntegrationEvent>>.
guild_id: snowflakes.Snowflake = attr.field()
# <<inherited docstring from ShardEvent>>.
id: snowflakes.Snowflake = attr.field()
# <<inherited docstring from IntegrationEvent>>
Event base for any integration related events …
Event base for any guild-bound event …
Base class for any event that was shard-specific.
Base event type that all Hikari events should subclass.
Helper class that provides a standard way to create an ABC using inheritance.
property app : traits.RESTAware
App instance for this application.
RESTAware
property application_id : Optional[snowflakes.Snowflake]
ID of Discord bot application this integration is connected to.
property guild_id : snowflakes.Snowflake
ID of the guild that this event relates to.
Snowflake
property id : snowflakes.Snowflake
ID of the integration.
Snowflake
property shard : gateway_shard.GatewayShard
Shard that received this event.
GatewayShard
async def fetch_guild() -> guilds.RESTGuild: ...
Inherited from:
IntegrationEvent
.fetch_guild
Perform an API call to get the guild that this event relates to.
RESTGuild
async def fetch_guild_preview() -> guilds.GuildPreview: ...
Inherited from:
IntegrationEvent
.fetch_guild_preview
Perform an API call to get the preview of the event's guild.
GuildPreview
async def fetch_integrations() -> Sequence[guilds.Integration]: ...
Inherited from:
IntegrationEvent
.fetch_integrations
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.
Sequence[Integration]
def get_guild() -> Optional[guilds.GatewayGuild]: ...
Inherited from:
IntegrationEvent
.get_guild
Get the cached guild that this event relates to, if known.
If not known, this will return None
instead.
Optional[GatewayGuild]
None
if not known.def bitmask() -> int: ...
Inherited from:
IntegrationEvent
.bitmask
Bitmask for this event.
def dispatches() -> Sequence[Type[Event]]: ...
Inherited from:
IntegrationEvent
.dispatches
Sequence of the event classes this event is dispatched as.
class IntegrationEvent: ...
Event base for any integration related events.
This requires one of the following combinations of intents in order to be dispatched:
class IntegrationEvent(GuildEvent, abc.ABC):
"""Event base for any integration related events."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def application_id(self) -> typing.Optional[snowflakes.Snowflake]:
"""ID of Discord bot application this integration is connected to.
Returns
-------
typing.Optional[hikari.snowflakes.Snowflake]
The ID of Discord bot application this integration is connected to.
"""
@property
@abc.abstractmethod
def id(self) -> snowflakes.Snowflake:
"""ID of the integration.
Returns
-------
hikari.snowflakes.Snowflake
The ID of the integration.
"""
async def fetch_integrations(self) -> typing.Sequence[guilds.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
-------
typing.Sequence[hikari.guilds.Integration]
Some possibly random subset of the integrations in a guild,
probably.
"""
return await self.app.rest.fetch_integrations(self.guild_id)
Event that is fired when an integration is created in a guild …
Event that is fired when an integration is deleted in a guild …
Event that is fired when an integration is updated in a guild …
Event base for any guild-bound event …
Base class for any event that was shard-specific.
Base event type that all Hikari events should subclass.
Helper class that provides a standard way to create an ABC using inheritance.
abstract property app : RESTAware
App instance for this application.
RESTAware
abstract property application_id : Optional[snowflakes.Snowflake]
ID of Discord bot application this integration is connected to.
abstract property guild_id : snowflakes.Snowflake
ID of the guild that this event relates to.
Snowflake
abstract property id : snowflakes.Snowflake
ID of the integration.
Snowflake
abstract property shard : gateway_shard.GatewayShard
Shard that received this event.
GatewayShard
async def fetch_guild() -> guilds.RESTGuild: ...
Inherited from:
GuildEvent
.fetch_guild
Perform an API call to get the guild that this event relates to.
RESTGuild
async def fetch_guild_preview() -> guilds.GuildPreview: ...
Inherited from:
GuildEvent
.fetch_guild_preview
Perform an API call to get the preview of the event's guild.
GuildPreview
async def fetch_integrations() -> Sequence[guilds.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.
Sequence[Integration]
async def fetch_integrations(self) -> typing.Sequence[guilds.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
-------
typing.Sequence[hikari.guilds.Integration]
Some possibly random subset of the integrations in a guild,
probably.
"""
return await self.app.rest.fetch_integrations(self.guild_id)
def get_guild() -> Optional[guilds.GatewayGuild]: ...
Inherited from:
GuildEvent
.get_guild
Get the cached guild that this event relates to, if known.
If not known, this will return None
instead.
Optional[GatewayGuild]
None
if not known.def bitmask() -> int: ...
Inherited from:
GuildEvent
.bitmask
Bitmask for this event.
def dispatches() -> Sequence[Type[Event]]: ...
Inherited from:
GuildEvent
.dispatches
Sequence of the event classes this event is dispatched as.
class IntegrationUpdateEvent (
*,
app: traits.RESTAware,
shard: gateway_shard.GatewayShard,
integration: guilds.Integration,
): ...
Event that is fired when an integration is updated in a guild.
This requires one of the following combinations of intents in order to be dispatched:
Method generated by attrs for class IntegrationUpdateEvent.
class IntegrationUpdateEvent(IntegrationEvent):
"""Event that is fired when an integration is updated in a guild."""
app: traits.RESTAware = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from Event>>.
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
integration: guilds.Integration = attr.field()
"""Integration that was updated."""
@property
def application_id(self) -> typing.Optional[snowflakes.Snowflake]:
# <<inherited docstring from IntegrationEvent>>.
return self.integration.application.id if self.integration.application else None
@property
def guild_id(self) -> snowflakes.Snowflake:
# <<inherited docstring from GuildEvent>>.
return self.integration.guild_id
@property
def id(self) -> snowflakes.Snowflake:
# <<inherited docstring from IntegrationEvent>>
return self.integration.id
Event base for any integration related events …
Event base for any guild-bound event …
Base class for any event that was shard-specific.
Base event type that all Hikari events should subclass.
Helper class that provides a standard way to create an ABC using inheritance.
property app : traits.RESTAware
App instance for this application.
RESTAware
property application_id : Optional[snowflakes.Snowflake]
ID of Discord bot application this integration is connected to.
property guild_id : snowflakes.Snowflake
ID of the guild that this event relates to.
Snowflake
property id : snowflakes.Snowflake
ID of the integration.
Snowflake
property integration : guilds.Integration
Integration that was updated.
property shard : gateway_shard.GatewayShard
Shard that received this event.
GatewayShard
async def fetch_guild() -> guilds.RESTGuild: ...
Inherited from:
IntegrationEvent
.fetch_guild
Perform an API call to get the guild that this event relates to.
RESTGuild
async def fetch_guild_preview() -> guilds.GuildPreview: ...
Inherited from:
IntegrationEvent
.fetch_guild_preview
Perform an API call to get the preview of the event's guild.
GuildPreview
async def fetch_integrations() -> Sequence[guilds.Integration]: ...
Inherited from:
IntegrationEvent
.fetch_integrations
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.
Sequence[Integration]
def get_guild() -> Optional[guilds.GatewayGuild]: ...
Inherited from:
IntegrationEvent
.get_guild
Get the cached guild that this event relates to, if known.
If not known, this will return None
instead.
Optional[GatewayGuild]
None
if not known.def bitmask() -> int: ...
Inherited from:
IntegrationEvent
.bitmask
Bitmask for this event.
def dispatches() -> Sequence[Type[Event]]: ...
Inherited from:
IntegrationEvent
.dispatches
Sequence of the event classes this event is dispatched as.
class PresenceUpdateEvent (
*,
shard: gateway_shard.GatewayShard,
old_presence: Optional[presences_.MemberPresence],
presence: presences_.MemberPresence,
user: Optional[users.PartialUser],
): ...
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.
This requires one of the following combinations of intents in order to be dispatched:
Method generated by attrs for class PresenceUpdateEvent.
class PresenceUpdateEvent(shard_events.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.
"""
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
# <<inherited docstring from ShardEvent>>.
old_presence: typing.Optional[presences_.MemberPresence] = attr.field()
"""The old member presence object.
This will be `builtins.None` if the member presence missing from the cache.
"""
presence: presences_.MemberPresence = attr.field()
"""Member presence.
Returns
-------
hikari.presences.MemberPresence
Presence for the user in this guild.
"""
user: typing.Optional[users.PartialUser] = attr.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 `builtins.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.
Returns
-------
typing.Optional[hikari.users.PartialUser]
The partial user containing the updated fields.
"""
@property
def app(self) -> traits.RESTAware:
# <<inherited docstring from Event>>.
return self.presence.app
@property
def user_id(self) -> snowflakes.Snowflake:
"""User ID of the user that updated their presence.
Returns
-------
hikari.snowflakes.Snowflake
ID of the user the event concerns.
"""
return self.presence.user_id
@property
def guild_id(self) -> snowflakes.Snowflake:
"""Guild ID that the presence was updated in.
Returns
-------
hikari.snowflakes.Snowflake
ID of the guild the event occurred in.
"""
return self.presence.guild_id
def get_user(self) -> typing.Optional[users.User]:
"""Get the full cached user, if it is available.
Returns
-------
typing.Optional[hikari.users.User]
The full cached user, or `builtins.None` if not cached.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_user(self.user_id)
async def fetch_user(self) -> users.User:
"""Perform an API call to fetch the user this event concerns.
Returns
-------
hikari.users.User
The user affected by this event.
"""
return await self.app.rest.fetch_user(self.user_id)
Base class for any event that was shard-specific.
Base event type that all Hikari events should subclass.
Helper class that provides a standard way to create an ABC using inheritance.
property app : RESTAware
App instance for this application.
RESTAware
property guild_id : snowflakes.Snowflake
Guild ID that the presence was updated in.
Snowflake
property old_presence : Optional[presences_.MemberPresence]
The old member presence object.
This will be None
if the member presence missing from the cache.
property presence : presences_.MemberPresence
Member presence.
MemberPresence
property shard : gateway_shard.GatewayShard
Shard that received this event.
GatewayShard
property user : Optional[users.PartialUser]
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.
Optional[PartialUser]
property user_id : snowflakes.Snowflake
User ID of the user that updated their presence.
Snowflake
async def fetch_user() -> users.User: ...
Perform an API call to fetch the user this event concerns.
User
async def fetch_user(self) -> users.User:
"""Perform an API call to fetch the user this event concerns.
Returns
-------
hikari.users.User
The user affected by this event.
"""
return await self.app.rest.fetch_user(self.user_id)
def get_user() -> Optional[users.User]: ...
Get the full cached user, if it is available.
def get_user(self) -> typing.Optional[users.User]:
"""Get the full cached user, if it is available.
Returns
-------
typing.Optional[hikari.users.User]
The full cached user, or `builtins.None` if not cached.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_user(self.user_id)
def bitmask() -> int: ...
Inherited from:
ShardEvent
.bitmask
Bitmask for this event.
def dispatches() -> Sequence[Type[Event]]: ...
Inherited from:
ShardEvent
.dispatches
Sequence of the event classes this event is dispatched as.