class AuditLog (
    *,
    entries: Mapping[snowflakes.Snowflake, AuditLogEntry],
    integrations: Mapping[snowflakes.Snowflake, guilds.PartialIntegration],
    users: Mapping[snowflakes.Snowflake, users_.User],
    webhooks: Mapping[snowflakes.Snowflake, webhooks_.PartialWebhook],
): ...

Represents a guilds audit log's page.

Method generated by attrs for class AuditLog.

class AuditLog(typing.Sequence[AuditLogEntry]):
    """Represents a guilds audit log's page."""

    entries: typing.Mapping[snowflakes.Snowflake, AuditLogEntry] = attr.field(repr=False)
    """A mapping of snowflake IDs to the audit log's entries."""

    integrations: typing.Mapping[snowflakes.Snowflake, guilds.PartialIntegration] = attr.field(repr=False)
    """A mapping of the partial objects of integrations found in this audit log."""

    users: typing.Mapping[snowflakes.Snowflake, users_.User] = attr.field(repr=False)
    """A mapping of the objects of users found in this audit log."""

    webhooks: typing.Mapping[snowflakes.Snowflake, webhooks_.PartialWebhook] = attr.field(repr=False)
    """A mapping of the objects of webhooks found in this audit log."""

    @typing.overload
    def __getitem__(self, index: int, /) -> AuditLogEntry:
        ...

    @typing.overload
    def __getitem__(self, slice_: slice, /) -> typing.Sequence[AuditLogEntry]:
        ...

    def __getitem__(
        self, index_or_slice: typing.Union[int, slice], /
    ) -> typing.Union[AuditLogEntry, typing.Sequence[AuditLogEntry]]:
        return collections.get_index_or_slice(self.entries, index_or_slice)

    def __iter__(self) -> typing.Iterator[AuditLogEntry]:
        return iter(self.entries.values())

    def __len__(self) -> int:
        return len(self.entries)

Method resolution order

dataclass AuditLog

That's this class!

extern class collections.abc.Sequence

All the operations on a read-only sequence …

extern class collections.abc.Reversible

extern class collections.abc.Collection

extern class collections.abc.Sized

extern class collections.abc.Iterable

extern class collections.abc.Container

extern class Generic

Abstract base class for generic types …

Variables and properties

property entries : Mapping[snowflakes.Snowflake, AuditLogEntry]

A mapping of snowflake IDs to the audit log's entries.

property integrations : Mapping[snowflakes.Snowflake, guilds.PartialIntegration]

A mapping of the partial objects of integrations found in this audit log.

property users : Mapping[snowflakes.Snowflake, users_.User]

A mapping of the objects of users found in this audit log.

property webhooks : Mapping[snowflakes.Snowflake, webhooks_.PartialWebhook]

A mapping of the objects of webhooks found in this audit log.

class AuditLogChange (
    *,
    new_value: Optional[Any],
    old_value: Optional[Any],
    key: Union[AuditLogChangeKey, str],
): ...

Represents a change made to an audit log entry's target entity.

Method generated by attrs for class AuditLogChange.

class AuditLogChange:
    """Represents a change made to an audit log entry's target entity."""

    new_value: typing.Optional[typing.Any] = attr.field(repr=True)
    """The new value of the key, if something was added or changed."""

    old_value: typing.Optional[typing.Any] = attr.field(repr=True)
    """The old value of the key, if something was removed or changed."""

    key: typing.Union[AuditLogChangeKey, str] = attr.field(repr=True)
    """The name of the audit log change's key."""

Variables and properties

property key : Union[AuditLogChangeKey, str]

The name of the audit log change's key.

property new_value : Optional[Any]

The new value of the key, if something was added or changed.

property old_value : Optional[Any]

The old value of the key, if something was removed or changed.

class AuditLogChangeKey (
    value: Any,
): ...

Commonly known and documented keys for audit log change objects.

Others may exist. These should be expected to default to the raw string Discord provided us. These are defined for documentation purposes and can be treated as regular strings for all other purposes.

