apireference.rst

API Reference

Discord.py Changes

In order to make aspects of this library work, some aspects of the default Discord.py library have been modified. Though they present non-breaking behaviour, it's important to note them here.

• discord.abc.Messageable's send method and discord.Message's edit methods have been altered to have the components and ephemeral arguments. components refers to an instance of voxelbotutils.MessageComponents, and ephemeral refers to whether or not the sent message should be ephemeral (which only works with interactions responses - slash commands and components).

Utils

Bot

voxelbotutils.MinimalBot

voxelbotutils.Bot

Cog

voxelbotutils.Cog

Command

voxelbotutils.Command

voxelbotutils.Group

Context

voxelbotutils.Context

AbstractMentionable

voxelbotutils.AbstractMentionable

DatabaseConnection

voxelbotutils.DatabaseConnection

RedisConnection

voxelbotutils.RedisConnection

StatsdConnection

voxelbotutils.StatsdConnection

Embed

voxelbotutils.Embed

Paginator

voxelbotutils.Paginator

TimeValue

voxelbotutils.TimeValue

TimeFormatter

voxelbotutils.TimeFormatter

ComponentMessage

voxelbotutils.ComponentMessage

voxelbotutils.ComponentWebhookMessage

Slash Commands

Slash commands also have their own page<interactions howto> for a basic integration guide.

ApplicationCommand

voxelbotutils.ApplicationCommand

ApplicationCommandType

voxelbotutils.ApplicationCommandType

ApplicationCommandOption

voxelbotutils.ApplicationCommandOption

ApplicationCommandOptionChoice

voxelbotutils.ApplicationCommandOptionChoice

ApplicationCommandOptionType

voxelbotutils.ApplicationCommandOptionType

Components

Components also have their own page<interactions howto> for a basic integration guide.

InteractionMessageable

voxelbotutils.InteractionMessageable

ComponentInteractionPayload

voxelbotutils.cogs.utils.interactions.components.ComponentInteractionPayload

BaseComponent

voxelbotutils.BaseComponent

Note

You will not need to make instances of this class - make instances of the child classes of this instead.

DisableableComponent

voxelbotutils.DisableableComponent

Note

You will not need to make instances of this class - make instances of the child classes of this instead.

ComponentHolder

voxelbotutils.ComponentHolder

Note

You will not need to make instances of this class - make instances of the child classes of this instead.

MessageComponents

voxelbotutils.MessageComponents

ActionRow

voxelbotutils.ActionRow

ButtonStyle

voxelbotutils.ButtonStyle

Button

voxelbotutils.Button

SelectOption

voxelbotutils.SelectOption

SelectMenu

voxelbotutils.SelectMenu

Checks

checks.is_config_set

voxelbotutils.checks.is_config_set

checks.meta_command

voxelbotutils.checks.meta_command

checks.bot_is_ready

voxelbotutils.checks.bot_is_ready

checks.is_bot_support

voxelbotutils.checks.is_bot_support

checks.is_voter

voxelbotutils.checks.is_voter

checks.is_upgrade_chat_subscriber

voxelbotutils.checks.is_upgrade_chat_subscriber

checks.is_upgrade_chat_purchaser

voxelbotutils.checks.is_upgrade_chat_purchaser

checks.is_slash_command

voxelbotutils.checks.is_slash_command

checks.is_not_slash_command

voxelbotutils.checks.is_not_slash_command

checks.bot_in_guild

voxelbotutils.checks.bot_in_guild

Cooldowns

cooldown.cooldown

voxelbotutils.cooldown.cooldown

cooldown.no_raise_cooldown

voxelbotutils.cooldown.no_raise_cooldown

cooldown.Cooldown

voxelbotutils.cooldown.Cooldown

cooldown.GroupedCooldownMapping

voxelbotutils.cooldown.GroupedCooldownMapping

cooldown.RoleBasedCooldown

voxelbotutils.cooldown.RoleBasedCooldown

Converters

converters.UserID

voxelbotutils.converters.UserID

converters.ChannelID

voxelbotutils.converters.ChannelID

converters.BooleanConverter

voxelbotutils.converters.BooleanConverter

converters.ColourConverter

voxelbotutils.converters.ColourConverter

converters.FilteredUser

voxelbotutils.converters.FilteredUser

converters.FilteredMember

voxelbotutils.converters.FilteredMember

Menus

Menus also have their own page<menus howto> for a basic integration guide.

menus.DataLocation

voxelbotutils.menus.DataLocation

menus.MenuCallbacks

voxelbotutils.menus.MenuCallbacks

menus.Check

voxelbotutils.menus.Check

menus.CheckFailureAction

voxelbotutils.menus.CheckFailureAction

menus.Converter

voxelbotutils.menus.Converter

menus.Option

voxelbotutils.menus.Option

menus.Menu

voxelbotutils.menus.Menu

menus.MenuIterable

voxelbotutils.menus.MenuIterable

Errors

errors.ConfigNotSet

voxelbotutils.errors.ConfigNotSet

errors.InvokedMetaCommand

voxelbotutils.errors.InvokedMetaCommand

errors.BotNotReady

voxelbotutils.errors.BotNotReady

errors.IsNotVoter

voxelbotutils.errors.IsNotVoter

errors.NotBotSupport

voxelbotutils.errors.NotBotSupport

errors.IsSlashCommand

voxelbotutils.errors.IsSlashCommand

errors.IsNotSlashCommand

voxelbotutils.errors.IsNotSlashCommand

errors.BotNotInGuild

voxelbotutils.errors.BotNotInGuild

errors.MissingRequiredArgumentString

voxelbotutils.errors.MissingRequiredArgumentString

errors.InvalidTimeDuration

voxelbotutils.errors.InvalidTimeDuration

errors.IsNotUpgradeChatPurchaser

voxelbotutils.errors.IsNotUpgradeChatPurchaser

errors.IsNotUpgradeChatSubscriber

voxelbotutils.errors.IsNotUpgradeChatSubscriber

Websites

web.OauthGuild

voxelbotutils.web.OauthGuild

web.OauthUser

voxelbotutils.web.OauthUser

web.OauthMember

voxelbotutils.web.OauthMember

web.add_discord_arguments

voxelbotutils.web.add_discord_arguments

web.get_avatar_url

voxelbotutils.web.get_avatar_url

web.requires_login

voxelbotutils.web.requires_login

voxelbotutils.web.is_logged_in

web.is_logged_in

voxelbotutils.web.is_logged_in

voxelbotutils.web.requires_login

web.get_discord_login_url

voxelbotutils.web.get_discord_login_url

web.process_discord_login

voxelbotutils.web.process_discord_login

web.get_user_info_from_session

voxelbotutils.web.get_user_info_from_session

web.get_access_token_from_session

voxelbotutils.web.get_access_token_from_session

web.get_user_guilds_from_session

voxelbotutils.web.get_user_guilds_from_session

web.add_user_to_guild_from_session

voxelbotutils.web.add_user_to_guild_from_session