slidge.util.types#

Module Contents#

Classes#

MessageReference

A "message reply", ie a "quoted message" (XEP-0461)

LegacyAttachment

A file attachment to a message

Attributes#

LegacyGroupIdType

LegacyMessageType

LegacyThreadType

LegacyUserIdType

LegacyContactType

LegacyMUCType

LegacyParticipantType

PepItemType

Recipient

RecipientType

Sender

AvatarType

ChatState

ProcessingHint

Marker

PresenceShow

FieldType

slidge.util.types.LegacyGroupIdType[source]#
slidge.util.types.LegacyMessageType[source]#
slidge.util.types.LegacyThreadType[source]#
slidge.util.types.LegacyUserIdType[source]#
slidge.util.types.LegacyContactType[source]#
slidge.util.types.LegacyMUCType[source]#
slidge.util.types.LegacyParticipantType[source]#
slidge.util.types.PepItemType[source]#
slidge.util.types.Recipient[source]#
slidge.util.types.RecipientType[source]#
slidge.util.types.Sender[source]#
slidge.util.types.AvatarType[source]#
slidge.util.types.ChatState[source]#
slidge.util.types.ProcessingHint[source]#
slidge.util.types.Marker[source]#
slidge.util.types.PresenceShow[source]#
slidge.util.types.FieldType[source]#
class slidge.util.types.MessageReference[source]#

Bases: Generic[LegacyMessageType]

A “message reply”, ie a “quoted message” (XEP-0461)

At the very minimum, the legacy message ID attribute must be set, but to ensure that the quote is displayed in all XMPP clients, the author must also be set. The body is used as a fallback for XMPP clients that do not support XEP-0461 of that failed to find the referenced message.

legacy_id: LegacyMessageType[source]#
author: slidge.util.db.GatewayUser | slidge.core.muc.participant.LegacyParticipant | slidge.core.contact.LegacyContact | None[source]#
body: str | None[source]#
class slidge.util.types.LegacyAttachment[source]#

A file attachment to a message

At the minimum, one of the path, steam, data or url attribute has to be set

To be used with LegacyContact.send_files() or LegacyParticipant.send_files()

path: pathlib.Path | str | None[source]#
name: str | None[source]#
stream: IO[bytes] | None[source]#
data: bytes | None[source]#
content_type: str | None[source]#
legacy_file_id: str | int | None[source]#
url: str | None[source]#
caption: str | None[source]#

A caption for this specific image. For a global caption for a list of attachments, use the body parameter of AttachmentMixin.send_files()

__post_init__()[source]#