from .sid import botcmd
+
class Plugin:
- """Simple Plugin object to derive from:
- Exposes the bot object and its logger
- Provides some send helpers
+ """
+ Simple Plugin object to derive from:
+
+ * Exposes the bot object and its logger
+ * Provides send helpers
+
+ :param sid.sid.MUCBot bot: bot the plugin is load from
"""
def __init__(self, bot):
def send(self, dest, msg, mtype='chat'):
"""Send msg to dest
- msg = {
- mbody: 'text',
- mhtml: '<b>text</b>, # optional'
- }
+
+ :param str dest: Message recipient
+ :param dict,str msg: Message to send (use dict for xhtml-im)
+
+ .. note::
+ if **msg** is a :py:obj:`dict` to provide xhmlt-im massages::
+
+ msg = {
+ mbody: 'text',
+ mhtml: '<b>text</b>, # optional'
+ }
"""
if isinstance(msg, str):
msg = {'mbody': msg}
def reply(self, rcv, msg):
"""Smart reply to message received.
- Replies <msg> in private or on the muc depending on <rcv>
+
+ Replies ``msg`` in private or on the muc depending on ``rcv``
+
+ :param rcv: The received message (slixmpp object)
+ :param dict,str msg: The message to reply, refer to :py:obj:`sid.plugin.Plugin.send` for ``msg`` format
"""
to = rcv['from']
if rcv['type'] == 'groupchat':