Skip to content

Latest commit

 

History

History
366 lines (233 loc) · 9.35 KB

apireference.rst

File metadata and controls

366 lines (233 loc) · 9.35 KB
Raw

API Reference

Event Reference

twitch_stream(data)

param data

The Twitch stream that went live.

type data

voxelbotutils.TwitchStream

Pinged when a Twitch stream goes live. This only occurs if valid Twitch authentication is set inside of the config.

Utils

Bot

voxelbotutils.MinimalBot

voxelbotutils.Bot

Cog

voxelbotutils.Cog

Context

voxelbotutils.Context

AbstractMentionable

voxelbotutils.AbstractMentionable

DatabaseWrapper

voxelbotutils.DatabaseWrapper

DatabaseTransaction

voxelbotutils.DatabaseTransaction

RedisConnection

voxelbotutils.RedisConnection

StatsdConnection

voxelbotutils.StatsdConnection

Embed

voxelbotutils.Embed

Paginator

voxelbotutils.Paginator

TimeValue

voxelbotutils.TimeValue

TwitchStream

voxelbotutils.TwitchStream

component_check

voxelbotutils.component_check

format

voxelbotutils.format

translation

voxelbotutils.translation

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

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.ModalCheck

voxelbotutils.menus.ModalCheck

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.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