class AuditLogChangeKey(str, enums.Enum):
    """Commonly known and documented keys for audit log change objects.

    Others may exist. These should be expected to default to the raw string
    Discord provided us. These are defined for documentation purposes and
    can be treated as regular strings for all other purposes.
    """

    NAME = "name"
    DESCRIPTION = "description"
    ICON_HASH = "icon_hash"
    SPLASH_HASH = "splash_hash"
    DISCOVERY_SPLASH_HASH = "discovery_splash_hash"
    BANNER_HASH = "banner_hash"
    OWNER_ID = "owner_id"
    REGION = "region"  # TODO: remove when this disappears for the most part
    PREFERRED_LOCALE = "preferred_locale"
    RTC_REGION = "rtc_region"
    AFK_CHANNEL_ID = "afk_channel_id"
    AFK_TIMEOUT = "afk_timeout"
    RULES_CHANNEL_ID = "rules_channel_id"
    PUBLIC_UPDATES_CHANNEL_ID = "public_updates_channel_id"
    MFA_LEVEL = "mfa_level"
    VERIFICATION_LEVEL = "verification_level"
    EXPLICIT_CONTENT_FILTER = "explicit_content_filter"
    DEFAULT_MESSAGE_NOTIFICATIONS = "default_message_notifications"
    VANITY_URL_CODE = "vanity_url_code"
    PRUNE_DELETE_DAYS = "prune_delete_days"
    WIDGET_ENABLED = "widget_enabled"
    WIDGET_CHANNEL_ID = "widget_channel_id"
    POSITION = "position"
    TOPIC = "topic"
    BITRATE = "bitrate"
    PERMISSION_OVERWRITES = "permission_overwrites"
    NSFW = "nsfw"
    APPLICATION_ID = "application_id"
    PERMISSIONS = "permissions"
    USER_LIMIT = "user_limit"
    COLOR = "color"
    COMMAND_ID = "command_id"
    HOIST = "hoist"
    MENTIONABLE = "mentionable"
    ALLOW = "allow"
    DENY = "deny"
    INVITE_CODE = "code"
    CHANNEL_ID = "channel_id"
    INVITER_ID = "inviter_id"
    MAX_USES = "max_uses"
    USES = "uses"
    MAX_AGE = "max_age"
    TEMPORARY = "temporary"
    DEAF = "deaf"
    MUTE = "mute"
    NICK = "nick"
    AVATAR_HASH = "avatar_hash"
    ID = "id"
    TYPE = "type"
    ENABLE_EMOTICONS = "enable_emoticons"
    EXPIRE_BEHAVIOR = "expire_behavior"
    EXPIRE_GRACE_PERIOD = "expire_grace_period"
    RATE_LIMIT_PER_USER = "rate_limit_per_user"
    SYSTEM_CHANNEL_ID = "system_channel_id"
    TAGS = "tags"
    FORMAT_TYPE = "format_type"
    ASSETS = "asset"
    AVAILABLE = "available"
    GUILD_ID = "guild_id"

    # Who needs consistency?
    ADD_ROLE_TO_MEMBER = "$add"
    REMOVE_ROLE_FROM_MEMBER = "$remove"

    COLOUR = COLOR
    """Alias for "COLOR"""

Method resolution order

enum AuditLogChangeKey

That's this class!

extern class str

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str …

enum Enum

Clone of Python's enum.Enum implementation …

Variables and properties

property name : str

Return the name of the enum member as a str.

property value

Return the value of the enum member.

const ADD_ROLE_TO_MEMBER = '$add'

const AFK_CHANNEL_ID = 'afk_channel_id'

const AFK_TIMEOUT = 'afk_timeout'

const ALLOW = 'allow'

const APPLICATION_ID = 'application_id'

const ASSETS = 'asset'

const AVAILABLE = 'available'

const AVATAR_HASH = 'avatar_hash'

const BANNER_HASH = 'banner_hash'

const BITRATE = 'bitrate'

const CHANNEL_ID = 'channel_id'

const COLOR = 'color'

const COLOUR = 'color'

Alias for "COLOR

const COMMAND_ID = 'command_id'

const DEAF = 'deaf'

const DEFAULT_MESSAGE_NOTIFICATIONS = 'default_message_notifications'

const DENY = 'deny'

const DESCRIPTION = 'description'

const DISCOVERY_SPLASH_HASH = 'discovery_splash_hash'

const ENABLE_EMOTICONS = 'enable_emoticons'

const EXPIRE_BEHAVIOR = 'expire_behavior'

const EXPIRE_GRACE_PERIOD = 'expire_grace_period'

const EXPLICIT_CONTENT_FILTER = 'explicit_content_filter'

const FORMAT_TYPE = 'format_type'

const GUILD_ID = 'guild_id'

const HOIST = 'hoist'

const ICON_HASH = 'icon_hash'

const ID = 'id'

const INVITER_ID = 'inviter_id'

const INVITE_CODE = 'code'

const MAX_AGE = 'max_age'

const MAX_USES = 'max_uses'

const MENTIONABLE = 'mentionable'

const MFA_LEVEL = 'mfa_level'

const MUTE = 'mute'

const NAME = 'name'

const NICK = 'nick'

const NSFW = 'nsfw'

const OWNER_ID = 'owner_id'

const PERMISSIONS = 'permissions'

const PERMISSION_OVERWRITES = 'permission_overwrites'

const POSITION = 'position'

const PREFERRED_LOCALE = 'preferred_locale'

const PRUNE_DELETE_DAYS = 'prune_delete_days'

const PUBLIC_UPDATES_CHANNEL_ID = 'public_updates_channel_id'

const RATE_LIMIT_PER_USER = 'rate_limit_per_user'

const REGION = 'region'

const REMOVE_ROLE_FROM_MEMBER = '$remove'

const RTC_REGION = 'rtc_region'

const RULES_CHANNEL_ID = 'rules_channel_id'

const SPLASH_HASH = 'splash_hash'

const SYSTEM_CHANNEL_ID = 'system_channel_id'

const TAGS = 'tags'

const TEMPORARY = 'temporary'

const TOPIC = 'topic'

const TYPE = 'type'

const USER_LIMIT = 'user_limit'

const USES = 'uses'

const VANITY_URL_CODE = 'vanity_url_code'

const VERIFICATION_LEVEL = 'verification_level'

const WIDGET_CHANNEL_ID = 'widget_channel_id'

const WIDGET_ENABLED = 'widget_enabled'

