hikari API documentation

package api
module applications
module audit_logs
module channels
module cli
module colors
module colours
module commands
module embeds
module emojis
module errors
package events
module files
module guilds
package impl
module intents
package interactions
package internal
module invites
module iterators
module locales
module messages
module permissions
module presences
module scheduled_events
module sessions
module snowflakes
module stickers
module templates
module traits
module undefined
module urls
module users
module voices
module webhooks

This module

dataclass ActionRowComponent
dataclass Activity
dataclass ActivityAssets
enum flag ActivityFlag
dataclass ActivityParty
dataclass ActivitySecret
dataclass ActivityTimestamps
enum ActivityType
class All
dataclass Application
enum flag ApplicationFlags
dataclass ApplicationWebhook
dataclass Attachment
class AttrComparator
dataclass AuditLog
dataclass AuditLogChange
enum AuditLogChangeKey
dataclass AuditLogEntry
enum AuditLogEventType
dataclass AuthorizationApplication
dataclass AuthorizationInformation
dataclass AutocompleteInteraction
dataclass AutocompleteInteractionOption
dataclass BadRequestError
dataclass BanCreateEvent
dataclass BanDeleteEvent
class BanEvent
dataclass BaseAuditLogEntryInfo
dataclass BaseCommandInteraction
class BufferedLazyIterator
dataclass BulkDeleteError
dataclass ButtonComponent
enum ButtonStyle
class Bytes
trait CacheAware
class ChannelEvent
dataclass ChannelFollow
dataclass ChannelFollowerWebhook
dataclass ChannelOverwriteEntryInfo
enum ChannelType
class ClientCredentialsStrategy
dataclass ClientHTTPResponseError
dataclass ClientStatus
class Color
class Colour
dataclass CommandChoice
dataclass CommandInteraction
dataclass CommandInteractionOption
dataclass CommandOption
dataclass CommandPermission
enum CommandPermissionType
enum CommandType
dataclass ComponentInteraction
dataclass ComponentStateConflictError
enum ComponentType
enum ConnectionVisibility
dataclass ContextMenuCommand
dataclass CustomEmoji
dataclass DMChannel
class DMChannelEvent
dataclass DMMessageCreateEvent
dataclass DMMessageDeleteEvent
dataclass DMMessageUpdateEvent
dataclass DMPinsUpdateEvent
dataclass DMReactionAddEvent
dataclass DMReactionDeleteAllEvent
dataclass DMReactionDeleteEmojiEvent
dataclass DMReactionDeleteEvent
class DMReactionEvent
dataclass DMTypingEvent
class Embed
dataclass EmbedAuthor
dataclass EmbedField
dataclass EmbedFooter
dataclass EmbedImage
dataclass EmbedProvider
dataclass EmbedResource
dataclass EmbedResourceWithProxy
dataclass EmbedVideo
class Emoji
dataclass EmojisUpdateEvent
trait EntityFactoryAware
class Event
trait EventFactoryAware
trait EventManagerAware
enum EventPrivacyLevel
dataclass ExceptionEvent
class ExecutableWebhook
trait ExecutorAware
class File
class FlatLazyIterator
dataclass ForbiddenError
class GatewayBot
trait GatewayBotAware
dataclass GatewayBotInfo
dataclass GatewayConnectionError
dataclass GatewayError
dataclass GatewayGuild
dataclass GatewayServerClosedConnectionError
dataclass GroupDMChannel
dataclass Guild
dataclass GuildAvailableEvent
dataclass GuildBan
dataclass GuildBulkMessageDeleteEvent
dataclass GuildCategory
dataclass GuildChannel
dataclass GuildChannelCreateEvent
dataclass GuildChannelDeleteEvent
class GuildChannelEvent
dataclass GuildChannelUpdateEvent
dataclass GuildCommandPermissions
class GuildEvent
enum GuildExplicitContentFilterLevel
enum GuildFeature
dataclass GuildJoinEvent
dataclass GuildLeaveEvent
enum GuildMFALevel
dataclass GuildMessageCreateEvent
dataclass GuildMessageDeleteEvent
enum GuildMessageNotificationsLevel
dataclass GuildMessageUpdateEvent
enum GuildNSFWLevel
dataclass GuildNewsChannel
dataclass GuildPinsUpdateEvent
enum GuildPremiumTier
dataclass GuildPreview
dataclass GuildReactionAddEvent
dataclass GuildReactionDeleteAllEvent
dataclass GuildReactionDeleteEmojiEvent
dataclass GuildReactionDeleteEvent
class GuildReactionEvent
dataclass GuildStageChannel
dataclass GuildSticker
enum flag GuildSystemChannelFlag
dataclass GuildTextChannel
dataclass GuildTypingEvent
dataclass GuildUnavailableEvent
dataclass GuildUpdateEvent
enum GuildVerificationLevel
class GuildVisibilityEvent
dataclass GuildVoiceChannel
dataclass GuildWidget
dataclass HTTPError
dataclass HTTPResponseError
dataclass HikariError
dataclass HikariInterrupt
dataclass HikariWarning
dataclass IncomingWebhook
dataclass Integration
dataclass IntegrationAccount
dataclass IntegrationApplication
dataclass IntegrationCreateEvent
dataclass IntegrationDeleteEvent
class IntegrationEvent
enum IntegrationExpireBehaviour
enum IntegrationType
dataclass IntegrationUpdateEvent
enum flag Intents
trait IntentsAware
dataclass InteractionChannel
dataclass InteractionCreateEvent
dataclass InteractionMember
trait InteractionServerAware
enum InteractionType
dataclass InternalServerError
dataclass Invite
class InviteCode
dataclass InviteCreateEvent
dataclass InviteDeleteEvent
class InviteEvent
dataclass InviteGuild
dataclass InviteWithMetadata
dataclass KnownCustomEmoji
class LazyIterator
enum Locale
dataclass Member
dataclass MemberChunkEvent
dataclass MemberCreateEvent
dataclass MemberDeleteEvent
dataclass MemberDisconnectEntryInfo
class MemberEvent
dataclass MemberMoveEntryInfo
dataclass MemberPresence
dataclass MemberPruneEntryInfo
dataclass MemberUpdateEvent
dataclass Mentions
dataclass Message
dataclass MessageActivity
enum MessageActivityType
dataclass MessageBulkDeleteEntryInfo
class MessageCreateEvent
dataclass MessageDeleteEntryInfo
class MessageDeleteEvent
class MessageEvent
enum flag MessageFlag
dataclass MessageInteraction
dataclass MessagePinEntryInfo
dataclass MessageReference
dataclass MessageResponseMixin
enum MessageType
class MessageUpdateEvent
dataclass MissingIntentError
dataclass MissingIntentWarning
trait NetworkSettingsAware
dataclass NotFoundError
dataclass OAuth2AuthorizationToken
dataclass OAuth2ImplicitToken
enum OAuth2Scope
enum OptionType
dataclass OwnConnection
dataclass OwnGuild
dataclass OwnUser
dataclass OwnUserUpdateEvent
dataclass PartialApplication
dataclass PartialChannel
dataclass PartialCommand
dataclass PartialComponent
dataclass PartialGuild
dataclass PartialIntegration
dataclass PartialInteraction
dataclass PartialMessage
dataclass PartialOAuth2Token
dataclass PartialRole
dataclass PartialSticker
class PartialUser
dataclass PartialWebhook
dataclass PermissionOverwrite
enum PermissionOverwriteType
enum flag Permissions
class PinsUpdateEvent
enum PremiumType
dataclass PresenceUpdateEvent
dataclass PrivateChannel
class RESTApp
trait RESTAware
class RESTBot
trait RESTBotAware
dataclass RESTGuild
dataclass RateLimitTooLongError
dataclass RateLimitedError
dataclass Reaction
class ReactionAddEvent
class ReactionDeleteAllEvent
class ReactionDeleteEmojiEvent
class ReactionDeleteEvent
class ReactionEvent
dataclass ResolvedOptionData
enum ResponseType
dataclass RichActivity
dataclass Role
dataclass RoleCreateEvent
dataclass RoleDeleteEvent
class RoleEvent
dataclass RoleUpdateEvent
trait Runnable
dataclass ScheduledEvent
dataclass ScheduledEventCreateEvent
dataclass ScheduledEventDeleteEvent
class ScheduledEventEvent
enum ScheduledEventStatus
enum ScheduledEventType
dataclass ScheduledEventUpdateEvent
dataclass ScheduledEventUser
dataclass ScheduledEventUserAddEvent
dataclass ScheduledEventUserRemoveEvent
dataclass ScheduledExternalEvent
dataclass ScheduledStageEvent
dataclass ScheduledVoiceEvent
dataclass SelectMenuComponent
dataclass SelectMenuOption
dataclass SessionStartLimit
trait ShardAware
enum ShardCloseCode
dataclass ShardConnectedEvent
dataclass ShardDisconnectedEvent
class ShardEvent
dataclass ShardPayloadEvent
dataclass ShardReadyEvent
dataclass ShardResumedEvent
class ShardStateEvent
dataclass SlashCommand
class Snowflake
dataclass StandardSticker
dataclass StartedEvent
dataclass StartingEvent
enum Status
enum StickerFormatType
dataclass StickerPack
enum StickerType
dataclass StoppedEvent
dataclass StoppingEvent
enum TargetType
dataclass Team
dataclass TeamMember
enum TeamMembershipState
dataclass Template
dataclass TemplateGuild
dataclass TemplateRole
dataclass TextableChannel
dataclass TextableGuildChannel
enum TokenType
class TypingEvent
class URL
dataclass UnauthorizedError
class UndefinedType
class UnicodeEmoji
class Unique
dataclass UnrecognisedEntityError
class User
enum flag UserFlag
dataclass VanityURL
enum VideoQualityMode
trait VoiceAware
dataclass VoiceError
class VoiceEvent
dataclass VoiceRegion
dataclass VoiceServerUpdateEvent
dataclass VoiceState
dataclass VoiceStateUpdateEvent
enum WebhookType
dataclass WebhookUpdateEvent
dataclass WelcomeChannel
dataclass WelcomeScreen

