slidgram.group¶
Attributes¶
Classes¶
This is instantiated once per |
|
Mixin for XMPP entities that have avatars that represent them. |
|
A legacy participant of a legacy group chat. |
Functions¶
|
Module Contents¶
- class slidgram.group.Bookmarks(session)[source]¶
Bases:
slidge.group.LegacyBookmarks
[int
,MUC
]This is instantiated once per
BaseSession
- Parameters:
session (slidge.core.session.BaseSession)
- session: slidgram.session.Session[source]¶
- property tg: slidgram.telegram.Client[source]¶
- Return type:
- class slidgram.group.MUC(*a, **kw)[source]¶
Bases:
slidgram.reactions.ReactionsMixin
,slidgram.avatar.SetAvatarMixin
,slidge.group.LegacyMUC
[int
,int
,Participant
,int
]Mixin for XMPP entities that have avatars that represent them.
Both
slidge.LegacyContact
andslidge.LegacyMUC
useAvatarMixin
.- session: slidgram.session.Session[source]¶
- property tg: slidgram.telegram.Client[source]¶
- Return type:
- async update_info()[source]¶
Fetch information about this group from the legacy network
This is awaited on MUC instantiation, and should be overridden to update the attributes of the group chat, like title, subject, number of participants etc.
To take advantage of the slidge avatar cache, you can check the .avatar property to retrieve the “legacy file ID” of the cached avatar. If there is no change, you should not call
slidge.core.mixins.avatar.AvatarMixin.set_avatar()
or attempt to modify the :attr:.avatar property.
- async fill_participants()[source]¶
This method should yield the list of all members of this group.
Typically, use
participant = self.get_participant()
, self.get_participant_by_contact(), of self.get_user_participant(), and update their affiliation, hats, etc. before yielding them.
- async backfill(after=None, before=None)[source]¶
Override this if the legacy network provide server-side group archives.
In it, send history messages using
self.get_participant(xxx).send_xxxx
, with thearchive_only=True
kwarg. This is only called once per slidge run for a given group.- Parameters:
after (slidge.util.types.HoleBound | None) – Fetch messages after this one. If
None
, it’s up to you to decide how far you want to go in the archive. If it’s notNone
, it means slidge has some messages in this archive and you should really try to complete it to avoid “holes” in the history of this group.before (slidge.util.types.HoleBound | None) – Fetch messages before this one. If
None
, fetch all messages up to the most recent one
- async on_set_affiliation(contact, affiliation, reason, nickname)[source]¶
Triggered when the user requests changing the affiliation of a contact for this group.
Examples: promotion them to moderator, ban (affiliation=outcast).
- Parameters:
contact (slidgram.contact.Contact) – The contact whose affiliation change is requested
affiliation (slidge.util.types.MucAffiliation) – The new affiliation
reason (str | None) – A reason for this affiliation change
nickname (str | None)
- async on_kick(contact, reason, nickname)[source]¶
Triggered when the user requests changing the role of a contact to “none” for this group. Action commonly known as “kick”.
- Parameters:
contact (slidgram.contact.Contact) – Contact to be kicked
reason (str | None) – A reason for this kick
nickname (str | None)
- async _on_ban(member, contact, until=zero_datetime())[source]¶
- Parameters:
member (pyrogram.types.ChatMember)
contact (slidgram.contact.Contact)
until (datetime.datetime)
- Return type:
None
- async _on_set_member(member, contact)[source]¶
- Parameters:
member (pyrogram.types.ChatMember)
contact (slidgram.contact.Contact)
- Return type:
None
- async _on_set_admin(member, contact)[source]¶
- Parameters:
member (pyrogram.types.ChatMember)
contact (slidgram.contact.Contact)
- Return type:
None
- async on_set_config(name, description)[source]¶
Triggered when the user requests changing the room configuration. Only title and description can be changed at the moment.
The legacy module is responsible for updating
title
and/ordescription
of this instance.If
HAS_DESCRIPTION
is set to False, description will always beNone
.
- async on_destroy_request(reason)[source]¶
Triggered when the user requests room destruction.
- Parameters:
reason (str | None) – Optionally, a reason for the destruction
- async on_avatar(data, mime)[source]¶
Called when the user tries to set the avatar of the room from an XMPP client.
If the set avatar operation is completed, should return a legacy image unique identifier. In this case the MUC avatar will be immediately updated on the XMPP side.
If data is not None and this method returns None, then we assume that self.set_avatar() will be called elsewhere, eg triggered by a legacy room update event.
- Parameters:
- Returns:
A unique avatar identifier, which will trigger
slidge.group.room.LegacyMUC.set_avatar()
. Alternatively, None, ifLegacyMUC.set_avatar()
is meant to be awaited somewhere else.- Return type:
None
- async on_set_subject(subject)[source]¶
Triggered when the user requests changing the room subject.
The legacy module is responsible for updating
subject
of this instance.- Parameters:
subject (str) – The new subject for this room.
- Return type:
None
- set_tg_pinned_message(message=None)[source]¶
- Parameters:
message (pyrogram.types.Message | None)
- Return type:
None
- class slidgram.group.Participant(*a, **kw)[source]¶
Bases:
slidgram.tg_msg.TelegramMessageSenderMixin
,slidge.group.LegacyParticipant
A legacy participant of a legacy group chat.