deltachat-rpc-client 1.159.5__py3-none-any.whl → 2.0.0__py3-none-any.whl

deltachat_rpc_client/account.py

@@ -211,8 +211,8 @@ class Account:
     def get_contacts(
         self,
         query: Optional[str] = None,
+        *,
         with_self: bool = False,
-        verified_only: bool = False,
         snapshot: bool = False,
     ) -> Union[list[Contact], list[AttrDict]]:
         """Get a filtered list of contacts.
@@ -220,12 +220,9 @@ class Account:
         :param query: if a string is specified, only return contacts
                       whose name or e-mail matches query.
         :param with_self: if True the self-contact is also included if it matches the query.
-        :param only_verified: if True only return verified contacts.
         :param snapshot: If True return a list of contact snapshots instead of Contact instances.
         """
         flags = 0
-        if verified_only:
-            flags |= ContactFlag.VERIFIED_ONLY
         if with_self:
             flags |= ContactFlag.ADD_SELF
 
@@ -291,10 +288,46 @@ class Account:
     def create_group(self, name: str, protect: bool = False) -> Chat:
         """Create a new group chat.
 
-        After creation, the group has only self-contact as member and is in unpromoted state.
+        After creation,
+        the group has only self-contact as member one member (see `SpecialContactId.SELF`)
+        and is in _unpromoted_ state.
+        This means, you can add or remove members, change the name,
+        the group image and so on without messages being sent to all group members.
+
+        This changes as soon as the first message is sent to the group members
+        and the group becomes _promoted_.
+        After that, all changes are synced with all group members
+        by sending status message.
+
+        To check, if a chat is still unpromoted, you can look at the `is_unpromoted` property of a chat
+        (see `get_full_snapshot()` / `get_basic_snapshot()`).
+        This may be useful if you want to show some help for just created groups.
+
+        :param protect: If set to 1 the function creates group with protection initially enabled.
+                        Only verified members are allowed in these groups
+                        and end-to-end-encryption is always enabled.
         """
         return Chat(self, self._rpc.create_group_chat(self.id, name, protect))
 
+    def create_broadcast(self, name: str) -> Chat:
+        """Create a new **broadcast channel**
+        (called "Channel" in the UI).
+
+        Broadcast channels are similar to groups on the sending device,
+        however, recipients get the messages in a read-only chat
+        and will not see who the other members are.
+
+        Called `broadcast` here rather than `channel`,
+        because the word "channel" already appears a lot in the code,
+        which would make it hard to grep for it.
+
+        After creation, the chat contains no recipients and is in _unpromoted_ state;
+        see `create_group()` for more information on the unpromoted state.
+
+        Returns the created chat.
+        """
+        return Chat(self, self._rpc.create_broadcast(self.id, name))
+
     def get_chat_by_id(self, chat_id: int) -> Chat:
         """Return the Chat instance with the given ID."""
         return Chat(self, chat_id)

deltachat_rpc_client/const.py

@@ -8,8 +8,8 @@ COMMAND_PREFIX = "/"
 class ContactFlag(IntEnum):
     """Bit flags for get_contacts() method."""
 
-    VERIFIED_ONLY = 0x01
     ADD_SELF = 0x02
+    ADDRESS = 0x04
 
 
 class ChatlistFlag(IntEnum):
@@ -91,10 +91,40 @@ class ChatType(IntEnum):
     """Chat type."""
 
     UNDEFINED = 0
+
     SINGLE = 100
+    """1:1 chat, i.e. a direct chat with a single contact"""
+
     GROUP = 120
+
     MAILINGLIST = 140
-    BROADCAST = 160
+
+    OUT_BROADCAST = 160
+    """Outgoing broadcast channel, called "Channel" in the UI.
+
+    The user can send into this channel,
+    and all recipients will receive messages
+    in an `IN_BROADCAST`.
+
+    Called `broadcast` here rather than `channel`,
+    because the word "channel" already appears a lot in the code,
+    which would make it hard to grep for it.
+    """
+
+    IN_BROADCAST = 165
+    """Incoming broadcast channel, called "Channel" in the UI.
+
+    This channel is read-only,
+    and we do not know who the other recipients are.
+
+    This is similar to a `MAILINGLIST`,
+    with the main difference being that
+    `IN_BROADCAST`s are encrypted.
+
+    Called `broadcast` here rather than `channel`,
+    because the word "channel" already appears a lot in the code,
+    which would make it hard to grep for it.
+    """
 
 
 class ChatVisibility(str, Enum):

