hikari.audit_logs
Application and entities that are used to describe audit logs on Discord.
View Source
# -*- 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. """Application and entities that are used to describe audit logs on Discord.""" from __future__ import annotations __all__: typing.Sequence[str] = ( "AuditLog", "AuditLogChange", "AuditLogChangeKey", "AuditLogEntry", "AuditLogEventType", "BaseAuditLogEntryInfo", "ChannelOverwriteEntryInfo", "MemberDisconnectEntryInfo", "MemberMoveEntryInfo", "MemberPruneEntryInfo", "MessageBulkDeleteEntryInfo", "MessageDeleteEntryInfo", "MessagePinEntryInfo", ) import abc import typing import attr from hikari import channels from hikari import snowflakes from hikari.internal import attr_extensions from hikari.internal import collections from hikari.internal import enums if typing.TYPE_CHECKING: import datetime from hikari import guilds from hikari import messages from hikari import traits from hikari import users as users_ from hikari import webhooks as webhooks_ @typing.final 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" 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""" @attr_extensions.with_copy @attr.define(hash=False, kw_only=True, weakref_slot=False) 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.""" @typing.final 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 @attr.define(hash=False, kw_only=True, weakref_slot=False) 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.""" @attr_extensions.with_copy @attr.define(hash=False, kw_only=True, weakref_slot=False) 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.""" @attr_extensions.with_copy @attr.define(hash=False, kw_only=True, weakref_slot=False) 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) @attr_extensions.with_copy @attr.define(hash=False, kw_only=True, weakref_slot=False) 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.""" @attr_extensions.with_copy @attr.define(hash=False, kw_only=True, weakref_slot=False) 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.""" @attr_extensions.with_copy @attr.define(hash=False, kw_only=True, weakref_slot=False) 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 @attr_extensions.with_copy @attr.define(hash=False, kw_only=True, weakref_slot=False) 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.""" @attr_extensions.with_copy @attr.define(hash=False, kw_only=True, weakref_slot=False) 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 @attr_extensions.with_copy @attr.define(hash=True, kw_only=True, weakref_slot=False) 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) @attr_extensions.with_copy @attr.define(hash=False, kw_only=True, repr=False, weakref_slot=False) 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)
View Source
@attr_extensions.with_copy @attr.define(hash=False, kw_only=True, repr=False, weakref_slot=False) 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)
Represents a guilds audit log's page.
Variables and properties
A mapping of snowflake IDs to the audit log's entries.
A mapping of the partial objects of integrations found in this audit log.
A mapping of the objects of users found in this audit log.
A mapping of the objects of webhooks found in this audit log.
Methods
self,
*,
entries: Mapping[hikari.snowflakes.Snowflake, hikari.audit_logs.AuditLogEntry],
integrations: Mapping[hikari.snowflakes.Snowflake, hikari.guilds.PartialIntegration],
users: Mapping[hikari.snowflakes.Snowflake, hikari.users.User],
webhooks: Mapping[hikari.snowflakes.Snowflake, hikari.webhooks.PartialWebhook]
):
View Source
def __init__(self, *, entries, integrations, users, webhooks): self.entries = entries self.integrations = integrations self.users = users self.webhooks = webhooks
Method generated by attrs for class AuditLog.
View Source
def count(self, value): 'S.count(value) -> integer -- return number of occurrences of value' return sum(1 for v in self if v is value or v == value)
S.count(value) -> integer -- return number of occurrences of value
View Source
def index(self, value, start=0, stop=None): '''S.index(value, [start, [stop]]) -> integer -- return first index of value. Raises ValueError if the value is not present. Supporting start and stop arguments is optional, but recommended. ''' if start is not None and start < 0: start = max(len(self) + start, 0) if stop is not None and stop < 0: stop += len(self) i = start while stop is None or i < stop: try: v = self[i] if v is value or v == value: return i except IndexError: break i += 1 raise ValueError
S.index(value, [start, [stop]]) -> integer -- return first index of value. Raises ValueError if the value is not present.
Supporting start and stop arguments is optional, but recommended.
View Source
@attr_extensions.with_copy @attr.define(hash=False, kw_only=True, weakref_slot=False) 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."""
Represents a change made to an audit log entry's target entity.
Variables and properties
The name of the audit log change's key.
The new value of the key, if something was added or changed.
The old value of the key, if something was removed or changed.
Methods
self,
*,
new_value: Optional[Any],
old_value: Optional[Any],
key: Union[hikari.audit_logs.AuditLogChangeKey, str]
):
View Source
def __init__(self, *, new_value, old_value, key): self.new_value = new_value self.old_value = old_value self.key = key
Method generated by attrs for class AuditLogChange.
View Source
@typing.final 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" 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"""
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.
Variables and properties
Alias for "COLOR
Return the name of the enum member as a str.
Return the value of the enum member.
Methods
View Source
def __call__(cls, value: typing.Any) -> typing.Any: """Cast a value to the enum, returning the raw value that was passed if value not found.""" try: return cls._value_to_member_map_[value] except KeyError: # If we can't find the value, just return what got casted in return value
Cast a value to the enum, returning the raw value that was passed if value not found.
Return a capitalized version of the string.
More specifically, make the first character have upper case and the rest lower case.
Return a version of the string suitable for caseless comparisons.
Return a centered string of length width.
Padding is done using the specified fill character (default is a space).
S.count(sub[, start[, end]]) -> int
Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.
Encode the string using the codec registered for encoding.
encoding The encoding in which to encode the string. errors The error handling scheme to use for encoding errors. The default is 'strict' meaning that encoding errors raise a UnicodeEncodeError. Other possible values are 'ignore', 'replace' and 'xmlcharrefreplace' as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.
S.endswith(suffix[, start[, end]]) -> bool
Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.
Return a copy where all tab characters are expanded using spaces.
If tabsize is not given, a tab size of 8 characters is assumed.
S.find(sub[, start[, end]]) -> int
Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.
Return -1 on failure.
S.format(args, *kwargs) -> str
Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').
S.format_map(mapping) -> str
Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces ('{' and '}').
S.index(sub[, start[, end]]) -> int
Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.
Raises ValueError when the substring is not found.
Return True if the string is an alpha-numeric string, False otherwise.
A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.
Return True if the string is an alphabetic string, False otherwise.
A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.
Return True if all characters in the string are ASCII, False otherwise.
ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.
Return True if the string is a decimal string, False otherwise.
A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.
Return True if the string is a digit string, False otherwise.
A string is a digit string if all characters in the string are digits and there is at least one character in the string.
Return True if the string is a valid Python identifier, False otherwise.
Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as "def" or "class".
Return True if the string is a lowercase string, False otherwise.
A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.
Return True if the string is a numeric string, False otherwise.
A string is numeric if all characters in the string are numeric and there is at least one character in the string.
Return True if the string is printable, False otherwise.
A string is printable if all of its characters are considered printable in repr() or if it is empty.
Return True if the string is a whitespace string, False otherwise.
A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.
Return True if the string is a title-cased string, False otherwise.
In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.
Return True if the string is an uppercase string, False otherwise.
A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.
Concatenate any number of strings.
The string whose method is called is inserted in between each given string. The result is returned as a new string.
Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'
Return a left-justified string of length width.
Padding is done using the specified fill character (default is a space).
Return a copy of the string converted to lowercase.
Return a copy of the string with leading whitespace removed.
If chars is given and not None, remove characters in chars instead.
Return a translation table usable for str.translate().
If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.
Partition the string into three parts using the given separator.
This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.
If the separator is not found, returns a 3-tuple containing the original string and two empty strings.
Return a str with the given prefix string removed if present.
If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.
Return a str with the given suffix string removed if present.
If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.
Return a copy with all occurrences of substring old replaced by new.
count Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.
If the optional argument count is given, only the first count occurrences are replaced.
S.rfind(sub[, start[, end]]) -> int
Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.
Return -1 on failure.
S.rindex(sub[, start[, end]]) -> int
Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.
Raises ValueError when the substring is not found.
Return a right-justified string of length width.
Padding is done using the specified fill character (default is a space).
Partition the string into three parts using the given separator.
This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.
If the separator is not found, returns a 3-tuple containing two empty strings and the original string.
Return a list of the words in the string, using sep as the delimiter string.
sep The delimiter according which to split the string. None (the default value) means split according to any whitespace, and discard empty strings from the result. maxsplit Maximum number of splits to do. -1 (the default value) means no limit.
Splits are done starting at the end of the string and working to the front.
Return a copy of the string with trailing whitespace removed.
If chars is given and not None, remove characters in chars instead.
Return a list of the words in the string, using sep as the delimiter string.
sep The delimiter according which to split the string. None (the default value) means split according to any whitespace, and discard empty strings from the result. maxsplit Maximum number of splits to do. -1 (the default value) means no limit.
Return a list of the lines in the string, breaking at line boundaries.
Line breaks are not included in the resulting list unless keepends is given and true.
S.startswith(prefix[, start[, end]]) -> bool
Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.
Return a copy of the string with leading and trailing whitespace removed.
If chars is given and not None, remove characters in chars instead.
Convert uppercase characters to lowercase and lowercase characters to uppercase.
Return a version of the string where each word is titlecased.
More specifically, words start with uppercased characters and all remaining cased characters have lower case.
Replace each character in the string using the given translation table.
table Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.
The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.
Return a copy of the string converted to uppercase.
Pad a numeric string with zeros on the left, to fill a field of the given width.
The string is never truncated.
View Source
@attr_extensions.with_copy @attr.define(hash=True, kw_only=True, weakref_slot=False) 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)
Represents an entry in a guild's audit log.
Variables and properties
The type of action this entry represents.
The client application that models may use for procedures.
A sequence of the changes made to AuditLogEntry.target_id.
When the object was created.
The ID of this entity.
Extra information about this entry. Only be provided for certain event_type.
The reason for this change, if set (between 0-512 characters).
The ID of the entity affected by this change, if applicable.
The ID of the user who made this change.
Methods
self,
*,
app: hikari.traits.RESTAware,
id: hikari.snowflakes.Snowflake,
target_id: Optional[hikari.snowflakes.Snowflake],
changes: Sequence[hikari.audit_logs.AuditLogChange],
user_id: Optional[hikari.snowflakes.Snowflake],
action_type: Union[hikari.audit_logs.AuditLogEventType, int],
options: Optional[hikari.audit_logs.BaseAuditLogEntryInfo],
reason: Optional[str]
):
View Source
def __init__(self, *, app, id, target_id, changes, user_id, action_type, options, reason): self.app = app self.id = id self.target_id = target_id self.changes = changes self.user_id = user_id self.action_type = action_type self.options = options self.reason = reason
Method generated by attrs for class AuditLogEntry.
View Source
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)
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_limitwhen 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.
View Source
@typing.final 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
The type of event that occurred.
Variables and properties
the denominator of a rational number in lowest terms
the imaginary part of a complex number
Return the name of the enum member as a str.
the numerator of a rational number in lowest terms
the real part of a complex number
Return the value of the enum member.
Methods
View Source
def __call__(cls, value: typing.Any) -> typing.Any: """Cast a value to the enum, returning the raw value that was passed if value not found.""" try: return cls._value_to_member_map_[value] except KeyError: # If we can't find the value, just return what got casted in return value
Cast a value to the enum, returning the raw value that was passed if value not found.
Return integer ratio.
Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.
>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)
Number of bits necessary to represent self in binary.
>>> bin(37)
'0b100101'
>>> (37).bit_length()
6
Returns self, the complex conjugate of any int.
Return the integer represented by the given array of bytes.
bytes Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol. byteorder The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. signed Indicates whether two's complement is used to represent the integer.
Return an array of bytes representing an integer.
length Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. byteorder The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. signed Determines whether two's complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.
View Source
@attr.define(hash=False, kw_only=True, weakref_slot=False) 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."""
A base object that all audit log entry info objects will inherit from.
Variables and properties
The client application that models may use for procedures.
Methods
View Source
def __init__(self, *, app): self.app = app
Method generated by attrs for class BaseAuditLogEntryInfo.
View Source
@attr_extensions.with_copy @attr.define(hash=False, kw_only=True, weakref_slot=False) 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."""
Represents the extra information for overwrite related audit log entries.
Will be attached to the overwrite create, update and delete audit log entries.
Variables and properties
The client application that models may use for procedures.
When the object was created.
The ID of this entity.
The name of the role this overwrite targets, if it targets a role.
The type of entity this overwrite targets.
Methods
self,
*,
app: hikari.traits.RESTAware,
id: hikari.snowflakes.Snowflake,
type: Union[hikari.channels.PermissionOverwriteType, str],
role_name: Optional[str]
):
View Source
def __init__(self, *, app, id, type, role_name): self.app = app self.id = id self.type = type self.role_name = role_name
Method generated by attrs for class ChannelOverwriteEntryInfo.
View Source
@attr_extensions.with_copy @attr.define(hash=False, kw_only=True, weakref_slot=False) 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."""
Extra information for the voice chat member disconnect entry.
Variables and properties
The client application that models may use for procedures.
The amount of members who were disconnected from voice in this entry.
Methods
View Source
def __init__(self, *, app, count): self.app = app self.count = count
Method generated by attrs for class MemberDisconnectEntryInfo.
View Source
@attr_extensions.with_copy @attr.define(hash=False, kw_only=True, weakref_slot=False) 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
Extra information for the voice chat based member move entry.
Variables and properties
The client application that models may use for procedures.
The channel that the member(s) have been moved to
The amount of members who were disconnected from voice in this entry.
Methods
self,
*,
app: hikari.traits.RESTAware,
count: int,
channel_id: hikari.snowflakes.Snowflake
):
View Source
def __init__(self, *, app, count, channel_id): self.app = app self.count = count self.channel_id = channel_id
Method generated by attrs for class MemberMoveEntryInfo.
View Source
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
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_MESSAGESpermission 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_limitwhen 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.
View Source
@attr_extensions.with_copy @attr.define(hash=False, kw_only=True, weakref_slot=False) 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."""
Extra information attached to guild prune log entries.
Variables and properties
The client application that models may use for procedures.
The timedelta of how many days members were pruned for inactivity based on.
The number of members who were removed by this prune.
Methods
self,
*,
app: hikari.traits.RESTAware,
delete_member_days: datetime.timedelta,
members_removed: int
):
View Source
def __init__(self, *, app, delete_member_days, members_removed): self.app = app self.delete_member_days = delete_member_days self.members_removed = members_removed
Method generated by attrs for class MemberPruneEntryInfo.
View Source
@attr_extensions.with_copy @attr.define(hash=False, kw_only=True, weakref_slot=False) 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."""
Extra information for the message bulk delete audit entry.
Variables and properties
The client application that models may use for procedures.
The amount of messages that were deleted.
Methods
View Source
def __init__(self, *, app, count): self.app = app self.count = count
Method generated by attrs for class MessageBulkDeleteEntryInfo.
View Source
@attr_extensions.with_copy @attr.define(hash=False, kw_only=True, weakref_slot=False) 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
Extra information attached to the message delete audit entry.
Variables and properties
The client application that models may use for procedures.
The ID of guild text based channel where these message(s) were deleted.
The amount of messages that were deleted.
Methods
self,
*,
app: hikari.traits.RESTAware,
count: int,
channel_id: hikari.snowflakes.Snowflake
):
View Source
def __init__(self, *, app, count, channel_id): self.app = app self.count = count self.channel_id = channel_id
Method generated by attrs for class MessageDeleteEntryInfo.
View Source
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
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_MESSAGESpermission 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_limitwhen 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.
View Source
@attr_extensions.with_copy @attr.define(hash=False, kw_only=True, weakref_slot=False) 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)
The extra information for message pin related audit log entries.
Will be attached to the message pin and message unpin audit log entries.
Variables and properties
The client application that models may use for procedures.
The ID of the text based channel where a pinned message is being targeted.
The ID of the message that's being pinned or unpinned.
Methods
self,
*,
app: hikari.traits.RESTAware,
channel_id: hikari.snowflakes.Snowflake,
message_id: hikari.snowflakes.Snowflake
):
View Source
def __init__(self, *, app, channel_id, message_id): self.app = app self.channel_id = channel_id self.message_id = message_id
Method generated by attrs for class MessagePinEntryInfo.
View Source
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
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_MESSAGESpermission 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_limitwhen 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.
View Source
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)
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_MESSAGESpermission 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_limitwhen 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.