id stringlengths 16 145 | text stringlengths 1 179k | title stringclasses 1
value |
|---|---|---|
TeleBot/Types_of_API_39_0.txt | _ class _ telebot.types. ChatMemberLeft ( _ user _ , _ status _ , _
custom_title = None _ , _ is_anonymous = None _ , _ can_be_edited =
None _ , _ can_post_messages = None _ , _ can_edit_messages = None _ ,
_ can_delete_messages = None _ , _ can_restrict_members = None _ , _
can_promote_member... | |
TeleBot/TeleBot_2_58.txt | * **sticker_format** ( ` str ` ) – One of “static”, “animated”, “video”.
Returns :
On success, the sent file is returned.
Return type :
[ ` telebot.types.File ` ](../types.html#telebot.types.File
"telebot.types.File")
_ property _ user _ : [ User ](../types.html#telebot.types.User
"telebot.typ... | |
TeleBot/custom_filters_11_0.txt | _ class _ telebot.custom_filters. TextFilter ( _ equals : str | None = None _ , _ contains : list | tuple | None = None _ , _ starts_with : str | list | tuple | None = None _ , _ ends_with : str | list | tuple | None = None _ , _ ignore_case : bool = False _ ) #
Ba... | |
TeleBot/Types_of_API_54_0.txt | _ class _ telebot.types. ForceReply ( _ selective : bool | None = None _ , _ input_field_placeholder : str | None = None _ ) ¶
Bases: ` JsonSerializable `
Upon receiving a message with this object, Telegram clients will display a
reply interface to the user (act as if the user has selected ... | |
TeleBot/Types_of_API_147_0.txt | _ class _ telebot.types. ProximityAlertTriggered ( _ traveler _ , _
watcher _ , _ distance _ , _ ** kwargs _ ) ¶
Bases: ` JsonDeserializable `
This object represents the content of a service message, sent whenever a user
in the chat triggers a proximity alert set by another user.
Telegram Documenta... | |
TeleBot/Types_of_API_141_0.txt | _ class _ telebot.types. OrderInfo ( _ name = None _ , _ phone_number
= None _ , _ email = None _ , _ shipping_address = None _ , _ **
kwargs _ ) ¶
Bases: ` JsonDeserializable `
This object represents information about an order.
Telegram Documentation: [ https://core.telegram.org/bots/api#or... | |
TeleBot/Types_of_API_117_0.txt | _ class _ telebot.types. KeyboardButtonRequestUsers ( _ request_id : int _ , _ user_is_bot : bool | None = None _ , _ user_is_premium : bool | None = None _ , _ max_quantity : int | None = None _ , _ request_name : str | None = None _ , _ request_username : bool | None = None _... | |
TeleBot/Types_of_API_26_0.txt | _ class _ telebot.types. ChatBoostAdded ( _ boost_count _ , _ ** kwargs
_ ) ¶
Bases: ` JsonDeserializable `
This object represents a service message about a user boosting a chat.
Telegram documentation: [ https://core.telegram.org/bots/api#chatboostadded
](https://core.telegram.org/bots/api#chatboosta... | |
TeleBot/TeleBot_methods_2_40.txt | ceed max_tip_amount.
* **protect_content** ( ` bool ` ) – Protects the contents of the sent message from forwarding and saving
* **message_thread_id** ( ` int ` ) – The identifier of a message thread, in which the invoice message will be sent
* **reply_parameters** ( [ ` types.ReplyParameters ` ](../type... | |
TeleBot/TeleBot_16_0.txt | _ class _ telebot.handler_backends. BaseMiddleware #
Bases: ` object `
Base class for middleware. Your middlewares should be inherited from this
class.
Set update_sensitive=True if you want to get different updates on different
functions. For example, if you want to handle pre_process for message update,
t... | |
TeleBot/Types_of_API_175_0.txt | _ class _ telebot.types. VideoChatScheduled ( _ start_date _ , _ **
kwargs _ ) ¶
Bases: ` JsonDeserializable `
This object represents a service message about a video chat scheduled in the
chat.
Telegram Documentation: [
https://core.telegram.org/bots/api#videochatscheduled
](https://core.telegram.org/... | |
TeleBot/Types_of_API_80_0.txt | _ class _ telebot.types. InlineQueryResultCachedGif ( _ id _ , _
gif_file_id _ , _ title = None _ , _ description = None _ , _ caption
= None _ , _ caption_entities = None _ , _ parse_mode = None _ , _
reply_markup = None _ , _ input_message_content = None _ ) ¶
Bases: ` InlineQueryRe... | |
TeleBot/TeleBot_2_45.txt | d, in which the poll will be sent
* **reply_parameters** ( ` ReplyParameters ` ) – reply parameters.
Returns :
On success, the sent Message is returned.
Return type :
[ ` types.Message ` ](../types.html#telebot.types.Message
"telebot.types.Message")
send_sticker ( _ chat_id : int | str ... | |
TeleBot/Types_of_API_166_1.txt | n a chat. The bot must be an administrator in the chat and must explicitly specify “chat_member” in the list of allowed_updates to receive these updates.
* **chat_join_request** ( ` telebot.types.ChatJoinRequest ` ) – Optional. A request to join the chat has been sent. The bot must have the can_invite_users admin... | |
TeleBot/TeleBot_methods_2_58.txt | * **sticker_format** ( ` str ` ) – One of “static”, “animated”, “video”.
Returns :
On success, the sent file is returned.
Return type :
[ ` telebot.types.File ` ](../types.html#telebot.types.File
"telebot.types.File")
_ property _ user _ : [ User ](../types.html#telebot.types.User
"telebot.typ... | |
TeleBot/handler_backends_1_0.txt | _ class _ telebot.handler_backends. BaseMiddleware #
Bases: ` object `
Base class for middleware. Your middlewares should be inherited from this
class.
Set update_sensitive=True if you want to get different updates on different
functions. For example, if you want to handle pre_process for message update,
t... | |
TeleBot/Types_of_API_87_0.txt | _ class _ telebot.types. InlineQueryResultDocument ( _ id _ , _ title _
, _ document_url _ , _ mime_type _ , _ caption = None _ , _
caption_entities = None _ , _ parse_mode = None _ , _ description =
None _ , _ reply_markup = None _ , _ input_message_content = None _ , _
thumbnail_url = None ... | |
TeleBot/Types_of_API_43_0.txt | _ class _ telebot.types. ChatMemberUpdated ( _ chat _ , _ from_user _ ,
_ date _ , _ old_chat_member _ , _ new_chat_member _ , _ invite_link =
None _ , _ via_chat_folder_invite_link = None _ , _ ** kwargs _ ) ¶
Bases: ` JsonDeserializable `
This object represents changes in the status of a ch... | |
TeleBot/Types_of_API_134_0.txt | _ class _ telebot.types. MessageOrigin ( _ type : str _ , _ date :
int _ ) ¶
Bases: ` JsonDeserializable `
This object describes the origin of a message.
Telegram documentation: [ https://core.telegram.org/bots/api#messageorigin
](https://core.telegram.org/bots/api#messageorigin)
Parameters :
... | |
TeleBot/TeleBot_4_0.txt | _ class _ telebot.custom_filters. ChatFilter #
Bases: ` AdvancedCustomFilter `
Check whether chat_id corresponds to given chat_id.
Example on using this filter: #
@bot.message_handler(chat_id=[99999])
# your function
key _ : str _ _ = 'chat_id' _ #
| |
TeleBot/Types_of_API_159_0.txt | _ class _ telebot.types. ShippingQuery ( _ id _ , _ from_user _ , _
invoice_payload _ , _ shipping_address _ , _ ** kwargs _ ) ¶
Bases: ` JsonDeserializable `
This object contains information about an incoming shipping query.
Telegram Documentation: [ https://core.telegram.org/bots/api#shippingque... | |
TeleBot/Types_of_API_162_0.txt | _ class _ telebot.types. Story ( _ chat : Chat _ , _ id : int _ , _
** kwargs _ ) ¶
Bases: ` JsonDeserializable `
This object represents a story.
Telegram documentation: [ https://core.telegram.org/bots/api#story
](https://core.telegram.org/bots/api#story)
Parameters :
* **chat** ( `... | |
TeleBot/TeleBot_2_44.txt | is_closed : bool | None = None _ , _ disable_notification : bool | None = False _ , _ reply_to_message_id : int | None = None _ , _ reply_markup : [ InlineKeyboardMarkup ](../types.html#telebot.types.InlineKeyboardMarkup "telebot.types.InlineKeyboardMarkup") | [ ReplyKeyboardMarkup ](../types.... | |
TeleBot/Types_of_API_186_1.txt | ultArticle.thumb_width `
* ` InlineQueryResultAudio `
* ` InlineQueryResultBase `
* ` InlineQueryResultCachedAudio `
* ` InlineQueryResultCachedBase `
* ` InlineQueryResultCachedDocument `
* ` InlineQueryResultCachedGif `
* ` InlineQueryResultCachedMpeg4Gif `
* ` InlineQueryResul... | |
TeleBot/TeleBot_2_10.txt | ropriate admin rights. Returns True on success. Note: In regular
groups (non-supergroups), this method will only work if the ‘All Members Are
Admins’ setting is off in the target group.
Parameters :
**chat_id** ( ` int ` or ` str ` ) – Int or Str: Unique identifier for the
target chat or username of the tar... | |
TeleBot/Types_of_API_2_0.txt | _ class _ telebot.types. Audio ( _ file_id _ , _ file_unique_id _ , _
duration _ , _ performer = None _ , _ title = None _ , _ file_name =
None _ , _ mime_type = None _ , _ file_size = None _ , _ thumbnail =
None _ , _ ** kwargs _ ) ¶
Bases: ` JsonDeserializable `
This object represe... | |
TeleBot/Types_of_API_183_0.txt | _ class _ telebot.types. WebAppData ( _ data _ , _ button_text _ , _ **
kwargs _ ) ¶
Bases: ` JsonDeserializable ` , ` Dictionaryable `
Describes data sent from a Web App to the bot.
Telegram Documentation: [ https://core.telegram.org/bots/api#webappdata
](https://core.telegram.org/bots/api#webappd... | |
TeleBot/Types_of_API_33_0.txt | _ class _ telebot.types. ChatInviteLink ( _ invite_link _ , _ creator _
, _ creates_join_request _ , _ is_primary _ , _ is_revoked _ , _ name =
None _ , _ expire_date = None _ , _ member_limit = None _ , _
pending_join_request_count = None _ , _ ** kwargs _ ) ¶
Bases: ` JsonSerializable ... | |
TeleBot/Types_of_API_92_0.txt | _ class _ telebot.types. InlineQueryResultPhoto ( _ id _ , _ photo_url _
, _ thumbnail_url _ , _ photo_width = None _ , _ photo_height = None _
, _ title = None _ , _ description = None _ , _ caption = None _ , _
caption_entities = None _ , _ parse_mode = None _ , _ reply_markup =
None _ ,... | |
TeleBot/TeleBot_2_31.txt | n type :
Optional[Any]
revoke_chat_invite_link ( _ chat_id : int | str _ , _ invite_link : str _ ) → [ ChatInviteLink ](../types.html#telebot.types.ChatInviteLink "telebot.types.ChatInviteLink") #
Use this method to revoke an invite link created by the bot. Note: If the
primary link is revo... | |
TeleBot/TeleBot_2_1.txt | ** ( ` int ` ) – Chat’s identifier
* **kwargs** – Data to add
Returns :
None
add_sticker_to_set ( _ user_id : int _ , _ name : str _ , _ emojis : List [ str ] | str _ , _ png_sticker : str | Any | None = None _ , _ tgs_sticker : str | Any | None = None _ , _ webm_sticke... | |
TeleBot/Types_of_API_127_3.txt | Optional. Service message: video chat started
* **video_chat_ended** ( ` telebot.types.VideoChatEnded ` ) – Optional. Service message: video chat ended
* **video_chat_participants_invited** ( ` telebot.types.VideoChatParticipantsInvited ` ) – Optional. Service message: new participants invited to a video c... | |
TeleBot/Types_of_API_75_0.txt | _ class _ telebot.types. InlineQueryResultAudio ( _ id _ , _ audio_url _
, _ title _ , _ caption = None _ , _ caption_entities = None _ , _
parse_mode = None _ , _ performer = None _ , _ audio_duration = None
_ , _ reply_markup = None _ , _ input_message_content = None _ ) ¶
Bases: `... | |
TeleBot/Types_of_API_21_0.txt | _ class _ telebot.types. BusinessOpeningHoursInterval ( _ opening_minute
_ , _ closing_minute _ , _ ** kwargs _ ) ¶
Bases: ` JsonDeserializable `
This object represents a business opening hours interval.
Telegram documentation: [
https://core.telegram.org/bots/api#businessopeninghoursinterval
](https... | |
TeleBot/Types_of_API_170_0.txt | _ class _ telebot.types. UsersShared ( _ request_id _ , _ user_ids :
SharedUser _ , _ ** kwargs _ ) ¶
Bases: ` JsonDeserializable `
This object contains information about the users whose identifiers were shared
with the bot using a KeyboardButtonRequestUsers button.
Telegram documentation: [ https:... | |
TeleBot/Types_of_API_149_0.txt | _ class _ telebot.types. ReactionType ( _ type : str _ ) ¶
Bases: ` JsonDeserializable ` , ` Dictionaryable ` , ` JsonSerializable
`
This object represents a reaction type.
Telegram documentation: [ https://core.telegram.org/bots/api#reactiontype
](https://core.telegram.org/bots/api#reactiontype)
... | |
TeleBot/Types_of_API_119_0.txt | _ class _ telebot.types. LinkPreviewOptions ( _ is_disabled : bool | None = None _ , _ url : str | None = None _ , _ prefer_small_media : bool | None = None _ , _ prefer_large_media : bool | None = None _ , _ show_above_text : bool | None = None _ , _ ** kwargs _ ) ¶
Bas... | |
TeleBot/Types_of_API_84_0.txt | _ class _ telebot.types. InlineQueryResultCachedVideo ( _ id _ , _
video_file_id _ , _ title _ , _ description = None _ , _ caption = None
_ , _ caption_entities = None _ , _ parse_mode = None _ , _ reply_markup
= None _ , _ input_message_content = None _ ) ¶
Bases: ` InlineQueryResultCa... | |
TeleBot/TeleBot_methods_2_48.txt | [ ` telebot.types.ForceReply ` ](../types.html#telebot.types.ForceReply "telebot.types.ForceReply") ) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
* **timeout** ( ` int ` ) – Timeou... | |
TeleBot/Types_of_API_90_0.txt | _ class _ telebot.types. InlineQueryResultLocation ( _ id _ , _ title _
, _ latitude _ , _ longitude _ , _ horizontal_accuracy _ , _ live_period =
None _ , _ reply_markup = None _ , _ input_message_content = None _ , _
thumbnail_url = None _ , _ thumbnail_width = None _ , _ thumbnail_height
= No... | |
TeleBot/Types_of_API_114_0.txt | _ class _ telebot.types. KeyboardButtonPollType ( _ type = '' _ ) ¶
Bases: ` Dictionaryable `
This object represents type of a poll, which is allowed to be created and sent
when the corresponding button is pressed.
Telegram Documentation: [
https://core.telegram.org/bots/api#keyboardbuttonpolltype
](... | |
TeleBot/Types_of_API_48_0.txt | _ class _ telebot.types. Contact ( _ phone_number _ , _ first_name _ , _
last_name = None _ , _ user_id = None _ , _ vcard = None _ , _ **
kwargs _ ) ¶
Bases: ` JsonDeserializable `
This object represents a phone contact.
Telegram Documentation: [ https://core.telegram.org/bots/api#contact
]... | |
TeleBot/TeleBot_2_26.txt | ler.
Parameters :
* **callback** ( ` function ` ) – function to be called
* **func** ( ` function ` ) – Function executed as a filter
* **pass_bot** ( ` bool ` ) – True if you need to pass TeleBot instance to handler(useful for separating handlers into different files)
* **kwargs** – Optional ... | |
TeleBot/TeleBot_2_12.txt | s_join_request** ( ` bool ` ) – True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can’t be specified
Returns :
Returns the new invite link as ChatInviteLink object.
Return type :
[ ` telebot.types.ChatInviteLink `
](../types.html#telebot.... | |
TeleBot/Types_of_API_25_0.txt | _ class _ telebot.types. ChatBoost ( _ boost_id _ , _ add_date _ , _
expiration_date _ , _ source _ , _ ** kwargs _ ) ¶
Bases: ` JsonDeserializable `
This object contains information about a chat boost.
Telegram documentation: [ https://core.telegram.org/bots/api#chatboost
](https://core.telegram.... | |
TeleBot/TeleBot_methods_2_51.txt |
True on success.
Return type :
` bool `
set_chat_permissions ( _ chat_id : int | str _ , _ permissions : [ ChatPermissions ](../types.html#telebot.types.ChatPermissions "telebot.types.ChatPermissions") _ , _ use_independent_chat_permissions : bool | None = None _ ) → bool #
Use t... | |
TeleBot/Types_of_API_96_0.txt | _ class _ telebot.types. InlineQueryResultsButton ( _ text : str _ , _ web_app : WebAppInfo | None = None _ , _ start_parameter : str | None = None _ ) ¶
Bases: ` JsonSerializable ` , ` Dictionaryable `
This object represents a button to be shown above inline query results. You
must us... | |
TeleBot/Types_of_API_133_0.txt | _ class _ telebot.types. MessageID ( _ message_id _ , _ ** kwargs _ )
¶
Bases: ` JsonDeserializable `
This object represents a unique message identifier.
Telegram Documentation: [ https://core.telegram.org/bots/api#messageid
](https://core.telegram.org/bots/api#messageid)
Parameters :
**messa... | |
TeleBot/custom_filters_2_0.txt | _ class _ telebot.custom_filters. ChatFilter #
Bases: ` AdvancedCustomFilter `
Check whether chat_id corresponds to given chat_id.
Example on using this filter: #
@bot.message_handler(chat_id=[99999])
# your function
key _ : str _ _ = 'chat_id' _ #
| |
TeleBot/handler_backends_3_0.txt | _ class _ telebot.handler_backends. ContinueHandling #
Bases: ` object `
Class for continue updates in handlers. Just return instance of this class in
handlers to continue process.
Example of using ContinueHandling #
@bot.message_handler(commands=['start'])
def start(message):
b... | |
TeleBot/TeleBot_methods_2_1.txt | ** ( ` int ` ) – Chat’s identifier
* **kwargs** – Data to add
Returns :
None
add_sticker_to_set ( _ user_id : int _ , _ name : str _ , _ emojis : List [ str ] | str _ , _ png_sticker : str | Any | None = None _ , _ tgs_sticker : str | Any | None = None _ , _ webm_sticke... | |
TeleBot/TeleBot_methods_2_11.txt | rs :
* **scope** ( [ ` telebot.types.BotCommandScope ` ](../types.html#telebot.types.BotCommandScope "telebot.types.BotCommandScope") ) – The scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.
* **language_code** ( ` str ` ) – A two-letter ISO 639-1 language code. If... | |
TeleBot/Types_of_API_86_0.txt | _ class _ telebot.types. InlineQueryResultContact ( _ id _ , _
phone_number _ , _ first_name _ , _ last_name = None _ , _ vcard = None
_ , _ reply_markup = None _ , _ input_message_content = None _ , _
thumbnail_url = None _ , _ thumbnail_width = None _ , _ thumbnail_height
= None _ ) ¶
... | |
TeleBot/TeleBot_methods_2_38.txt | str _ , _ disable_notification : bool | None = None _ , _ reply_to_message_id : int | None = None _ , _ reply_markup : [ InlineKeyboardMarkup ](../types.html#telebot.types.InlineKeyboardMarkup "telebot.types.InlineKeyboardMarkup") | [ ReplyKeyboardMarkup ](../types.html#telebot.types.ReplyKeyboardMa... | |
TeleBot/Types_of_API_11_0.txt | _ class _ telebot.types. BotCommandScopeChatMember ( _ chat_id = None _
, _ user_id = None _ ) ¶
Bases: ` BotCommandScope `
Represents the scope of bot commands, covering a specific member of a group or
supergroup chat.
Telegram Documentation: [
https://core.telegram.org/bots/api#botcommandscopech... | |
TeleBot/custom_filters_9_0.txt | _ class _ telebot.custom_filters. StateFilter ( _ bot _ ) #
Bases: ` AdvancedCustomFilter `
Filter to check state.
Example on using this filter: #
@bot.message_handler(state=1)
# your function
key _ : str _ _ = 'state' _ #
| |
TeleBot/Types_of_API_23_1.txt | urned only in getChat. Always returned in getChat.
* **background_custom_emoji_id** ( ` str ` ) – Optional. Custom emoji identifier of emoji chosen by the chat for the reply header and link preview background. Returned only in getChat.
* **profile_accent_color_id** ( ` int ` ) – Optional. Identifier of the ac... | |
TeleBot/TeleBot_2_32.txt | _ , _ parse_mode : str | None = None _ , _ caption_entities : List [ [ MessageEntity ](../types.html#telebot.types.MessageEntity "telebot.types.MessageEntity") ] | None = None _ , _ disable_notification : bool | None = None _ , _ protect_content : bool | None = None _ , _ reply_to_message... | |
TeleBot/Types_of_API_78_0.txt | _ class _ telebot.types. InlineQueryResultCachedBase ¶
Bases: ` ABC ` , ` JsonSerializable `
Base class of all InlineQueryResultCached* classes.
| |
TeleBot/Types_of_API_58_0.txt | _ class _ telebot.types. ForumTopicEdited ( _ name : str | None = None _ , _ icon_custom_emoji_id : str | None = None _ , _ ** kwargs _ ) ¶
Bases: ` JsonDeserializable `
This object represents a service message about an edited forum topic.
Telegram documentation: [ https://core.telegram.... | |
TeleBot/TeleBot_3_0.txt | _ class _ telebot.custom_filters. AdvancedCustomFilter #
Bases: ` ABC `
Advanced Custom Filter base class. Create child class with check() method.
Accepts two parameters, returns bool: True - filter passed, False - filter
failed. message: Message class text: Filter value given in handler
Child classes shou... | |
TeleBot/TeleBot_methods_2_49.txt | lently. Users will receive a notification with no sound.
* **reply_to_message_id** ( ` int ` ) – deprecated.
* **allow_sending_without_reply** ( ` bool ` ) – deprecated.
* **timeout** ( ` int ` ) – Timeout in seconds for the request.
* **thumbnail** ( ` str ` or [ ` telebot.types.InputFile ` ](../t... | |
TeleBot/Types_of_API_142_0.txt | _ class _ telebot.types. PhotoSize ( _ file_id _ , _ file_unique_id _ ,
_ width _ , _ height _ , _ file_size = None _ , _ ** kwargs _ ) ¶
Bases: ` JsonDeserializable `
This object represents one size of a photo or a file / sticker thumbnail.
Telegram Documentation: [ https://core.telegram.org/b... | |
TeleBot/Types_of_API_137_0.txt | _ class _ telebot.types. MessageOriginHiddenUser ( _ date : int _ , _
sender_user_name : str _ ) ¶
Bases: ` MessageOrigin `
The message was originally sent by an unknown user.
Parameters :
**sender_user_name** ( ` str ` ) – Name of the user that sent the message
originally
| |
TeleBot/TeleBot_methods_2_21.txt | olling (see API docs)
* **skip_pending** ( ` bool ` ) – skip old updates
* **logger_level** ( ` int ` .) – Custom (different from logger itself) logging level for infinity_polling logging. Use logger levels from logging as a value. None/NOTSET = no error logging
* **allowed_updates** ( ` list ` of ` str ... | |
TeleBot/TeleBot_2_42.txt | ypes.ForceReply "telebot.types.ForceReply") | None = None _ , _ timeout : int | None = None _ , _ message_thread_id : int | None = None _ , _ reply_parameters : [ ReplyParameters ](../types.html#telebot.types.ReplyParameters "telebot.types.ReplyParameters") | None = None _ , _ link_preview_opti... | |
TeleBot/Types_of_API_186_0.txt | _ class _ telebot.types. WriteAccessAllowed ( _ from_request : bool | None = None _ , _ web_app_name : str | None = None _ , _ from_attachment_menu : bool | None = None _ , _ ** kwargs _ ) ¶
Bases: ` JsonDeserializable `
This object represents a service message about a user allowin... | |
TeleBot/Types_of_API_45_0.txt | _ class _ telebot.types. ChatPhoto ( _ small_file_id _ , _
small_file_unique_id _ , _ big_file_id _ , _ big_file_unique_id _ , _ **
kwargs _ ) ¶
Bases: ` JsonDeserializable `
This object represents a chat photo.
Telegram Documentation: [ https://core.telegram.org/bots/api#chatphoto
](https://core.t... | |
TeleBot/Types_of_API_56_0.txt | _ class _ telebot.types. ForumTopicClosed ¶
Bases: ` JsonDeserializable `
This object represents a service message about a forum topic closed in the
chat. Currently holds no information.
Telegram documentation: [ https://core.telegram.org/bots/api#forumtopicclosed
](https://core.telegram.org/bots/api#foru... | |
TeleBot/TeleBot_methods_0_0.txt | _ class _ telebot. ExceptionHandler #
Bases: ` object `
Class for handling exceptions while Polling
handle ( _ exception _ ) #
| |
TeleBot/Types_of_API_74_0.txt | _ class _ telebot.types. InlineQueryResultArticle ( _ id _ , _ title _ ,
_ input_message_content _ , _ reply_markup = None _ , _ url = None _ ,
_ hide_url = None _ , _ description = None _ , _ thumbnail_url = None
_ , _ thumbnail_width = None _ , _ thumbnail_height = None _ ) ¶
Bases:... | |
TeleBot/TeleBot_2_11.txt | rs :
* **scope** ( [ ` telebot.types.BotCommandScope ` ](../types.html#telebot.types.BotCommandScope "telebot.types.BotCommandScope") ) – The scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.
* **language_code** ( ` str ` ) – A two-letter ISO 639-1 language code. If... | |
TeleBot/custom_filters_7_0.txt | _ class _ telebot.custom_filters. LanguageFilter #
Bases: ` AdvancedCustomFilter `
Check users language_code.
Example on using this filter: #
@bot.message_handler(language_code=['ru'])
# your function
key _ : str _ _ = 'language_code' _ #
| |
TeleBot/Types_of_API_41_0.txt | _ class _ telebot.types. ChatMemberOwner ( _ user _ , _ status _ , _
custom_title = None _ , _ is_anonymous = None _ , _ can_be_edited =
None _ , _ can_post_messages = None _ , _ can_edit_messages = None _ ,
_ can_delete_messages = None _ , _ can_restrict_members = None _ , _
can_promote_membe... | |
TeleBot/Types_of_API_122_0.txt | _ class _ telebot.types. MaskPosition ( _ point _ , _ x_shift _ , _
y_shift _ , _ scale _ , _ ** kwargs _ ) ¶
Bases: ` Dictionaryable ` , ` JsonDeserializable ` , ` JsonSerializable
`
This object describes the position on faces where a mask should be placed by
default.
Telegram Documentation: [... | |
TeleBot/TeleBot_methods_2_12.txt | s_join_request** ( ` bool ` ) – True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can’t be specified
Returns :
Returns the new invite link as ChatInviteLink object.
Return type :
[ ` telebot.types.ChatInviteLink `
](../types.html#telebot.... | |
TeleBot/TeleBot_methods_2_7.txt | essages don’t have a link to the original
message. Album grouping is kept for copied messages. On success, an array of
MessageId of the sent messages is returned.
Parameters :
* **chat_id** ( ` int ` or ` str ` ) – Unique identifier for the target chat or username of the target channel (in the format @cha... | |
TeleBot/TeleBot_2_6.txt | oardMarkup") | [ ReplyKeyboardRemove ](../types.html#telebot.types.ReplyKeyboardRemove "telebot.types.ReplyKeyboardRemove") | [ ForceReply ](../types.html#telebot.types.ForceReply "telebot.types.ForceReply") | None = None _ , _ timeout : int | None = None _ , _ message_thread_id : int | None = None... | |
TeleBot/Types_of_API_20_0.txt | _ class _ telebot.types. BusinessOpeningHours ( _ time_zone_name _ , _
opening_hours _ , _ ** kwargs _ ) ¶
Bases: ` JsonDeserializable `
This object represents business opening hours.
Telegram documentation: [
https://core.telegram.org/bots/api#businessopeninghours
](https://core.telegram.org/bots/a... | |
TeleBot/Types_of_API_139_0.txt | _ class _ telebot.types. MessageReactionCountUpdated ( _ chat : Chat _
, _ message_id : int _ , _ date : int _ , _ reactions : List [
ReactionCount ] _ , _ ** kwargs _ ) ¶
Bases: ` JsonDeserializable `
This object represents a service message about a change in the list of the
current user... | |
TeleBot/TeleBot_8_0.txt | _ class _ telebot.custom_filters. IsReplyFilter #
Bases: ` SimpleCustomFilter `
Check whether message is a reply.
Example on using this filter: #
@bot.message_handler(is_reply=True)
# your function
key _ : str _ _ = 'is_reply' _ #
| |
TeleBot/Types_of_API_116_0.txt | _ class _ telebot.types. KeyboardButtonRequestUser ( _ request_id : int _ , _ user_is_bot : bool | None = None _ , _ user_is_premium : bool | None = None _ , _ max_quantity : int | None = None _ ) ¶
Bases: ` KeyboardButtonRequestUsers `
Deprecated. Use KeyboardButtonRequestUsers i... | |
TeleBot/TeleBot_methods_2_13.txt | bot.types.Message") | ` bool `
edit_message_live_location ( _ latitude : float _ , _ longitude : float _ , _ chat_id : int | str | None = None _ , _ message_id : int | None = None _ , _ inline_message_id : str | None = None _ , _ reply_markup : [ InlineKeyboardMarkup ](../types.html#... | |
TeleBot/Types_of_API_115_0.txt | _ class _ telebot.types. KeyboardButtonRequestChat ( _ request_id : int _ , _ chat_is_channel : bool _ , _ chat_is_forum : bool | None = None _ , _ chat_has_username : bool | None = None _ , _ chat_is_created : bool | None = None _ , _ user_administrator_rights : ChatAdministratorRights... | |
TeleBot/TeleBot_methods_2_25.txt | ` bool ` ) – Pass True, if the administrator can restrict, ban or unban chat members
* **can_pin_messages** ( ` bool ` ) – Pass True, if the administrator can pin messages, supergroups only
* **can_promote_members** ( ` bool ` ) – Pass True, if the administrator can add new administrators with a subset of h... | |
TeleBot/Types_of_API_88_0.txt | _ class _ telebot.types. InlineQueryResultGame ( _ id _ , _
game_short_name _ , _ reply_markup = None _ ) ¶
Bases: ` InlineQueryResultBase `
Represents a Game.
Telegram Documentation: [
https://core.telegram.org/bots/api#inlinequeryresultgame
](https://core.telegram.org/bots/api#inlinequeryresultga... | |
TeleBot/TeleBot_2_43.txt | elebot.types.ReplyKeyboardRemove "telebot.types.ReplyKeyboardRemove") | [ ForceReply ](../types.html#telebot.types.ForceReply "telebot.types.ForceReply") | None = None _ , _ timeout : int | None = None _ , _ message_thread_id : int | None = None _ , _ has_spoiler : bool | None = None _ , _ re... | |
TeleBot/TeleBot_methods_2_20.txt | l) – Request connection timeout
* **allowed_updates** ( ` list ` , optional) – Array of string. List the types of updates you want your bot to receive.
* **long_polling_timeout** ( ` int ` , optional) – Timeout in seconds for long polling.
Returns :
An Array of Update objects is returned.
Return ty... | |
TeleBot/TeleBot_17_0.txt | _ class _ telebot.handler_backends. CancelUpdate #
Bases: ` object `
Class for canceling updates. Just return instance of this class in middleware
to skip update. Update will skip handler and execution of post_process in
middlewares.
| |
TeleBot/custom_filters_3_0.txt | _ class _ telebot.custom_filters. ForwardFilter #
Bases: ` SimpleCustomFilter `
Check whether message was forwarded from channel or group.
Example on using this filter: #
@bot.message_handler(is_forwarded=True)
# your function
key _ : str _ _ = 'is_forwarded' _ #
| |
TeleBot/TeleBot_methods_2_24.txt | tom (different from logger itself) logging level for infinity_polling logging. Use logger levels from logging as a value. None/NOTSET = no error logging
* **allowed_updates** ( ` list ` of ` str ` ) –
A list of the update types you want your bot to receive. For example, specify
[“message”, “edited_channel_post”... | |
TeleBot/TeleBot_2_9.txt | ns_masks : bool | None = None _ , _ sticker_type : str | None = None _ , _ mask_position : [ MaskPosition ](../types.html#telebot.types.MaskPosition "telebot.types.MaskPosition") | None = None _ , _ needs_repainting : bool | None = None _ , _ stickers : List [ [ InputSticker ](../types.... | |
TeleBot/Types_of_API_186_2.txt | * ` ProximityAlertTriggered `
* ` ReactionCount `
* ` ReactionType `
* ` ReactionTypeCustomEmoji `
* ` ReactionTypeEmoji `
* ` ReplyKeyboardMarkup `
* ` ReplyKeyboardMarkup.add() `
* ` ReplyKeyboardMarkup.max_row_keys `
* ` ReplyKeyboardMarkup.row() `
* ` ReplyKeyb... | |
TeleBot/Types_of_API_150_0.txt | _ class _ telebot.types. ReactionTypeCustomEmoji ( _ custom_emoji_id :
str _ , _ ** kwargs _ ) ¶
Bases: ` ReactionType `
This object represents a custom emoji reaction type.
Telegram documentation: [
https://core.telegram.org/bots/api#reactiontypecustomemoji
](https://core.telegram.org/bots/api#reac... | |
TeleBot/Types_of_API_64_0.txt | _ class _ telebot.types. GeneralForumTopicHidden ¶
Bases: ` JsonDeserializable `
This object represents a service message about General forum topic hidden in
the chat. Currently holds no information.
Telegram documentation: [
https://core.telegram.org/bots/api#generalforumtopichidden
](https://core.telegr... | |
TeleBot/TeleBot_methods_2_44.txt | is_closed : bool | None = None _ , _ disable_notification : bool | None = False _ , _ reply_to_message_id : int | None = None _ , _ reply_markup : [ InlineKeyboardMarkup ](../types.html#telebot.types.InlineKeyboardMarkup "telebot.types.InlineKeyboardMarkup") | [ ReplyKeyboardMarkup ](../types.... | |
TeleBot/TeleBot_methods_2_3.txt | ation: [
Parameters :
* **shipping_query_id** ( ` str ` ) – Unique identifier for the query to be answered
* **ok** ( ` bool ` ) – Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)
* ... | |
TeleBot/TeleBot_2_2.txt | _ is_personal : bool | None = None _ , _ next_offset : str | None = None _ , _ switch_pm_text : str | None = None _ , _ switch_pm_parameter : str | None = None _ , _ button : [ InlineQueryResultsButton ](../types.html#telebot.types.InlineQueryResultsButton "telebot.types.InlineQueryResul... | |
TeleBot/Types_of_API_61_0.txt | _ classmethod _ parse_entities ( _ message_entity_array _ ) ¶
Parse the message entity array into a list of MessageEntity objects
| |
TeleBot/TeleBot_methods_2_57.txt | or username of the target channel (in the format @channelusername)
* **sender_chat_id** ( ` int ` or ` str ` ) – Unique identifier of the target sender chat.
Returns :
True on success.
Return type :
` bool `
unhide_general_forum_topic ( _ chat_id : int | str _ ) → bool #
Use... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.