class AuditLogEntry (
    *,
    app: traits.RESTAware,
    id: snowflakes.Snowflake,
    target_id: Optional[snowflakes.Snowflake],
    changes: Sequence[AuditLogChange],
    user_id: Optional[snowflakes.Snowflake],
    action_type: Union[AuditLogEventType, int],
    options: Optional[BaseAuditLogEntryInfo],
    reason: Optional[str],
): ...

Represents an entry in a guild's audit log.

Method generated by attrs for class AuditLogEntry.

class AuditLogEntry(snowflakes.Unique):
    """Represents an entry in a guild's audit log."""

    app: traits.RESTAware = attr.field(
        repr=False, eq=False, hash=False, metadata={attr_extensions.SKIP_DEEP_COPY: True}
    )
    """The client application that models may use for procedures."""

    id: snowflakes.Snowflake = attr.field(hash=True, repr=True)
    """The ID of this entity."""

    target_id: typing.Optional[snowflakes.Snowflake] = attr.field(eq=False, hash=False, repr=True)
    """The ID of the entity affected by this change, if applicable."""

    changes: typing.Sequence[AuditLogChange] = attr.field(eq=False, hash=False, repr=False)
    """A sequence of the changes made to `AuditLogEntry.target_id`."""

    user_id: typing.Optional[snowflakes.Snowflake] = attr.field(eq=False, hash=False, repr=True)
    """The ID of the user who made this change."""

    action_type: typing.Union[AuditLogEventType, int] = attr.field(eq=False, hash=False, repr=True)
    """The type of action this entry represents."""

    options: typing.Optional[BaseAuditLogEntryInfo] = attr.field(eq=False, hash=False, repr=False)
    """Extra information about this entry. Only be provided for certain `event_type`."""

    reason: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
    """The reason for this change, if set (between 0-512 characters)."""

    async def fetch_user(self) -> typing.Optional[users_.User]:
        """Fetch the user who made this change.

        Returns
        -------
        typing.Optional[hikari.users.User]
            The user who made this change, if available.

        Raises
        ------
        hikari.errors.UnauthorizedError
            If you are unauthorized to make the request (invalid/missing token).
        hikari.errors.NotFoundError
            If the user is not found.
        hikari.errors.RateLimitTooLongError
            Raised in the event that a rate limit occurs that is
            longer than `max_rate_limit` when making a request.
        hikari.errors.RateLimitedError
            Usually, Hikari will handle and retry on hitting
            rate-limits automatically. This includes most bucket-specific
            rate-limits and global rate-limits. In some rare edge cases,
            however, Discord implements other undocumented rules for
            rate-limiting, such as limits per attribute. These cannot be
            detected or handled normally by Hikari due to their undocumented
            nature, and will trigger this exception if they occur.
        hikari.errors.InternalServerError
            If an internal error occurs on Discord while handling the request.
        """
        if self.user_id is None:
            return None
        return await self.app.rest.fetch_user(self.user_id)

Method resolution order

dataclass AuditLogEntry

That's this class!

abstract class Unique

Mixin for a class that enforces uniqueness by a snowflake ID.

extern class abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Variables and properties

property action_type : Union[AuditLogEventType, int]

The type of action this entry represents.

property app : traits.RESTAware

The client application that models may use for procedures.

property changes : Sequence[AuditLogChange]

A sequence of the changes made to target_id.

property created_at : datetime.datetime

When the object was created.

property id : snowflakes.Snowflake

The ID of this entity.

property options : Optional[BaseAuditLogEntryInfo]

Extra information about this entry. Only be provided for certain event_type.

property reason : Optional[str]

The reason for this change, if set (between 0-512 characters).

property target_id : Optional[snowflakes.Snowflake]

The ID of the entity affected by this change, if applicable.

property user_id : Optional[snowflakes.Snowflake]

The ID of the user who made this change.

Methods

async def fetch_user() -> Optional[users_.User]: ...

Fetch the user who made this change.

Returns

Optional[User]

The user who made this change, if available.

Raises

UnauthorizedError

If you are unauthorized to make the request (invalid/missing token).

NotFoundError

If the user is not found.

RateLimitTooLongError

Raised in the event that a rate limit occurs that is longer than max_rate_limit when making a request.

RateLimitedError

Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.

InternalServerError

If an internal error occurs on Discord while handling the request.

Expand source code
Browse git

async def fetch_user(self) -> typing.Optional[users_.User]:
    """Fetch the user who made this change.

    Returns
    -------
    typing.Optional[hikari.users.User]
        The user who made this change, if available.

    Raises
    ------
    hikari.errors.UnauthorizedError
        If you are unauthorized to make the request (invalid/missing token).
    hikari.errors.NotFoundError
        If the user is not found.
    hikari.errors.RateLimitTooLongError
        Raised in the event that a rate limit occurs that is
        longer than `max_rate_limit` when making a request.
    hikari.errors.RateLimitedError
        Usually, Hikari will handle and retry on hitting
        rate-limits automatically. This includes most bucket-specific
        rate-limits and global rate-limits. In some rare edge cases,
        however, Discord implements other undocumented rules for
        rate-limiting, such as limits per attribute. These cannot be
        detected or handled normally by Hikari due to their undocumented
        nature, and will trigger this exception if they occur.
    hikari.errors.InternalServerError
        If an internal error occurs on Discord while handling the request.
    """
    if self.user_id is None:
        return None
    return await self.app.rest.fetch_user(self.user_id)