Expand source code
Browse git

# -*- 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.
"""A sane Python framework for writing modern Discord bots.

To get started, you will want to initialize an instance of `GatewayBot`
for writing a bot, or `RESTApp` if you only need to use the REST API.
"""

from __future__ import annotations

import os as _os

from hikari import api
from hikari import applications
from hikari import events
from hikari import files
from hikari import impl
from hikari import interactions
from hikari import snowflakes
from hikari import undefined
from hikari._about import __author__
from hikari._about import __ci__
from hikari._about import __copyright__
from hikari._about import __discord_invite__
from hikari._about import __docs__
from hikari._about import __email__
from hikari._about import __issue_tracker__
from hikari._about import __license__
from hikari._about import __url__
from hikari._about import __version__
from hikari.applications import Application
from hikari.applications import ApplicationFlags
from hikari.applications import AuthorizationApplication
from hikari.applications import AuthorizationInformation
from hikari.applications import ConnectionVisibility
from hikari.applications import OAuth2AuthorizationToken
from hikari.applications import OAuth2ImplicitToken
from hikari.applications import OAuth2Scope
from hikari.applications import OwnConnection
from hikari.applications import OwnGuild
from hikari.applications import PartialOAuth2Token
from hikari.applications import Team
from hikari.applications import TeamMember
from hikari.applications import TeamMembershipState
from hikari.applications import TokenType
from hikari.audit_logs import *
from hikari.channels import *
from hikari.colors import *
from hikari.colours import *
from hikari.commands import *
from hikari.embeds import *
from hikari.emojis import *
from hikari.errors import *
from hikari.events.base_events import Event
from hikari.events.base_events import ExceptionEvent
from hikari.events.channel_events import *
from hikari.events.guild_events import *
from hikari.events.interaction_events import *
from hikari.events.lifetime_events import *
from hikari.events.member_events import *
from hikari.events.message_events import *
from hikari.events.reaction_events import *
from hikari.events.role_events import *
from hikari.events.scheduled_events import *
from hikari.events.shard_events import *
from hikari.events.typing_events import *
from hikari.events.user_events import *
from hikari.events.voice_events import *
from hikari.files import URL
from hikari.files import Bytes
from hikari.files import File
from hikari.files import LazyByteIteratorish
from hikari.files import Pathish
from hikari.files import Rawish
from hikari.files import Resourceish
from hikari.guilds import *
from hikari.impl import ClientCredentialsStrategy
from hikari.impl import GatewayBot
from hikari.impl import RESTApp
from hikari.impl import RESTBot
from hikari.intents import *
from hikari.interactions.base_interactions import *
from hikari.interactions.command_interactions import *
from hikari.interactions.component_interactions import *
from hikari.invites import *
from hikari.iterators import *
from hikari.locales import *
from hikari.messages import *
from hikari.permissions import *
from hikari.presences import *
from hikari.scheduled_events import *
from hikari.sessions import *
from hikari.snowflakes import SearchableSnowflakeish
from hikari.snowflakes import SearchableSnowflakeishOr
from hikari.snowflakes import Snowflake
from hikari.snowflakes import Snowflakeish
from hikari.snowflakes import SnowflakeishOr
from hikari.snowflakes import SnowflakeishSequence
from hikari.snowflakes import Unique
from hikari.stickers import *
from hikari.templates import *
from hikari.traits import *
from hikari.undefined import UNDEFINED
from hikari.undefined import UndefinedNoneOr
from hikari.undefined import UndefinedOr
from hikari.undefined import UndefinedType
from hikari.users import *
from hikari.voices import *
from hikari.webhooks import *