deltachat_rpc_client/contact.py

@@ -37,10 +37,6 @@ class Contact:
         """Delete contact."""
         self._rpc.delete_contact(self.account.id, self.id)
 
-    def reset_encryption(self) -> None:
-        """Reset contact encryption."""
-        self._rpc.reset_contact_encryption(self.account.id, self.id)
-
     def set_name(self, name: str) -> None:
         """Change the name of this contact."""
         self._rpc.change_contact_name(self.account.id, self.id, name)

deltachat_rpc_client/message.py

@@ -2,7 +2,7 @@
 
 import json
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, Optional, Union
+from typing import TYPE_CHECKING, List, Optional, Union
 
 from ._utils import AttrDict, futuremethod
 from .const import EventType
@@ -39,6 +39,11 @@ class Message:
         snapshot["message"] = self
         return snapshot
 
+    def get_read_receipts(self) -> List[AttrDict]:
+        """Get message read receipts."""
+        read_receipts = self._rpc.get_message_read_receipts(self.account.id, self.id)
+        return [AttrDict(read_receipt) for read_receipt in read_receipts]
+
     def get_reactions(self) -> Optional[AttrDict]:
         """Get message reactions."""
         reactions = self._rpc.get_message_reactions(self.account.id, self.id)

{deltachat_rpc_client-1.159.5.dist-info → deltachat_rpc_client-2.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deltachat-rpc-client
-Version: 1.159.5
+Version: 2.0.0
 Summary: Python client for Delta Chat core JSON-RPC interface
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers

deltachat_rpc_client-2.0.0.dist-info/RECORD

@@ -0,0 +1,19 @@
+deltachat_rpc_client/__init__.py,sha256=zroJARiq9HBi7Ln03KlICOUJHSjm3CGIFkHfXILEdOQ,567
+deltachat_rpc_client/_utils.py,sha256=v0iWVSa6S-s078GgnnhflCRhA9pfWI-CfK8mjZ4zjXc,6393
+deltachat_rpc_client/account.py,sha256=rgCdXo4oF7_cckBci_t03NFS0VEx-mZ5uk5rkvP9qwI,18090
+deltachat_rpc_client/chat.py,sha256=LTZSYHC24bo5fDAX1XCDP79XaHIyuPZS_-zzD0vu1Rw,11238
+deltachat_rpc_client/client.py,sha256=UeCJov-ZvB3WMzl_6aJEESGRQCdvS3UAKFL4Adar6cg,7206
+deltachat_rpc_client/const.py,sha256=wwaXSt7gXdjveT_Hpy963WXz7AoUZ0hNS4-V9pmaX1U,6647
+deltachat_rpc_client/contact.py,sha256=NLh1XNnD_LQf27pNcVgqNN97Gbv190VSCuEyjjce4L4,1893
+deltachat_rpc_client/deltachat.py,sha256=4KpiHbpfXM_LmbG-OvtDACK9W09UH0tsJyFunfH9TR4,1544
+deltachat_rpc_client/events.py,sha256=Y45LoGlQy0i1U-LhoqF9njqJWA8v4b-XHfXZ4VOr1TQ,10205
+deltachat_rpc_client/message.py,sha256=o5XqsfwNS-MFv7ptjTA4no-OsIDliIopsMp3vs8qBwA,3946
+deltachat_rpc_client/py.typed,sha256=nGQ9Itq-bkXBn5Ri1JIR0oYnDNv7LDRfkowxBSSqVTM,60
+deltachat_rpc_client/pytestplugin.py,sha256=gUOP63mbEBrWJAta1JOoXaGYm3oCElYRgBkEEtKtnn8,5603
+deltachat_rpc_client/rpc.py,sha256=AUY8UJP7NlRSE5ewJs9jGxJdK8etKqsCEFWiIqnX5T8,6981
+deltachat_rpc_client-2.0.0.dist-info/licenses/LICENSE,sha256=Pz2eACSxkhsGfW9_iN60pgy-enjnbGTj8df8O3ebnQQ,16726
+deltachat_rpc_client-2.0.0.dist-info/METADATA,sha256=zuDbTsinHJ5sBJpUtKF8mTOTnYHPmUgHU5SnqlEbavE,2173
+deltachat_rpc_client-2.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+deltachat_rpc_client-2.0.0.dist-info/entry_points.txt,sha256=VHpX6EnKBaNj89qJWctApThnMa8suyaamfZEnQacXgc,81
+deltachat_rpc_client-2.0.0.dist-info/top_level.txt,sha256=ePNMkY10htGrLiLydH1ITvYFM3LcTEa51HyPqJ40hDk,21
+deltachat_rpc_client-2.0.0.dist-info/RECORD,,

{deltachat_rpc_client-1.159.5.dist-info → deltachat_rpc_client-2.0.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.4.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

deltachat_rpc_client-1.159.5.dist-info/RECORD

@@ -1,19 +0,0 @@
-deltachat_rpc_client/__init__.py,sha256=zroJARiq9HBi7Ln03KlICOUJHSjm3CGIFkHfXILEdOQ,567
-deltachat_rpc_client/_utils.py,sha256=v0iWVSa6S-s078GgnnhflCRhA9pfWI-CfK8mjZ4zjXc,6393
-deltachat_rpc_client/account.py,sha256=1Vh2Dez3CCpXaZaa9Fyjpx8fkKheg5n-4_1YOZ5qqTM,16554
-deltachat_rpc_client/chat.py,sha256=LTZSYHC24bo5fDAX1XCDP79XaHIyuPZS_-zzD0vu1Rw,11238
-deltachat_rpc_client/client.py,sha256=UeCJov-ZvB3WMzl_6aJEESGRQCdvS3UAKFL4Adar6cg,7206
-deltachat_rpc_client/const.py,sha256=3Ds8xvY58CIntj7SfJ6BLdlu20csBTlUV8x8OkqGXCM,5778
-deltachat_rpc_client/contact.py,sha256=ORhz1TWcCxvYQnpVACDptWEbrpjKoIJEsTWAcwo8Fqw,2043
-deltachat_rpc_client/deltachat.py,sha256=4KpiHbpfXM_LmbG-OvtDACK9W09UH0tsJyFunfH9TR4,1544
-deltachat_rpc_client/events.py,sha256=Y45LoGlQy0i1U-LhoqF9njqJWA8v4b-XHfXZ4VOr1TQ,10205
-deltachat_rpc_client/message.py,sha256=2MnC4OgDockrfqPherOI_ad8AFbGhHGLVoGKanb5GRU,3687
-deltachat_rpc_client/py.typed,sha256=nGQ9Itq-bkXBn5Ri1JIR0oYnDNv7LDRfkowxBSSqVTM,60
-deltachat_rpc_client/pytestplugin.py,sha256=gUOP63mbEBrWJAta1JOoXaGYm3oCElYRgBkEEtKtnn8,5603
-deltachat_rpc_client/rpc.py,sha256=AUY8UJP7NlRSE5ewJs9jGxJdK8etKqsCEFWiIqnX5T8,6981
-deltachat_rpc_client-1.159.5.dist-info/licenses/LICENSE,sha256=Pz2eACSxkhsGfW9_iN60pgy-enjnbGTj8df8O3ebnQQ,16726
-deltachat_rpc_client-1.159.5.dist-info/METADATA,sha256=kL0BDIsaZRscIRk2NBI-FlAjrDzdnl_McVDVafq0ryY,2175
-deltachat_rpc_client-1.159.5.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
-deltachat_rpc_client-1.159.5.dist-info/entry_points.txt,sha256=VHpX6EnKBaNj89qJWctApThnMa8suyaamfZEnQacXgc,81
-deltachat_rpc_client-1.159.5.dist-info/top_level.txt,sha256=ePNMkY10htGrLiLydH1ITvYFM3LcTEa51HyPqJ40hDk,21
-deltachat_rpc_client-1.159.5.dist-info/RECORD,,