ChatMember

class pyrogram.types.ChatMember

Contains information about one member of a chat.

Parameters:

  • status (:obj:`~pyrogram.enums.ChatMemberStatus`) – The member’s status in the chat.

  • user (:obj:`~pyrogram.types.User`, *optional*) – Information about the user.

  • chat (:obj:`~pyrogram.types.Chat`, *optional*) – Information about the chat (useful in case of banned channel senders).

  • joined_date (:py:obj:`~datetime.datetime`, *optional*) – Date when the user joined. Not available for the owner.

  • custom_title (``str``, *optional*) – A custom title that will be shown to all members instead of “Owner” or “Admin”. Creator (owner) and administrators only. Can be None in case there’s no custom title set.

  • tag (``str``, *optional*) – Tag of the chat member or its custom title if the member is an administrator of the chat. 0-16 characters without emoji. Applicable to basic groups and supergroups only.

  • until_date (:py:obj:`~datetime.datetime`, *optional*) – Member, restricted, banned only. If status is RESTRICTED or BANNED, Date when restrictions will be lifted for this user. If status is MEMBER, Date when the user’s subscription will expire.

  • invited_by (:obj:`~pyrogram.types.User`, *optional*) – Administrators and self member only. Information about the user who invited this member. In case the user joined by himself this will be the same as “user”.

  • promoted_by (:obj:`~pyrogram.types.User`, *optional*) – Administrators only. Information about the user who promoted this member as administrator.

  • restricted_by (:obj:`~pyrogram.types.User`, *optional*) – Restricted and banned only. Information about the user who restricted or banned this member.

  • is_member (``bool``, *optional*) – Restricted only. True, if the user is a member of the chat at the moment of the request.

  • can_be_edited (``bool``, *optional*) – True, if the you are allowed to edit administrator privileges of the user.

  • permissions (:obj:`~pyrogram.types.ChatPermissions`, *optional*) – Restricted only. Restricted actions that a non-administrator user is allowed to take.

  • privileges (:obj:`~pyrogram.types.ChatPrivileges`, *optional*) – Administrators only. Privileged actions that an administrator is able to take.