# Only expose this during documentation, as we need it to make anything visible.
if _os.getenv("PDOC3_GENERATING") == "1":  # pragma: no cover
    __all__ = [name for name in dir() if not name.startswith("_")]

del _os

Child Modules

package api: Interfaces for components that make up Hikari applications …
module applications: Application and entities related to discord's OAuth2 flow.
module audit_logs: Application and entities that are used to describe audit logs on Discord.
module channels: Application and entities that are used to describe both DMs and guild channels on Discord.
module cli: Provides the python -m hikari and hikari commands to the shell.
module colors: Model that represents a common RGB color and provides simple conversions to other common color systems.
module colours: Alias for the hikari.colors module.
module commands: Models and enums used for application commands on Discord.
module embeds: Application and entities that are used to describe message embeds on Discord.
module emojis: Application and entities that are used to describe emojis on Discord.
module errors: Exceptions and warnings that can be thrown by this library.
package events: Events that can be fired by Hikari's gateway implementation.
module files: Utilities and classes for interacting with files and web resources.
module guilds: Application and entities that are used to describe guilds on Discord.
package impl: Basic implementations of application components …
module intents: Shard intents for controlling which events the application receives.
package interactions: Models and enums related to Discord's interactions system.
package internal: Package containing internal utilities used within this API.
module invites: Application and entities that are used to describe invites on Discord.
module iterators: Lazy iterators for data that requires repeated API calls to retrieve …
module locales: Enum of Discord accepted locales.
module messages: Application and entities that are used to describe messages on Discord.
module permissions: Bitfield of permissions.
module presences: Application and entities that are used to describe guilds on Discord.
module scheduled_events: Application and entities that are used to describe guild scheduled events on Discord.
module sessions: Entities directly related to creating and managing gateway shard sessions.
module snowflakes: Implementation of a Snowflake type.
module stickers: Application and entities that are used to describe stickers on Discord.
module templates: Application and entities that are used to describe guild templates on Discord.
module traits: Core app interface for application implementations.
module undefined: Singleton used throughout the library to denote values that are not present.
module urls: API-wide URLs.
module users: Application and entities that are used to describe Users on Discord.
module voices: Application and entities that are used to describe voice state on Discord.
module webhooks: Application and entities that are used to describe webhooks on Discord.

Classes

