Source code for

# Copyright(C) 2010-2011 Christophe Benz
# This file is part of woob.
# woob is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# woob is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# GNU Lesser General Public License for more details.
# You should have received a copy of the GNU Lesser General Public License
# along with woob. If not, see <>.

import datetime

from .base import Capability, BaseObject, StringField, UserError
from .date import DateField

__all__ = ['ChatException', 'ChatMessage', 'CapChat']

[docs]class ChatException(UserError): """ Exception raised when there is a problem with the chat. """
[docs]class ChatMessage(BaseObject): """ Message on the chat. """ id_from = StringField('ID of sender') id_to = StringField('ID of recipient') message = StringField('Content of message') date = DateField('Date when the message has been sent') def __init__(self, id_from, id_to, message, date=None, url=None): super(ChatMessage, self).__init__('%s.%s' % (id_from, id_to), url) self.id_from = id_from self.id_to = id_to self.message = message = date if is None: = datetime.datetime.utcnow()
[docs]class CapChat(Capability): """ Websites with a chat system. """
[docs] def iter_chat_messages(self, _id=None): """ Iter messages. :param _id: optional parameter to only get messages from a given contact. :type _id: str :rtype: iter[:class:`ChatMessage`] """ raise NotImplementedError()
[docs] def send_chat_message(self, _id, message): """ Send a message to a contact. :param _id: ID of recipient :type _id: str :param message: message to send :type message: str :raises: :class:`ChatException` """ raise NotImplementedError()