class AuditLogEventType (
    value: Any,
): ...

The type of event that occurred.

class AuditLogEventType(int, enums.Enum):
    """The type of event that occurred."""

    GUILD_UPDATE = 1
    CHANNEL_CREATE = 10
    CHANNEL_UPDATE = 11
    CHANNEL_DELETE = 12
    CHANNEL_OVERWRITE_CREATE = 13
    CHANNEL_OVERWRITE_UPDATE = 14
    CHANNEL_OVERWRITE_DELETE = 15
    MEMBER_KICK = 20
    MEMBER_PRUNE = 21
    MEMBER_BAN_ADD = 22
    MEMBER_BAN_REMOVE = 23
    MEMBER_UPDATE = 24
    MEMBER_ROLE_UPDATE = 25
    MEMBER_MOVE = 26
    MEMBER_DISCONNECT = 27
    BOT_ADD = 28
    ROLE_CREATE = 30
    ROLE_UPDATE = 31
    ROLE_DELETE = 32
    INVITE_CREATE = 40
    INVITE_UPDATE = 41
    INVITE_DELETE = 42
    WEBHOOK_CREATE = 50
    WEBHOOK_UPDATE = 51
    WEBHOOK_DELETE = 52
    EMOJI_CREATE = 60
    EMOJI_UPDATE = 61
    EMOJI_DELETE = 62
    MESSAGE_DELETE = 72
    MESSAGE_BULK_DELETE = 73
    MESSAGE_PIN = 74
    MESSAGE_UNPIN = 75
    INTEGRATION_CREATE = 80
    INTEGRATION_UPDATE = 81
    INTEGRATION_DELETE = 82
    STICKER_CREATE = 90
    STICKER_UPDATE = 91
    STICKER_DELETE = 92
    GUILD_SCHEDULED_EVENT_CREATE = 100
    GUILD_SCHEDULED_EVENT_UPDATE = 101
    GUILD_SCHEDULED_EVENT_DELETE = 102
    APPLICATION_COMMAND_PERMISSION_UPDATE = 121

Method resolution order

enum AuditLogEventType

That's this class!

extern class int

int([x]) -> integer int(x, base=10) -> integer …

enum Enum

Clone of Python's enum.Enum implementation …

Variables and properties

property name : str

Return the name of the enum member as a str.

property value

Return the value of the enum member.

const APPLICATION_COMMAND_PERMISSION_UPDATE = 121

const BOT_ADD = 28

const CHANNEL_CREATE = 10

const CHANNEL_DELETE = 12

const CHANNEL_OVERWRITE_CREATE = 13

const CHANNEL_OVERWRITE_DELETE = 15

const CHANNEL_OVERWRITE_UPDATE = 14

const CHANNEL_UPDATE = 11

const EMOJI_CREATE = 60

const EMOJI_DELETE = 62

const EMOJI_UPDATE = 61

const GUILD_SCHEDULED_EVENT_CREATE = 100

const GUILD_SCHEDULED_EVENT_DELETE = 102

const GUILD_SCHEDULED_EVENT_UPDATE = 101

const GUILD_UPDATE = 1

const INTEGRATION_CREATE = 80

const INTEGRATION_DELETE = 82

const INTEGRATION_UPDATE = 81

const INVITE_CREATE = 40

const INVITE_DELETE = 42

const INVITE_UPDATE = 41

const MEMBER_BAN_ADD = 22

const MEMBER_BAN_REMOVE = 23

const MEMBER_DISCONNECT = 27

const MEMBER_KICK = 20

const MEMBER_MOVE = 26

const MEMBER_PRUNE = 21

const MEMBER_ROLE_UPDATE = 25

const MEMBER_UPDATE = 24

const MESSAGE_BULK_DELETE = 73

const MESSAGE_DELETE = 72

const MESSAGE_PIN = 74

const MESSAGE_UNPIN = 75

const ROLE_CREATE = 30

const ROLE_DELETE = 32

const ROLE_UPDATE = 31

const STICKER_CREATE = 90

const STICKER_DELETE = 92

const STICKER_UPDATE = 91

const WEBHOOK_CREATE = 50

const WEBHOOK_DELETE = 52

const WEBHOOK_UPDATE = 51

class BaseAuditLogEntryInfo (
    *,
    app: traits.RESTAware,
): ...

A base object that all audit log entry info objects will inherit from.

Method generated by attrs for class BaseAuditLogEntryInfo.

class BaseAuditLogEntryInfo(abc.ABC):
    """A base object that all audit log entry info objects will inherit from."""

    app: traits.RESTAware = attr.field(repr=False, eq=False, metadata={attr_extensions.SKIP_DEEP_COPY: True})
    """The client application that models may use for procedures."""

Subclasses

dataclass ChannelOverwriteEntryInfo

Represents the extra information for overwrite related audit log entries …

dataclass MemberDisconnectEntryInfo

Extra information for the voice chat member disconnect entry …

dataclass MemberPruneEntryInfo

Extra information attached to guild prune log entries …

