Events

Bases: ABC, BaseModel

Shared shape and fields common to every received event.

Fields:

• server_delivered_timestamp (int)
• server_received_timestamp (int)
• source (str | None)
• source_device (int | None)
• source_name (str | None)
• source_number (str | None)
• source_uuid (str | None)
• timestamp (int)

14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

class BaseMessage(ABC, BaseModel):
    """Shared shape and fields common to every received event."""

    server_delivered_timestamp: int
    server_received_timestamp: int
    source: str | None = Field(default=None, deprecated=True)
    source_device: int | None = None
    source_name: str | None = None
    source_number: str | None = None
    source_uuid: str | None = None
    timestamp: int

    @abstractmethod
    def is_group(self) -> bool:
        """Check if the message is a group message.

        Returns:
            True if the message is a group message, False otherwise.
        """

    @abstractmethod
    def is_private(self) -> bool:
        """Check if the message is a private (one-on-one) message.


        Returns:
            True if the message is a private (one-on-one) message, False otherwise.
        """

    @abstractmethod
    def source_or_group_id(self) -> str:
        """Get the source of the message.

        Returns:
            The source of the message.
        """

is_group() -> bool

26
27
28
29
30
31
32

@abstractmethod
def is_group(self) -> bool:
    """Check if the message is a group message.

    Returns:
        True if the message is a group message, False otherwise.
    """

is_private() -> bool

34
35
36
37
38
39
40
41

@abstractmethod
def is_private(self) -> bool:
    """Check if the message is a private (one-on-one) message.


    Returns:
        True if the message is a private (one-on-one) message, False otherwise.
    """

source_or_group_id() -> str

43
44
45
46
47
48
49

@abstractmethod
def source_or_group_id(self) -> str:
    """Get the source of the message.

    Returns:
        The source of the message.
    """

Bases: BaseMessage

BaseMessage variant for events that may originate from a group.

Fields:

• server_delivered_timestamp (int)
• server_received_timestamp (int)
• source (str | None)
• source_device (int | None)
• source_name (str | None)
• source_number (str | None)
• source_uuid (str | None)
• timestamp (int)
• group_info (GroupInfo | None)

52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

class BaseMessageWithGroup(BaseMessage):
    """BaseMessage variant for events that may originate from a group."""

    group_info: GroupInfo | None = None

    def is_group(self) -> bool:

        return self.group_info is not None and self.group_info.group_id is not None

    def is_private(self) -> bool:

        return not self.is_group()

    def source_or_group_id(self) -> str:

        if self.group_info is not None and self.group_info.group_id is not None:
            return self.group_info.group_id

        if self.source_uuid is not None:
            return self.source_uuid

        if self.source_number is not None:
            return self.source_number

        error_msg = "Message does not contain a source"
        raise ValueError(error_msg)

Bases: GroupInfo

The group a received event originated from, if any.

Fields:

• group_id (str | None)
• group_name (str | None)
• revision (int)
• type (str | None)

10
11

class GroupInfo(GeneratedGroupInfo):
    """The group a received event originated from, if any."""