reference to dataclass ActionRowComponent: Represents a row of components attached to a message …
reference to dataclass Activity: Represents a regular activity that can be associated with a presence …
reference to dataclass ActivityAssets: Used to represent possible assets for an activity …
reference to enum flag ActivityFlag: Flags that describe what an activity includes …
reference to dataclass ActivityParty: Used to represent activity groups of users …
reference to dataclass ActivitySecret: The secrets used for interacting with an activity party …
reference to dataclass ActivityTimestamps: The datetimes for the start and/or end of an activity session …
reference to enum ActivityType: The activity type.
reference to class All: Helper that wraps predicates and invokes them together …
reference to dataclass Application: Represents the information of an Oauth2 Application …
reference to enum flag ApplicationFlags: The known application flag bits.
reference to dataclass ApplicationWebhook: Represents an application webhook object on Discord …
reference to dataclass Attachment: Represents a file attached to a message …
reference to class AttrComparator: A comparator that compares the result of a call with something else …
reference to dataclass AuditLog: Represents a guilds audit log's page …
reference to dataclass AuditLogChange: Represents a change made to an audit log entry's target entity …
reference to enum AuditLogChangeKey: Commonly known and documented keys for audit log change objects …
reference to dataclass AuditLogEntry: Represents an entry in a guild's audit log …
reference to enum AuditLogEventType: The type of event that occurred.
reference to dataclass AuthorizationApplication: The application model found attached to AuthorizationInformation …
reference to dataclass AuthorizationInformation: Model for the data returned by Get Current Authorization Information …
reference to dataclass AutocompleteInteraction: Represents an autocomplete interaction on Discord …
reference to dataclass AutocompleteInteractionOption: Represents the options passed for a command autocomplete interaction …
reference to dataclass BadRequestError: Raised when you send an invalid request somehow …
reference to dataclass BanCreateEvent: Event that is fired when a user is banned from a guild …
reference to dataclass BanDeleteEvent: Event that is fired when a user is unbanned from a guild …
reference to abstract class BanEvent: Event base for any guild ban or unban …
reference to dataclass BaseAuditLogEntryInfo: A base object that all audit log entry info objects will inherit from …
reference to dataclass BaseCommandInteraction: Represents a base command interaction on Discord …
reference to abstract class BufferedLazyIterator: A special kind of lazy iterator that is used by internal components …
reference to dataclass BulkDeleteError: Exception raised when a bulk delete fails midway through a call …
reference to dataclass ButtonComponent: Represents a message button component …
reference to enum ButtonStyle: Enum of the available button styles …
reference to class Bytes: Representation of in-memory data to upload …
reference to trait CacheAware: Structural supertype for a cache-aware object …
reference to abstract class ChannelEvent: Event base for any channel-bound event in guilds or private messages …
reference to dataclass ChannelFollow: Relationship between a news channel and a subscriber channel …
reference to dataclass ChannelFollowerWebhook: Represents a channel follower webhook object on Discord …
reference to dataclass ChannelOverwriteEntryInfo: Represents the extra information for overwrite related audit log entries …
reference to enum ChannelType: The known channel types that are exposed to us by the API.
reference to class ClientCredentialsStrategy: Strategy class for handling client credential OAuth2 authorization …
reference to dataclass ClientHTTPResponseError: Base exception for an erroneous HTTP response that is a client error …
reference to dataclass ClientStatus: The client statuses for this member …
reference to class Color: Representation of a color …
reference to class Colour: Representation of a color …
reference to dataclass CommandChoice: Represents the choices set for an application command's argument …
reference to dataclass CommandInteraction: Represents a command interaction on Discord …
reference to dataclass CommandInteractionOption: Represents the options passed for a command interaction …
reference to dataclass CommandOption: Represents an application command's argument …
reference to dataclass CommandPermission: Representation of a permission which enables or disables a command for a user or role …
reference to enum CommandPermissionType: The type of entity a command permission targets.
reference to enum CommandType: The type of a command.
reference to dataclass ComponentInteraction: Represents a component interaction on Discord …
reference to dataclass ComponentStateConflictError: Exception thrown when an action cannot be executed in the component's current state …
reference to enum ComponentType: Types of components found within Discord.
reference to enum ConnectionVisibility: Describes who can see a connection with a third party account.
reference to dataclass ContextMenuCommand: Represents a slash command on Discord …
reference to dataclass CustomEmoji: Represents a custom emoji …
reference to dataclass DMChannel: Represents a direct message text channel that is between you and another user …
reference to abstract class DMChannelEvent: Event base for any channel-bound event in private messages.
reference to dataclass DMMessageCreateEvent: Event that is fired when a message is created within a DM …
reference to dataclass DMMessageDeleteEvent: Event that is triggered if a message is deleted in a DM …
reference to dataclass DMMessageUpdateEvent: Event that is fired when a message is updated in a DM …
reference to dataclass DMPinsUpdateEvent: Event fired when a message is pinned/unpinned in a private channel …
reference to dataclass DMReactionAddEvent: Event fired when a reaction is added to a private message …
reference to dataclass DMReactionDeleteAllEvent: Event fired when all of a private message's reactions are removed …
reference to dataclass DMReactionDeleteEmojiEvent: Event fired when an emoji is removed from a private message's reactions …
reference to dataclass DMReactionDeleteEvent: Event fired when a reaction is removed from a private message …
reference to abstract class DMReactionEvent: Event base for any reaction-bound event in private messages …
reference to dataclass DMTypingEvent: Event fired when a user starts typing in a guild channel …
reference to class Embed: Represents an embed.
reference to dataclass EmbedAuthor: Represents an author of an embed …
reference to dataclass EmbedField: Represents a field in a embed …
reference to dataclass EmbedFooter: Represents an embed footer …
reference to dataclass EmbedImage: Represents an embed image …
reference to dataclass EmbedProvider: Represents an embed provider …
reference to dataclass EmbedResource: A base type for any resource provided in an embed …
reference to dataclass EmbedResourceWithProxy: Resource with a corresponding proxied element …
reference to dataclass EmbedVideo: Represents an embed video …
reference to abstract class Emoji: Base class for all emojis …
reference to dataclass EmojisUpdateEvent: Event that is fired when the emojis in a guild are updated …
reference to trait EntityFactoryAware: Structural supertype for an entity factory-aware object …
reference to abstract class Event: Base event type that all Hikari events should subclass.
reference to trait EventFactoryAware: Structural supertype for an event factory-aware object …
reference to trait EventManagerAware: Structural supertype for a event manager-aware object …
reference to enum EventPrivacyLevel: Enum of the possible scheduled event privacy levels.
reference to dataclass ExceptionEvent: Event that is raised when another event handler raises an Exception …
reference to abstract class ExecutableWebhook: An abstract class with logic for executing entities as webhooks.
reference to trait ExecutorAware: Structural supertype for an executor-aware object …
reference to class File: A resource that exists on the local machine's storage to be uploaded …
reference to class FlatLazyIterator: A lazy iterator that has all items in-memory and ready …
reference to dataclass ForbiddenError: Raised when you are not allowed to access a specific resource …
reference to class GatewayBot: Basic auto-sharding bot implementation …
reference to trait GatewayBotAware: Structural supertype for a component that has all the gateway components.
reference to dataclass GatewayBotInfo: Used to represent gateway information for the connected bot …
reference to dataclass GatewayConnectionError: An exception thrown if a connection issue occurs …
reference to dataclass GatewayError: A base exception type for anything that can be thrown by the Gateway …
reference to dataclass GatewayGuild: Guild specialization that is sent via the gateway only …
reference to dataclass GatewayServerClosedConnectionError: An exception raised when the server closes the connection …
reference to dataclass GroupDMChannel: Represents a group direct message channel …
reference to dataclass Guild: A representation of a guild on Discord …
reference to dataclass GuildAvailableEvent: Event fired when a guild becomes available …
reference to dataclass GuildBan: Used to represent guild bans …
reference to dataclass GuildBulkMessageDeleteEvent: Event that is triggered when a bulk deletion is triggered in a guild …
reference to dataclass GuildCategory: Represents a guild category channel …
reference to dataclass GuildChannel: The base for anything that is a guild channel …
reference to dataclass GuildChannelCreateEvent: Event fired when a guild channel is created …
reference to dataclass GuildChannelDeleteEvent: Event fired when a guild channel is deleted …
reference to abstract class GuildChannelEvent: Event base for any channel-bound event in guilds …
reference to dataclass GuildChannelUpdateEvent: Event fired when a guild channel is edited …
reference to dataclass GuildCommandPermissions: Representation of the permissions set for a command within a guild …
reference to abstract class GuildEvent: Event base for any guild-bound event …
reference to enum GuildExplicitContentFilterLevel: Represents the explicit content filter setting for a guild.
reference to enum GuildFeature: Features that a guild can provide.
reference to dataclass GuildJoinEvent: Event fired when the bot joins a new guild …
reference to dataclass GuildLeaveEvent: Event fired when the bot is banned/kicked/leaves a guild …
reference to enum GuildMFALevel: Represents the multi-factor authorization requirement for a guild.
reference to dataclass GuildMessageCreateEvent: Event that is fired when a message is created within a guild …
reference to dataclass GuildMessageDeleteEvent: Event that is triggered if a message is deleted in a guild …
reference to enum GuildMessageNotificationsLevel: Represents the default notification level for new messages in a guild.
reference to dataclass GuildMessageUpdateEvent: Event that is fired when a message is updated in a guild …
reference to enum GuildNSFWLevel: Represents the NSFW level of a guild.
reference to dataclass GuildNewsChannel: Represents an news channel …
reference to dataclass GuildPinsUpdateEvent: Event fired when a message is pinned/unpinned in a guild channel …
reference to enum GuildPremiumTier: Tier for Discord Nitro boosting in a guild.
reference to dataclass GuildPreview: A preview of a guild with the DISCOVERABLE feature …
reference to dataclass GuildReactionAddEvent: Event fired when a reaction is added to a guild message …
reference to dataclass GuildReactionDeleteAllEvent: Event fired when all of a guild message's reactions are removed …
reference to dataclass GuildReactionDeleteEmojiEvent: Event fired when an emoji is removed from a guild message's reactions …
reference to dataclass GuildReactionDeleteEvent: Event fired when a reaction is removed from a guild message …
reference to abstract class GuildReactionEvent: Event base for any reaction-bound event in guild messages …
reference to dataclass GuildStageChannel: Represents a stage channel …
reference to dataclass GuildSticker: Represents a Discord sticker that belongs to a guild …
reference to enum flag GuildSystemChannelFlag: Defines which features are suppressed in the system channel.
reference to dataclass GuildTextChannel: Represents a guild text channel …
reference to dataclass GuildTypingEvent: Event fired when a user starts typing in a guild channel …
reference to dataclass GuildUnavailableEvent: Event fired when a guild becomes unavailable because of an outage …
reference to dataclass GuildUpdateEvent: Event fired when an existing guild is updated …
reference to enum GuildVerificationLevel: Represents the level of verification of a guild.
reference to abstract class GuildVisibilityEvent: Event base for any event that changes the visibility of a guild …
reference to dataclass GuildVoiceChannel: Represents a voice channel …
reference to dataclass GuildWidget: Represents a guild widget …
reference to dataclass HTTPError: Base exception raised if an HTTP error occurs while making a request …
reference to dataclass HTTPResponseError: Base exception for an erroneous HTTP response …
reference to dataclass HikariError: Base for an error raised by this API …
reference to dataclass HikariInterrupt: Exception raised when a kill signal is handled internally …
reference to dataclass HikariWarning: Base for a warning raised by this API …
reference to dataclass IncomingWebhook: Represents an incoming webhook object on Discord …
reference to dataclass Integration: Represents a guild integration object …
reference to dataclass IntegrationAccount: An account that's linked to an integration …
reference to dataclass IntegrationApplication: An application that's linked to an integration …
reference to dataclass IntegrationCreateEvent: Event that is fired when an integration is created in a guild …
reference to dataclass IntegrationDeleteEvent: Event that is fired when an integration is deleted in a guild …
reference to abstract trait class IntegrationEvent: Event base for any integration related events …
reference to enum IntegrationExpireBehaviour: Behavior for expiring integration subscribers.
reference to enum IntegrationType: The integration type.
reference to dataclass IntegrationUpdateEvent: Event that is fired when an integration is updated in a guild …
reference to enum flag Intents: Represents an intent on the gateway …
reference to trait IntentsAware: A component that is aware of the application intents.
reference to dataclass InteractionChannel: Represents partial channels returned as resolved entities on interactions …
reference to dataclass InteractionCreateEvent: Event fired when an interaction is created …
reference to dataclass InteractionMember: Model of the member who triggered an interaction …
reference to trait InteractionServerAware: Structural supertype for a interaction REST server-aware object.
reference to enum InteractionType: The type of an interaction.
reference to dataclass InternalServerError: Base exception for an erroneous HTTP response that is a server error …
reference to dataclass Invite: Represents an invite that's used to add users to a guild or group dm …
reference to abstract trait class InviteCode: A representation of a guild/channel invite.
reference to dataclass InviteCreateEvent: Event fired when an invite is created in a channel …
reference to dataclass InviteDeleteEvent: Event fired when an invite is deleted from a channel …
reference to abstract trait class InviteEvent: Base event type for guild invite updates …
reference to dataclass InviteGuild: Represents the partial data of a guild that is attached to invites …
reference to dataclass InviteWithMetadata: Extends the base Invite object with metadata …
reference to dataclass KnownCustomEmoji: Represents an emoji that is known from a guild the bot is in …
reference to abstract class LazyIterator: A set of results that are fetched asynchronously from the API as needed …
reference to enum Locale: Possible user/guild locales.
reference to dataclass Member: Used to represent a guild bound member …
reference to dataclass MemberChunkEvent: Event fired when a member chunk payload is received on a gateway shard …
reference to dataclass MemberCreateEvent: Event that is fired when a member joins a guild …
reference to dataclass MemberDeleteEvent: Event fired when a member is kicked from or leaves a guild …
reference to dataclass MemberDisconnectEntryInfo: Extra information for the voice chat member disconnect entry …
reference to abstract class MemberEvent: Event base for any events that concern guild members …
reference to dataclass MemberMoveEntryInfo: Extra information for the voice chat based member move entry …
reference to dataclass MemberPresence: Used to represent a guild member's presence …
reference to dataclass MemberPruneEntryInfo: Extra information attached to guild prune log entries …
reference to dataclass MemberUpdateEvent: Event that is fired when a member is updated in a guild …
reference to dataclass Mentions: Description of mentions that exist in the message …
reference to dataclass Message: Represents a message with all known details …
reference to dataclass MessageActivity: Represents the activity of a rich presence-enabled message …
reference to enum MessageActivityType: The type of a rich presence message activity.
reference to dataclass MessageBulkDeleteEntryInfo: Extra information for the message bulk delete audit entry …
reference to abstract class MessageCreateEvent: Event that is fired when a message is created …
reference to dataclass MessageDeleteEntryInfo: Extra information attached to the message delete audit entry …
reference to abstract class MessageDeleteEvent: Special event that is triggered when a message gets deleted …
reference to abstract class MessageEvent: Any event that concerns manipulation of messages …
reference to enum flag MessageFlag: Additional flags for message options.
reference to dataclass MessageInteraction: Representation of information provided for a message from an interaction …
reference to dataclass MessagePinEntryInfo: The extra information for message pin related audit log entries …
reference to dataclass MessageReference: Represents information about a referenced message …
reference to dataclass MessageResponseMixin: Mixin' class for all interaction types which can be responded to with a message …
reference to enum MessageType: The type of a message.
reference to abstract class MessageUpdateEvent: Event that is fired when a message is updated …
reference to dataclass MissingIntentError: Error raised when you try to perform an action without an intent …
reference to dataclass MissingIntentWarning: Warning raised when subscribing to an event that cannot be fired …
reference to trait NetworkSettingsAware: Structural supertype for any component aware of network settings.
reference to dataclass NotFoundError: Raised when something is not found …
reference to dataclass OAuth2AuthorizationToken: Model for the OAuth2 token data returned by the authorization grant flow …
reference to dataclass OAuth2ImplicitToken: Model for the OAuth2 token data returned by the implicit grant flow …
reference to enum OAuth2Scope: OAuth2 Scopes that Discord allows …
reference to enum OptionType: The type of a command option.
reference to dataclass OwnConnection: Represents a user's connection with a third party account …
reference to dataclass OwnGuild: Represents a user bound partial guild object …
reference to dataclass OwnUser: Represents a user with extended OAuth2 information …
reference to dataclass OwnUserUpdateEvent: Event fired when the account user is updated …
reference to dataclass PartialApplication: A partial representation of a Discord application …
reference to dataclass PartialChannel: Channel representation for cases where further detail is not provided …
reference to dataclass PartialCommand: Represents any application command on Discord …
reference to dataclass PartialComponent: Base class for all component entities …
reference to dataclass PartialGuild: Base object for any partial guild objects …
reference to dataclass PartialIntegration: A partial representation of an integration, found in audit logs …
reference to dataclass PartialInteraction: The base model for all interaction models …
reference to dataclass PartialMessage: A message representation containing partially populated information …
reference to dataclass PartialOAuth2Token: Model for partial OAuth2 token data returned by the API …
reference to dataclass PartialRole: Represents a partial guild bound Role object …
reference to dataclass PartialSticker: Represents the partial stickers found attached to messages on Discord …
reference to abstract class PartialUser: A partial interface for a user …
reference to dataclass PartialWebhook: Base class for all webhook implementations …
reference to dataclass PermissionOverwrite: Represents permission overwrites for a channel or role in a channel …
reference to enum PermissionOverwriteType: The type of entity a Permission Overwrite targets.
reference to enum flag Permissions: Represents the permissions available in a given channel or guild …
reference to abstract class PinsUpdateEvent: Base event fired when a message is pinned/unpinned in a channel …
reference to enum PremiumType: The types of Nitro.
reference to dataclass PresenceUpdateEvent: Event fired when a user in a guild updates their presence in a guild …
reference to dataclass PrivateChannel: The base for anything that is a private (non-guild bound) channel …
reference to class RESTApp: The base for a HTTP-only Discord application …
reference to trait RESTAware: Structural supertype for a REST-aware object …
reference to class RESTBot: Basic implementation of an interaction based REST-only bot …
reference to trait RESTBotAware: Structural supertype for a component that has all the RESTful components.
reference to dataclass RESTGuild: Guild specialization that is sent via the REST API only …
reference to dataclass RateLimitTooLongError: Internal error raised if the wait for a rate limit is too long …
reference to dataclass RateLimitedError: Raised when a non-global rate limit that cannot be handled occurs …
reference to dataclass Reaction: Represents a reaction in a message …
reference to abstract class ReactionAddEvent: Event base for any reaction that is added to a message …
reference to abstract class ReactionDeleteAllEvent: Event base fired when all reactions are removed from a message …
reference to abstract class ReactionDeleteEmojiEvent: Event base fired when all reactions are removed for one emoji …
reference to abstract class ReactionDeleteEvent: Event base for any single reaction that is removed from a message …
reference to abstract class ReactionEvent: Event base for any message reaction event …
reference to dataclass ResolvedOptionData: Represents the resolved objects of entities referenced in a command's options …
reference to enum ResponseType: The type of an interaction response.
reference to dataclass RichActivity: Represents a rich activity that can be associated with a presence …
reference to dataclass Role: Represents a guild bound Role object …
reference to dataclass RoleCreateEvent: Event fired when a role is created …
reference to dataclass RoleDeleteEvent: Event fired when a role is deleted …
reference to abstract class RoleEvent: Event base for any event that involves guild roles …
reference to dataclass RoleUpdateEvent: Event fired when a role is updated …
reference to trait Runnable: Structural super-type for an application which can be run independently.
reference to dataclass ScheduledEvent: Base class for scheduled events …
reference to dataclass ScheduledEventCreateEvent: Event fired when a guild scheduled event is created …
reference to dataclass ScheduledEventDeleteEvent: Event fired when a guild scheduled event is deleted …
reference to abstract class ScheduledEventEvent: Event bassed for any scheduled event related events …
reference to enum ScheduledEventStatus: Enum of the scheduled event statuses.
reference to enum ScheduledEventType: Enum of the scheduled event types.
reference to dataclass ScheduledEventUpdateEvent: Event fired when a guild scheduled event is updated …
reference to dataclass ScheduledEventUser: A user who is subscribed to a scheduled event …
reference to dataclass ScheduledEventUserAddEvent: Event fired when a user subscribes to a guild scheduled event …
reference to dataclass ScheduledEventUserRemoveEvent: Event fired when a user unsubscribes from a guild scheduled event …
reference to dataclass ScheduledExternalEvent: A scheduled event that takes place outside of Discord …
reference to dataclass ScheduledStageEvent: A scheduled event that takes place in a stage channel …
reference to dataclass ScheduledVoiceEvent: A scheduled event that takes place in a voice channel …
reference to dataclass SelectMenuComponent: Represents a message button component …
reference to dataclass SelectMenuOption: Represents an option for a SelectMenuComponent …
reference to dataclass SessionStartLimit: Used to represent information about the current session start limits …
reference to trait ShardAware: Structural supertype for a shard-aware object …
reference to enum ShardCloseCode: Reasons for a shard connection closure.
reference to dataclass ShardConnectedEvent: Event fired when a shard connects …
reference to dataclass ShardDisconnectedEvent: Event fired when a shard disconnects …
reference to abstract class ShardEvent: Base class for any event that was shard-specific.
reference to dataclass ShardPayloadEvent: Event fired for most shard events with their raw payload …
reference to dataclass ShardReadyEvent: Event fired when a shard declares it is ready …
reference to dataclass ShardResumedEvent: Event fired when a shard resumes an existing session …
reference to abstract class ShardStateEvent: Base class for any event concerning the state/connectivity of a shard …
reference to dataclass SlashCommand: Represents a slash command on Discord …
reference to class Snowflake: A concrete representation of a unique ID for an entity on Discord …
reference to dataclass StandardSticker: Represents a standard Discord sticker that belongs to a pack …
reference to dataclass StartedEvent: Event that is triggered after the application has started …
reference to dataclass StartingEvent: Event that is triggered before the application connects to discord …
reference to enum Status: The status of a member.
reference to enum StickerFormatType: The formats types of a sticker's asset.
reference to dataclass StickerPack: Represents a sticker pack on Discord …
reference to enum StickerType: The sticker type.
reference to dataclass StoppedEvent: Event that is triggered once the application has disconnected …
reference to dataclass StoppingEvent: Event that is triggered as soon as the application is requested to close …
reference to enum TargetType: The target of the invite.
reference to dataclass Team: Represents a development team, along with all its members …
reference to dataclass TeamMember: Represents a member of a Team …
reference to enum TeamMembershipState: Represents the state of a user's team membership.
reference to dataclass Template: Represents a template used for creating guilds …
reference to dataclass TemplateGuild: The partial guild object attached to Template …
reference to dataclass TemplateRole: The partial role object attached to Template …
reference to dataclass TextableChannel: Mixin class for a channel which can have text messages in it …
reference to dataclass TextableGuildChannel: Mixin class for any guild channel which can have text messages in it …
reference to enum TokenType: Token types used within Hikari clients.
reference to abstract class TypingEvent: Base event fired when a user begins typing in a channel …
reference to class URL: A URL that represents a web resource …
reference to dataclass UnauthorizedError: Raised when you are not authorized to access a specific resource …
reference to class UndefinedType: The type of the UNDEFINED singleton sentinel value.
reference to class UnicodeEmoji: Represents a unicode emoji …
reference to abstract class Unique: Mixin for a class that enforces uniqueness by a snowflake ID.
reference to dataclass UnrecognisedEntityError: An exception thrown when an unrecognised entity is found …
reference to abstract class User: Interface for any user-like object …
reference to enum flag UserFlag: The known user flags that represent account badges.
reference to dataclass VanityURL: A special case invite object, that represents a guild's vanity url …
reference to enum VideoQualityMode: The camera quality of the voice chat.
reference to trait VoiceAware: Structural supertype for a voice-aware object …
reference to dataclass VoiceError: Error raised when a problem occurs with the voice subsystem.
reference to abstract class VoiceEvent: Base for any voice-related event.
reference to dataclass VoiceRegion: Represents a voice region server …
reference to dataclass VoiceServerUpdateEvent: Event fired when a voice server is changed …
reference to dataclass VoiceState: Represents a user's voice connection status …
reference to dataclass VoiceStateUpdateEvent: Event fired when a user changes their voice state …
reference to enum WebhookType: Types of webhook.
reference to dataclass WebhookUpdateEvent: Event fired when a webhook is created/updated/deleted in a channel …
reference to dataclass WelcomeChannel: Used to represent channels on guild welcome screens …
reference to dataclass WelcomeScreen: Used to represent guild welcome screens on Discord …