dataclass MessageBulkDeleteEntryInfo

Extra information for the message bulk delete audit entry …

dataclass MessagePinEntryInfo

The extra information for message pin related audit log entries …

Method resolution order

dataclass BaseAuditLogEntryInfo

That's this class!

extern class abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Variables and properties

property app : traits.RESTAware

The client application that models may use for procedures.

class ChannelOverwriteEntryInfo (
    *,
    app: traits.RESTAware,
    id: snowflakes.Snowflake,
    type: Union[channels.PermissionOverwriteType, str],
    role_name: Optional[str],
): ...

Represents the extra information for overwrite related audit log entries.

Will be attached to the overwrite create, update and delete audit log entries.

Method generated by attrs for class ChannelOverwriteEntryInfo.

class ChannelOverwriteEntryInfo(BaseAuditLogEntryInfo, snowflakes.Unique):
    """Represents the extra information for overwrite related audit log entries.

    Will be attached to the overwrite create, update and delete audit log
    entries.
    """

    id: snowflakes.Snowflake = attr.field(hash=True, repr=True)
    """The ID of this entity."""

    type: typing.Union[channels.PermissionOverwriteType, str] = attr.field(repr=True)
    """The type of entity this overwrite targets."""

    role_name: typing.Optional[str] = attr.field(repr=True)
    """The name of the role this overwrite targets, if it targets a role."""

Method resolution order

dataclass ChannelOverwriteEntryInfo

That's this class!

dataclass BaseAuditLogEntryInfo

A base object that all audit log entry info objects will inherit from …

abstract class Unique

Mixin for a class that enforces uniqueness by a snowflake ID.

extern class abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Variables and properties

property app : traits.RESTAware

The client application that models may use for procedures.

property created_at : datetime.datetime

When the object was created.

property id : snowflakes.Snowflake

The ID of this entity.

property role_name : Optional[str]

The name of the role this overwrite targets, if it targets a role.

property type : Union[channels.PermissionOverwriteType, str]

The type of entity this overwrite targets.

class MemberDisconnectEntryInfo (
    *,
    app: traits.RESTAware,
    count: int,
): ...

Extra information for the voice chat member disconnect entry.

Method generated by attrs for class MemberDisconnectEntryInfo.

class MemberDisconnectEntryInfo(BaseAuditLogEntryInfo):
    """Extra information for the voice chat member disconnect entry."""

    count: int = attr.field(repr=True)
    """The amount of members who were disconnected from voice in this entry."""

Subclasses

dataclass MemberMoveEntryInfo

Extra information for the voice chat based member move entry …

Method resolution order

dataclass MemberDisconnectEntryInfo

That's this class!

dataclass BaseAuditLogEntryInfo

A base object that all audit log entry info objects will inherit from …

extern class abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Variables and properties

property app : traits.RESTAware

The client application that models may use for procedures.

property count : int

The amount of members who were disconnected from voice in this entry.

class MemberMoveEntryInfo (
    *,
    app: traits.RESTAware,
    count: int,
    channel_id: snowflakes.Snowflake,
): ...

Extra information for the voice chat based member move entry.

Method generated by attrs for class MemberMoveEntryInfo.

class MemberMoveEntryInfo(MemberDisconnectEntryInfo):
    """Extra information for the voice chat based member move entry."""

    channel_id: snowflakes.Snowflake = attr.field(repr=True)
    """The channel that the member(s) have been moved to"""

    async def fetch_channel(self) -> channels.GuildVoiceChannel:
        """Fetch the guild voice based channel where the member(s) have been moved to.

        Returns
        -------
        hikari.channels.GuildVoiceChannel
            The guild voice based channel where the member(s) have been moved to.

        Raises
        ------
        hikari.errors.UnauthorizedError
            If you are unauthorized to make the request (invalid/missing token).
        hikari.errors.ForbiddenError
            If you are missing the `READ_MESSAGES` permission in the channel.
        hikari.errors.NotFoundError
            If the channel is not found.
        hikari.errors.RateLimitTooLongError
            Raised in the event that a rate limit occurs that is
            longer than `max_rate_limit` when making a request.
        hikari.errors.RateLimitedError
            Usually, Hikari will handle and retry on hitting
            rate-limits automatically. This includes most bucket-specific
            rate-limits and global rate-limits. In some rare edge cases,
            however, Discord implements other undocumented rules for
            rate-limiting, such as limits per attribute. These cannot be
            detected or handled normally by Hikari due to their undocumented
            nature, and will trigger this exception if they occur.
        hikari.errors.InternalServerError
            If an internal error occurs on Discord while handling the request.
        """
        channel = await self.app.rest.fetch_channel(self.channel_id)
        assert isinstance(channel, channels.GuildVoiceChannel)
        return channel

Method resolution order

dataclass MemberMoveEntryInfo

That's this class!

dataclass MemberDisconnectEntryInfo

Extra information for the voice chat member disconnect entry …

dataclass BaseAuditLogEntryInfo

A base object that all audit log entry info objects will inherit from …

extern class abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Variables and properties

property app : traits.RESTAware

The client application that models may use for procedures.

property channel_id : snowflakes.Snowflake

The channel that the member(s) have been moved to

property count : int

The amount of members who were disconnected from voice in this entry.

