mirror of
https://github.com/pyrogram/pyrogram
synced 2025-08-29 13:27:47 +00:00
Remove pyrogram types IDs from docs
This commit is contained in:
parent
42e8e1f9b5
commit
e081637f37
@ -22,9 +22,6 @@ from pyrogram.api.core import Object
|
|||||||
class Audio(Object):
|
class Audio(Object):
|
||||||
"""This object represents an audio file to be treated as music by the Telegram clients.
|
"""This object represents an audio file to be treated as music by the Telegram clients.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700006``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
file_id (``str``):
|
file_id (``str``):
|
||||||
Unique identifier for this file.
|
Unique identifier for this file.
|
||||||
|
@ -25,9 +25,6 @@ class CallbackQuery(Object):
|
|||||||
will be present. If the button was attached to a message sent via the bot (in inline mode),
|
will be present. If the button was attached to a message sent via the bot (in inline mode),
|
||||||
the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.
|
the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700024``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
id (``str``):
|
id (``str``):
|
||||||
Unique identifier for this query.
|
Unique identifier for this query.
|
||||||
|
@ -22,9 +22,6 @@ from pyrogram.api.core import Object
|
|||||||
class Chat(Object):
|
class Chat(Object):
|
||||||
"""This object represents a chat.
|
"""This object represents a chat.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700002``
|
|
||||||
|
|
||||||
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. This number may be greater than 32 bits and some programming
|
||||||
|
@ -22,9 +22,6 @@ from pyrogram.api.core import Object
|
|||||||
class ChatMember(Object):
|
class ChatMember(Object):
|
||||||
"""This object contains information about one member of a chat.
|
"""This object contains information about one member of a chat.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700016``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
user (:obj:`User <pyrogram.User>`):
|
user (:obj:`User <pyrogram.User>`):
|
||||||
Information about the user.
|
Information about the user.
|
||||||
|
@ -22,9 +22,6 @@ from pyrogram.api.core import Object
|
|||||||
class ChatPhoto(Object):
|
class ChatPhoto(Object):
|
||||||
"""This object represents a chat photo.
|
"""This object represents a chat photo.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700015``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
small_file_id (``str``):
|
small_file_id (``str``):
|
||||||
Unique file identifier of small (160x160) chat photo. This file_id can be used only for photo download.
|
Unique file identifier of small (160x160) chat photo. This file_id can be used only for photo download.
|
||||||
|
@ -22,9 +22,6 @@ from pyrogram.api.core import Object
|
|||||||
class Contact(Object):
|
class Contact(Object):
|
||||||
"""This object represents a phone contact.
|
"""This object represents a phone contact.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700011``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
phone_number (``str``):
|
phone_number (``str``):
|
||||||
Contact's phone number.
|
Contact's phone number.
|
||||||
|
@ -22,9 +22,6 @@ from pyrogram.api.core import Object
|
|||||||
class Document(Object):
|
class Document(Object):
|
||||||
"""This object represents a general file (as opposed to photos, voice messages and audio files).
|
"""This object represents a general file (as opposed to photos, voice messages and audio files).
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700007``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
file_id (``str``):
|
file_id (``str``):
|
||||||
Unique file identifier.
|
Unique file identifier.
|
||||||
|
@ -22,9 +22,6 @@ from pyrogram.api.core import Object
|
|||||||
class GIF(Object):
|
class GIF(Object):
|
||||||
"""This object represents a GIF file.
|
"""This object represents a GIF file.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700025``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
file_id (``str``):
|
file_id (``str``):
|
||||||
Unique identifier for this file.
|
Unique identifier for this file.
|
||||||
|
@ -22,9 +22,6 @@ from pyrogram.api.core import Object
|
|||||||
class Location(Object):
|
class Location(Object):
|
||||||
"""This object represents a point on the map.
|
"""This object represents a point on the map.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700012``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
longitude (``float``):
|
longitude (``float``):
|
||||||
Longitude as defined by sender.
|
Longitude as defined by sender.
|
||||||
|
@ -22,9 +22,6 @@ from pyrogram.api.core import Object
|
|||||||
class Message(Object):
|
class Message(Object):
|
||||||
"""This object represents a message.
|
"""This object represents a message.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700003``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
message_id (``int``):
|
message_id (``int``):
|
||||||
Unique message identifier inside this chat.
|
Unique message identifier inside this chat.
|
||||||
|
@ -23,9 +23,6 @@ class MessageEntity(Object):
|
|||||||
"""This object represents one special entity in a text message.
|
"""This object represents one special entity in a text message.
|
||||||
For example, hashtags, usernames, URLs, etc.
|
For example, hashtags, usernames, URLs, etc.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700004``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
type (``str``):
|
type (``str``):
|
||||||
Type of the entity.
|
Type of the entity.
|
||||||
|
@ -22,9 +22,6 @@ from pyrogram.api.core import Object
|
|||||||
class Messages(Object):
|
class Messages(Object):
|
||||||
"""This object represent a chat's messages.
|
"""This object represent a chat's messages.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700026``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
total_count (``int``):
|
total_count (``int``):
|
||||||
Total number of messages the target chat has.
|
Total number of messages the target chat has.
|
||||||
|
@ -22,9 +22,6 @@ from pyrogram.api.core import Object
|
|||||||
class PhotoSize(Object):
|
class PhotoSize(Object):
|
||||||
"""This object represents one size of a photo or a file / sticker thumbnail.
|
"""This object represents one size of a photo or a file / sticker thumbnail.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700005``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
file_id (``str``):
|
file_id (``str``):
|
||||||
Unique identifier for this file.
|
Unique identifier for this file.
|
||||||
|
@ -26,9 +26,6 @@ class ForceReply(Object):
|
|||||||
This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to
|
This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to
|
||||||
sacrifice privacy mode.
|
sacrifice privacy mode.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700018``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
selective (``bool``, *optional*):
|
selective (``bool``, *optional*):
|
||||||
Use this parameter if you want to force reply from specific users only. Targets:
|
Use this parameter if you want to force reply from specific users only. Targets:
|
||||||
|
@ -27,9 +27,6 @@ from pyrogram.api.types import (
|
|||||||
class InlineKeyboardButton(Object):
|
class InlineKeyboardButton(Object):
|
||||||
"""This object represents one button of an inline keyboard. You must use exactly one of the optional fields.
|
"""This object represents one button of an inline keyboard. You must use exactly one of the optional fields.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700019``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
text (``str``):
|
text (``str``):
|
||||||
Label text on the button.
|
Label text on the button.
|
||||||
|
@ -25,9 +25,6 @@ from . import InlineKeyboardButton
|
|||||||
class InlineKeyboardMarkup(Object):
|
class InlineKeyboardMarkup(Object):
|
||||||
"""This object represents an inline keyboard that appears right next to the message it belongs to.
|
"""This object represents an inline keyboard that appears right next to the message it belongs to.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700020``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
inline_keyboard (List of List of :obj:`InlineKeyboardButton <pyrogram.InlineKeyboardButton>`):
|
inline_keyboard (List of List of :obj:`InlineKeyboardButton <pyrogram.InlineKeyboardButton>`):
|
||||||
Array of button rows, each represented by an Array of InlineKeyboardButton objects.
|
Array of button rows, each represented by an Array of InlineKeyboardButton objects.
|
||||||
|
@ -27,9 +27,6 @@ class KeyboardButton(Object):
|
|||||||
For simple text buttons String can be used instead of this object to specify text of the button.
|
For simple text buttons String can be used instead of this object to specify text of the button.
|
||||||
Optional fields are mutually exclusive.
|
Optional fields are mutually exclusive.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700021``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
text (``str``):
|
text (``str``):
|
||||||
Text of the button. If none of the optional fields are used, it will be sent as a message when
|
Text of the button. If none of the optional fields are used, it will be sent as a message when
|
||||||
|
@ -27,9 +27,6 @@ from . import KeyboardButton
|
|||||||
class ReplyKeyboardMarkup(Object):
|
class ReplyKeyboardMarkup(Object):
|
||||||
"""This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).
|
"""This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700022``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
keyboard (List of List of :obj:`KeyboardButton <pyrogram.KeyboardButton>`):
|
keyboard (List of List of :obj:`KeyboardButton <pyrogram.KeyboardButton>`):
|
||||||
Array of button rows, each represented by an Array of KeyboardButton objects.
|
Array of button rows, each represented by an Array of KeyboardButton objects.
|
||||||
|
@ -26,9 +26,6 @@ class ReplyKeyboardRemove(Object):
|
|||||||
by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a
|
by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a
|
||||||
button (see ReplyKeyboardMarkup).
|
button (see ReplyKeyboardMarkup).
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700023``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
selective (``bool``, *optional*):
|
selective (``bool``, *optional*):
|
||||||
Use this parameter if you want to remove the keyboard for specific users only. Targets:
|
Use this parameter if you want to remove the keyboard for specific users only. Targets:
|
||||||
|
@ -22,9 +22,6 @@ from pyrogram.api.core import Object
|
|||||||
class Sticker(Object):
|
class Sticker(Object):
|
||||||
"""This object represents a sticker.
|
"""This object represents a sticker.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700017``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
file_id (``str``):
|
file_id (``str``):
|
||||||
Unique identifier for this file.
|
Unique identifier for this file.
|
||||||
|
@ -23,9 +23,6 @@ class Update(Object):
|
|||||||
"""This object represents an incoming update.
|
"""This object represents an incoming update.
|
||||||
At most one of the optional parameters can be present in any given update.
|
At most one of the optional parameters can be present in any given update.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700000``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
message (:obj:`Message <pyrogram.Message>`, *optional*):
|
message (:obj:`Message <pyrogram.Message>`, *optional*):
|
||||||
New incoming message of any kind — text, photo, sticker, etc.
|
New incoming message of any kind — text, photo, sticker, etc.
|
||||||
|
@ -22,9 +22,6 @@ from pyrogram.api.core import Object
|
|||||||
class User(Object):
|
class User(Object):
|
||||||
"""This object represents a Telegram user or bot.
|
"""This object represents a Telegram user or bot.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700001``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
id (``int``):
|
id (``int``):
|
||||||
Unique identifier for this user or bot.
|
Unique identifier for this user or bot.
|
||||||
|
@ -22,9 +22,6 @@ from pyrogram.api.core import Object
|
|||||||
class UserProfilePhotos(Object):
|
class UserProfilePhotos(Object):
|
||||||
"""This object represent a user's profile pictures.
|
"""This object represent a user's profile pictures.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700014``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
total_count (``int``):
|
total_count (``int``):
|
||||||
Total number of profile pictures the target user has.
|
Total number of profile pictures the target user has.
|
||||||
|
@ -22,9 +22,6 @@ from pyrogram.api.core import Object
|
|||||||
class Venue(Object):
|
class Venue(Object):
|
||||||
"""This object represents a venue.
|
"""This object represents a venue.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700013``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
location (:obj:`Location <pyrogram.Location>`):
|
location (:obj:`Location <pyrogram.Location>`):
|
||||||
Venue location.
|
Venue location.
|
||||||
|
@ -22,9 +22,6 @@ from pyrogram.api.core import Object
|
|||||||
class Video(Object):
|
class Video(Object):
|
||||||
"""This object represents a video file.
|
"""This object represents a video file.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700008``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
file_id (``str``):
|
file_id (``str``):
|
||||||
Unique identifier for this file.
|
Unique identifier for this file.
|
||||||
|
@ -22,9 +22,6 @@ from pyrogram.api.core import Object
|
|||||||
class VideoNote(Object):
|
class VideoNote(Object):
|
||||||
"""This object represents a video message (available in Telegram apps as of v.4.0).
|
"""This object represents a video message (available in Telegram apps as of v.4.0).
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700010``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
file_id (``str``):
|
file_id (``str``):
|
||||||
Unique identifier for this file.
|
Unique identifier for this file.
|
||||||
|
@ -22,9 +22,6 @@ from pyrogram.api.core import Object
|
|||||||
class Voice(Object):
|
class Voice(Object):
|
||||||
"""This object represents a voice note.
|
"""This object represents a voice note.
|
||||||
|
|
||||||
Attributes:
|
|
||||||
ID: ``0xb0700009``
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
file_id (``str``):
|
file_id (``str``):
|
||||||
Unique identifier for this file.
|
Unique identifier for this file.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user