hikari

This module

Child Modules

Classes

reference to dataclass ActionRowComponent

reference to dataclass Activity

reference to dataclass ActivityAssets

reference to enum flag ActivityFlag

reference to dataclass ActivityParty

reference to dataclass ActivitySecret

reference to dataclass ActivityTimestamps

reference to enum ActivityType

reference to class All

reference to dataclass Application

reference to enum flag ApplicationFlags

reference to dataclass ApplicationWebhook

reference to dataclass Attachment

reference to class AttrComparator

reference to dataclass AuditLog

reference to dataclass AuditLogChange

reference to enum AuditLogChangeKey

reference to dataclass AuditLogEntry

reference to enum AuditLogEventType

reference to dataclass AuthorizationApplication

reference to dataclass AuthorizationInformation

reference to dataclass AutocompleteInteraction

reference to dataclass AutocompleteInteractionOption

reference to dataclass BadRequestError

reference to dataclass BanCreateEvent

reference to dataclass BanDeleteEvent

reference to abstract class BanEvent

reference to dataclass BaseAuditLogEntryInfo

reference to dataclass BaseCommandInteraction

reference to abstract class BufferedLazyIterator

reference to dataclass BulkDeleteError

reference to dataclass ButtonComponent

reference to enum ButtonStyle

reference to class Bytes