Methods

async def fetch_channel() -> GuildVoiceChannel: ...

Fetch the guild voice based channel where the member(s) have been moved to.

Returns

GuildVoiceChannel

The guild voice based channel where the member(s) have been moved to.

Raises

UnauthorizedError

If you are unauthorized to make the request (invalid/missing token).

ForbiddenError

If you are missing the READ_MESSAGES permission in the channel.

NotFoundError

If the channel is not found.

RateLimitTooLongError

Raised in the event that a rate limit occurs that is longer than max_rate_limit when making a request.

RateLimitedError

Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.

InternalServerError

If an internal error occurs on Discord while handling the request.

Expand source code
Browse git

async def fetch_channel(self) -> channels.GuildVoiceChannel:
    """Fetch the guild voice based channel where the member(s) have been moved to.

    Returns
    -------
    hikari.channels.GuildVoiceChannel
        The guild voice based channel where the member(s) have been moved to.

    Raises
    ------
    hikari.errors.UnauthorizedError
        If you are unauthorized to make the request (invalid/missing token).
    hikari.errors.ForbiddenError
        If you are missing the `READ_MESSAGES` permission in the channel.
    hikari.errors.NotFoundError
        If the channel is not found.
    hikari.errors.RateLimitTooLongError
        Raised in the event that a rate limit occurs that is
        longer than `max_rate_limit` when making a request.
    hikari.errors.RateLimitedError
        Usually, Hikari will handle and retry on hitting
        rate-limits automatically. This includes most bucket-specific
        rate-limits and global rate-limits. In some rare edge cases,
        however, Discord implements other undocumented rules for
        rate-limiting, such as limits per attribute. These cannot be
        detected or handled normally by Hikari due to their undocumented
        nature, and will trigger this exception if they occur.
    hikari.errors.InternalServerError
        If an internal error occurs on Discord while handling the request.
    """
    channel = await self.app.rest.fetch_channel(self.channel_id)
    assert isinstance(channel, channels.GuildVoiceChannel)
    return channel

class MemberPruneEntryInfo (
    *,
    app: traits.RESTAware,
    delete_member_days: datetime.timedelta,
    members_removed: int,
): ...

Extra information attached to guild prune log entries.

Method generated by attrs for class MemberPruneEntryInfo.

class MemberPruneEntryInfo(BaseAuditLogEntryInfo):
    """Extra information attached to guild prune log entries."""

    delete_member_days: datetime.timedelta = attr.field(repr=True)
    """The timedelta of how many days members were pruned for inactivity based on."""

    members_removed: int = attr.field(repr=True)
    """The number of members who were removed by this prune."""

Method resolution order

dataclass MemberPruneEntryInfo

That's this class!

dataclass BaseAuditLogEntryInfo

A base object that all audit log entry info objects will inherit from …

extern class abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Variables and properties

property app : traits.RESTAware

The client application that models may use for procedures.

property delete_member_days : datetime.timedelta

The timedelta of how many days members were pruned for inactivity based on.

property members_removed : int

The number of members who were removed by this prune.

class MessageBulkDeleteEntryInfo (
    *,
    app: traits.RESTAware,
    count: int,
): ...

Extra information for the message bulk delete audit entry.

Method generated by attrs for class MessageBulkDeleteEntryInfo.

class MessageBulkDeleteEntryInfo(BaseAuditLogEntryInfo):
    """Extra information for the message bulk delete audit entry."""

    count: int = attr.field(repr=True)
    """The amount of messages that were deleted."""

Subclasses

dataclass MessageDeleteEntryInfo

Extra information attached to the message delete audit entry …

Method resolution order

dataclass MessageBulkDeleteEntryInfo

That's this class!

dataclass BaseAuditLogEntryInfo

A base object that all audit log entry info objects will inherit from …

extern class abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Variables and properties

property app : traits.RESTAware

The client application that models may use for procedures.

property count : int

The amount of messages that were deleted.

class MessageDeleteEntryInfo (
    *,
    app: traits.RESTAware,
    count: int,
    channel_id: snowflakes.Snowflake,
): ...

Extra information attached to the message delete audit entry.

Method generated by attrs for class MessageDeleteEntryInfo.

class MessageDeleteEntryInfo(MessageBulkDeleteEntryInfo):
    """Extra information attached to the message delete audit entry."""

    channel_id: snowflakes.Snowflake = attr.field(repr=True)
    """The ID of guild text based channel where these message(s) were deleted."""

    async def fetch_channel(self) -> channels.TextableGuildChannel:
        """Fetch the guild text based channel where these message(s) were deleted.

        Returns
        -------
        hikari.channels.TextableGuildChannel
            The guild text based channel where these message(s) were deleted.

        Raises
        ------
        hikari.errors.UnauthorizedError
            If you are unauthorized to make the request (invalid/missing token).
        hikari.errors.ForbiddenError
            If you are missing the `READ_MESSAGES` permission in the channel.
        hikari.errors.NotFoundError
            If the channel is not found.
        hikari.errors.RateLimitTooLongError
            Raised in the event that a rate limit occurs that is
            longer than `max_rate_limit` when making a request.
        hikari.errors.RateLimitedError
            Usually, Hikari will handle and retry on hitting
            rate-limits automatically. This includes most bucket-specific
            rate-limits and global rate-limits. In some rare edge cases,
            however, Discord implements other undocumented rules for
            rate-limiting, such as limits per attribute. These cannot be
            detected or handled normally by Hikari due to their undocumented
            nature, and will trigger this exception if they occur.
        hikari.errors.InternalServerError
            If an internal error occurs on Discord while handling the request.
        """
        channel = await self.app.rest.fetch_channel(self.channel_id)
        assert isinstance(channel, channels.TextableGuildChannel)
        return channel

