1
0
Fork 0
mirror of https://github.com/deltachat/deltachat-core.git synced 2025-10-04 02:09:17 +02:00

Merge branch 'master' into patch-3

This commit is contained in:
holger krekel 2019-05-23 21:05:44 +02:00 committed by GitHub
commit 7095142d30
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -119,7 +119,7 @@ class Chat(object):
""" send a text message and return the resulting Message instance. """ send a text message and return the resulting Message instance.
:param msg: unicode text :param msg: unicode text
:raises: ValueError if message can not be send/chat does not exist. :raises ValueError: if message can not be send/chat does not exist.
:returns: the resulting :class:`deltachat.message.Message` instance :returns: the resulting :class:`deltachat.message.Message` instance
""" """
msg = as_dc_charpointer(text) msg = as_dc_charpointer(text)
@ -133,7 +133,7 @@ class Chat(object):
:param path: path to the file. :param path: path to the file.
:param mime_type: the mime-type of this file, defaults to application/octet-stream. :param mime_type: the mime-type of this file, defaults to application/octet-stream.
:raises: ValueError if message can not be send/chat does not exist. :raises ValueError: if message can not be send/chat does not exist.
:returns: the resulting :class:`deltachat.message.Message` instance :returns: the resulting :class:`deltachat.message.Message` instance
""" """
path = as_dc_charpointer(path) path = as_dc_charpointer(path)
@ -149,7 +149,7 @@ class Chat(object):
""" send an image message and return the resulting Message instance. """ send an image message and return the resulting Message instance.
:param path: path to an image file. :param path: path to an image file.
:raises: ValueError if message can not be send/chat does not exist. :raises ValueError: if message can not be send/chat does not exist.
:returns: the resulting :class:`deltachat.message.Message` instance :returns: the resulting :class:`deltachat.message.Message` instance
""" """
if not os.path.exists(path): if not os.path.exists(path):
@ -168,7 +168,7 @@ class Chat(object):
:param path: path to the file. :param path: path to the file.
:param mime_type: the mime-type of this file, defaults to auto-detection. :param mime_type: the mime-type of this file, defaults to auto-detection.
:param view_type: passed to :meth:`MessageType.new`. :param view_type: passed to :meth:`MessageType.new`.
:raises: ValueError if message can not be prepared/chat does not exist. :raises ValueError: if message can not be prepared/chat does not exist.
:returns: the resulting :class:`Message` instance :returns: the resulting :class:`Message` instance
""" """
path = as_dc_charpointer(path) path = as_dc_charpointer(path)
@ -185,7 +185,7 @@ class Chat(object):
:param message: a :class:`Message` instance previously returned by :param message: a :class:`Message` instance previously returned by
:meth:`prepare_file`. :meth:`prepare_file`.
:raises: ValueError if message can not be sent. :raises ValueError: if message can not be sent.
:returns: a :class:`deltachat.message.Message` instance with updated state :returns: a :class:`deltachat.message.Message` instance with updated state
""" """
msg_id = lib.dc_send_msg(self._dc_context, 0, message._dc_msg) msg_id = lib.dc_send_msg(self._dc_context, 0, message._dc_msg)
@ -224,7 +224,7 @@ class Chat(object):
""" add a contact to this chat. """ add a contact to this chat.
:params: contact object. :params: contact object.
:exception: ValueError if contact could not be added :raises ValueError: if contact could not be added
:returns: None :returns: None
""" """
ret = lib.dc_add_contact_to_chat(self._dc_context, self.id, contact.id) ret = lib.dc_add_contact_to_chat(self._dc_context, self.id, contact.id)
@ -235,7 +235,7 @@ class Chat(object):
""" remove a contact from this chat. """ remove a contact from this chat.
:params: contact object. :params: contact object.
:exception: ValueError if contact could not be removed :raises ValueError: if contact could not be removed
:returns: None :returns: None
""" """
ret = lib.dc_remove_contact_from_chat(self._dc_context, self.id, contact.id) ret = lib.dc_remove_contact_from_chat(self._dc_context, self.id, contact.id)
@ -244,9 +244,10 @@ class Chat(object):
def get_contacts(self): def get_contacts(self):
""" get all contacts for this chat. """ get all contacts for this chat.
:params: contact object.
:exception: ValueError if contact could not be added :raises ValueError: if contact could not be added
:returns: list of :class:`deltachat.chatting.Contact` objects for this chat :returns: list of :class:`deltachat.chatting.Contact` objects for this chat
""" """
dc_array = ffi.gc( dc_array = ffi.gc(
lib.dc_get_chat_contacts(self._dc_context, self.id), lib.dc_get_chat_contacts(self._dc_context, self.id),