reference to trait CacheAware

reference to abstract class ChannelEvent

reference to dataclass ChannelFollow

reference to dataclass ChannelFollowerWebhook

reference to dataclass ChannelOverwriteEntryInfo

reference to enum ChannelType

reference to class ClientCredentialsStrategy

reference to dataclass ClientHTTPResponseError

reference to dataclass ClientStatus

reference to class Color

reference to class Colour

reference to dataclass CommandChoice

reference to dataclass CommandInteraction

reference to dataclass CommandInteractionOption

reference to dataclass CommandOption

reference to dataclass CommandPermission

reference to enum CommandPermissionType

reference to enum CommandType

reference to dataclass ComponentInteraction

reference to dataclass ComponentStateConflictError

reference to enum ComponentType

reference to enum ConnectionVisibility

reference to dataclass ContextMenuCommand

reference to dataclass CustomEmoji

reference to dataclass DMChannel

reference to abstract class DMChannelEvent

reference to dataclass DMMessageCreateEvent

reference to dataclass DMMessageDeleteEvent

reference to dataclass DMMessageUpdateEvent

reference to dataclass DMPinsUpdateEvent

reference to dataclass DMReactionAddEvent

reference to dataclass DMReactionDeleteAllEvent

reference to dataclass DMReactionDeleteEmojiEvent

reference to dataclass DMReactionDeleteEvent

reference to abstract class DMReactionEvent

reference to dataclass DMTypingEvent

reference to class Embed

reference to dataclass EmbedAuthor

reference to dataclass EmbedField

reference to dataclass EmbedFooter

reference to dataclass EmbedImage

reference to dataclass EmbedProvider

`hikari`