Method resolution order

dataclass MessageDeleteEntryInfo

That's this class!

dataclass MessageBulkDeleteEntryInfo

Extra information for the message bulk delete audit entry …

dataclass BaseAuditLogEntryInfo

A base object that all audit log entry info objects will inherit from …

extern class abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Variables and properties

property app : traits.RESTAware

The client application that models may use for procedures.

property channel_id : snowflakes.Snowflake

The ID of guild text based channel where these message(s) were deleted.

property count : int

The amount of messages that were deleted.

Methods

async def fetch_channel() -> TextableGuildChannel: ...

Fetch the guild text based channel where these message(s) were deleted.

Returns

TextableGuildChannel

The guild text based channel where these message(s) were deleted.

Raises

UnauthorizedError

If you are unauthorized to make the request (invalid/missing token).

ForbiddenError

If you are missing the READ_MESSAGES permission in the channel.

NotFoundError

If the channel is not found.

RateLimitTooLongError

Raised in the event that a rate limit occurs that is longer than max_rate_limit when making a request.

RateLimitedError

Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.

InternalServerError

If an internal error occurs on Discord while handling the request.

Expand source code
Browse git

async def fetch_channel(self) -> channels.TextableGuildChannel:
    """Fetch the guild text based channel where these message(s) were deleted.

    Returns
    -------
    hikari.channels.TextableGuildChannel
        The guild text based channel where these message(s) were deleted.

    Raises
    ------
    hikari.errors.UnauthorizedError
        If you are unauthorized to make the request (invalid/missing token).
    hikari.errors.ForbiddenError
        If you are missing the `READ_MESSAGES` permission in the channel.
    hikari.errors.NotFoundError
        If the channel is not found.
    hikari.errors.RateLimitTooLongError
        Raised in the event that a rate limit occurs that is
        longer than `max_rate_limit` when making a request.
    hikari.errors.RateLimitedError
        Usually, Hikari will handle and retry on hitting
        rate-limits automatically. This includes most bucket-specific
        rate-limits and global rate-limits. In some rare edge cases,
        however, Discord implements other undocumented rules for
        rate-limiting, such as limits per attribute. These cannot be
        detected or handled normally by Hikari due to their undocumented
        nature, and will trigger this exception if they occur.
    hikari.errors.InternalServerError
        If an internal error occurs on Discord while handling the request.
    """
    channel = await self.app.rest.fetch_channel(self.channel_id)
    assert isinstance(channel, channels.TextableGuildChannel)
    return channel

class MessagePinEntryInfo (
    *,
    app: traits.RESTAware,
    channel_id: snowflakes.Snowflake,
    message_id: snowflakes.Snowflake,
): ...

The extra information for message pin related audit log entries.

Will be attached to the message pin and message unpin audit log entries.

Method generated by attrs for class MessagePinEntryInfo.

class MessagePinEntryInfo(BaseAuditLogEntryInfo):
    """The extra information for message pin related audit log entries.

    Will be attached to the message pin and message unpin audit log entries.
    """

    channel_id: snowflakes.Snowflake = attr.field(repr=True)
    """The ID of the text based channel where a pinned message is being targeted."""

    message_id: snowflakes.Snowflake = attr.field(repr=True)
    """The ID of the message that's being pinned or unpinned."""

    async def fetch_channel(self) -> channels.TextableChannel:
        """Fetch The channel where this message was pinned or unpinned.

        Returns
        -------
        hikari.channels.TextableChannel
            The channel where this message was pinned or unpinned.

        Raises
        ------
        hikari.errors.UnauthorizedError
            If you are unauthorized to make the request (invalid/missing token).
        hikari.errors.ForbiddenError
            If you are missing the `READ_MESSAGES` permission in the channel.
        hikari.errors.NotFoundError
            If the channel is not found.
        hikari.errors.RateLimitTooLongError
            Raised in the event that a rate limit occurs that is
            longer than `max_rate_limit` when making a request.
        hikari.errors.RateLimitedError
            Usually, Hikari will handle and retry on hitting
            rate-limits automatically. This includes most bucket-specific
            rate-limits and global rate-limits. In some rare edge cases,
            however, Discord implements other undocumented rules for
            rate-limiting, such as limits per attribute. These cannot be
            detected or handled normally by Hikari due to their undocumented
            nature, and will trigger this exception if they occur.
        hikari.errors.InternalServerError
            If an internal error occurs on Discord while handling the request.
        """
        channel = await self.app.rest.fetch_channel(self.channel_id)
        assert isinstance(channel, channels.TextableChannel)
        return channel

    async def fetch_message(self) -> messages.Message:
        """Fetch the object of the message that's being pinned or unpinned.

        Returns
        -------
        hikari.messages.Message
            The message that's being pinned or unpinned.

        Raises
        ------
        hikari.errors.UnauthorizedError
            If you are unauthorized to make the request (invalid/missing token).
        hikari.errors.ForbiddenError
            If you are missing the `READ_MESSAGES` permission in the channel that the message is in.
        hikari.errors.NotFoundError
            If the message is not found.
        hikari.errors.RateLimitTooLongError
            Raised in the event that a rate limit occurs that is
            longer than `max_rate_limit` when making a request.
        hikari.errors.RateLimitedError
            Usually, Hikari will handle and retry on hitting
            rate-limits automatically. This includes most bucket-specific
            rate-limits and global rate-limits. In some rare edge cases,
            however, Discord implements other undocumented rules for
            rate-limiting, such as limits per attribute. These cannot be
            detected or handled normally by Hikari due to their undocumented
            nature, and will trigger this exception if they occur.
        hikari.errors.InternalServerError
            If an internal error occurs on Discord while handling the request.
        """
        return await self.app.rest.fetch_message(self.channel_id, self.message_id)

