Plugin

botcity.plugins.discord.plugin.BotDiscordPlugin

webhook: DiscordWebhook property readonly

Returns the discord-webhook instance.

Returns:

Type	Description
discord-webhook	The discord-webhook instance.

__init__(self, urls, username=None, **kwargs) special

BotDiscordPlugin

Parameters:

Name	Type	Description	Default
urls	list or str	Webhook urls.	required
username	str	The bot username	None

delete_message(self, message_response, **kwargs)

Deletes the message based on the response passed as argument.

Parameters:

Name	Type	Description	Default
message_response	requests.Response or list	webhook.execute() response	required

Returns:

Type	Description
response	Webhook response.

edit_message(self, message_response, new_content_message, **kwargs)

Edits the message based on the response passed as argument.

Parameters:

Name	Type	Description	Default
message_response	requests.Response or list	webhook.execute() response	required
new_content_message	str	The new message content.	required

Returns:

Type	Description
response	Webhook response.

send_embedded_message(self, message, **kwargs)

Discord Embed Message.

Parameters:

Name	Type	Description	Default
message	EmbeddedMessage	The message content. See EmbeddedMessage	required

Returns:

Type	Description
response	Webhook response.

send_file(self, files, **kwargs)

Upload file to the webhook.

Parameters:

Name	Type	Description	Default
files	list	The file paths.	required

Returns:

Type	Description
response	Webhook response.

send_message(self, content, rate_limit_retry=False, allowed_mentions=None, **kwargs)

Sends a simple message.

Parameters:

Name	Type	Description	Default
content	str	The message content.	required
rate_limit_retry	bool	if rate_limit_retry is True then in the event that you are being rate limited by Discord your webhook will automatically be sent once the rate limit has been lifted	False
allowed_mentions	list	The list of users to ping.	None

Returns:

Type	Description
response	Webhook response.