Client

Client #

A wrapper class for the main bot class, designed to work with the Aurum framework and its features.

Note

At the moment, the wrapper only supports gateway connections.

Attributes:

bot (GatewayBotAware) –

The bot instance.
l10n (LocalizationProviderInterface) –

The localization provider instance for multi-language support. It is recommended to provide a localization provider if multi-language support is required.
commands (CommandHandler) –

The command handler.
plugins (PluginManager) –

The plugins manager.

Parameters:

bot (GatewayBotAware) –

The bot instance that this client will interact with.
l10n (LocalizationProviderInterface, default: None ) –

Localization provider. If a localization provider is not provided, an EmptyLocalizationProvider will be used, which will pass all functions and return the key.
sync_commands (SyncCommandFlag, default: SyncCommandsFlag.SYNC ) –

An optional SyncCommandsFlag enum value, indicating how to handle command synchronization.
ignore_l10n (bool, default: False ) –

An optional flag. If True, the client will not emit a warning when a localization provider is not provided.
ignore_unknown_interactions (bool, default: False ) –

An optional flag that, if set to True, will disable the warning message for unknown interactions.

add_starting_task(coro: Coroutine[None, None, Any]) -> None

Add starting task.

include(includable: Type[Includable]) -> None

Decorator to include an includable object to client.