RegisterCommands

This object contains methods to help registering a command to Discord. While you shouldn't need to import this directly, it's still accessible if you prefer not to initalize a Dispike object.

Important to remember all methods are not async.

bot_token property writable

You cannot view the bot_token directly, but you can still 'update' it.

Exceptions:

Type	Description
PermissionError	If you attempt to view the bot token without a new value

request_headers property readonly

Return a valid header for authorization

Returns:

Type	Description
dict	a valid header for authorization

__init__(self, application_id, bot_token) special

Initalize object provided with application_id and a bot token

Parameters:

Name	Type	Description	Default
application_id	str	Client ID	required
bot_token	str	Bot user Token	required

Source code in dispike/creating/registrator.py

def __init__(self, application_id: str, bot_token: str):
    """Initalize object provided with application_id and a bot token

    Args:
        application_id (str): Client ID
        bot_token (str): Bot user Token
    """
    self.__bot_token = bot_token
    self._application_id = application_id
    self._client = Client(
        base_url=f"https://discord.com/api/v8/applications/{self._application_id}/",
        event_hooks={
            "response": [dispike_httpx_event_hook_incoming_request],
            "request": [dispike_httpx_event_hook_outgoing_request],
        },
    )

bulk_overwrite_commands(self, commands, guild_only=False, guild_to_target=None)

Bulk OVERWRITE commands to specific guilds or globally.

Parameters:

Name	Type	Description	Default
commands	List[dispike.creating.models.options.DiscordCommand]	List of new commands (these commands will be overwritten)	required
guild_only	bool	Default to set global mode (True). Set to False to let the function know to expect a guild_id	False
guild_to_target	int	A guild Id if guild_only is set to True.	None

Source code in dispike/creating/registrator.py

@logger.catch(reraise=True, message="Issue with bulk overrwriting commands")
def bulk_overwrite_commands(
    self,
    commands: typing.List[DiscordCommand],
    guild_only: bool = False,
    guild_to_target: int = None,
):
    """Bulk OVERWRITE commands to specific guilds or globally.

    Args:
        commands (typing.List[DiscordCommand]): List of new commands (these commands will be overwritten)
        guild_only (bool, optional): Default to set global mode (True). Set to False to let the function know to expect a guild_id
        guild_to_target (int, optional): A guild Id if guild_only is set to True.
    """
    if guild_only == True:
        if guild_to_target is None:
            raise TypeError(
                "if guild_only is set to true, a guild id must be provided."
            )

        logger.info(f"Targeting a specific guild -> {guild_to_target}")
        _request_url = f"guilds/{guild_to_target}/commands"
    else:
        _request_url = f"commands"

    _commands_to_json = [command.dict(exclude_none=True) for command in commands]
    _send_request = self._client.put(
        url=_request_url, json=_commands_to_json, headers=self.request_headers
    )
    if _send_request.status_code == 200:
        logger.info(
            f"Overwritten {len(_send_request.json())} commands.. Recieved ({len(_commands_to_json)}"
        )
        return True
    else:
        logger.debug(
            f"BULK Overwrite failed ({guild_only} = {guild_to_target}): Body: {_commands_to_json}.. Status code: {_send_request.status_code}"
        )
        raise DiscordAPIError(_send_request.status_code, _send_request.text)

register(self, command, guild_only=False, guild_to_target=None)

Register a completed DiscordCommand model to Discord API.

Parameters:

Name	Type	Description	Default
command	DiscordCommand	A properly configured DiscordCommand	required
guild_only	bool	Default to set global mode (True). Set to False to let the function know to expect a guild_id	False
guild_to_target	int	A guild Id if guild_only is set to True.	None

Source code in dispike/creating/registrator.py

def register(
    self, command: DiscordCommand, guild_only=False, guild_to_target: int = None
):
    """Register a completed `DiscordCommand` model to Discord API.

    Args:
        command (DiscordCommand): A properly configured DiscordCommand
        guild_only (bool, optional): Default to set global mode (True). Set to False to let the function know to expect a guild_id
        guild_to_target (int, optional): A guild Id if guild_only is set to True.
    """
    if guild_only == True:
        if guild_to_target is None:
            raise TypeError(
                "if guild_only is set to true, a guild id must be provided."
            )

        logger.info(f"Targeting a specific guild -> {guild_to_target}")
        _request_url = f"guilds/{guild_to_target}/commands"
    else:
        _request_url = f"commands"

    try:
        _command_to_json = command.dict(exclude_none=True)
        _send_request = self._client.post(
            _request_url, headers=self.request_headers, json=_command_to_json
        )
        if _send_request.status_code in [200, 201]:
            return True

        raise DiscordAPIError(_send_request.status_code, _send_request.text)
    except Exception:
        raise