Method resolution order

dataclass MessagePinEntryInfo

That's this class!

dataclass BaseAuditLogEntryInfo

A base object that all audit log entry info objects will inherit from …

extern class abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Variables and properties

property app : traits.RESTAware

The client application that models may use for procedures.

property channel_id : snowflakes.Snowflake

The ID of the text based channel where a pinned message is being targeted.

property message_id : snowflakes.Snowflake

The ID of the message that's being pinned or unpinned.

Methods

async def fetch_channel() -> TextableChannel: ...

Fetch The channel where this message was pinned or unpinned.

Returns

TextableChannel

The channel where this message was pinned or unpinned.

Raises

UnauthorizedError

If you are unauthorized to make the request (invalid/missing token).

ForbiddenError

If you are missing the READ_MESSAGES permission in the channel.

NotFoundError

If the channel is not found.

RateLimitTooLongError

Raised in the event that a rate limit occurs that is longer than max_rate_limit when making a request.

RateLimitedError

Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.

InternalServerError

If an internal error occurs on Discord while handling the request.

Expand source code
Browse git

async def fetch_channel(self) -> channels.TextableChannel:
    """Fetch The channel where this message was pinned or unpinned.

    Returns
    -------
    hikari.channels.TextableChannel
        The channel where this message was pinned or unpinned.

    Raises
    ------
    hikari.errors.UnauthorizedError
        If you are unauthorized to make the request (invalid/missing token).
    hikari.errors.ForbiddenError
        If you are missing the `READ_MESSAGES` permission in the channel.
    hikari.errors.NotFoundError
        If the channel is not found.
    hikari.errors.RateLimitTooLongError
        Raised in the event that a rate limit occurs that is
        longer than `max_rate_limit` when making a request.
    hikari.errors.RateLimitedError
        Usually, Hikari will handle and retry on hitting
        rate-limits automatically. This includes most bucket-specific
        rate-limits and global rate-limits. In some rare edge cases,
        however, Discord implements other undocumented rules for
        rate-limiting, such as limits per attribute. These cannot be
        detected or handled normally by Hikari due to their undocumented
        nature, and will trigger this exception if they occur.
    hikari.errors.InternalServerError
        If an internal error occurs on Discord while handling the request.
    """
    channel = await self.app.rest.fetch_channel(self.channel_id)
    assert isinstance(channel, channels.TextableChannel)
    return channel

async def fetch_message() -> messages.Message: ...

Fetch the object of the message that's being pinned or unpinned.

Returns

Message

The message that's being pinned or unpinned.

Raises

UnauthorizedError

If you are unauthorized to make the request (invalid/missing token).

ForbiddenError

If you are missing the READ_MESSAGES permission in the channel that the message is in.

NotFoundError

If the message is not found.

RateLimitTooLongError

Raised in the event that a rate limit occurs that is longer than max_rate_limit when making a request.

RateLimitedError

Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.

InternalServerError

If an internal error occurs on Discord while handling the request.

Expand source code
Browse git

async def fetch_message(self) -> messages.Message:
    """Fetch the object of the message that's being pinned or unpinned.

    Returns
    -------
    hikari.messages.Message
        The message that's being pinned or unpinned.

    Raises
    ------
    hikari.errors.UnauthorizedError
        If you are unauthorized to make the request (invalid/missing token).
    hikari.errors.ForbiddenError
        If you are missing the `READ_MESSAGES` permission in the channel that the message is in.
    hikari.errors.NotFoundError
        If the message is not found.
    hikari.errors.RateLimitTooLongError
        Raised in the event that a rate limit occurs that is
        longer than `max_rate_limit` when making a request.
    hikari.errors.RateLimitedError
        Usually, Hikari will handle and retry on hitting
        rate-limits automatically. This includes most bucket-specific
        rate-limits and global rate-limits. In some rare edge cases,
        however, Discord implements other undocumented rules for
        rate-limiting, such as limits per attribute. These cannot be
        detected or handled normally by Hikari due to their undocumented
        nature, and will trigger this exception if they occur.
    hikari.errors.InternalServerError
        If an internal error occurs on Discord while handling the request.
    """
    return await self.app.rest.fetch_message(self.channel_id, self.message_id)