errbot.core module¶
-
class
errbot.core.
ErrBot
(bot_config)[source]¶ Bases:
errbot.backends.base.Backend
,errbot.storage.StoreMixin
ErrBot is the layer taking care of commands management and dispatching.
-
MSG_ERROR_OCCURRED
= 'Computer says nooo. See logs for details'¶
-
MSG_UNKNOWN_COMMAND
= 'Unknown command: "%(command)s". '¶
-
all_commands
¶ Return both commands and re_commands together.
-
callback_message
(msg)[source]¶ Processes for commands and dispatches the message to all the plugins.
-
callback_room_joined
(room)[source]¶ Triggered when the bot has joined a MUC.
Parameters: room – An instance of MUCRoom
representing the room that was joined.
-
callback_room_left
(room)[source]¶ Triggered when the bot has left a MUC.
Parameters: room – An instance of MUCRoom
representing the room that was left.
-
callback_room_topic
(room)[source]¶ Triggered when the topic in a MUC changes.
Parameters: room – An instance of MUCRoom
representing the room for which the topic changed.
-
prefix_groupchat_reply
(message: errbot.backends.base.Message, identifier: errbot.backends.base.Identifier)[source]¶ Patches message with the conventional prefix to ping the specific contact For example: @gbin, you forgot the milk !
-
process_message
(msg)[source]¶ Check if the given message is a command for the bot and act on it. It return True for triggering the callback_messages on the .callback_messages on the plugins.
Parameters: msg – the incoming message.
-
send
(identifier, text, in_reply_to=None, groupchat_nick_reply=False)[source]¶ Sends a simple message to the specified user.
Parameters: - identifier – an identifier from build_identifier or from an incoming message
- in_reply_to – the original message the bot is answering from
- text – the markdown text you want to send
- groupchat_nick_reply (
bool
) – authorized the prefixing with the nick form the user
-
send_card
(card)[source]¶ Sends a card, this can be overriden by the backends without a super() call.
Parameters: card – the card to send. Returns: None
-
send_message
(msg)[source]¶ This needs to be overridden by the backends with a super() call.
Parameters: msg – the message to send. Returns: None
-
send_simple_reply
(msg, text, private=False, threaded=False)[source]¶ Send a simple response to a given incoming message
Parameters: - private (
bool
) – if True will force a response in private. - threaded (
bool
) – if True and if the backend supports it, sends the response in a threaded message. - text – the markdown text of the message.
- msg – the message you are replying to.
- private (
-
send_templated
(identifier, template_name, template_parameters, in_reply_to=None, groupchat_nick_reply=False)[source]¶ Sends a simple message to the specified user using a template.
Parameters: - template_parameters – the parameters for the template.
- template_name – the template name you want to use.
- identifier – an identifier from build_identifier or from an incoming message, a room etc.
- in_reply_to – the original message the bot is answering from
- groupchat_nick_reply (
bool
) – authorized the prefixing with the nick form the user
-
startup_time
= datetime.datetime(2019, 7, 7, 14, 18, 48, 347474)¶
-