Module pytgcalls.mtproto.data

Expand source code 
#  tgcalls - a Python binding for C++ library by Telegram
#  pytgcalls - a library connecting the Python binding with MTProto
#  Copyright (C) 2020-2021 Il`ya (Marshal) <https://github.com/MarshalX>
#
#  This file is part of tgcalls and pytgcalls.
#
#  tgcalls and pytgcalls is free software: you can redistribute it and/or modify
#  it under the terms of the GNU Lesser General Public License as published
#  by the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#
#  tgcalls and pytgcalls is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU Lesser General Public License for more details.
#
#  You should have received a copy of the GNU Lesser General Public License v3
#  along with tgcalls. If not, see <http://www.gnu.org/licenses/>.

from .base_wrapper import WrapperBase
from .group_call_wrapper import GroupCallWrapper
from .group_call_discarded_wrapper import GroupCallDiscardedWrapper
from .group_call_participant_wrapper import GroupCallParticipantWrapper

__all__ = [
    'WrapperBase',
    'GroupCallWrapper',
    'GroupCallDiscardedWrapper',
    'GroupCallParticipantWrapper',
]

Sub-modules

pytgcalls.mtproto.data.base_wrapper
pytgcalls.mtproto.data.group_call_discarded_wrapper
pytgcalls.mtproto.data.group_call_participant_wrapper
pytgcalls.mtproto.data.group_call_wrapper
pytgcalls.mtproto.data.update

Classes

class GroupCallDiscardedWrapper
Expand source code 
class GroupCallDiscardedWrapper(WrapperBase):
    def __init__(self):
        pass

Ancestors

class GroupCallParticipantWrapper (peer: Union[_ForwardRef('raw.base.Peer'), _ForwardRef('TypePeer')], date: Union[int, datetime.datetime, NoneType], source: int, muted: Optional[bool] = None, left: Optional[bool] = None, can_self_unmute: Optional[bool] = None, just_joined: Optional[bool] = None, versioned: Optional[bool] = None, min: Optional[bool] = None, muted_by_you: Optional[bool] = None, volume_by_admin: Optional[bool] = None, is_self: Optional[bool] = None, video_joined: Optional[bool] = None, active_date: Union[int, datetime.datetime, NoneType] = None, volume: Optional[int] = None, about: Optional[str] = None, raise_hand_rating: Optional[int] = None, **kwargs)

Group Call Participant wrapper for any MTProto client.

Note

peer will be raw.base.Peer when you are using Pyrogram bridge.

peer will be TypePeer when you are using Telethon bridge.

date and active_datewill be int when you are using Pyrogram bridge.

date and active_datewill be datetime when you are using Telethon bridge.

video_joined always will be None for Pyrogram until it will update.

Expand source code 
class GroupCallParticipantWrapper(WrapperBase):
    """Group Call Participant wrapper for any MTProto client.

    Note:
        `peer` will be `raw.base.Peer` when you are using Pyrogram bridge.

        `peer` will be `TypePeer` when you are using Telethon bridge.

        `date` and `active_date`will be `int` when you are using Pyrogram bridge.

        `date` and `active_date`will be `datetime` when you are using Telethon bridge.

        `video_joined` always will be `None` for Pyrogram until it will update.
    """

    def __init__(
        self,
        peer: Union['raw.base.Peer', 'TypePeer'],
        date: Optional[Union[int, datetime]],
        source: int,
        muted: Optional[bool] = None,
        left: Optional[bool] = None,
        can_self_unmute: Optional[bool] = None,
        just_joined: Optional[bool] = None,
        versioned: Optional[bool] = None,
        min: Optional[bool] = None,
        muted_by_you: Optional[bool] = None,
        volume_by_admin: Optional[bool] = None,
        is_self: Optional[bool] = None,
        video_joined: Optional[bool] = None,
        active_date: Optional[Union[int, datetime]] = None,
        volume: Optional[int] = None,
        about: Optional[str] = None,
        raise_hand_rating: Optional[int] = None,
        **kwargs,  # to bypass new attr from layers
    ):
        self.peer = peer
        '''Peer (as joined) of the group call participant'''
        self.date = date
        self.source = source
        '''User's audio channel synchronization source identifier'''
        self.muted = muted
        '''True, if the participant is muted for all users'''
        self.left = left
        '''True, if the participant left the group call'''
        self.can_self_unmute = can_self_unmute
        '''True, if the participant is muted for all users, but can unmute themselves'''
        self.just_joined = just_joined
        self.versioned = versioned
        self.min = min
        self.muted_by_you = muted_by_you
        '''True, if the current user can mute the participant only for self'''
        self.volume_by_admin = volume_by_admin
        self.is_self = is_self
        '''True, if the participant is the current user'''
        self.video_joined = video_joined
        self.active_date = active_date
        self.volume = volume
        '''Participant's volume level'''
        self.about = about
        '''The participant user's bio or the participant chat's description'''
        self.raise_hand_rating = raise_hand_rating

    @classmethod
    def create(cls, participant):
        if hasattr(participant, '__slots__'):  # pyrogram
            attrs = participant.__slots__
            args_for_init = {}
            for attr in attrs:
                args_for_init[attr] = getattr(participant, attr, None)

            return cls(**args_for_init)
        else:  # telethon
            return cls(**vars(participant))

Ancestors

Static methods

def create(participant)
Expand source code 
@classmethod
def create(cls, participant):
    if hasattr(participant, '__slots__'):  # pyrogram
        attrs = participant.__slots__
        args_for_init = {}
        for attr in attrs:
            args_for_init[attr] = getattr(participant, attr, None)

        return cls(**args_for_init)
    else:  # telethon
        return cls(**vars(participant))

Instance variables

var about

The participant user's bio or the participant chat's description

var can_self_unmute

True, if the participant is muted for all users, but can unmute themselves

var is_self

True, if the participant is the current user

var left

True, if the participant left the group call

var muted

True, if the participant is muted for all users

var muted_by_you

True, if the current user can mute the participant only for self

var peer

Peer (as joined) of the group call participant

var source

User's audio channel synchronization source identifier

var volume

Participant's volume level

class GroupCallWrapper (call_id: int, params)
Expand source code 
class GroupCallWrapper(WrapperBase):
    def __init__(self, call_id: int, params):
        self.id = call_id
        self.params = params  # its a DataJSON object with params.data attr

Ancestors

class WrapperBase
Expand source code 
class WrapperBase:
    __slots__ = '__dict__'

    def __repr__(self):
        return f'<{self.__class__.__name__}>({vars(self)})'

    def __str__(self):
        return repr(self)

Subclasses