mir/pyrogram
2
0
Fork 0
mirror of https://github.com/pyrogram/pyrogram synced 2025-08-29 05:18:10 +00:00
Code Issues Releases Wiki Activity

Cleaner Chat docstrings

Browse Source
This commit is contained in:
Dan 2018-07-11 17:25:39 +02:00
parent f7b661a6c4
commit ad9fb26808
1 changed files with 17 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
pyrogram/client/types/chat.py
View File

@ -24,15 +24,13 @@ class Chat(Object):
Args: Args:
id (``int``): id (``int``):
Unique identifier for this chat. This number may be greater than 32 bits and some programming Unique identifier for this chat.
languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits,
so a signed 64 bit integer or double-precision float type are safe for storing this identifier.
type (``str``): type (``str``):
Type of chat, can be either "private", "group", "supergroup" or "channel". Type of chat, can be either "private", "group", "supergroup" or "channel".
title (``str``, *optional*): title (``str``, *optional*):
Title, for supergroups, channels and group chats. Title, for supergroups, channels and basic group chats.
username (``str``, *optional*): username (``str``, *optional*):
Username, for private chats, supergroups and channels if available. Username, for private chats, supergroups and channels if available.
@ -44,25 +42,33 @@ class Chat(Object):
Last name of the other party in a private chat. Last name of the other party in a private chat.
all_members_are_administrators (``bool``, *optional*): all_members_are_administrators (``bool``, *optional*):
True if a group has 'All Members Are Admins' enabled. True if a basic group has "All Members Are Admins" enabled.
photo (:obj:`ChatPhoto <pyrogram.ChatPhoto>`, *optional*): photo (:obj:`ChatPhoto <pyrogram.ChatPhoto>`, *optional*):
Chat photo. Returned only in getChat. Chat photo. Suitable for downloads only.
description (``str``, *optional*): description (``str``, *optional*):
Description, for supergroups and channel chats. Returned only in getChat. Description, for supergroups and channel chats.
Returned only in :meth:`get_chat() <pyrogram.Client.get_chat>`.
invite_link (``str``, *optional*): invite_link (``str``, *optional*):
Chat invite link, for supergroups and channel chats. Returned only in getChat. Chat invite link, for supergroups and channel chats.
Returned only in :meth:`get_chat() <pyrogram.Client.get_chat>`.
pinned_message (:obj:`Message <pyrogram.Message>`, *optional*): pinned_message (:obj:`Message <pyrogram.Message>`, *optional*):
Pinned message, for supergroups and channel chats. Returned only in getChat. Pinned message, for supergroups and channel chats.
Returned only in :meth:`get_chat() <pyrogram.Client.get_chat>`.
sticker_set_name (``str``, *optional*): sticker_set_name (``str``, *optional*):
For supergroups, name of group sticker set. Returned only in getChat. For supergroups, name of group sticker set.
Returned only in :meth:`get_chat() <pyrogram.Client.get_chat>`.
can_set_sticker_set (``bool``, *optional*): can_set_sticker_set (``bool``, *optional*):
True, if the bot can change the group sticker set. Returned only in getChat. True, if the group sticker set can be changed by you.
Returned only in :meth:`get_chat() <pyrogram.Client.get_chat>`.
members_count (``int``, *optional*):
Chat members count, for groups and channels only.
""" """
ID = 0xb0700002 ID = 0xb0700002